NuRadioReco.modules.io.coreas.readCoREAS module

class NuRadioReco.modules.io.coreas.readCoREAS.readCoREAS

Bases: object

Methods

begin(input_files, station_id[, n_cores, ...])	begin method
run(detector[, output_mode])	Read in a random sample of stations from a CoREAS file.

end

begin(input_files, station_id, n_cores=10, max_distance=2000.0, seed=None)

begin method

initialize readCoREAS module

Parameters:

input_files: input files

list of coreas hdf5 files

station_id: station id

id number of the station

n_cores: number of cores (integer)

the number of random core positions to generate for each input file

max_distance: radius of random cores (double or None)

if None: max distance is set to the maximum ground distance of the star pattern simulation

seed: int (default: None)

Seed for the random number generation. If None is passed, no seed is set

run(detector, output_mode=0)

Read in a random sample of stations from a CoREAS file. A number of random positions is selected within a certain radius. For each position the closest observer is selected and a simulated event is created for that observer.

Parameters:

detector: Detector object

Detector description of the detector that shall be simulated

output_mode: integer (default 0)

• 0: only the event object is returned

• 1: the function reuturns the event object, the current inputfilename, the distance between the choosen station and the requested core position,

  and the area in which the core positions are randomly distributed

end()