A cut about the number of intersections of a track with STK. More...
#include <algorithms/geometry/StkIntersectionsCut.h>
Inheritance diagram for Herd::StkIntersectionsCut:
Public Member Functions | |
| StkIntersectionsCut (const std::string &name) | |
| Constructor. More... | |
| bool | Initialize () |
| Initializes the cut. More... | |
| bool | Process () |
| Applies the cut. More... | |
| bool | Finalize () |
| Do nothing. More... | |
Private Attributes | |
| observer_ptr< EventDataStore > | _evStore |
| unsigned int | _nOfStkInt |
| Pointer to the event data store. More... | |
Detailed Description
A cut about the number of intersections of a track with STK.
This cut rejects events with a number of intersection less than a given threshold
Needed event objects:
| name | type | store | optional | description |
|---|---|---|---|---|
| stkIntersectionsMC | StkIntersections | evStore | no | Info about the track intersections with STK. |
Parameters:
| name | type | default value | description |
|---|---|---|---|
| nOfStkInt | int | 12 | The number of intersections. |
Constructor & Destructor Documentation
◆ StkIntersectionsCut()
| Herd::StkIntersectionsCut::StkIntersectionsCut | ( | const std::string & | name | ) |
Constructor.
- Parameters
-
name The name of the algorithm object.
Member Function Documentation
◆ Finalize()
| bool Herd::StkIntersectionsCut::Finalize | ( | ) |
Do nothing.
- Returns
- true if no error occurs during finalization, false otherwise.
◆ Initialize()
| bool Herd::StkIntersectionsCut::Initialize | ( | ) |
Initializes the cut.
- Returns
- true if initialization is done without errors, false otherwise.
◆ Process()
| bool Herd::StkIntersectionsCut::Process | ( | ) |
Applies the cut.
- Returns
- true if no error occurs during processing, false otherwise.
Member Data Documentation
◆ _evStore
|
private |
◆ _nOfStkInt
|
private |
Pointer to the event data store.
The threshold for the cut, i.e. the minimum number of interesections.
The documentation for this class was generated from the following files:
- /builds/herd/HerdSoftware/include/analysis/algorithms/geometry/StkIntersectionsCut.h
- /builds/herd/HerdSoftware/src/analysis/algorithms/geometry/StkIntersectionsCut.cpp
