Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
RecoCoord Struct Reference

#include <index.h>

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
 
RecoCoordset_uniform_mode (RecoIndex::indexMode m)
 
RecoCoordset_mode (RecoIndex::indexMode m, recoDim d1=n_recoDims, recoDim d2=n_recoDims, recoDim d3=n_recoDims, recoDim d4=n_recoDims, recoDim d5=n_recoDims, recoDim d6=n_recoDims, recoDim d7=n_recoDims, recoDim d8=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, recoDim d6=n_recoDims, recoDim d7=n_recoDims, recoDim d8=n_recoDims)
 

Public Attributes

RecoIndex index [n_recoDims]
 
unsigned char flags
 
const ReadoutShape * readoutShape
 
const KspaceTrajkspaceTraj
 
const ComplexData< 1 > * weightVec
 
double dwellTime
 
float overSamplingFactor
 
float relCenterPos
 
unsigned short adcstart
 
unsigned short adcend
 
float gridScaleFactor
 
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::RecoCoord ( )
inline

Construct default coordinate

Definition at line 164 of file index.h.

Member Function Documentation

§ any()

static RecoCoord RecoCoord::any ( )
inlinestatic

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

Definition at line 219 of file index.h.

§ compatible()

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.

§ coord_with_mode()

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,
recoDim  d6 = n_recoDims,
recoDim  d7 = n_recoDims,
recoDim  d8 = n_recoDims 
)
inlinestatic

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

Definition at line 254 of file index.h.

§ numof()

unsigned short RecoCoord::numof ( recoDim  dim) const
inline

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

Definition at line 263 of file index.h.

§ operator<()

bool RecoCoord::operator< ( const RecoCoord rc) const
inline

Comparison operator for indexing

Definition at line 170 of file index.h.

§ operator==()

bool RecoCoord::operator== ( const RecoCoord rc) const
inline

Equality operator

Definition at line 183 of file index.h.

§ prep_count()

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.

§ print()

STD_string RecoCoord::print ( RecoIndex::printMode  printmode = RecoIndex::brief) const

Converts the coordinate to a string according to 'printmode'

§ set_mode()

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,
recoDim  d6 = n_recoDims,
recoDim  d7 = n_recoDims,
recoDim  d8 = n_recoDims 
)
inline

Convenience function: Sets specified dimensions to mode 'm'

Definition at line 238 of file index.h.

§ set_uniform_mode()

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.

Member Data Documentation

§ adcend

unsigned short RecoCoord::adcend

Last index in readout direction actually measured, will be converted from 'relCenterPos' in functor 'adc_pad'

Definition at line 320 of file index.h.

§ adcstart

unsigned short RecoCoord::adcstart

First index in readout direction actually measured, will be converted from 'relCenterPos' in functor 'adc_pad'

Definition at line 315 of file index.h.

§ dwellTime

double RecoCoord::dwellTime

Dwell time of the signal data

Definition at line 300 of file index.h.

§ echopos

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 331 of file index.h.

§ echotrain

unsigned short RecoCoord::echotrain

EPI echo-train index for 3D multi-EPI readout and EPI navigator correction.

Definition at line 336 of file index.h.

§ flags

unsigned char RecoCoord::flags

Combination of recoFlags

Definition at line 275 of file index.h.

§ gridScaleFactor

float RecoCoord::gridScaleFactor

Scale factor for gridding reconstruction

Definition at line 325 of file index.h.

§ index

RecoIndex RecoCoord::index[n_recoDims]

The index in each dimension

Definition at line 269 of file index.h.

§ kspaceTraj

const KspaceTraj* RecoCoord::kspaceTraj

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

Definition at line 289 of file index.h.

§ overSamplingFactor

float RecoCoord::overSamplingFactor

Oversampling factor in readout direction

Definition at line 305 of file index.h.

§ readoutShape

const ReadoutShape* RecoCoord::readoutShape

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

Definition at line 282 of file index.h.

§ relCenterPos

float RecoCoord::relCenterPos

Relative position of k-space center in readout direction

Definition at line 310 of file index.h.

§ weightVec

const ComplexData<1>* RecoCoord::weightVec

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

Definition at line 294 of file index.h.


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