RecoStep Class Reference
[The reconstruction framework (odinreco)]
#include <step.h>
Public Member Functions | |
| virtual bool | process (RecoData &rd, RecoController &controller)=0 |
| virtual RecoCoord | input_coord () const =0 |
| virtual void | modify_coord (RecoCoord &coord) const =0 |
| virtual bool | pipeline_init (const RecoController &controller, const RecoCoord &input_coord) |
| virtual bool | query (RecoQueryContext &context) |
| void | set_next_step (RecoStep *step) |
Protected Member Functions | |
| RecoStep () | |
| bool | execute_next_step (RecoData &rd, RecoController &controller) |
Friends | |
| class | RecoController |
Detailed Description
The base class of all basic reconstruction steps (functors) within a reconstruction pipeline.Definition at line 84 of file odinreco/step.h.
Constructor & Destructor Documentation
| RecoStep::RecoStep | ( | ) | [inline, protected] |
Default constructor
Definition at line 148 of file odinreco/step.h.
Member Function Documentation
| virtual bool RecoStep::process | ( | RecoData & | rd, | |
| RecoController & | controller | |||
| ) | [pure virtual] |
Overload this function to perform the reconstruction step. Input data should be taken from 'rd' and the result stored back into 'rd' before executing the next step with 'execute_next_step()'. Read-only access to the current reconstruction controller is possible via 'controller'. Return 'true' on sucess, and 'false' if functor fails.
| virtual RecoCoord RecoStep::input_coord | ( | ) | const [pure virtual] |
Overload this function to specify the input dimensions state/index of the functor.
| virtual void RecoStep::modify_coord | ( | RecoCoord & | coord | ) | const [pure virtual] |
Overload this function to specify the modification of the input dimensions state/index after applying the functor.
| virtual bool RecoStep::pipeline_init | ( | const RecoController & | controller, | |
| const RecoCoord & | input_coord | |||
| ) | [inline, virtual] |
Overload this function to initialize the step for usage in the pieline. Read-only access to the current reconstruction controller is possible via 'controller'. The input interface of the step is passed in 'input_coord'.
Definition at line 117 of file odinreco/step.h.
| virtual bool RecoStep::query | ( | RecoQueryContext & | context | ) | [virtual] |
Queries the reconstruction pipeline. Overload this function for particular actions depending on 'context'. Returns 'true' only if sucessful.
| void RecoStep::set_next_step | ( | RecoStep * | step | ) | [inline] |
Sets the functor to be executed after this.
Definition at line 131 of file odinreco/step.h.
| bool RecoStep::execute_next_step | ( | RecoData & | rd, | |
| RecoController & | controller | |||
| ) | [protected] |
Execute next functor in reconstruction pipeline, returns 'true' on sucess, and 'false' if functor fails. Note: Do not lock any mutexes when calling this function.
The documentation for this class was generated from the following file:
