RecoData Class Reference [The reconstruction framework (odinreco)]

#include <data.h>

List of all members.

Public Types
enum	dataMode
Public Member Functions
	RecoData (const RecoCoord &coord=RecoCoord())
	RecoData (const RecoData &rd)
	~RecoData ()
RecoData &	operator= (const RecoData &rd)
RecoData &	copy_meta (const RecoData &rd)
ComplexData< 1 > &	data (Rank< 1 >) const
RecoCoord &	coord ()
RecoData &	free (int dim)
const RecoCoord &	coord () const
void	new_profiler (const STD_string &steplabel)
Public Attributes
const Protocol *	override_protocol
dataMode	mode
const CoordCountMap *	interpolated

---

Detailed Description

Class to hold intermediate results (multidimensional complex data) of steps in the reconstruction pipeline.

Definition at line 48 of file odinreco/data.h.

---

Member Enumeration Documentation

enum RecoData::dataMode

Mode of complex data:

• complex_data : Regular complex data.
• real_data : Use only real part.
• weighted_real_data : weight real part by imaginray part.

Definition at line 58 of file odinreco/data.h.

---

Constructor & Destructor Documentation

RecoData::RecoData

(

const RecoCoord &

coord = RecoCoord()

)

[inline]

Creates object with initial k-space coordinate 'coord'.

Definition at line 63 of file odinreco/data.h.

RecoData::RecoData

(

const RecoData &

rd

)

[inline]

Copy constructor (deep copy)

Definition at line 68 of file odinreco/data.h.

RecoData::~RecoData

(

)

Destructor

---

Member Function Documentation

RecoCoord& RecoData::coord

(

)

[inline]

Returns reference to the k-space coordinate.

Definition at line 103 of file odinreco/data.h.

const RecoCoord& RecoData::coord

(

)

const [inline]

Returns const reference to the k-space coordinate.

Definition at line 113 of file odinreco/data.h.

RecoData& RecoData::copy_meta

(

const RecoData &

rd

)

Copy only the meta data from 'rd'

ComplexData<1>& RecoData::data

(

Rank< 1 >

)

const [inline]

Returns reference to current N-dimensional complex data. The dimension is determined according to the instantiation of template 'Rank'.

Definition at line 91 of file odinreco/data.h.

RecoData& RecoData::free

(

int

dim

)

Free (deallocate) data with dimension 'dim'.

void RecoData::new_profiler

(

const STD_string &

steplabel

)

Initializes new profiler object which is allocated/deallocted at the entry and exit of each step to measure the performance of the pipeline.

RecoData& RecoData::operator=

(

const RecoData &

rd

)

Assignment operator (deep copy)

---

Member Data Documentation

const CoordCountMap* RecoData::interpolated

Coordinates interpolated during pipeline execution.

Definition at line 128 of file odinreco/data.h.

dataMode RecoData::mode

Type of data.

Definition at line 123 of file odinreco/data.h.

const Protocol* RecoData::override_protocol

Override protocol in output files if non-zero

Definition at line 118 of file odinreco/data.h.

---

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

• odinreco/data.h