RecoController Class Reference [The reconstruction framework (odinreco)]

#include <controller.h>

List of all members.

Public Member Functions
	RecoController (JcampDxBlock &parblock)
bool	init (RecoReaderInterface *reader, JcampDxBlock &opts, int argc, char *argv[])
bool	start ()
dvector	dim_values (recoDim dim) const
TinyVector< float, 3 >	reloffset () const
STD_string	image_proc () const
TinyVector< int, 3 >	image_size () const
TinyVector< float, 3 >	kspace_extent () const
const Protocol &	protocol () const
void	announce_data (const STD_string &label)
void	post_data (const STD_string &label, const RecoData &data)
bool	data_announced (const STD_string &label)
bool	inquire_data (const STD_string &label, RecoData &data)
const CoordCountMap *	create_count_map (const RecoCoord &mask) const
bool	create_numof (const RecoCoord &mask, unsigned short numof[n_recoDims], STD_string &printed) const
RecoStep *	create_pipeline (const STD_string &rec, const RecoCoord *initial_coord=0, int argc=0, char *argv[]=0) const
STD_string	stepmanual () const

---

Detailed Description

Class to manage reconstruction process.

Definition at line 49 of file controller.h.

---

Constructor & Destructor Documentation

RecoController::RecoController

(

JcampDxBlock &

parblock

)

Creates uninitialized reconstruction controller. Appends parameters to 'parblock'.

---

Member Function Documentation

void RecoController::announce_data

(

const STD_string &

label

)

[inline]

Announces to blackboard that data with identifier 'label' will become available during pipeline execution.

Definition at line 109 of file controller.h.

const CoordCountMap* RecoController::create_count_map

(

const RecoCoord &

mask

)

const

Returns a map where the key are k-space coordinates (except those not in 'mask') and the value of the map is a count of ADC indices with this particular k-space coordinate.

bool RecoController::create_numof	(	const RecoCoord &	mask,
		unsigned short	numof[n_recoDims],
		STD_string &	printed
	)			const

Creates the maximum extent of reco dimension in 'numof' using all coordinates except those not in 'mask'. In addition, returns a printed version of the result in 'printed'.

RecoStep* RecoController::create_pipeline	(	const STD_string &	rec,
		const RecoCoord *	initial_coord = 0,
		int	argc = 0,
		char *	argv[] = 0
	)			const

Creates a pipeline and returns its 1st functor according to the recipe (pieline layout) given in 'rec'. Checking of input/output dimension match starts with 'initial_coord', if non-zero. Returns zero if the pipeline could not be created because of input/output dimension mismatches.

bool RecoController::data_announced

(

const STD_string &

label

)

[inline]

Returns whether data with 'label' will become available during pipeline execution.

Definition at line 119 of file controller.h.

dvector RecoController::dim_values

(

recoDim

dim

)

const

Returns vector of values associated with a certain dimension.

STD_string RecoController::image_proc

(

)

const

Extra command-line arguments for processing of final images.

TinyVector<int,3> RecoController::image_size

(

)

const

Returns the image size, will be used if it cannot be determined from the k-space coordinates (i.e. when gridding).

bool RecoController::init	(	RecoReaderInterface *	reader,
		JcampDxBlock &	opts,
		int	argc,
		char *	argv[]
	)

Initializes reconstruction process controller to use reco input 'reader' and option block 'opts'. Returns 'true' only if sucessful.

bool RecoController::inquire_data	(	const STD_string &	label,
		RecoData &	data
	)

Returns 'data' with identifier 'label' for k-space coordinate set in 'data' from blackboard. Waits until data becomes available. Returns 'true' if data is available, otherwise returns 'false' if all data was processed and the requested data was not available.

TinyVector<float,3> RecoController::kspace_extent

(

)

const

Returns the extent of the k-space in each direction (in rad/mm)

void RecoController::post_data	(	const STD_string &	label,
		const RecoData &	data
	)			[inline]

Posts 'data' with identifier 'label' on blackboard, it will be indexed according to the k-space coordinate in 'data'.

Definition at line 114 of file controller.h.

const Protocol& RecoController::protocol

(

)

const [inline]

Returns the scan protocol.

Definition at line 103 of file controller.h.

TinyVector<float,3> RecoController::reloffset

(

)

const

Returns the relative spatial offset the image should be shifted after reconstruction. The result contains the offsets in (phase3d,phase,read) direction.

bool RecoController::start

(

)

Starts reconstruction process using 'firststep' as the start of the reconstruction pipeline. Returns 'true' only if sucessful.

STD_string RecoController::stepmanual

(

)

const

Returns documention 'code' of steps for doxygen.

---

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

• controller.h