Dataclasses documentation

Dataclasses are the common classes used to describe objects in IceCube/Icetray. These classes are the objects exchanged by I3Modules.

This project is maintained by:

• Don La Dieu <dladieu@icecube.wisc.edu>

• David Schultz <david.schultz@icecube.wisc.edu>

If you find an area where Dataclasses’ documentation is lacking, you can help out!

Table of Contents:

• Release Notes

• I3Particle
  • Purpose and properties
  • Data members
    • Floating point data members
    • Integer data members
  • Use case overview
  • Conventions and recommendations
  • History
• SuperDST
  • Rationale
  • Using SuperDST
    • C++
    • Python
  • Format details
    • I3SuperDST
    • I3SuperDSTTriggerSeries
• Selecting pulses: I3RecoPulseSeriesMapMask
  • Purpose
  • Examples
    • Creation
    • Manipulation
    • Retrieving the underlying pulses
• Vector Math
  • I3Position and I3Direction
• Coordinate Systems
  • IceCube Coordinate System
    • Orientation
    • Origin
    • Depth
    • Spherical Coordinates
    • Definition of “Northern” and “Southern sky”
  • Survey Coordinates
    • Conversion to IceCube coordinates
    • Survey azimuth
    • Elevation
  • Astronomical Coordinates
  • AMANDA Coordinates
    • Conversion to IceCube coordinates
    • Spherical Coordinates
  • See Also
• I3Direction
• Examples
• I3Time
  • double
  • Typical Simulation Chain
  • The Problem
  • The Solution
  • Examples
• I3Position
• Examples
• I3ComplexVector
• I3MCTree
  • Users Guide
    • boost::optional
    • C++
    • Python
  • Tree Internals
    • N-ary Tree
    • Storage of I3Particles
    • Iterator Internals
    • Compilers
  • Python Bindings
• Fourier Transforms and Derived Dataclasses/Functions
  • The Discrete Fourier Transform
  • Normalizations of FFTs
  • FFTW
  • FFTDataContainer
    • Example
    • Normalization
    • Calculation of Energy in the Two Domains
  • Hilbert Envelope
    • Example
  • Waveform Resampling
• Python bindings to dataclasses
  • Examples
    • Get an object out of the frame
    • nchannel
    • nhit
    • Getting the energy of the most energetic primary
    • Getting an I3RecoPulseSeriesMap from an I3RecoPulseSeriesMapMask
    • Efficiently getting pulse properties with numpy
• FAQ / common errors
  • I can’t make pybindings to an I3Vector of my class
  • No to_python (by-value) converter found for C++ type
  • RuntimeError: extension class wrapper for base class I3FrameObject has not been created yet
• icecube.dataclasses – python bindings to dataclasses
  • I3Double.I3Double()

Also see the doxygen docs.