NuRadioReco.modules.io.coreas.readCoREASStationGrid module
- class NuRadioReco.modules.io.coreas.readCoREASStationGrid.readCoREAS[source]
Bases:
object
coreas input module for fixed grid of stations. This module distributes core positions randomly within a user defined area and calculates the electric field at the detector positions as specified in the detector description by choosing the closest antenna of the star shape pattern simulation
Methods
begin
(input_files, xmin, xmax, ymin, ymax[, ...])begin method
run
(detector[, output_mode])Read in a random sample of stations from a CoREAS file.
end
- begin(input_files, xmin, xmax, ymin, ymax, n_cores=10, seed=None, log_level=0)[source]
begin method
initialize readCoREAS module
- Parameters:
- input_files: input files
list of coreas hdf5 files
- xmin: float
minimum x coordinate of the area in which core positions are distributed
- xmax: float
maximum x coordinate of the area in which core positions are distributed
- ymin: float
minimum y coordinate of the area in which core positions are distributed
- ynax: float
maximum y coordinate of the area in which core positions are distributed
- n_cores: number of cores (integer)
the number of random core positions to generate for each input file
- seed: int (default: None)
Seed for the random number generation. If None is passed, no seed is set
- run(detector, output_mode=0)[source]
Read in a random sample of stations from a CoREAS file. 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