NuRadioReco.detector.detector module

NuRadioReco.detector.detector.Detector(*args, **kwargs)[source]

This function returns a detector class object.

It chooses the correct class based on the “source” argument. The returned object is of one of these classes:

For ‘kwargs[“source”] == “json”’, whether to use “detector_base” or “generic_detector” depends on whether a reference station / channel is defined in the json file / dictionary or not.

Parameters:
args: Positional arguments (arguments without keyword)

For backwards compatibility, when source is sql | json | dictionary, args are interpreted as follows:

  • json_filename = args[0] only when source == “json”)

  • source = args[1]

  • dictionary = args[2]

  • assume_inf = args[3]

  • antenna_by_depth = args[4]

kwargs: Optional arguments (arguments with keyword)

Keyword arguments passed to detector object. The argument “source” is used to select the correct class (see description above). If no keyword “source” is passed, the default “json” is used.

Returns:
det: NuRadioReco.detector.* (see options above)

Detector class object