icecube.production_histograms.icetray_modules.production_histograms_module module

class icecube.production_histograms.icetray_modules.production_histograms_module.ProductionHistogramModule(context)

Bases: I3Module

This I3Module passes frames to any histograms and histogram modules loaded in the user-defined configuration.

If OutputFilename is set then the output is a pickle file which contains a dictionary (key = name, data = histogram).

If DataSet is set then histograms for that dataset are updated, or created on the first instance.

OutputFilename and DataSet are independent of each other, so it’s possible to write pickle files and update the DB.

It’s also possible to use different prescales for different streams by passing a dictionary (key = stream, data = prescale).

Calibration((I3Module)arg1, (I3Frame)arg2) None :
C++ signature :

void Calibration(PythonModule<I3Module> {lvalue},boost::shared_ptr<I3Frame>)

Configure((I3Module)arg1) None :
C++ signature :

void Configure(PythonModule<I3Module> {lvalue})

DAQ((I3Module)arg1, (I3Frame)arg2) None :
C++ signature :

void DAQ(PythonModule<I3Module> {lvalue},boost::shared_ptr<I3Frame>)

DetectorStatus((I3Module)arg1, (I3Frame)arg2) None :
C++ signature :

void DetectorStatus(PythonModule<I3Module> {lvalue},boost::shared_ptr<I3Frame>)

Finish()

Write the histograms to an output pickle file or DB. The output is a dictionary of histograms where the key is the name of the histogram.

Geometry((I3Module)arg1, (I3Frame)arg2) None :
C++ signature :

void Geometry(PythonModule<I3Module> {lvalue},boost::shared_ptr<I3Frame>)

Physics((I3Module)arg1, (I3Frame)arg2) None :
C++ signature :

void Physics(PythonModule<I3Module> {lvalue},boost::shared_ptr<I3Frame>)

icecube.production_histograms.icetray_modules.production_histograms_module.instance_of(h)

This function simply returns an instance of the object if it’s a Histogram or HistogramModule.

icecube.production_histograms.icetray_modules.production_histograms_module.parameter_conversion(container)

ProductionHistogramModule takes ‘Histograms’ as a parameter. This can contain both Histogram and HistogramModule object object and class instances…as well as iterables of each.

This function converts class instances to object instances, returning a flat list of Histogram or HistogramModule object instances.