HerdSoftware  0.1.1
Public Member Functions | Private Attributes | List of all members
Herd::PolarAngleCut Class Reference

An algorithm that rejects events with the polar angle greather than a threshold. More...

#include <algorithms/geometry/PolarAngleCut.h>

Inheritance diagram for Herd::PolarAngleCut:

Public Member Functions

 PolarAngleCut (const std::string &name)
 Constructor. More...
 
bool Initialize ()
 Initializes the algo. More...
 
bool Process ()
 Applies the cut. More...
 
bool Finalize ()
 Do nothing. More...
 

Private Attributes

observer_ptr< EventDataStore > _evStore
 Pointer to the event data store. More...
 
float _maxTheta
 Cut threshold. More...
 

Detailed Description

An algorithm that rejects events with the polar angle greather than a threshold.

Needed event objects:

name type store optional description
mcTruth MCTruth evStore no Info about MC truth

Parameters:

name type optional default value description
maxTheta float no 0 Set the maximum polar angle [degree].

Constructor & Destructor Documentation

◆ PolarAngleCut()

Herd::PolarAngleCut::PolarAngleCut ( const std::string &  name)

Constructor.

Parameters
nameThe name of the algorithm object.

Member Function Documentation

◆ Finalize()

bool Herd::PolarAngleCut::Finalize ( )

Do nothing.

Returns
true if no error occurs during finalization, false otherwise.

◆ Initialize()

bool Herd::PolarAngleCut::Initialize ( )

Initializes the algo.

Returns
true if initialization is done without errors, false otherwise.

◆ Process()

bool Herd::PolarAngleCut::Process ( )

Applies the cut.

Returns
true if no error occurs during processing, false otherwise.

Member Data Documentation

◆ _evStore

observer_ptr<EventDataStore> Herd::PolarAngleCut::_evStore
private

Pointer to the event data store.

◆ _maxTheta

float Herd::PolarAngleCut::_maxTheta
private

Cut threshold.


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