Nymph  v1.5.2
Flow-Based Data Processing Framework
Public Member Functions | Private Member Functions | Private Attributes | List of all members
KTCutFilter Class Reference

Filters data based on cuts already applied and a filter mask. More...

#include <KTCutFilter.hh>

Inheritance diagram for KTCutFilter:
Inheritance graph

Public Member Functions

 KTCutFilter (const std::string &name="cut-filter")
 
virtual ~KTCutFilter ()
 
bool Configure (const scarab::param_node &node)
 Should perform parameter store and command-line configurations. More...
 
void SetCutMask (KTCutStatus::bitset_type mask)
 
void SetCutMask (unsigned long long mask)
 
void SetCutMask (const std::string &mask)
 Set the mask with a string; String must consist of all 0's and 1's. More...
 
void SetCutMaskAll ()
 Set the cut mask to use all cuts. More...
 
bool Filter (KTData &data)
 
void FilterData (KTDataPtr)
 
- Public Member Functions inherited from KTProcessor
 KTProcessor (const std::string &name="default-proc-name")
 
virtual ~KTProcessor ()
 
void ConnectASlot (const std::string &signalName, KTProcessor *processor, const std::string &slotName, int groupNum=-1)
 
void ConnectASignal (KTProcessor *processor, const std::string &signalName, const std::string &slotName, int groupNum=-1)
 
void ConnectSignalToSlot (KTSignalWrapper *signal, KTSlotWrapper *slot, int groupNum=-1)
 
template<class XProcessor >
void RegisterSignal (std::string name, XProcessor *signalPtr)
 
template<class XTarget , typename XReturn >
void RegisterSlot (std::string name, XTarget *target, XReturn(XTarget::*funcPtr)())
 
template<class XTarget , typename XReturn , typename XArg1 >
void RegisterSlot (std::string name, XTarget *target, XReturn(XTarget::*funcPtr)(XArg1))
 
template<class XTarget , typename XReturn , typename XArg1 , typename XArg2 >
void RegisterSlot (std::string name, XTarget *target, XReturn(XTarget::*funcPtr)(XArg1, XArg2))
 
KTSignalWrapperGetSignal (const std::string &name)
 
KTSlotWrapperGetSlot (const std::string &name)
 
template<typename XSignalSig >
void RegisterSignal (std::string name, XSignalSig *signalPtr)
 
- Public Member Functions inherited from KTConfigurable
 KTConfigurable (const std::string &name="default-name")
 
virtual ~KTConfigurable ()
 
bool Configure (const std::string &config)
 Implement the option for calling Configure without passing a parameter store node. More...
 
const std::string & GetConfigName () const
 
void SetConfigName (const std::string &name)
 

Private Member Functions

 MEMBERVARIABLE_NOSET (unsigned long long, CutMaskInt)
 

Private Attributes

KTCutStatus::bitset_type fCutMask
 
bool fConvertToBitset
 
bool fAllBits
 
KTSignalData fAfterCutSignal
 
KTSignalData fAfterCutPassSignal
 
KTSignalData fAfterCutFailSignal
 

Additional Inherited Members

- Protected Types inherited from KTProcessor
typedef std::map< std::string, KTSignalWrapper *> SignalMap
 
typedef SignalMap::iterator SigMapIt
 
typedef SignalMap::value_type SigMapVal
 
typedef std::map< std::string, KTSlotWrapper *> SlotMap
 
typedef SlotMap::iterator SlotMapIt
 
typedef SlotMap::value_type SlotMapVal
 
- Protected Attributes inherited from KTProcessor
SignalMap fSignalMap
 
SlotMap fSlotMap
 
- Protected Attributes inherited from KTConfigurable
KTCommandLineHandlerfCLHandler
 
std::string fConfigName
 

Detailed Description

Filters data based on cuts already applied and a filter mask.

Author
N. S. Oblath

KTCutFilter checks the status of cuts that have already been applied to a data. If the bitwise AND of the cut status with the configurable cut mask is non-zero, than the data fails the filter.

Interpretation of the boolean returned by Filter(KTData&):

Configuration name: "cut-filter"

Available configuration values:

Slots:

Signals:

Definition at line 57 of file KTCutFilter.hh.

Constructor & Destructor Documentation

◆ KTCutFilter()

KTCutFilter ( const std::string &  name = "cut-filter")

Definition at line 21 of file KTCutFilter.cc.

◆ ~KTCutFilter()

~KTCutFilter ( )
virtual

Definition at line 34 of file KTCutFilter.cc.

Member Function Documentation

◆ Configure()

bool Configure ( const scarab::param_node &  node)
virtual

Should perform parameter store and command-line configurations.

Implements KTConfigurable.

Definition at line 38 of file KTCutFilter.cc.

◆ Filter()

bool Filter ( KTData data)

Definition at line 57 of file KTCutFilter.cc.

◆ FilterData()

void FilterData ( KTDataPtr  dataPtr)

Definition at line 75 of file KTCutFilter.cc.

◆ MEMBERVARIABLE_NOSET()

MEMBERVARIABLE_NOSET ( unsigned long  long,
CutMaskInt   
)
private

◆ SetCutMask() [1/3]

void SetCutMask ( KTCutStatus::bitset_type  mask)
inline

Definition at line 104 of file KTCutFilter.hh.

◆ SetCutMask() [2/3]

void SetCutMask ( unsigned long long  mask)
inline

Definition at line 112 of file KTCutFilter.hh.

◆ SetCutMask() [3/3]

void SetCutMask ( const std::string &  mask)
inline

Set the mask with a string; String must consist of all 0's and 1's.

Definition at line 120 of file KTCutFilter.hh.

◆ SetCutMaskAll()

void SetCutMaskAll ( )
inline

Set the cut mask to use all cuts.

Definition at line 128 of file KTCutFilter.hh.

Member Data Documentation

◆ fAfterCutFailSignal

KTSignalData fAfterCutFailSignal
private

Definition at line 93 of file KTCutFilter.hh.

◆ fAfterCutPassSignal

KTSignalData fAfterCutPassSignal
private

Definition at line 92 of file KTCutFilter.hh.

◆ fAfterCutSignal

KTSignalData fAfterCutSignal
private

Definition at line 91 of file KTCutFilter.hh.

◆ fAllBits

bool fAllBits
private

Definition at line 78 of file KTCutFilter.hh.

◆ fConvertToBitset

bool fConvertToBitset
private

Definition at line 77 of file KTCutFilter.hh.

◆ fCutMask

KTCutStatus::bitset_type fCutMask
private

Definition at line 74 of file KTCutFilter.hh.


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