NCFS-Pack
A generic (astro)particle physics analysis framework
 
Loading...
Searching...
No Matches
Public Member Functions | Protected Attributes | List of all members
IceXtalk Class Reference

TTask derived class to perform cross talk hit correction. More...

#include "IceXtalk.h"

Inheritance diagram for IceXtalk:

Detailed Description

TTask derived class to perform cross talk hit correction.

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 IceXtalk
// TTask derived class to perform cross talk hit correction.
//
// In case an event has been rejected by an NcEventSelector (based) processor,
// this task (and its sub-tasks) is not executed.
//
// Note : This processor only acts on MuDaq data.
//
// This task takes the current event in memory and uses the attached
// OM database to identify pairs of OMs which might induce cross talk.
// For each particular transmitter and receiver pair within the event
// a probability for cross talk induction is determined on basis of
// the hit data and the cross talk probability functions from the OM database.
// If this probability is above a certain threshold "pmin" and the difference
// in LE between transmitter and receiver signal is within the bounds as
// given by the Xtalk calibration data, the occurrence of a cross talk signal
// of "pe" photo-electrons in the receiver is assumed and this signal is
// lateron subtracted from the receiver ADC signal.
// The subtraction of the Xtalk signal from the various hits is delayed
// until the very end, since receiver OMs may also act as transmitter OMs
// for other pair combinations.
// In case a transmitter OM was flagged as a bad module, the check on the
// LE time difference will not be performed and a cross talk induction
// decision will be solely based on the corresponding probability, since
// the latter only depends on the un-calibrated signal amplitude of the
// transmitter hit.
// So, hits which have induced cross talk are not completely removed
// but their signal is corrected for the cross talk.
// This will prevent severe losses when studying UHE events, where cross
// talk effects are expected to have negligible effects on the observed
// large module signals.
//
// Note : The amount with which the ADC value was corrected is stored
// in the signal as an ADC offset. This will allow easy investigation
// of Xtalk corrected signals and also enables successive
// applications of this Xtalk processor to investigate (systematic)
// effects of various criteria.
// Example : In case an amount of 1 pe was subtracted from the ADC
// value, the ADC offset will be set to 1.
//
// The values of "pmin" and "pe" can be set by the user via the
// SetMinProb() and SetXtalkPE() memberfunctions.
// The default values are pmin=0.5 and pe=1.
//
// Information about the actual parameter settings can be found in the event
// structure itself via the device named "IceXtalk".
//
// In case this processor is followed by an ADC threshold hit cleaning
// procedure, hits which only contained cross talk can be efficiently
// skipped or removed from the event.
// In case one would like to always remove a hit which containes induced
// cross talk, one could set the "pe" parameter to some very large value.
// This will result in cross talk induced hits to get large negative ADC
// signals and can as such easily be skipped/removed afterwards.
//
// Note : This processor only works properly on Time and ADC calibrated data.
// In case no OM database has been specified for this processor,
// no cross talk hit correction will be performed.
//
//--- Author: Nick van Eijndhoven 11-aug-2005 Utrecht University
//- Modified: Nick van Eijndhoven, IIHE-VUB, Brussel, February 15, 2022 15:16Z

Definition at line 19 of file IceXtalk.h.

Public Member Functions

 IceXtalk (const char *name="", const char *title="")
 
virtual ~IceXtalk ()
 
virtual void Exec (Option_t *opt)
 
void SetCalibFile (TString name)
 
void SetMinProb (Float_t pmin)
 
void SetOMdbase (NcObjMatrix *omdb)
 
void SetXtalkPE (Float_t pe)
 

Protected Attributes

TFile * fCalfile
 
NcObjMatrix * fOmdb
 
Float_t fPe
 
Float_t fPmin
 

Constructor & Destructor Documentation

◆ IceXtalk()

IceXtalk::IceXtalk ( const char * name = "",
const char * title = "" )
// Default constructor.

Definition at line 92 of file IceXtalk.cxx.

◆ ~IceXtalk()

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

Definition at line 106 of file IceXtalk.cxx.

Member Function Documentation

◆ Exec()

void IceXtalk::Exec ( Option_t * opt)
virtual
// Implementation of cross talk hit correction.

Definition at line 179 of file IceXtalk.cxx.

◆ SetCalibFile()

void IceXtalk::SetCalibFile ( TString name)
// Set the calibration ROOT file as created with IceCal2Root.
// Note : this will overrule a previously attached database.
//
// Environment variables may be used as $(...) in the filenname for convenience.
// For example "$(HOME)/my-data/calibrations.root".

Definition at line 133 of file IceXtalk.cxx.

◆ SetMinProb()

void IceXtalk::SetMinProb ( Float_t pmin)
// Set the minimal probability for cross talk induction.

Definition at line 157 of file IceXtalk.cxx.

◆ SetOMdbase()

void IceXtalk::SetOMdbase ( NcObjMatrix * omdb)
// Set the pointer to the OM database.
// Note : this will overrule a previously attached database.

Definition at line 121 of file IceXtalk.cxx.

◆ SetXtalkPE()

void IceXtalk::SetXtalkPE ( Float_t pe)
// Set the nominal Xtalk signal in photo-electron equivalent.

Definition at line 168 of file IceXtalk.cxx.

Member Data Documentation

◆ fCalfile

TFile* IceXtalk::fCalfile
protected

Definition at line 31 of file IceXtalk.h.

◆ fOmdb

NcObjMatrix* IceXtalk::fOmdb
protected

Definition at line 32 of file IceXtalk.h.

◆ fPe

Float_t IceXtalk::fPe
protected

Definition at line 34 of file IceXtalk.h.

◆ fPmin

Float_t IceXtalk::fPmin
protected

Definition at line 33 of file IceXtalk.h.

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