NuRadio Logo

Contents:

  • Introduction
    • Introduction
    • Installing NuRadioMC / NuRadioReco
      • Requirements
      • Installation using pip
      • Development version
      • Manual installation
        • Pip-installable dependencies
          • Core Dependencies
          • Optional Dependencies
        • Not pip-installable packages
    • Some notes on conventions
      • Coordinates
        • Default coordinate system
        • Points
        • Angles
        • Directions
        • Electic Fields
      • Units
      • Particle types
      • Fourier transformations
    • Contributing to NuRadioMC
      • Installing NuRadioMC for developers
      • Workflow
      • Coding conventions
      • How to
        • Writing docstrings
        • Update the version number / dependencies
        • Writing additional documentation
          • Compiling the documentation
          • Headings and text
          • Lists
          • Links and cross-references
          • Showing code
  • NuRadioReco Documentation
    • Data Structure
      • .nur Files and How to Use Them
        • Philosophy and Basic Structure
        • Reading and Writing .nur Files
      • Parameter Storage
      • List of Data Classes
        • Event
        • Radio Shower
        • SimShower
        • SimEmitter
        • Particle
        • Station
        • Trigger
        • SimStation
        • BaseTrace
        • Electric Field
        • Channel
        • Hybrid Information
        • Hybrid Shower
        • Hybrid Detector
    • Detector Description
      • Detector Description
        • The Detector Class
        • Detector Description Formats
          • DataBase
          • JSON
          • Dictionary
          • Signal Chain Responses
        • GenericDetector
          • Event-Specific Changes
        • Detector Description in Event Files
          • Writing the Detector
          • Reading the Detector
          • Detector Viewer
      • Properties of Detector Description
        • Antennas
          • Further Discussion on Antenna Coordinates
        • ADC Table
      • Antenna Models
      • Implemetation of Antenna Models
      • Overview of available Antenna Models
        • bicone_v8_InfAir
        • bicone_v8_InfFirn
        • bicone_v8_inf_n1.32
        • bicone_v8_inf_n1.4
        • bicone_v8_inf_n1.78
        • createLPDA_100MHz_InfFirn
        • createLPDA_InfFirn_n1.4
        • createLPDA_100MHz_z1cm_InFirn_RG
        • createLPDA_100MHz_z1cm_InFirn_BoresightToBoundary
        • createLPDA_100MHz_z10cm_InFirn_RG
        • createLPDA_100MHz_z1m_InFirn_RG
        • createLPDA_100MHz_z2m_InFirn_RG
        • createLPDA_100MHz_z2m_InFirn_Backlobe_NoRG
        • createLPDA_100MHz_z3m_InAir_RG
        • createLPDA_100MHz_z3m_InFirn_BoresightToBoundary
        • createLPDA_100MHz_z3mAndLPDALen_InFirn_BoresightToBoundary
        • createLPDA_100MHz_z5m_InFirn_RG
        • createLPDA_100MHz_z10m_InFirn_RG
        • createLPDA_100MHz_z100m_InFirn_RG
        • createLPDA_100MHz_z200m_InFirn_RG
        • createLPDA_100MHz_InfAir
        • createLPDA_100MHz_z1cm_InAir_RG
        • createLPDA_100MHz_z1m_InFirn_RG_v2
        • dip7cm_hpol_infFirn
        • dip7cm_z260mm_InFirn_RG
        • dip7cm_z1m_InFirn_RG
        • dip7cm_z2m_InFirn_RG
        • dip7cm_z3m_InFirn_RG_NearHorizontalHD
        • dip7cm_z5m_InFirn_RG
        • dip7cm_z10m_InFirn_RG
        • dip7cm_z200m_InFirn_RG
        • dip7cm_z100m_InFirn_RG
        • dip7cm_infAir_s12
        • dip7cm_z270mm_InAir
        • dip7cm_z1m_InAir
        • dip7cm_z1m_InAir_RG_NearHorizontalHD
        • dip7cm_z1m_InAir_RG_NearHorizontalHD2
        • dip7cm_z2m_InAir
        • dip7cm_z5m_InAir
        • RNOG_vpol_4inch_center_n1.73
        • RNOG_vpol_4inch_half_n1.73
        • RNOG_vpol_4inch_wall_n1.73
        • RNOG_vpol_v3_5inch_center_n1.74
        • RNOG_hpol_v4_8inch_center_n1.74
        • RNOG_quadslot_v1_n1.74
        • RNOG_quadslot_v2_n1.74
        • RNOG_quadslot_v2_rescaled_fineFreq
        • RNOG_quadslot_v3_air_rescaled_to_n1.74
        • SKALA_InfFirn
        • SmallBlackSpider_ground2_measured
        • Butterfly_ground2
        • Butterfly_ground2_East
        • Butterfly_ground2_North
      • Additional Models
        • RNOG_vpol_v1_n1.4
        • RNOG_vpol_v1_n1.73
        • fourslot_InfFirn
        • greenland_vpol_InfFirn
        • trislot_RNOG
        • dipole_ARA_bicone_infinitefirn
        • XFDTD_Hpol_150mmHole_n1.78
        • XFDTD_Vpol_CrossFeed_150mmHole_n1.78
        • XFDTD_Vpol_CrossFeed_150mmHole_n1.78_InfFirn
      • The RNO-G detector class and database interface
        • Detector time and database time
        • Database structure
        • Signal Chain
        • Response class
        • Detector class
    • Overview of times
      • Station time (Event time)
        • Trace start times in channels
        • Trace start times in E-fields
        • Trigger times
      • Overview of modules that affect time
    • Modules
      • Basic Module Structure
      • Logging
    • Event Display
    • Utilities
      • Unit System
      • Fourier Transformation
      • Metaclasses
        • Singleton
    • Code Documentation
      • NuRadioReco.framework package
        • Submodules
          • NuRadioReco.framework.base_shower module
          • NuRadioReco.framework.base_station module
          • NuRadioReco.framework.base_trace module
          • NuRadioReco.framework.channel module
          • NuRadioReco.framework.electric_field module
          • NuRadioReco.framework.emitter module
          • NuRadioReco.framework.event module
          • NuRadioReco.framework.hybrid_information module
          • NuRadioReco.framework.hybrid_shower module
          • NuRadioReco.framework.parameter_storage module
          • NuRadioReco.framework.parameters module
          • NuRadioReco.framework.particle module
          • NuRadioReco.framework.radio_shower module
          • NuRadioReco.framework.sim_channel module
          • NuRadioReco.framework.sim_emitter module
          • NuRadioReco.framework.sim_station module
          • NuRadioReco.framework.station module
          • NuRadioReco.framework.trigger module
      • NuRadioReco.modules package
        • Subpackages
          • NuRadioReco.modules.ARA package
          • NuRadioReco.modules.ARIANNA package
          • NuRadioReco.modules.LOFAR package
          • NuRadioReco.modules.RNO_G package
          • NuRadioReco.modules.base package
          • NuRadioReco.modules.custom package
          • NuRadioReco.modules.iftElectricFieldReconstructor package
          • NuRadioReco.modules.io package
          • NuRadioReco.modules.measured_noise package
          • NuRadioReco.modules.neutrinoDirectionReconstructor package
          • NuRadioReco.modules.neutrinoVertexReconstructor package
          • NuRadioReco.modules.phasedarray package
          • NuRadioReco.modules.trigger package
        • Submodules
          • NuRadioReco.modules.analogToDigitalConverter module
          • NuRadioReco.modules.beamFormingDirectionFitter module
          • NuRadioReco.modules.channelAddCableDelay module
          • NuRadioReco.modules.channelAntennaDedispersion module
          • NuRadioReco.modules.channelBandPassFilter module
          • NuRadioReco.modules.channelCWNotchFilter module
          • NuRadioReco.modules.channelGalacticNoiseAdder module
          • NuRadioReco.modules.channelGenericNoiseAdder module
          • NuRadioReco.modules.channelLengthAdjuster module
          • NuRadioReco.modules.channelReadoutWindowCutter module
          • NuRadioReco.modules.channelResampler module
          • NuRadioReco.modules.channelSignalReconstructor module
          • NuRadioReco.modules.channelSinewaveSubtraction module
          • NuRadioReco.modules.channelStopFilter module
          • NuRadioReco.modules.channelTemplateCorrelation module
          • NuRadioReco.modules.channelTimeOffsetCalculator module
          • NuRadioReco.modules.channelTimeWindow module
          • NuRadioReco.modules.correlationDirectionFitter module
          • NuRadioReco.modules.cosmicRayEnergyReconstructor module
          • NuRadioReco.modules.efieldGalacticNoiseAdder module
          • NuRadioReco.modules.efieldRadioInterferometricReconstruction module
          • NuRadioReco.modules.efieldTimeDirectionFitter module
          • NuRadioReco.modules.efieldToVoltageConverter module
          • NuRadioReco.modules.efieldToVoltageConverterPerEfield module
          • NuRadioReco.modules.electricFieldBandPassFilter module
          • NuRadioReco.modules.electricFieldResampler module
          • NuRadioReco.modules.electricFieldSignalReconstructor module
          • NuRadioReco.modules.eventTypeIdentifier module
          • NuRadioReco.modules.sphericalWaveFitter module
          • NuRadioReco.modules.templateDirectionFitter module
          • NuRadioReco.modules.voltageToAnalyticEfieldConverter module
          • NuRadioReco.modules.voltageToEfieldConverter module
          • NuRadioReco.modules.voltageToEfieldConverterPerChannel module
          • NuRadioReco.modules.voltageToEfieldConverterPerChannelGroup module
      • NuRadioReco.detector package
        • Subpackages
          • NuRadioReco.detector.ARA package
          • NuRadioReco.detector.ARIANNA package
          • NuRadioReco.detector.LOFAR package
          • NuRadioReco.detector.RNO_G package
        • Submodules
          • NuRadioReco.detector.amp module
          • NuRadioReco.detector.antennapattern module
          • NuRadioReco.detector.detector module
          • NuRadioReco.detector.detector_base module
          • NuRadioReco.detector.detector_sql module
          • NuRadioReco.detector.detector_sys_uncertainties module
          • NuRadioReco.detector.filterresponse module
          • NuRadioReco.detector.generic_detector module
          • NuRadioReco.detector.response module
          • NuRadioReco.detector.sql_to_json module
          • NuRadioReco.detector.test_detector_db module
          • NuRadioReco.detector.visualize_detector module
      • NuRadioReco.utilities package
        • Submodules
          • NuRadioReco.utilities.analytic_pulse module
          • NuRadioReco.utilities.cr_flux module
          • NuRadioReco.utilities.dataservers module
          • NuRadioReco.utilities.diodeSimulator module
          • NuRadioReco.utilities.fft module
          • NuRadioReco.utilities.framework_utilities module
          • NuRadioReco.utilities.geometryUtilities module
          • NuRadioReco.utilities.ice module
          • NuRadioReco.utilities.interferometry module
          • NuRadioReco.utilities.io_utilities module
          • NuRadioReco.utilities.logging module
          • NuRadioReco.utilities.metaclasses module
          • NuRadioReco.utilities.noise module
          • NuRadioReco.utilities.particle_names module
          • NuRadioReco.utilities.signal_processing module
          • NuRadioReco.utilities.templates module
          • NuRadioReco.utilities.timing module
          • NuRadioReco.utilities.trace_utilities module
          • NuRadioReco.utilities.units module
          • NuRadioReco.utilities.version module
    • Manuals
      • Use the Vertex Reconstruction Modules
        • Creating Lookup Tables
        • Creating Electric Field Templates
        • 2D vs. 3D Vertex Reconstructor
      • Using the cosmic-ray pulse interpolator in NRR
        • Initialising the interpolator
        • Interpolating signals
        • What happens when you initialise a signal interpolator?
        • Some tips to work with fluence interpolation
  • NuRadioMC Documentation
    • HDF5 output structure
      • Opening the HDF5 file
      • What’s behind the HDF5 files
      • HDF5 structure
        • HDF5 file attributes
        • HDF5 file contents
        • Station data
    • Code Documentation
      • NuRadioMC.EvtGen package
        • Submodules
          • NuRadioMC.EvtGen.NuRadioMCtoAraSim module
          • NuRadioMC.EvtGen.NuRadioProposal module
          • NuRadioMC.EvtGen.create_tau_tab module
          • NuRadioMC.EvtGen.generate_cylinder module
          • NuRadioMC.EvtGen.generate_unforced module
          • NuRadioMC.EvtGen.generator module
          • NuRadioMC.EvtGen.generator_ASCII module
          • NuRadioMC.EvtGen.generator_skeleton module
          • NuRadioMC.EvtGen.hdf5_to_ASCII module
          • NuRadioMC.EvtGen.proposal_table_manager module
          • NuRadioMC.EvtGen.readARAEventList module
          • NuRadioMC.EvtGen.readEventList_ASCII module
      • NuRadioMC.SignalGen package
        • Subpackages
          • NuRadioMC.SignalGen.ARZ package
        • Submodules
          • NuRadioMC.SignalGen.HCRB2017 module
          • NuRadioMC.SignalGen.askaryan module
          • NuRadioMC.SignalGen.emitter module
          • NuRadioMC.SignalGen.parametrizations module
      • NuRadioMC.SignalProp package
        • Submodules
          • NuRadioMC.SignalProp.analyticraytracing module
          • NuRadioMC.SignalProp.directRayTracing module
          • NuRadioMC.SignalProp.propagation module
          • NuRadioMC.SignalProp.propagation_base_class module
          • NuRadioMC.SignalProp.radioproparaytracing module
      • NuRadioMC.simulation package
        • Submodules
          • NuRadioMC.simulation.output_writer_hdf5 module
          • NuRadioMC.simulation.simulation module
          • NuRadioMC.simulation.time_logger module
      • NuRadioMC.utilities package
        • Submodules
          • NuRadioMC.utilities.Veff module
          • NuRadioMC.utilities.attenuation module
          • NuRadioMC.utilities.cross_sections module
          • NuRadioMC.utilities.dump_hdf5 module
          • NuRadioMC.utilities.earth_attenuation module
          • NuRadioMC.utilities.fluxes module
          • NuRadioMC.utilities.inelasticities module
          • NuRadioMC.utilities.medium module
          • NuRadioMC.utilities.medium_base module
          • NuRadioMC.utilities.merge_hdf5 module
          • NuRadioMC.utilities.muon_flux module
          • NuRadioMC.utilities.plotting module
          • NuRadioMC.utilities.runner module
          • NuRadioMC.utilities.runner_example module
          • NuRadioMC.utilities.split_hdf5 module
    • Manuals
      • Example: Calculating effective volume
        • Run an effective volume simulation
          • Generating the input event list
          • Running the simulation
          • Visualization of results
      • Example: Calculating expected sensitivities
      • Example: Multi-station coincidences
        • 1. Generation of detector layout
        • 2. Detector simulation
        • 3. Running the simulation
        • 4. Analyzing the output
      • Event Generation
        • Events in a cylindrical volume
          • Input parameters
          • Data sets and attributes
        • Atmospheric muons generated on a flat surface
        • NuRadioProposal as a standalone module
      • Signal Generation (from in-ice showers)
        • Frequency-domain parameterisations
        • ARZ - semi-analytical model
        • Validity of the parameterisations and the ARZ model
        • Timing
        • Using the same shower. Random seed
        • FFT normalisation
      • Signal Generation (emitter)
        • SPice Pulser
      • Signal Propagation
        • Propagation module
        • Ray tracing
          • Analytical ray tracer
          • RadioPropa numerical ray tracer (in development)
        • Example scripts
          • How to calculate an analytic ray path
          • How to calculate an radiopropa ray path
      • Ice and attenuation models
        • Ice model implementation
          • The IceModel and IceModel_Simple class
          • RadioPropaIceWrapper
        • Available models in NuRadioMC
          • Simple ice models
          • RadioPropa ice models
          • Attenuation model
          • Using specific models
        • Example script
        • Birefringence Ice Models
          • Available Birefringence Ice Models
          • Ice-Flow Direction
          • Available Birefringence Propagation Options
          • Using specific birefringence models
      • Simulation and configuration
        • Steering files
        • Config files
        • Detector description
        • Detector simulation
      • Running on a cluster
        • 1. Generate input files
        • 2. Generate job *.sh scripts
        • 3. Submit jobs to the cluster
        • 4. Merge individual hdf5 output files
  • Experiment-specific features
    • LOFAR
NuRadio
  • NuRadioReco Documentation
  • Code Documentation
  • NuRadioReco.utilities package
  • View page source

NuRadioReco.utilities package

This package contains many useful utility functions.

Some rely on the classes defined in the framework of the NuRadio package but some can also be used independently to analyze radio data.

List of (most relevant) modules for users of NuRadio are:

  • NuRadioReco.utilities.signal_processing

  • NuRadioReco.utilities.trace_utilities

  • NuRadioReco.utilities.units

  • NuRadioReco.utilities.geometryUtilities

  • NuRadioReco.utilities.fft

Submodules

  • NuRadioReco.utilities.analytic_pulse module
  • NuRadioReco.utilities.cr_flux module
  • NuRadioReco.utilities.dataservers module
  • NuRadioReco.utilities.diodeSimulator module
  • NuRadioReco.utilities.fft module
  • NuRadioReco.utilities.framework_utilities module
  • NuRadioReco.utilities.geometryUtilities module
  • NuRadioReco.utilities.ice module
  • NuRadioReco.utilities.interferometry module
  • NuRadioReco.utilities.io_utilities module
  • NuRadioReco.utilities.logging module
  • NuRadioReco.utilities.metaclasses module
  • NuRadioReco.utilities.noise module
  • NuRadioReco.utilities.particle_names module
  • NuRadioReco.utilities.signal_processing module
  • NuRadioReco.utilities.templates module
  • NuRadioReco.utilities.timing module
  • NuRadioReco.utilities.trace_utilities module
  • NuRadioReco.utilities.units module
  • NuRadioReco.utilities.version module
Previous Next

© Copyright 2025, The NuRadio Group.

Built with Sphinx using a theme provided by Read the Docs.