HighLAND
Public Member Functions | Protected Attributes | List of all members
CorrectionBase Class Reference

All corrections should be registered with the CorrectionManager. More...

#include <CorrectionBase.hxx>

Inheritance diagram for CorrectionBase:
CT4POTCorrection DataQualityCorrection FlipKinematicsCorrection IgnoreRightECalRuns3and4Correction MomRangeCorrection MomResolMCCorrection PileUpCorrection ToFCorrection TPCdEdxDataCorrection TPCdEdxMCCorrection TPCExpecteddEdxCorrection TPCPIDPullMCCorrection tutorialCorrection UseGlobalAltMomCorrection

Public Member Functions

 CorrectionBase (const CorrectionBase &corr)
 Copy constructor.
 
virtual ~CorrectionBase ()
 Everyone should have a destructor.
 
virtual void Apply (AnaSpillC &spill)
 
virtual const char * GetName () const
 Return the name of this correction. This overrides the TObject::GetName() interface.
 
const std::string & Name () const
 Return the name of this correction.
 
void SetName (const std::string &name)
 Set the name of this correction.
 
void Enable ()
 Enable the correction.
 
void Disable ()
 Disable the correction.
 
bool IsEnabled () const
 Is the correction enabled.
 
void SetAppliedInInput (bool ap)
 Set the correction as applied in the input file.
 
bool IsAppliedInInput () const
 Is the correction already applied in the input file ?
 
Int_t GetIndex () const
 Return the index of this correction.
 
void SetIndex (Int_t index)
 Set the index of this correction.
 
 ClassDef (CorrectionBase, 2)
 

Protected Attributes

std::string _name
 The name of this correction.
 
bool _enabled
 Is the correction enabled?
 
bool _appliedInInput
 Is the correction already applied in the input file ?
 
Int_t _index
 The index of the correction.
 

Detailed Description

All corrections should be registered with the CorrectionManager.

This is the base class that all corrections should inherit. They change information contained in the current AnaSpill.

A correction fixes some aspect of the AnaSpill that is deemed incorrect. The correction is only applied once per spill. The correction should work on the input().GetCorrectedSpill() version of the spill.

Definition at line 15 of file CorrectionBase.hxx.

Member Function Documentation

§ Apply()

virtual void CorrectionBase::Apply ( AnaSpillC spill)
inlinevirtual

This is the function that applies the correction to the input data. This MUST be overridden in the derived class.

Reimplemented in TPCdEdxDataCorrection, IgnoreRightECalRuns3and4Correction, UseGlobalAltMomCorrection, DataQualityCorrection, FlipKinematicsCorrection, MomResolMCCorrection, TPCdEdxMCCorrection, ToFCorrection, TPCPIDPullMCCorrection, TPCExpecteddEdxCorrection, CT4POTCorrection, MomRangeCorrection, PileUpCorrection, and tutorialCorrection.

Definition at line 30 of file CorrectionBase.hxx.

30 {(void)spill;}

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