NuRadioReco.modules.io.coreas.readCoREASShower module

class NuRadioReco.modules.io.coreas.readCoREASShower.readCoREASShower

Bases: object

This module can be used to read in all simulated “observers” from a CoREAS simulation and return them as stations. This is in particular useful for air shower array experiments like Auger, LOFAR or SKA. However, it is important to stress that this module will return a station object per simulated observer. That fits well the terminology used in Auger were a “Station” is a dual-polerized antenna. However, for other experiments like LOFAR or SKA where a “Station” is a cluster of (dual-polerized) antennas, the user has to be aware that this module will return a station object per antenna.

Methods

begin(input_files[, det, logger_level, ...])	begin method
run()	Reads in CoREAS file(s) and returns one event containing all simulated observer positions as stations.

end

begin(input_files, det=None, logger_level=0, set_ascending_run_and_event_number=False)

begin method

initialize readCoREASShower module

Parameters:

input_files: input files

list of coreas hdf5 files

det: genericDetector object

If a genericDetector is passed, the stations from the CoREAS file will be added to it and the run method returns both the event and the detector

logger_level: string or logging variable

Set verbosity level for logger (default: logging.NOTSET)

set_ascending_run_and_event_number: bool

If set to True the run number and event id is set to self.__ascending_run_and_event_number instead of beeing taken from the simulation file. The value is increases monoton. This can be used to avoid ambiguities values (default: False)

run()

Reads in CoREAS file(s) and returns one event containing all simulated observer positions as stations.

Yields:

evtNuRadioReco.framework.event.Event

The event containing the simulated observer as sim. stations.

detNuRadioReco.detector.generic_detector.GenericDetector

Optional, only if a detector description is passed to the begin method. Contains the detector description with the on-the-fly added stations.

end()

NuRadioReco.modules.io.coreas.readCoREASShower.antenna_id(antenna_name, default_id)

This function parses the antenna names given in a CoREAS simulation and tries to find an ID It can be extended to other name patterns