AliPhysics  2c6b7ad (2c6b7ad)
PWG::EMCAL::AliEmcalAODFilterBitCuts Class Reference

Implementation of the AOD filter bit selection as virtual cut class. More...

#include <AliEmcalAODFilterBitCuts.h>

Inheritance diagram for PWG::EMCAL::AliEmcalAODFilterBitCuts:

Public Types

enum  SelectionMode_t { kSelAny = 0, kSelAll = 1 }
 Definition of the mode how multiple filter bits are selected. More...
 

Public Member Functions

 AliEmcalAODFilterBitCuts ()
 
 AliEmcalAODFilterBitCuts (const char *name, const char *title)
 
virtual ~AliEmcalAODFilterBitCuts ()
 
void AddFilterBitNumber (ULong_t bitnumber)
 
void AddStatusBitNumber (ULong_t bitnumber)
 
void SetFilterBits (ULong_t filterbits, Bool_t doReset=false)
 Set the filter bits to be checked. More...
 
void SetStatusBits (ULong_t statusbits, Bool_t doReset=false)
 Set the track status bits to be checked. More...
 
void SetSelectionMode (SelectionMode_t mode)
 Set the selection mode. More...
 
virtual Bool_t IsSelected (TObject *o)
 

Protected Member Functions

Bool_t IsFilterBitsSelected (const AliAODTrack *const trk) const
 Select track according to presence of track filter bits. More...
 
Bool_t IsStatusBitsSelected (const AliAODTrack *const trk) const
 Select track according to presence of track status bits. More...
 

Protected Attributes

ULong_t fAODfilterBits
 Requested filter bits. More...
 
ULong_t fAODstatusBits
 Requested track status bits. More...
 
SelectionMode_t fSelectionMode
 Mode of the filter bit selection (any or all) More...
 

Detailed Description

Implementation of the AOD filter bit selection as virtual cut class.

Author
Markus Fasel marku.nosp@m.s.fa.nosp@m.sel@c.nosp@m.ern..nosp@m.ch, Lawrence Berkeley National Laboratory
Since
July 1st, 2016

AliEmcalAODFilterBitCuts implements the track filter bit selection of AOD tracks within the framework of virtual cuts. This means that in filters it can be used as any virtual cut class. Like this no special treatment is for AOD filter bit selection.

The cut is applied in the function

which needs to be called in any filter with the AOD track as argument.

The filter allows two selection modes:

  • Any: at least one of the bits needs to be found
  • All: all bits need to be found.

Definition at line 37 of file AliEmcalAODFilterBitCuts.h.

Member Enumeration Documentation

Definition of the mode how multiple filter bits are selected.

Enumerator
kSelAny 

Any (either of the bits set)

kSelAll 

All (all bits must be found in the AOD track)

Definition at line 43 of file AliEmcalAODFilterBitCuts.h.

Constructor & Destructor Documentation

PWG::EMCAL::AliEmcalAODFilterBitCuts::AliEmcalAODFilterBitCuts ( )

Dummy constructor

Definition at line 29 of file AliEmcalAODFilterBitCuts.cxx.

PWG::EMCAL::AliEmcalAODFilterBitCuts::AliEmcalAODFilterBitCuts ( const char *  name,
const char *  title 
)

Constructor, defining also name and title

Parameters
[in]nameName of the cut object
[in]titleTitle of the cut object

Definition at line 37 of file AliEmcalAODFilterBitCuts.cxx.

virtual PWG::EMCAL::AliEmcalAODFilterBitCuts::~AliEmcalAODFilterBitCuts ( )
inlinevirtual

Definition at line 60 of file AliEmcalAODFilterBitCuts.h.

Member Function Documentation

void PWG::EMCAL::AliEmcalAODFilterBitCuts::AddFilterBitNumber ( ULong_t  bitnumber)
inline

Request filter bit at a given bit number (not bit representation).

Parameters
[in]bitnumberNumber of the bit to be set (integer number)

Definition at line 66 of file AliEmcalAODFilterBitCuts.h.

void PWG::EMCAL::AliEmcalAODFilterBitCuts::AddStatusBitNumber ( ULong_t  bitnumber)
inline

Definition at line 68 of file AliEmcalAODFilterBitCuts.h.

Bool_t PWG::EMCAL::AliEmcalAODFilterBitCuts::IsFilterBitsSelected ( const AliAODTrack *const  trk) const
protected

Select track according to presence of track filter bits.

Parameters
[in]trktrack to check
Returns
True if the track is selected, false otherwise

Definition at line 59 of file AliEmcalAODFilterBitCuts.cxx.

Referenced by IsSelected(), and SetSelectionMode().

Bool_t PWG::EMCAL::AliEmcalAODFilterBitCuts::IsSelected ( TObject o)
virtual

Select AOD tracks according which contain any of the bits. The way of the selection is determined by the selection mode (default: any):

  • Any: At least one bit needs to be found
  • All: All bits must be found
Parameters
[in]oObject to be checked: Must be an AliAODTrack
Returns
True if object is selected. Always false in case object is not an AliAODTrack

Definition at line 45 of file AliEmcalAODFilterBitCuts.cxx.

Referenced by PWG::EMCAL::TestImplAliEmcalAODFilterBitCuts::RunTest(), and SetSelectionMode().

Bool_t PWG::EMCAL::AliEmcalAODFilterBitCuts::IsStatusBitsSelected ( const AliAODTrack *const  trk) const
protected

Select track according to presence of track status bits.

Parameters
[in]trktrack to check
Returns
True if the track is selected, false otherwise

Definition at line 68 of file AliEmcalAODFilterBitCuts.cxx.

Referenced by IsSelected(), and SetSelectionMode().

void PWG::EMCAL::AliEmcalAODFilterBitCuts::SetFilterBits ( ULong_t  filterbits,
Bool_t  doReset = false 
)
inline

Set the filter bits to be checked.

Function using the bit representation, not the number of then bit. Bits will be added to the existing bits (not if doReset is true).

Parameters
[in]filterbitsFilter bits requested
[in]doResetIf true existing filter bits will be set to 0

Definition at line 78 of file AliEmcalAODFilterBitCuts.h.

Referenced by AliEmcalTrackSelectionAOD::AddFilterBit().

void PWG::EMCAL::AliEmcalAODFilterBitCuts::SetSelectionMode ( SelectionMode_t  mode)
inline

Set the selection mode.

Can be any (any of the filter/status) bits set, or all. Note the selection mode is applied to filter and status bits in the same way. Filter and status bit cuts must be fulfilled independently.

Parameters
[in]modeSelection mode (any/all) used in the bit selection

Definition at line 99 of file AliEmcalAODFilterBitCuts.h.

Referenced by PWG::EMCAL::TestImplAliEmcalAODFilterBitCutsHybrid::TestImplAliEmcalAODFilterBitCutsHybrid().

void PWG::EMCAL::AliEmcalAODFilterBitCuts::SetStatusBits ( ULong_t  statusbits,
Bool_t  doReset = false 
)
inline

Set the track status bits to be checked.

Function using the bit representation, not the number of then bit. Bits will be added to the existing bits (not if doReset is true).

Parameters
[in]filterbitsFilter bits requested
[in]doResetIf true existing filter bits will be set to 0

Definition at line 88 of file AliEmcalAODFilterBitCuts.h.

Referenced by PWG::EMCAL::TestImplAliEmcalAODFilterBitCutsHybrid::TestImplAliEmcalAODFilterBitCutsHybrid(), and PWG::EMCAL::TestImplAliEmcalAODFilterBitCutsTPCconstrained::TestImplAliEmcalAODFilterBitCutsTPCconstrained().

Member Data Documentation

ULong_t PWG::EMCAL::AliEmcalAODFilterBitCuts::fAODfilterBits
protected

Requested filter bits.

Definition at line 128 of file AliEmcalAODFilterBitCuts.h.

Referenced by AddFilterBitNumber(), IsFilterBitsSelected(), IsSelected(), and SetFilterBits().

ULong_t PWG::EMCAL::AliEmcalAODFilterBitCuts::fAODstatusBits
protected

Requested track status bits.

Definition at line 129 of file AliEmcalAODFilterBitCuts.h.

Referenced by AddStatusBitNumber(), IsSelected(), IsStatusBitsSelected(), and SetStatusBits().

SelectionMode_t PWG::EMCAL::AliEmcalAODFilterBitCuts::fSelectionMode
protected

Mode of the filter bit selection (any or all)

Definition at line 130 of file AliEmcalAODFilterBitCuts.h.

Referenced by IsFilterBitsSelected(), IsStatusBitsSelected(), and SetSelectionMode().


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