Previous topic

pycrtools.rftools

Next topic

pycrtools.srcfind

This Page

pycrtools.simhelp

GetAngleMagneticField(theta, phi) Returns the angle between the shower and the magnetic field.
checkLDFFitQuality(ldf_fit_output) Returns True or False for the quality of the LDF reconstruction for simulation purposes.
check_conex(datadir, x_estimate[, ...]) Check if CONEX simulations are complete.
create_antenna_position_file(eventID, az, zen) Creates a file with antenna positions for input into CoREAS.
generate_cr_simulation(eventID, ...[, conex]) Schedule a CONEX or CoREAS simulation.
running_jobs() Returns a list of jobs that are currently running in the scheduler.
setSimulationDirection(run_wavefront, ...[, ...]) Sets the direction to use for the automated simulations.
setSimulationEnergy(ldf_fit_energy, quality, ...) Sets the energy from the LDF fit parameters or the original LORA energy in the database.
setSimulationStatus(old_status, ...[, ...]) Logic to decide whether a shower should be simulated automatically by the pipeline.
setSimulationXmax(ldf_fit_output, quality, ...) Calculates the Xmax from the LDF fit parameters and sets the corresponding value in the database.
simulation_complete(eventID, runno, ...) Returns the completeness of the requested simulation as True or False.
writefile(name, eventID, energy, az, zen, ...) Creates a CoREAS input file.

Module for interfacing with CoREAS. Used by ‘’cr_simulation.py’‘.

Module author: Pim Schellart <P.Schellart@astro.ru.nl>

pycrtools.simhelp.GetAngleMagneticField(theta, phi)

Returns the angle between the shower and the magnetic field.

Properties

Parameter Description
theta elevation angle of shower in LOFAR convention and degrees
phi azimuth angle of shower in LOFAR convention and degrees
pycrtools.simhelp.checkLDFFitQuality(ldf_fit_output)

Returns True or False for the quality of the LDF reconstruction for simulation purposes. Thus, somewhat conservative cuts are required.

Properties

Parameter Description
ldf_output Dictionary as generated by the task ldf.py
pycrtools.simhelp.check_conex(datadir, x_estimate, n_around_x_estimate=11, n_proton=11, n_iron=5)

Check if CONEX simulations are complete.

Selects n_around_x_estimate simulations around the x_estimate value. Additionally n_proton and n_iron simulations are selected from their full respective ranges.

Properties

Parameter Description
datadir directory where simulations are located
x_estimate X_max estimate arround which simulations are selected
n_around_x_estimate number of simulations to select around X_max estimate
n_proton number of proton simulations to select
n_iron number of iron simulations to select

Returns

(nevents_proton, nevents_iron, proton_ok, iron_ok, runno_proton, runno_iron)

Field Description
nevents_proton number of completed proton simulations that match the criteria
nevents_iron number of completed iron simulations that match the criteria
proton_ok do we have sufficient (i.e. n_proton) proton simulations
iron_ok do we have sufficient (i.e. n_iron) iron simulations
runno_proton what are the runnumbers of the selected proton simulations
runno_iron what are the runnumbers of the selected iron simulations
pycrtools.simhelp.create_antenna_position_file(eventID, az, zen)

Creates a file with antenna positions for input into CoREAS.

Properties

Parameter Description
eventID event id from the database
az arrival direction azimuth (Auger definition)
zen arrival direction zenith (Auger definition)
pycrtools.simhelp.generate_cr_simulation(eventID, event_output_directory, particle_type, energy, az, zen, runnum, conex=False)

Schedule a CONEX or CoREAS simulation.

Properties

Parameter Description
name filename
eventID event id from the database
energy energy in GeV
az arrival direction azimuth (Auger definition)
zen arrival direction zenith (Auger definition)
particle_type particle type in CORSIKA numerical notation
runnum scheduler run number
conex CONEX True or CoREAS False simulations
pycrtools.simhelp.running_jobs()

Returns a list of jobs that are currently running in the scheduler.

pycrtools.simhelp.setSimulationDirection(run_wavefront, wavefront_output, chi2, average_direction, fitAzEl, angle=3.0)

Sets the direction to use for the automated simulations. Checks whether wavefront has run reliably.

Properties

Parameter Description
run_wavefront True or False value if wavefront task was run
wavefront_output Output dictionary of wavefront.py
chi2 Chi^2 of wavefront fit
average_direction Average direction of plane wave fit.
fitAzEl Wavefront return value for direction.
angle Value allowed for deviation (in degree) between wavefront and plane wave fit
pycrtools.simhelp.setSimulationEnergy(ldf_fit_energy, quality, lora_energy)

Sets the energy from the LDF fit parameters or the original LORA energy in the database.

Properties

Parameter Description
ldf_fit_energy Output of task ldf.py
quality Return value of checkLDFFitQuality
lora_energy Database values stored from the original LORA reconstruction
pycrtools.simhelp.setSimulationStatus(old_status, old_statusmessage, nof_good_stations, flagged, hba, average_direction, lora_direction, angle=10.0, overwrite=False)

Logic to decide whether a shower should be simulated automatically by the pipeline.

Properties

Parameter Description
old_status Status of event before the pipeline was run again.
old_statusmessage Statusmessage of event before the pipeline was run again.
nof_good_stations Number of good stations identified by pipeline
flagged Parameter to indicate whether event was flagged (thunderstorm or other)
hba Parameter to indicate whether event is HBA event
average_direction Average direction from plane wave fit
lora_direction Direction reconstructed with LORA (database parameter)
angle Difference in degree allowed between average_direction and lora_direction
overwrite Should the old status be overwritten?
pycrtools.simhelp.setSimulationXmax(ldf_fit_output, quality, elevation, xmax_conversion=[230.0, 0.91, 0.008], full_atmosphere=1036.0)

Calculates the Xmax from the LDF fit parameters and sets the corresponding value in the database.

Properties

Parameter Description
ldf_output Dictionary as generated by the task ldf.py
quality Return value of checkLDFFitQuality
elevation Elevation angle of shower in LOFAR convention and degrees
xmax_conversion Values to convert fitted sigma to xmax (from LDF paper)
full_atmosphere US Standard atmosphere above LOFAR
pycrtools.simhelp.simulation_complete(eventID, runno, particle_type, iteration)

Returns the completeness of the requested simulation as True or False.

Properties

Parameter Description
eventID event id from the database
runno run number from the scheduler
*particle_type numerical type of the primary particle in CORSIKA notation
iteration iteration of the simulation
pycrtools.simhelp.writefile(name, eventID, energy, az, zen, particle_type, simdir, conex=False)

Creates a CoREAS input file.

Properties

Parameter Description
name filename
eventID event id from the database
energy energy in GeV
az arrival direction azimuth (Auger definition)
zen arrival direction zenith (Auger definition)
particle_type particle type in CORSIKA numerical notation
simdir directory containing simulations
conex CONEX True or CoREAS False simulations