FairEvtFilter Class Reference

#include <FairEvtFilter.h>

Inheritance diagram for FairEvtFilter:

Public Types
enum	ChargeState {   kNeutral = 0, kPlus, kMinus, kCharged,   kAll, kChargeLastElement }
enum	MomState { kMomTotal = 0, kMomTrans, kMomZ, kMomLastElement }
enum	GeomState {   kTheta = 0, kPhi, kVertexZ, kVertexRho,   kVertexRadius, kGeomLastElement }
enum	LogicOp { kAnd = 0, kOr, kLogicOpLastElement }

Public Member Functions
	FairEvtFilter ()
	FairEvtFilter (const char *name, const char *title="FairEvtFilter")
virtual	~FairEvtFilter ()
Bool_t	SetListOfParticles (TClonesArray *ParticleList)
void	PrintAllTParticleInEvent ()
Bool_t	Init ()
void	SetVerbose (Int_t verbose=12)
void	ShowAcceptedEventNumbers ()
void	ShowEvtNrsToAccept ()
void	SetTestMode (Int_t *arrayPtr, Int_t nEntries)
Bool_t	TestPassed ()
virtual Bool_t	EventMatches (Int_t evtNr)=0
virtual Bool_t	FilterActive ()=0
Bool_t	GetCharge (Int_t inPdgCode, Double_t *pdgCodeCharge)

Protected Attributes
TDatabasePDG *	fdbPdg
TClonesArray *	fParticleList
Int_t	fVerbose
Bool_t	fTestMode
std::set< Int_t >	fAcceptedEventNumbers
std::set< Int_t >	fEvtNrsToAccept
Int_t	fEventNr

Static Protected Attributes
static const Double_t	kNoChargeSpecified

Detailed Description

Definition at line 41 of file FairEvtFilter.h.

Member Enumeration Documentation

ChargeState

enum FairEvtFilter::ChargeState

Enumerator
kNeutral
kPlus
kMinus
kCharged
kAll
kChargeLastElement

Definition at line 44 of file FairEvtFilter.h.

{ kNeutral = 0, kPlus, kMinus, kCharged, kAll, kChargeLastElement };

GeomState

enum FairEvtFilter::GeomState

Enumerator
kTheta
kPhi
kVertexZ
kVertexRho
kVertexRadius
kGeomLastElement

Definition at line 46 of file FairEvtFilter.h.

{ kTheta = 0, kPhi, kVertexZ, kVertexRho, kVertexRadius, kGeomLastElement };

LogicOp

enum FairEvtFilter::LogicOp

Enumerator
kAnd
kOr
kLogicOpLastElement

Definition at line 47 of file FairEvtFilter.h.

{ kAnd = 0, kOr, kLogicOpLastElement };

MomState

enum FairEvtFilter::MomState

Enumerator
kMomTotal
kMomTrans
kMomZ
kMomLastElement

Definition at line 45 of file FairEvtFilter.h.

{ kMomTotal = 0, kMomTrans, kMomZ, kMomLastElement };

Constructor & Destructor Documentation

FairEvtFilter() [1/2]

FairEvtFilter::FairEvtFilter

(

)

Default constructor.

FairEvtFilter() [2/2]

FairEvtFilter::FairEvtFilter	(	const char *	name,
		const char *	title = "FairEvtFilter"
	)

Constructor with name and title

~FairEvtFilter()

virtual FairEvtFilter::~FairEvtFilter ( )

virtual

Destructor.

Member Function Documentation

EventMatches()

virtual Bool_t FairEvtFilter::EventMatches ( Int_t  evtNr )

pure virtual

Implemented in FairEvtFilterOnSingleParticleCounts, PndEvtFilterOnInvMassCounts, and PndEvtFilter.

Referenced by TestPassed().

FilterActive()

virtual Bool_t FairEvtFilter::FilterActive ( )

pure virtual

Implemented in FairEvtFilterOnSingleParticleCounts, PndEvtFilterOnInvMassCounts, and PndEvtFilter.

Referenced by TestPassed().

GetCharge()

Bool_t FairEvtFilter::GetCharge	(	Int_t	inPdgCode,
		Double_t *	pdgCodeCharge
	)

Referenced by TestPassed().

Init()

Bool_t FairEvtFilter::Init ( )

inline

Definition at line 69 of file FairEvtFilter.h.

{ return kTRUE; }

PrintAllTParticleInEvent()

void FairEvtFilter::PrintAllTParticleInEvent

(

)

Referenced by SetListOfParticles().

SetListOfParticles()

Bool_t FairEvtFilter::SetListOfParticles ( TClonesArray *  ParticleList )

inline

Definition at line 59 of file FairEvtFilter.h.

References fParticleList, and PrintAllTParticleInEvent().

  {
    fParticleList = ParticleList;
    return kTRUE;
  };

SetTestMode()

void FairEvtFilter::SetTestMode ( Int_t *  arrayPtr, Int_t  nEntries  )

inline

Definition at line 97 of file FairEvtFilter.h.

References fEvtNrsToAccept, and fTestMode.

  {
    // turns on the test mode with the declared fEvtNrsToAccept
    fTestMode = kTRUE;
    std::set<Int_t> evtNrsToAccept(arrayPtr, arrayPtr + nEntries);
    fEvtNrsToAccept = evtNrsToAccept;
  }

SetVerbose()

void FairEvtFilter::SetVerbose ( Int_t  verbose = 12 )

inline

Definition at line 71 of file FairEvtFilter.h.

References fVerbose.

  {
    if (verbose >= 0) {
      fVerbose = verbose;
      std::cout << "FairEvtFilter: fVerbose is now set to " << verbose << "\n";
    } else {
      std::cout << "\n\n\n  -WARNING from FairEvtFilter: verbose must be a positive number! Check your SetVerbose call!\n\n\n";
    }
  }

ShowAcceptedEventNumbers()

void FairEvtFilter::ShowAcceptedEventNumbers ( )

inline

Definition at line 81 of file FairEvtFilter.h.

References fAcceptedEventNumbers.

  {
    // for QA
    // shows fAcceptedEventNumbers that is filled after running a simulation
    std::cout << "\n fAcceptedEventNumbers"
              << " = " << fAcceptedEventNumbers;
  }

ShowEvtNrsToAccept()

void FairEvtFilter::ShowEvtNrsToAccept ( )

inline

Definition at line 89 of file FairEvtFilter.h.

References fEvtNrsToAccept.

  {
    // for QA
    // shows fEvtNrsToAccept that has to be set if you want to run your simulation in test mode
    std::cout << "\n fEvtNrsToAccept"
              << " = " << fEvtNrsToAccept;
  }

TestPassed()

Bool_t FairEvtFilter::TestPassed ( )

inline

Definition at line 105 of file FairEvtFilter.h.

References EventMatches(), fAcceptedEventNumbers, fEvtNrsToAccept, FilterActive(), fTestMode, and GetCharge().

  {
    if (kFALSE == fTestMode) {
      std::cout << "\n\n\n WARNING from FairEvtFilter: Test mode not set.\n\n\n";
      return kFALSE;
    }
    if (fAcceptedEventNumbers == fEvtNrsToAccept) {
      // std::cout << "\n\n\n FairEvtFilter: Test passed.\n\n\n";
      return kTRUE;
    } else {
      // std::cout << "\n\n\n FairEvtFilter: Test failed. Check your SetTestMode calls. \n\n\n";
      return kFALSE;
    }
  }

Member Data Documentation

fAcceptedEventNumbers

std::set<Int_t> FairEvtFilter::fAcceptedEventNumbers

protected

Definition at line 139 of file FairEvtFilter.h.

Referenced by ShowAcceptedEventNumbers(), and TestPassed().

fdbPdg

TDatabasePDG* FairEvtFilter::fdbPdg

protected

Definition at line 131 of file FairEvtFilter.h.

fEventNr

Int_t FairEvtFilter::fEventNr

protected

Definition at line 141 of file FairEvtFilter.h.

fEvtNrsToAccept

std::set<Int_t> FairEvtFilter::fEvtNrsToAccept

protected

Definition at line 140 of file FairEvtFilter.h.

Referenced by SetTestMode(), ShowEvtNrsToAccept(), and TestPassed().

fParticleList

TClonesArray* FairEvtFilter::fParticleList

protected

Definition at line 136 of file FairEvtFilter.h.

Referenced by SetListOfParticles().

fTestMode

Bool_t FairEvtFilter::fTestMode

protected

Definition at line 138 of file FairEvtFilter.h.

Referenced by SetTestMode(), and TestPassed().

fVerbose

Int_t FairEvtFilter::fVerbose

protected

Definition at line 137 of file FairEvtFilter.h.

Referenced by SetVerbose().

kNoChargeSpecified

const Double_t FairEvtFilter::kNoChargeSpecified

staticprotected

Definition at line 134 of file FairEvtFilter.h.

Referenced by PndEvtFilter::Init().

---

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

• FairEvtFilter.h