RecoCoord Struct Reference
[The reconstruction framework (odinreco)]

#include <index.h>

List of all members.

Public Member Functions
	RecoCoord ()
bool	operator< (const RecoCoord &rc) const
bool	operator== (const RecoCoord &rc) const
bool	compatible (const RecoCoord &rc) const
bool	prep_count (const RecoCoord &mask)
STD_string	print (RecoIndex::printMode printmode=RecoIndex::brief) const
RecoCoord &	set_uniform_mode (RecoIndex::indexMode m)
RecoCoord &	set_mode (RecoIndex::indexMode m, recoDim d1=n_recoDims, recoDim d2=n_recoDims, recoDim d3=n_recoDims, recoDim d4=n_recoDims, recoDim d5=n_recoDims)
unsigned short	numof (recoDim dim) const
Static Public Member Functions
static RecoCoord	any ()
static RecoCoord	coord_with_mode (RecoIndex::indexMode m, recoDim d1=n_recoDims, recoDim d2=n_recoDims, recoDim d3=n_recoDims, recoDim d4=n_recoDims, recoDim d5=n_recoDims)
Public Attributes
RecoIndex	index [n_recoDims]
unsigned char	flags
const ReadoutShape *	readoutShape
const KspaceTraj *	kspaceTraj
const ComplexData< 1 > *	weightVec
double	dwellTime
float	overSamplingFactor
unsigned short	echopos
unsigned short	echotrain

---

Detailed Description

Holds reconstruction coordinate of one acquisition frame, i.e. position of reconstruction data in multiple dimensions.

Definition at line 158 of file index.h.

---

Constructor & Destructor Documentation

RecoCoord::RecoCoord

(

)

[inline]

Construct default coordinate

Definition at line 164 of file index.h.

---

Member Function Documentation

bool RecoCoord::operator<

(

const RecoCoord &

rc

)

const [inline]

Comparison operator for indexing

Definition at line 170 of file index.h.

bool RecoCoord::operator==

(

const RecoCoord &

rc

)

const [inline]

Equality operator

Definition at line 183 of file index.h.

bool RecoCoord::compatible

(

const RecoCoord &

rc

)

const [inline]

Returns true if two coordinates are compatible when chaining functors.

Definition at line 191 of file index.h.

bool RecoCoord::prep_count

(

const RecoCoord &

mask

)

[inline]

Returns true if this is in the range of 'mask'. Prepares this for count map.

Definition at line 202 of file index.h.

STD_string RecoCoord::print

(

RecoIndex::printMode

printmode = RecoIndex::brief

)

const

Converts the coordinate to a string according to 'printmode'

static RecoCoord RecoCoord::any

(

)

[inline, static]

Convenience function: Returns coordinate with all dimensions mode set to 'any'

Definition at line 219 of file index.h.

RecoCoord& RecoCoord::set_uniform_mode

(

RecoIndex::indexMode

m

)

[inline]

Convenience function: Sets all dimensions to mode 'm'

Definition at line 229 of file index.h.

RecoCoord& RecoCoord::set_mode	(	RecoIndex::indexMode	m,
		recoDim	d1 = n_recoDims,
		recoDim	d2 = n_recoDims,
		recoDim	d3 = n_recoDims,
		recoDim	d4 = n_recoDims,
		recoDim	d5 = n_recoDims
	)			[inline]

Convenience function: Sets specified dimensions to mode 'm'

Definition at line 238 of file index.h.

static RecoCoord RecoCoord::coord_with_mode	(	RecoIndex::indexMode	m,
		recoDim	d1 = n_recoDims,
		recoDim	d2 = n_recoDims,
		recoDim	d3 = n_recoDims,
		recoDim	d4 = n_recoDims,
		recoDim	d5 = n_recoDims
	)			[inline, static]

Convenience function: Returns coordinate with specified dimensions set to mode 'm'

Definition at line 251 of file index.h.

unsigned short RecoCoord::numof

(

recoDim

dim

)

const [inline]

Convenience function: Returns the number of indices in dimension 'dim'

Definition at line 260 of file index.h.

---

Member Data Documentation

RecoIndex RecoCoord::index[n_recoDims]

The index in each dimension

Definition at line 266 of file index.h.

unsigned char RecoCoord::flags

Combination of recoFlags

Definition at line 272 of file index.h.

const ReadoutShape* RecoCoord::readoutShape

Readout shape for regridding, is zero, if none available. Protect acess by mutex.

Definition at line 279 of file index.h.

const KspaceTraj* RecoCoord::kspaceTraj

Explicit k-space trajectory for gridding. Protect acess by mutex.

Definition at line 286 of file index.h.

const ComplexData<1>* RecoCoord::weightVec

Complex weighting of ADC, is zero, if none available.

Definition at line 291 of file index.h.

double RecoCoord::dwellTime

Dwell time of the signal data

Definition at line 297 of file index.h.

float RecoCoord::overSamplingFactor

Oversampling factor in readout direction

Definition at line 302 of file index.h.

unsigned short RecoCoord::echopos

Echo-train index in a multi-echo readout, e.g. an CPMG or EPI echo train. Use this for non-phasecorr template scans and set echo index to zero.

Definition at line 308 of file index.h.

unsigned short RecoCoord::echotrain

EPI echo-train index for navigator correction.

Definition at line 313 of file index.h.

---

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

• index.h