shield C++ API Reference

class I3ShieldDataCollector : public I3ConditionalModule
#include <I3ShieldDataCollector.h>

Public Functions

I3ShieldDataCollector(const I3Context &ctx)
inline ~I3ShieldDataCollector()
void Configure()
void Physics(I3FramePtr frame)

Private Functions

SET_LOGGER ("I3ShieldDataCollector")

Private Members

std::string inputRecoPulsesName_
std::string inputTrackName_
std::string outputParamsName_
bool reportUnhitDOMs_
bool reportCharge_
bool useCurvatureApproximation_
std::vector<double> coefficients_
std::string badDOMListName_

Friends

friend class SingleModuleTestSetup< I3ShieldDataCollector >
template<typename ModuleType>
class SingleModuleTestSetup
#include <I3ShieldDataCollector.h>
namespace std

STL namespace.

file I3ShieldDataCollector.cxx
#include <shield/I3ShieldDataCollector.h>
#include <algorithm>
#include <cmath>
#include <dataclasses/I3Constants.h>
#include <dataclasses/geometry/I3Geometry.h>
#include <dataclasses/physics/I3RecoPulse.h>
#include <dataclasses/physics/I3Particle.h>
#include <recclasses/I3ShieldHitRecord.h>

Typedefs

typedef I3Vector<I3ShieldHitRecord> I3VectorI3ShieldHitRecord

Functions

double polynomial(double x, const std::vector<double> &coefficients)
I3_MODULE(I3ShieldDataCollector)
boost::shared_ptr<I3Vector<I3ShieldHitRecord>> ComputeCoincidences(const I3Particle &track, const I3Map<OMKey, I3RecoPulseSeries> &pulses, const I3Geometry &geometry, const I3Vector<OMKey> *badDOMs, bool reportCharge_, bool useCurvatureApproximation, std::vector<double> coefficients)

Do the actual computation of veto-relevant information.

Parameters:

  • track – The I3Particle representing the track hypothesis

  • pulses – The pulses for which to compute time residuals

  • geometry – The detector geometry

  • badDOMs – The list of known bad DOMs

  • reportCharge_ – Report the charge along with the time offset

  • useCurvatureApproximation – Apply curvature correction using provided coefficients

  • coefficients – Coefficients for curvature correction

boost::shared_ptr<I3Vector<I3ShieldHitRecord>> ComputeUnhitDistances(const I3Particle &track, const I3Map<OMKey, I3RecoPulseSeries> &pulses, const I3Geometry &geometry, const I3Vector<OMKey> *badDOMs)

Compute the distances between the track an all DOMs which do not have pulses.

Parameters:

  • track – The I3Particle representing the track hypothesis

  • pulses – The pulses for which to compute time residuals

  • geometry – The detector geometry

  • badDOMs – If non-NULL, a collection of DOMs which are not expected to work or are otherwise to be ignored

I3_SERIALIZABLE(I3VectorI3ShieldHitRecord)
file I3ShieldDataCollector.h
#include “icetray/I3ConditionalModule.h”

I3ShieldDataCollector Module

(c) 2012 the IceCube Collaboration $ID$

Date

$Date$

dir icetray
dir private
dir public
dir shield
dir shield
dir shield