RecoStep Class Reference

#include <step.h>

Inherits Step< RecoStep >.

Inherited by RecoAdcBaseline, RecoAdcGridPrep, RecoAdcPad, RecoAdcReflect, RecoAdcWeight, RecoB1Fit, RecoBladeComb, RecoBladeCorr, RecoBladeGrid, RecoChannelSum, RecoCircMask, RecoCollectorBase, RecoCycleRot, RecoDTI, RecoDeapodize< NDim >, RecoDebug, RecoDriftCalc, RecoDriftCorr, RecoDump, RecoEpiNavCorr, RecoEpiNavScan, RecoExpFit, RecoFFT, RecoFMRI, RecoFieldMap, RecoFieldMapUser, RecoFilter, RecoGrappa< interpolDim, orthoDim, interpolIndex, orthoIndex >, RecoGrappaWeights< interpolDim, orthoDim, interpolIndex, orthoIndex, Ignore >, RecoGrid< NDim >, RecoGridCut, RecoHalfFour, RecoHomodyne, RecoMagn, RecoMesser, RecoMip, RecoMultiFreq, RecoOffset, RecoOversampling, RecoPhaseCorr, RecoPhaseCourse, RecoPhaseMap, RecoPilot, RecoPost, RecoQualityControlSpike, RecoReal, RecoRefGain, RecoSliceTime, RecoSlidingWindow, RecoSplitter< Nunmod, Unmod, Nsplit, Split >, RecoStore, RecoSum< Nunmod, Unmod, Nsum, Sum, Magn >, RecoSwi, RecoSwitch, RecoT1Fit, and RecoZeroFill.

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)
Public Member Functions inherited from Step< RecoStep >
virtual STD_string	label () const=0
virtual STD_string	description () const=0
virtual RecoStep *	allocate () const=0
virtual void	init ()=0
RecoStep *	clone () const
void	set_args (const STD_string &argstr)
STD_string	args_description () const
STD_string	args_values () const
unsigned int	numof_args () const
void	append_opts (LDRblock &parblock)

Protected Member Functions
	RecoStep ()
bool	execute_next_step (RecoData &rd, RecoController &controller)
Protected Member Functions inherited from Step< RecoStep >
void	append_arg (LDRbase &arg, const STD_string &arglabel)

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::RecoStep ( )

inlineprotected

Default constructor

Definition at line 148 of file odinreco/step.h.

Member Function Documentation

execute_next_step()

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.

input_coord()

virtual RecoCoord RecoStep::input_coord ( ) const

pure virtual

Overload this function to specify the input dimensions state/index of the functor.

modify_coord()

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.

pipeline_init()

virtual bool RecoStep::pipeline_init ( const RecoController &  controller, const RecoCoord &  input_coord  )

inlinevirtual

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.

process()

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.

query()

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.

set_next_step()

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.

---

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

• odinreco/step.h