Public Member Functions | Friends | List of all members
RecoPars Class Reference

#include <reco.h>

Inheritance diagram for RecoPars:
Inheritance graph
[legend]

Public Member Functions

 RecoPars (const STD_string &label="unnamedRecoPars")
 
 RecoPars (const RecoPars &sr)
 
RecoParsoperator= (const RecoPars &sr)
 
const Protocolget_protocol () const
 
const LDRkSpaceCoordsget_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 STD_string & get_ImageProc () const
 
const dvectorget_DimValues (recoDim dim) const
 
fvector get_ChannelScales () const
 
double get_DwellTime (unsigned int i) const
 
int get_NumOfAdcChunks () const
 
RecoParsset_DimValues (recoDim dim, const dvector &vals)
 
int append_readout_shape (const fvector &shape, unsigned int dstsize)
 
int append_kspace_traj (const farray &kspace_traj)
 
int append_adc_weight_vec (const cvector &weightvec)
 
int append_dwell_time (double dt)
 
void get_ReadoutShape (unsigned int i, fvector &shape, unsigned int &dstsize) const
 
unsigned int numof_kSpaceTraj () const
 
const farrayget_kSpaceTraj (unsigned int i) const
 
const cvectorget_AdcWeightVector (unsigned int i) const
 
LONGEST_INT 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
 
- Public Member Functions inherited from LDRblock
 LDRblock (const STD_string &title="Parameter List")
 
 LDRblock (const LDRblock &block)
 
 ~LDRblock ()
 
LDRblockoperator= (const LDRblock &block)
 
LDRblockmerge (LDRblock &block, bool onlyUserPars=true)
 
LDRblockunmerge (LDRblock &block)
 
STD_string printval (const STD_string &parameterName, bool append_unit=false) const
 
bool parseval (const STD_string &parameterName, const STD_string &value)
 
int parseblock (const STD_string &source, const LDRserBase &serializer=LDRserJDX())
 
unsigned int numof_pars () const
 
LDRbaseget_parameter (const STD_string &ldrlabel)
 
bool parameter_exists (const STD_string &ldrlabel) const
 
LDRblockset_prefix (const STD_string &prefix)
 
LDRblockset_embedded (bool embedded)
 
bool is_embedded () const
 
LDRbaseoperator[] (unsigned int i)
 
const LDRbaseoperator[] (unsigned int i) const
 
LDRbaseget_parameter_by_id (int id)
 
LDRblockcreate_copy (const LDRblock &src)
 
LDRblockappend_copy (const LDRbase &src)
 
LDRblockcopy_ldr_vals (const LDRblock &src)
 
bool operator== (const LDRblock &rhs) const
 
bool operator< (const LDRblock &rhs) const
 
bool compare (const LDRblock &rhs, const STD_list< STD_string > *exclude=0, double accuracy=0.0) const
 
STD_string print (const LDRserBase &serializer=LDRserJDX()) const
 
LDRbaseset_parmode (parameterMode parameter_mode)
 
LDRbaseset_filemode (fileMode file_mode)
 
STD_string get_parx_code (parxCodeType type) const
 
STD_ostream & print2stream (STD_ostream &os, const LDRserBase &serializer) const
 
bool parsevalstring (const STD_string &, const LDRserBase *ser=0)
 
bool parse (STD_string &parstring, const LDRserBase &serializer)
 
STD_string printvalstring (const LDRserBase *ser=0) const
 
LDRbasecreate_copy () const
 
STD_string get_typeInfo (bool parx_equivtype=false) const
 
int load (const STD_string &filename, const LDRserBase &serializer=LDRserJDX())
 
int write (const STD_string &filename, const LDRserBase &serializer=LDRserJDX()) const
 
- Public Member Functions inherited from LDRbase
virtual double get_minval () const
 
virtual double get_maxval () const
 
bool has_minmax () const
 
const STD_string & get_description () const
 
LDRbaseset_description (const STD_string &descr)
 
virtual svector get_alternatives () const
 
const STD_string & get_unit () const
 
LDRbaseset_unit (const STD_string &un)
 
virtual parameterMode get_parmode () const
 
virtual fileMode get_filemode () const
 
virtual GuiProps get_gui_props () const
 
virtual LDRbaseset_gui_props (const GuiProps &)
 
JcampDxProps get_jdx_props () const
 
LDRbaseset_jdx_props (const JcampDxProps &jp)
 
- Public Member Functions inherited from Labeled
 Labeled (const STD_string &label="unnamed")
 
Labeledset_label (const STD_string &label)
 
const STD_string & get_label () const
 
Labeledoperator= (const Labeled &l)
 
- Public Member Functions inherited from List< I, P, R >
 List ()
 
 ~List ()
 
Listoperator= (const List &l)
 
Listclear ()
 
Listappend (R item)
 
Listremove (R item)
 
unsigned int size () const
 
iter get_begin ()
 
iter get_end ()
 
constiter get_const_begin () const
 
constiter get_const_end () const
 

Friends

class SeqAcq
 
class SeqMethod
 

Additional Inherited Members

- Public Types inherited from List< I, P, R >
typedef STD_list< P >::iterator iter
 
typedef STD_list< P >::const_iterator constiter
 
- Protected Member Functions inherited from LDRblock
LDRblockappend_member (LDRbase &ldr, const STD_string ldrlabel="")
 

Detailed Description

This class is used to hold all information about the reconstruction

Definition at line 265 of file reco.h.

Constructor & Destructor Documentation

§ RecoPars() [1/2]

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

Constructs a RecoPars with the given label

§ RecoPars() [2/2]

RecoPars::RecoPars ( const RecoPars sr)

Constructs a copy of 'sr'

Member Function Documentation

§ append_adc_weight_vec()

int RecoPars::append_adc_weight_vec ( const cvector weightvec)

Appends a new ADC weighting vector and returns its index

§ append_dwell_time()

int RecoPars::append_dwell_time ( double  dt)

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

§ append_kspace_traj()

int RecoPars::append_kspace_traj ( const farray kspace_traj)

Appends a new k-space trajectory and returns its index

§ append_readout_shape()

int RecoPars::append_readout_shape ( const fvector shape,
unsigned int  dstsize 
)

Appends a new ADC readout-gradient shape and its target grid size. Returns its index

§ get_AdcWeightVector()

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

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

§ get_ChannelScales()

fvector RecoPars::get_ChannelScales ( ) const
inline

Returns the scaling factors for ADC channels

Definition at line 332 of file reco.h.

§ get_CmdLineOpts()

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 460 of file reco.h.

§ get_DataFormat()

const STD_string& RecoPars::get_DataFormat ( ) const
inline

Returns the data type of the acquired ADCs

Definition at line 297 of file reco.h.

§ get_DimValues()

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

Returns the value vector attached to reco dimension 'dim'

Definition at line 327 of file reco.h.

§ get_DwellTime()

double RecoPars::get_DwellTime ( unsigned int  i) const

Returns the i'th dwell time (including oversampling)

§ get_ImageProc()

const STD_string& RecoPars::get_ImageProc ( ) const
inline

Extra command-line arguments for processing of final images

Definition at line 322 of file reco.h.

§ get_kSpaceCoord()

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

Returns the i'th ADC of the sequence

§ get_kSpaceCoords()

const LDRkSpaceCoords& RecoPars::get_kSpaceCoords ( ) const
inline

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

Definition at line 292 of file reco.h.

§ get_kSpaceTraj()

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

Returns the i'th k-space trajectory

§ get_NumOfAdcChunks()

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.

§ get_PostProc3D()

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 437 of file reco.h.

§ get_PreProc3D()

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 449 of file reco.h.

§ get_protocol()

const Protocol& RecoPars::get_protocol ( ) const
inline

Returns the scan protocol.

Definition at line 287 of file reco.h.

§ get_RawFile()

const STD_string& RecoPars::get_RawFile ( ) const
inline

Returns the file name of raw data

Definition at line 307 of file reco.h.

§ get_RawHeaderSize()

unsigned int RecoPars::get_RawHeaderSize ( ) const
inline

Returns the header size of raw data

Definition at line 312 of file reco.h.

§ get_ReadoutShape()

void RecoPars::get_ReadoutShape ( unsigned int  i,
fvector shape,
unsigned int &  dstsize 
) const

Returns the i'th ADC readout-gradient and its target grid size

§ get_Recipe()

STD_string RecoPars::get_Recipe ( ) const
inline

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

Definition at line 423 of file reco.h.

§ get_RelativeOffset()

const fvector& RecoPars::get_RelativeOffset ( ) const
inline

Returns the relative offset which should be added by the reco

Definition at line 317 of file reco.h.

§ get_TotalNumOfSamples()

LONGEST_INT 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'

§ is_LittleEndian()

bool RecoPars::is_LittleEndian ( ) const
inline

Returns whether the of the acquired ADCs is little endian

Definition at line 302 of file reco.h.

§ numof_adcs()

unsigned int RecoPars::numof_adcs ( ) const
inline

Returns the total number of ADCs

Definition at line 408 of file reco.h.

§ numof_kSpaceTraj()

unsigned int RecoPars::numof_kSpaceTraj ( ) const

Returns the number of k-space trajectories

§ operator=()

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

Assignment operator

§ set_CmdLineOpts()

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

Extra command-line options for the reco.

Definition at line 454 of file reco.h.

§ set_DimValues()

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

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

§ set_PostProc3D()

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 430 of file reco.h.

§ set_PreProc3D()

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 443 of file reco.h.

§ set_Recipe()

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

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

Definition at line 418 of file reco.h.


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