NCFS-Pack
A generic (astro)particle physics analysis framework
Loading...
Searching...
No Matches
IceIDOM Class Reference

Signal (Hit) handling of a generic IceCube In-ice Digital Optical Module (IDOM). More...

#include "IceIDOM.h"

Inheritance diagram for IceIDOM:
IceDOM IceGOM NcDevice NcSignal NcPosition NcAttrib Nc3Vector IceDCDOM IceICDOM

Detailed Description

Signal (Hit) handling of a generic IceCube In-ice Digital Optical Module (IDOM).

Copyright(c) 2003, IceCube Experiment at the South Pole. All rights reserved.
Author: The IceCube NCFS-based Offline Project.
Contributors are mentioned in the code where appropriate.
Permission to use, copy, modify and distribute this software and its
documentation strictly for non-commercial purposes is hereby granted
without fee, provided that the above copyright notice appears in all
copies and that both the copyright notice and this permission notice
appear in the supporting documentation.
The authors make no claims about the suitability of this software for
any purpose. It is provided "as is" without express or implied warranty.
// Class IceIDOM
// Signal/Hit handling of an IceCube In-ice Digital Optical Module (IDOM).
// Basically this class provides an IceCube tailored user interface
// to the functionality of the class NcDevice via the generic IceDOM
// and IceGOM classes.
//
// See IceGOM for some usage examples.
//
//--- Author: Nick van Eijndhoven 23-jun-2004 Utrecht University
//- Modified: NvE $Date: 2010-03-19 11:10:02 +0100 (Fri, 19 Mar 2010) $ NCFS

Definition at line 11 of file IceIDOM.h.

Public Member Functions

 IceIDOM ()
 IceIDOM (const IceIDOM &m)
virtual ~IceIDOM ()
virtual TObject * Clone (const char *name="") const
Public Member Functions inherited from IceDOM
 IceDOM ()
 IceDOM (const IceDOM &m)
virtual ~IceDOM ()
Public Member Functions inherited from IceGOM
 IceGOM ()
 IceGOM (const IceGOM &m)
virtual ~IceGOM ()
Int_t GetLevel (Int_t id=0) const
Int_t GetOMId (Int_t string, Int_t level) const
Int_t GetString (Int_t id=0) const
Double_t GetTimeResidual (NcEvent *evt, NcTrack *t, Int_t j, TString name="LE", Int_t mode=7, Int_t vgroup=1) const
Double_t GetTimeResidual (NcEvent *evt, NcTrack *t, NcSignal *s, TString name="LE", Int_t mode=7, Int_t vgroup=1) const
Public Member Functions inherited from NcDevice
 NcDevice (const char *name="", const char *title="")
 NcDevice (const NcDevice &dev)
virtual ~NcDevice ()
void AddHit (NcSignal &s)
void AddHit (NcSignal *s)
virtual void Data (TString f="car", TString u="rad") const
void DisplayHits (Int_t idx=1, Float_t scale=-1, TObjArray *hits=0, Int_t dp=0, Int_t mode=1, Int_t mcol=4)
void DisplayHits (TString name, Float_t scale=-1, TObjArray *hits=0, Int_t dp=0, Int_t mode=1, Int_t mcol=4)
NcPosition GetCOG (TObjArray *hits, Int_t pos=0, TString slotname="none", Int_t mode=0) const
Double_t GetCVAL (TObjArray *hits, TString obsname, TString weightname="none", Int_t mode=0, Int_t type=1) const
void GetExtremes (Float_t &vmin, Float_t &vmax, Int_t idx=1, TObjArray *hits=0, Int_t mode=1, Int_t deadcheck=1) const
void GetExtremes (Float_t &vmin, Float_t &vmax, TString name, TObjArray *hits=0, Int_t mode=1, Int_t deadcheck=1) const
NcSignal * GetHit (Int_t j) const
NcSignal * GetHit (TString name, Int_t mode=0, Int_t opt=0) const
Int_t GetHitCopy () const
Nc3Vector GetHitPath (TObjArray *hits, Int_t pos=0) const
TObjArray * GetHits ()
void GetHits (TObjArray &selected, TString name, Int_t mode=0, Int_t opt=0, TObjArray *hits=0) const
NcSignal * GetIdHit (Int_t id) const
Int_t GetNhits () const
Int_t GetNhits (TString name, Int_t mode=0, Int_t opt=0) const
Int_t GetStatus () const
void RemoveHit (NcSignal &s)
void RemoveHit (NcSignal *s)
void RemoveHits ()
virtual void Reset (Int_t mode=0)
void SetHitCopy (Int_t j)
virtual void SetOwner (Bool_t own=kTRUE)
void SetStatus (Int_t word)
void ShowHit (Int_t j=0, TString f="car", TString u="rad") const
Double_t SlideWindow (TObjArray *hits, Double_t thres, Double_t swin, TString sname, Int_t smode=0, TString wname="none", Int_t wmode=0, Int_t *i1=0, Int_t *i2=0) const
TObjArray * SortHits (Int_t idx=1, Int_t mode=-1, TObjArray *hits=0, Int_t mcal=1, Int_t deadcheck=1, TObjArray *ordered=0)
TObjArray * SortHits (TString name, Int_t mode=-1, TObjArray *hits=0, Int_t mcal=1, Int_t deadcheck=1, TObjArray *ordered=0)
Double_t SumSignals (Int_t idx, Int_t mode=1, TObjArray *hits=0)
Double_t SumSignals (TString name, Int_t mode=1, TObjArray *hits=0)
Public Member Functions inherited from NcSignal
 NcSignal (const char *name="", const char *title="")
 NcSignal (const NcSignal &s)
virtual ~NcSignal ()
void AddLink (TObject *obj, Int_t j=1)
void AddLink (TObject *obj, TString name)
virtual void AddSignal (Double_t sig, Int_t j=1)
virtual void AddSignal (Double_t sig, TString name)
void AddTrack (NcTrack &t, Int_t mode=1)
void DeleteSample (Int_t j=1)
void DeleteSample (TString name)
virtual void DeleteSignals (Int_t mode=0)
void DeleteWaveform (Int_t j=1)
void DeleteWaveform (TString name)
NcSample * DisplaySample (Int_t j=1, Int_t i=1) const
NcSample * DisplaySample (TString name, Int_t i=1) const
NcDevice * GetDevice () const
Int_t GetErrorFlag (Int_t j=1) const
Int_t GetErrorFlag (TString name) const
NcTrack * GetIdTrack (Int_t id) const
Int_t GetIndices (TObject *obj, Int_t j, TArrayI &ks) const
Int_t GetIndices (TObject *obj, TArrayI &js, Int_t k) const
Int_t GetIndices (TObject *obj, TArrayI &js, TArrayI &ks) const
Int_t GetIndices (TObject *obj, TString name, TArrayI &ks) const
TObject * GetLink (Int_t j=1, Int_t k=1) const
TObject * GetLink (TString name, Int_t k=1) const
Int_t GetNerrors () const
Int_t GetNlinks (TObject *obj, TString name) const
Int_t GetNlinks (TObject *obj=0, Int_t j=0) const
Int_t GetNsamples () const
virtual Int_t GetNslots () const
Int_t GetNtracks (NcTrack *t=0) const
Int_t GetNvalues () const
Int_t GetNwaveforms () const
NcSample * GetSample (Int_t j=1) const
NcSample * GetSample (TString name) const
Int_t GetSampleIndex (TString name) const
virtual Float_t GetSignal (Int_t j=1, Int_t mode=0) const
virtual Float_t GetSignal (TString name, Int_t mode=0) const
virtual Float_t GetSignalError (Int_t j=1) const
virtual Float_t GetSignalError (TString name) const
Int_t GetSignalFlag (Int_t j=1) const
Int_t GetSignalFlag (TString name) const
Int_t GetSwapMode () const
NcTrack * GetTrack (Int_t j) const
TH1F * GetWaveform (Int_t j=1) const
TH1F * GetWaveform (TString name) const
Int_t GetWaveformIndex (TString name) const
virtual void List (Int_t j=0) const
virtual void List (TString name) const
void ListSample (Int_t j=0) const
void ListTrack (Int_t j=0) const
void ListWaveform (Int_t j=0) const
void RemoveTrack (NcTrack &t, Int_t mode=1)
void RemoveTracks (Int_t mode=1)
void ResetLink (Int_t j=1, Int_t k=1)
void ResetLink (TString name, Int_t k=1)
void ResetLinks (TObject *obj, Int_t j=0, Int_t k=0)
void ResetLinks (TObject *obj, TString name, Int_t k=0)
void ResetSample (Int_t j=1)
void ResetSample (TString name)
virtual void ResetSignals (Int_t mode=0)
void ResetWaveform (Int_t j=1)
void ResetWaveform (TString name)
void SetDevice (NcDevice *dev)
void SetLink (TObject *obj, Int_t j=1, Int_t k=1)
void SetLink (TObject *obj, TString name, Int_t k=1)
void SetSample (NcSample *sample, Int_t j=1)
virtual void SetSignal (Double_t sig, Int_t j=1)
virtual void SetSignal (Double_t sig, TString name)
virtual void SetSignalError (Double_t dsig, Int_t j=1)
virtual void SetSignalError (Double_t dsig, TString name)
void SetSwapMode (Int_t swap=1)
void SetWaveform (TH1F *waveform, Int_t j=1)
Public Member Functions inherited from NcPosition
 NcPosition ()
 NcPosition (const NcPosition &p)
virtual ~NcPosition ()
Double_t GetDistance (NcPosition &p, Float_t scale=-1)
Double_t GetDistance (NcPosition *p, Float_t scale=-1)
NcPosition & GetPosition ()
void GetPosition (Double_t *r, TString f, TString u="rad", Float_t s=-1) const
void GetPosition (Float_t *r, TString f, TString u="rad", Float_t s=-1) const
void GetPositionErrors (Double_t *e, TString f, TString u="rad", Float_t s=-1) const
void GetPositionErrors (Float_t *e, TString f, TString u="rad", Float_t s=-1) const
NcTimestamp * GetTimestamp ()
Float_t GetUnitScale () const
NcPosition & operator= (const NcPosition &p)
void RemoveTimestamp ()
void ResetPosition ()
void SetPosition (Double_t *r, TString f, TString u="rad")
void SetPosition (Double_t r1, Double_t r2, Double_t r3, TString f, TString u="rad")
void SetPosition (Float_t *r, TString f, TString u="rad")
void SetPosition (Nc3Vector &r)
void SetPositionErrors (Double_t *e, TString f, TString u="rad")
void SetPositionErrors (Double_t e1, Double_t e2, Double_t e3, TString f, TString u="rad")
void SetPositionErrors (Float_t *e, TString f, TString u="rad")
void SetTimestamp (NcTimestamp &t)
void SetUnitScale (Float_t s)
Public Member Functions inherited from Nc3Vector
 Nc3Vector ()
 Nc3Vector (const Nc3Vector &v)
virtual ~Nc3Vector ()
Double_t ConvertAngle (Double_t a, TString in, TString out) const
Nc3Vector Cross (Nc3Vector &q) const
Double_t Dot (Nc3Vector &q)
void GetErrors (Double_t *e, TString f, TString u="rad") const
void GetErrors (Float_t *e, TString f, TString u="rad") const
Double_t GetNorm ()
virtual Double_t GetOpeningAngle (Nc3Vector &q, TString u="rad")
Nc3Vector GetPrimed (TRotMatrix *m) const
Double_t GetPseudoRapidity ()
Double_t GetResultError () const
Nc3Vector GetUnprimed (TRotMatrix *m) const
Nc3Vector GetVecLong () const
void GetVector (Double_t *v, TString f, TString u="rad") const
void GetVector (Float_t *v, TString f, TString u="rad") const
Nc3Vector GetVecTrans () const
Double_t GetX (Int_t i, TString f, TString u="rad")
Int_t HasErrors () const
Int_t HasVector () const
virtual void Load (Nc3Vector &q)
Nc3Vector operator* (Double_t s) const
Nc3Vector & operator*= (Double_t s)
Nc3Vector operator+ (Nc3Vector &q) const
Nc3Vector & operator+= (Nc3Vector &q)
Nc3Vector operator- (Nc3Vector &q) const
Nc3Vector & operator-= (Nc3Vector &q)
Nc3Vector operator/ (Double_t s) const
Nc3Vector & operator/= (Double_t s)
Nc3Vector & operator= (const Nc3Vector &q)
void PrintAngle (Double_t a, TString in, TString out, Int_t ndig=1, Bool_t align=kFALSE) const
void SetErrors (Double_t *e, TString f, TString u="rad")
void SetErrors (Double_t e1, Double_t e2, Double_t e3, TString f, TString u="rad")
void SetErrors (Float_t *e, TString f, TString u="rad")
void SetVector (Double_t *v, TString f, TString u="rad")
void SetVector (Double_t v1, Double_t v2, Double_t v3, TString f, TString u="rad")
void SetVector (Float_t *v, TString f, TString u="rad")
virtual void SetZero ()
Public Member Functions inherited from NcAttrib
 NcAttrib ()
 NcAttrib (const NcAttrib &a)
virtual ~NcAttrib ()
void AddNamedSlot (TString s)
void DecreaseEdgeValue (Int_t j=1)
void DecreaseEdgeValue (TString name)
void DeleteCalibrations (Int_t mode=0)
TF1 * GetCalFunction (Int_t j=1) const
TF1 * GetCalFunction (TString name) const
Int_t GetCalWord (Int_t j=1) const
Int_t GetCalWord (TString name) const
Int_t GetDeadValue (Int_t j=1) const
Int_t GetDeadValue (TString name) const
TF1 * GetDecalFunction (Int_t j=1) const
TF1 * GetDecalFunction (TString name) const
Int_t GetEdgeValue (Int_t j=1) const
Int_t GetEdgeValue (TString name) const
Float_t GetGain (Int_t j=1) const
Float_t GetGain (TString name) const
Int_t GetGainFlag (Int_t j=1) const
Int_t GetGainFlag (TString name) const
Int_t GetLockValue (Int_t j=1) const
Int_t GetLockValue (TString name) const
Int_t GetNcalflags () const
Int_t GetNcalfuncs () const
Int_t GetNdecalfuncs () const
Int_t GetNgains () const
Int_t GetNnames () const
Int_t GetNoffsets () const
Float_t GetOffset (Int_t j=1) const
Float_t GetOffset (TString name) const
Int_t GetOffsetFlag (Int_t j=1) const
Int_t GetOffsetFlag (TString name) const
Int_t GetSlotIndex (TString name, Int_t opt=0) const
TString GetSlotName (Int_t j=1) const
void IncreaseEdgeValue (Int_t j=1)
void IncreaseEdgeValue (TString name)
virtual void Load (NcAttrib &a, Int_t j=0)
virtual void Load (NcAttrib &a, TString name)
void Lock (Int_t j=1)
void Lock (TString name)
void ResetGain (Int_t j=1)
void ResetGain (TString name)
void ResetOffset (Int_t j=1)
void ResetOffset (TString name)
void SetAlive (Int_t j=1)
void SetAlive (TString name)
void SetCalFunction (TF1 *f, Int_t j=1)
void SetCalFunction (TF1 *f, TString name)
void SetDead (Int_t j=1)
void SetDead (TString name)
void SetDecalFunction (TF1 *f, Int_t j=1)
void SetDecalFunction (TF1 *f, TString name)
void SetEdgeOff (Int_t j=1)
void SetEdgeOff (TString name)
void SetEdgeOn (Int_t j=1)
void SetEdgeOn (TString name)
void SetEdgeValue (Int_t val, Int_t j=1)
void SetEdgeValue (Int_t val, TString name)
void SetGain (Double_t gain, Int_t j=1)
void SetGain (Double_t gain, TString name)
void SetOffset (Double_t off, Int_t j=1)
void SetOffset (Double_t off, TString name)
void SetSlotName (TString s, Int_t j=1)
void Unlock (Int_t j=1)
void Unlock (TString name)

Additional Inherited Members

Public Attributes inherited from NcSignal
Bool_t fDevset
Protected Member Functions inherited from NcSignal
void SetSigFlags (Int_t is, Int_t ie, Int_t j)
Protected Member Functions inherited from NcAttrib
void SetCalFlags (Int_t gf, Int_t of, Int_t j)
Protected Attributes inherited from NcDevice
Int_t fHitCopy
TObjArray * fHits
TObjArray * fMarkers
 ! Temp. array to hold the 3D markers for the hit display
TObjArray * fOrdered
 ! Temp. array to hold the ordered hits
Int_t fStatus
Protected Attributes inherited from NcSignal
TObject * fDevice
TArrayF * fDsignals
NcObjMatrix * fLinks
TObjArray * fSamples
TArrayI * fSigflags
TArrayF * fSignals
TObjArray * fTracks
TObjArray * fWaveforms
Protected Attributes inherited from NcPosition
Float_t fScale
NcTimestamp * fTstamp
Protected Attributes inherited from Nc3Vector
Double32_t fDresult
 ! Error on scalar result (e.g. norm or dotproduct)
Int_t fNv
Double32_t * fV
Protected Attributes inherited from NcAttrib
TArrayI * fCalflags
TObjArray * fCalfuncs
TObjArray * fDecalfuncs
TArrayF * fGains
TObjArray * fNames
TArrayF * fOffsets

Constructor & Destructor Documentation

◆ IceIDOM() [1/2]

IceIDOM::IceIDOM ( )
// Default constructor.

Definition at line 41 of file IceIDOM.cxx.

◆ ~IceIDOM()

IceIDOM::~IceIDOM ( )
virtual
// Default destructor.

Definition at line 50 of file IceIDOM.cxx.

◆ IceIDOM() [2/2]

IceIDOM::IceIDOM ( const IceIDOM & m)
// Copy constructor.

Definition at line 59 of file IceIDOM.cxx.

Member Function Documentation

◆ Clone()

TObject * IceIDOM::Clone ( const char * name = "") const
virtual
// Make a deep copy of the current object and provide the pointer to the copy.
// This memberfunction enables automatic creation of new objects of the
// correct type depending on the object type, a feature which may be very useful
// for containers like NcEvent when adding objects in case the
// container owns the objects. This feature allows e.g. NcEvent
// to store either IceIDOM objects or objects derived from IceIDOM
// via tha AddDevice memberfunction, provided these derived classes also have
// a proper Clone memberfunction.

Reimplemented from IceDOM.

Reimplemented in IceDCDOM, and IceICDOM.

Definition at line 68 of file IceIDOM.cxx.

The documentation for this class was generated from the following files: