RecoPars Class Reference
[MR Parameters (odinpara library)]

#include <reco.h>

Inheritance diagram for RecoPars:

Inheritance graph
[legend]
Collaboration diagram for RecoPars:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 RecoPars (const STD_string &label="unnamedRecoPars")
 RecoPars (const RecoPars &sr)
RecoParsoperator= (const RecoPars &sr)
const JDXkSpaceCoordsget_kSpaceCoords () const
const STD_string & get_DataFormat () const
bool is_LittleEndian () const
const STD_string & get_RawFile () const
unsigned int get_RawHeaderSize () const
const fvectorget_RelativeOffset () const
const fvectorget_CoordinateScaling () const
const dvectorget_DimValues (recoDim dim) const
fvector get_ChannelScales () const
double get_DwellTime (unsigned int i) const
int get_MatrixSizeRead () const
int get_MatrixSizePhase () const
int get_MatrixSizePhase2 () const
int get_NumOfAdcChunks () const
RecoParsset_DimValues (recoDim dim, const dvector &vals)
int append_readout_shape (const fvector &shape)
int append_kspace_traj (const farray &kspace_traj)
int append_adc_weight_vec (const cvector &weightvec)
int append_dwell_time (double dt)
const fvectorget_ReadoutShape (unsigned int i) const
unsigned int numof_kSpaceTraj () const
const farrayget_kSpaceTraj (unsigned int i) const
const cvectorget_AdcWeightVector (unsigned int i) const
unsigned long get_TotalNumOfSamples (bool discard=false) const
unsigned int numof_adcs () const
const kSpaceCoordget_kSpaceCoord (unsigned int i) const
RecoParsset_Recipe (const STD_string &recipe)
STD_string get_Recipe () const
RecoParsset_PostProc3D (const STD_string &recipe)
STD_string get_PostProc3D () const
RecoParsset_PreProc3D (const STD_string &recipe)
STD_string get_PreProc3D () const
RecoParsset_CmdLineOpts (const STD_string &opts)
STD_string get_CmdLineOpts () const

Friends

class SeqAcq
class SeqEpiDriverParavision
class SeqMethod

Detailed Description

This class is used to hold all information about the reconstruction

Definition at line 247 of file reco.h.


Constructor & Destructor Documentation

RecoPars::RecoPars ( const STD_string &  label = "unnamedRecoPars"  ) 

Constructs a RecoPars with the given label

RecoPars::RecoPars ( const RecoPars sr  ) 

Constructs a copy of 'sr'


Member Function Documentation

RecoPars& RecoPars::operator= ( const RecoPars sr  ) 

Assignment operator

const JDXkSpaceCoords& RecoPars::get_kSpaceCoords (  )  const [inline]

Returns the const assignment of ADC indices to k-space lines (for odinreco)

Definition at line 269 of file reco.h.

const STD_string& RecoPars::get_DataFormat (  )  const [inline]

Returns the data type of the acquired ADCs

Definition at line 274 of file reco.h.

bool RecoPars::is_LittleEndian (  )  const [inline]

Returns whether the of the acquired ADCs is little endian

Definition at line 279 of file reco.h.

const STD_string& RecoPars::get_RawFile (  )  const [inline]

Returns the file name of raw data

Definition at line 284 of file reco.h.

unsigned int RecoPars::get_RawHeaderSize (  )  const [inline]

Returns the header size of raw data

Definition at line 289 of file reco.h.

const fvector& RecoPars::get_RelativeOffset (  )  const [inline]

Returns the relative offset which should be added by the reco

Definition at line 294 of file reco.h.

const fvector& RecoPars::get_CoordinateScaling (  )  const [inline]

Returns the scaling of the coordinate system (also used for reflection in certain dimensions)

Definition at line 299 of file reco.h.

const dvector& RecoPars::get_DimValues ( recoDim  dim  )  const [inline]

Returns the value vector attached to reco dimension 'dim'

Definition at line 304 of file reco.h.

fvector RecoPars::get_ChannelScales (  )  const [inline]

Returns the scaling factors for ADC channels

Definition at line 309 of file reco.h.

double RecoPars::get_DwellTime ( unsigned int  i  )  const

Returns the i'th dwell time (including oversampling)

int RecoPars::get_MatrixSizeRead (  )  const [inline]

Returns the desired matrix size of the image grid in read direction. If 'consider_coord' is 'true', the maximum imposed by k-space coordinates is returned MatrixSizeRead, otherwise only MatrixSizeRead.

Definition at line 321 of file reco.h.

int RecoPars::get_MatrixSizePhase (  )  const [inline]

Returns the desired matrix size of the image grid in phase direction

Definition at line 326 of file reco.h.

int RecoPars::get_MatrixSizePhase2 (  )  const [inline]

Returns the desired matrix size of the image grid in the second phase direction

Definition at line 331 of file reco.h.

int RecoPars::get_NumOfAdcChunks (  )  const

Returns the number of ADC chunks, a chunk is a collection of one or more ADCs stored by the system in one block. It can be followed by an arbitrary number of zeroes.

RecoPars& RecoPars::set_DimValues ( recoDim  dim,
const dvector vals 
)

Attaches a vector 'vals' of values to each step in the given dimension 'dim'

int RecoPars::append_readout_shape ( const fvector shape  ) 

Appends a new ADC readout-gradient shape and returns its index

int RecoPars::append_kspace_traj ( const farray kspace_traj  ) 

Appends a new k-space trajectory and returns its index

int RecoPars::append_adc_weight_vec ( const cvector weightvec  ) 

Appends a new ADC weighting vector and returns its index

int RecoPars::append_dwell_time ( double  dt  ) 

Appends a new ADC dwell time (including oversampling) and returns its index

const fvector& RecoPars::get_ReadoutShape ( unsigned int  i  )  const

Returns the i'th ADC readout-gradient

unsigned int RecoPars::numof_kSpaceTraj (  )  const

Returns the number of k-space trajectories

const farray& RecoPars::get_kSpaceTraj ( unsigned int  i  )  const

Returns the i'th k-space trajectory

const cvector& RecoPars::get_AdcWeightVector ( unsigned int  i  )  const

Returns the i'th complex weighting vector with which the corresponding ADCs will be multiplied

unsigned long RecoPars::get_TotalNumOfSamples ( bool  discard = false  )  const

Returns the total number of ADC samples, if 'discard' is set to 'true' only the effective ADC size is returned, i.e. without 'preDiscard' and 'postDiscard'

unsigned int RecoPars::numof_adcs (  )  const [inline]

Returns the total number of ADCs

Definition at line 401 of file reco.h.

const kSpaceCoord& RecoPars::get_kSpaceCoord ( unsigned int  i  )  const

Returns the i'th ADC of the sequence

RecoPars& RecoPars::set_Recipe ( const STD_string &  recipe  )  [inline]

Set a string describing the reconstruction pipeline (chain of steps/functors).

Definition at line 411 of file reco.h.

STD_string RecoPars::get_Recipe (  )  const [inline]

Returns a string describing the reconstruction pipeline (chain of steps/functors).

Definition at line 416 of file reco.h.

RecoPars& RecoPars::set_PostProc3D ( const STD_string &  recipe  )  [inline]

The extra chain of reconstruction steps (functors) described by 'recipe' wil be performed after 3D reconstruction (including channel combination) but before data is stored on disk.

Definition at line 423 of file reco.h.

STD_string RecoPars::get_PostProc3D (  )  const [inline]

Returns the extra chain of reconstruction steps (functors) which will be performed after 3D reconstruction (including channel combination) but before data is stored on disk.

Definition at line 430 of file reco.h.

RecoPars& RecoPars::set_PreProc3D ( const STD_string &  recipe  )  [inline]

The extra chain of reconstruction steps (functors) described by 'recipe' wil be performed after 3D FFT but before channel combination.

Definition at line 436 of file reco.h.

STD_string RecoPars::get_PreProc3D (  )  const [inline]

Returns the extra chain of reconstruction steps (functors) described by 'recipe' wil be performed after 3D FFT but before channel combination.

Definition at line 442 of file reco.h.

RecoPars& RecoPars::set_CmdLineOpts ( const STD_string &  opts  )  [inline]

Extra command-line options for the reco.

Definition at line 447 of file reco.h.

STD_string RecoPars::get_CmdLineOpts (  )  const [inline]

Returns the extra chain of reconstruction steps (functors) which will be performed after 3D reconstruction before data is stored on disk.

Definition at line 453 of file reco.h.


The documentation for this class was generated from the following file:
Generated on Sat Jun 14 12:32:03 2008 by  doxygen 1.5.1