Acquisition. More...

#include <seqacq.h>

Inheritance diagram for SeqAcq:

[legend]

Public Member Functions
	SeqAcq (const STD_string &object_label, unsigned int nAcqPoints, double sweepwidth, float os_factor=1.0, const STD_string &nucleus="", const dvector &phaselist=0, const dvector &freqlist=0)

	SeqAcq (const SeqAcq &sa)

	SeqAcq (const STD_string &object_label="unnamedSeqAcq")

	~SeqAcq ()

SeqAcq &	set_npts (unsigned int nAcqPoints)

double	get_sweep_width () const

SeqAcq &	operator= (const SeqAcq &sa)

void	set_kspace_traj (const farray &kspaceTraj)

void	set_weight_vec (const cvector &weightVec)

SeqAcq &	set_rel_center (double relative_kspace_center)

const kSpaceCoord &	get_kcoord () const

double	get_acquisition_duration () const

double	get_acquisition_center () const

double	get_acquisition_start () const

unsigned int	get_npts () const

SeqAcqInterface &	set_sweepwidth (double sw, float os_factor)

double	get_sweepwidth () const

float	get_oversampling () const

SeqAcqInterface &	set_readout_shape (const fvector &shape, unsigned int dstsize)

SeqAcqInterface &	set_reco_vector (recoDim dim, const SeqVector &vec, const dvector &valvec=dvector())

SeqAcqInterface &	set_default_reco_index (recoDim dim, unsigned int index)

SeqAcqInterface &	set_reflect_flag (bool flag)

STD_string	get_program (programContext &context) const

double	get_duration () const

SeqValList	get_freqvallist (freqlistAction action) const

void	query (queryContext &context) const

RecoValList	get_recovallist (unsigned int reptimes, LDRkSpaceCoords &coords) const

unsigned int	event (eventContext &context) const

STD_string	get_properties () const

Public Member Functions inherited from SeqAcqInterface
virtual SeqAcqInterface &	set_template_type (templateType type)

Public Member Functions inherited from SeqFreqChanInterface
	operator const SeqVector & () const

virtual SeqFreqChanInterface &	set_encoding_scheme (encodingScheme scheme)

virtual SeqFreqChanInterface &	set_reorder_scheme (reorderScheme scheme, unsigned int nsegments=1)

virtual const SeqVector &	get_reorder_vector () const

virtual SeqFreqChanInterface &	set_phaselist_encoding_scheme (encodingScheme scheme)

virtual SeqFreqChanInterface &	set_phaselist_reorder_scheme (reorderScheme scheme, unsigned int nsegments=1)

virtual const SeqVector &	get_phaselist_reorder_vector () const

SeqFreqChanInterface &	set_freqoffset (double freqoffset)

SeqFreqChanInterface &	set_phase (double phaseval)

SeqFreqChanInterface &	set_phasespoiling (unsigned int size=80, double incr=117.0, double offset=0.0)

Public Member Functions inherited from SeqClass
SeqClass &	set_temporary ()

Public Member Functions inherited from Labeled
	Labeled (const STD_string &label="unnamed")

Labeled &	set_label (const STD_string &label)

const STD_string &	get_label () const

Labeled &	operator= (const Labeled &l)

Public Member Functions inherited from SeqTreeObj
bool	contains (const SeqTreeObj *sto) const

void	tree (SeqTreeCallbackAbstract *display) const

virtual SeqValList	get_delayvallist () const

virtual double	get_rf_energy () const

Public Member Functions inherited from SeqFreqChan
	SeqFreqChan (const STD_string &object_label="unnamedSeqFreqChan")

	SeqFreqChan (const STD_string &object_label, const STD_string &nucleus, const dvector &freqlist=0, const dvector &phaselist=0)

	SeqFreqChan (const SeqFreqChan &sfc)

virtual	~SeqFreqChan ()

SeqFreqChan &	operator= (const SeqFreqChan &sfc)

int	get_channel () const

dvector	get_freqlist () const

double	get_phase () const

virtual double	get_frequency () const

unsigned int	get_phaselistindex () const

virtual unsigned int	get_freqlistindex () const

STD_string	get_iteratorcommand (objCategory cat) const

SeqFreqChanInterface &	set_nucleus (const STD_string &nucleus)

SeqFreqChanInterface &	set_freqlist (const dvector &freqlist)

SeqFreqChanInterface &	set_phaselist (const dvector &phaselist)

const SeqVector &	get_freqlist_vector () const

const SeqVector &	get_phaselist_vector () const

unsigned int	get_vectorsize () const

bool	prep_iteration () const

bool	is_qualvector () const

svector	get_vector_commands (const STD_string &iterator) const

Public Member Functions inherited from SeqVector
	SeqVector (const STD_string &object_label="unnamedSeqVector")

	SeqVector (const STD_string &object_label, unsigned int nindices, int slope=1, int offset=0)

	SeqVector (const SeqVector &sv)

virtual	~SeqVector ()

SeqVector &	operator= (const SeqVector &sv)

virtual unsigned int	get_numof_iterations () const

virtual bool	needs_unrolling_check () const

virtual int	get_current_index () const

int	get_acq_index () const

virtual bool	is_acq_vector () const

virtual bool	is_obj_vector () const

virtual STD_string	get_loopcommand () const

SeqVector &	set_indexvec (const ivector &iv)

ivector	get_indexvec () const

SeqVector &	set_reorder_scheme (reorderScheme scheme, unsigned int nsegments=1)

SeqVector &	set_encoding_scheme (encodingScheme scheme)

const SeqVector &	get_reorder_vector () const

virtual nestingRelation	get_nesting_relation () const

iarray	get_index_matrix () const

int	get_current_reord_index () const

STD_string	get_reord_iterator (const STD_string &iterator) const

Friends
class	SeqMethod

Additional Inherited Members
Protected Member Functions inherited from SeqClass
void	marshall_error () const

virtual void	clear_container ()

Protected Member Functions inherited from SeqFreqChan
bool	prep ()

Protected Member Functions inherited from SeqVector
virtual svector	get_reord_vector_commands (const STD_string &iterator) const

bool	is_handled () const

Static Protected Member Functions inherited from SeqClass
static void	clear_temporary ()

static void	clear_containers ()

Detailed Description

Acquisition.

This class represents an acquisition window

Definition at line 206 of file seqacq.h.

Constructor & Destructor Documentation

◆ SeqAcq() [1/3]

SeqAcq::SeqAcq	(	const STD_string &	object_label,
		unsigned int	nAcqPoints,
		double	sweepwidth,
		float	os_factor = `1.0`,
		const STD_string &	nucleus = `""`,
		const dvector &	phaselist = `0`,
		const dvector &	freqlist = `0`
	)

Constructs an acquisition window labeled 'object_label' with the following properties:

nAcqPoints: The number of sampling points that will be acquired during the acquisition
sweepwidth: The sampling frequency without oversampling
os_factor: The oversampling factor, os_factor=1 means no oversampling
nucleus: The nucleus for which the acquisition should be performed. The default is to acquire on the protons resonance freuency.
phaselist: This is an array of phases at which the acquired signal will be demodulated. The actual phase for each acquisition is determined by cycling through this array of phases which are represented in degree.
freqlist: This is an array of frequency offsets at which the acquired signal will be demodulated.

◆ SeqAcq() [2/3]

SeqAcq::SeqAcq ( const SeqAcq & sa )

Constructs an acquisition window which is a copy of 'sa'

◆ SeqAcq() [3/3]

SeqAcq::SeqAcq ( const STD_string & object_label = "unnamedSeqAcq" )

Constructs an empty acquisition window with the given label.

◆ ~SeqAcq()

SeqAcq::~SeqAcq ( )

Destructor

Member Function Documentation

◆ event()

unsigned int SeqAcq::event ( eventContext & context ) const

virtual

Queries the sequence tree for events, returns the number of events executed

Reimplemented from SeqTreeObj.

◆ get_acquisition_center()

double SeqAcq::get_acquisition_center ( ) const

virtual

Returns the the duration from the the beginnig of the acquisition object to the middle of the acquisition window.

Reimplemented from SeqAcqInterface.

◆ get_acquisition_duration()

double SeqAcq::get_acquisition_duration ( ) const

inlinevirtual

Returns the duration of the acquisition window without padding delays.

Reimplemented from SeqAcqInterface.

Definition at line 290 of file seqacq.h.

◆ get_acquisition_start()

double SeqAcq::get_acquisition_start ( ) const

inlinevirtual

Returns the the duration from the the beginnig of the acquisition object to the beginnig of the acquisition window (the point of time where data starts to be acquired).

Reimplemented from SeqAcqInterface.

Definition at line 292 of file seqacq.h.

◆ get_duration()

double SeqAcq::get_duration ( ) const

virtual

Returns the duration of the sequence object.

Implements SeqTreeObj.

◆ get_freqvallist()

SeqValList SeqAcq::get_freqvallist ( freqlistAction action ) const

virtual

Returns the list of frequency values in the objects branch of the sequence tree

Reimplemented from SeqTreeObj.

◆ get_kcoord()

const kSpaceCoord& SeqAcq::get_kcoord ( ) const

Returns the k-space index of this ADCs

◆ get_npts()

unsigned int SeqAcq::get_npts ( ) const

inlinevirtual

Returns the total number of sampling points, without oversampling

Reimplemented from SeqAcqInterface.

Definition at line 293 of file seqacq.h.

◆ get_oversampling()

float SeqAcq::get_oversampling ( ) const

inlinevirtual

Returns the oversampling factor

Reimplemented from SeqAcqInterface.

Definition at line 296 of file seqacq.h.

◆ get_program()

STD_string SeqAcq::get_program ( programContext & context ) const

virtual

Returns the part in the pulse/gradient program of this sequence object. 'context' holds data about how the program should be generated, e.g. type of program and formatting.

Reimplemented from SeqTreeObj.

◆ get_properties()

STD_string SeqAcq::get_properties ( ) const

virtual

Returns a string describing the object

Reimplemented from SeqTreeObj.

◆ get_recovallist()

RecoValList SeqAcq::get_recovallist	(	unsigned int	reptimes,
		LDRkSpaceCoords &	coords
	)		const

virtual

Appends the k-space coordinates in this branch of the sequence tree to 'coords' and returns their ordering

Reimplemented from SeqTreeObj.

◆ get_sweep_width()

double SeqAcq::get_sweep_width ( ) const

inline

Returns the sweep width

Definition at line 255 of file seqacq.h.

◆ get_sweepwidth()

double SeqAcq::get_sweepwidth ( ) const

inlinevirtual

Returns the sweepwidth factor

Reimplemented from SeqAcqInterface.

Definition at line 295 of file seqacq.h.

◆ operator=()

SeqAcq& SeqAcq::operator= ( const SeqAcq & sa )

This assignment operator will make this object become an exact copy of 'sa'.

◆ query()

void SeqAcq::query ( queryContext & context ) const

inlinevirtual

Query the sequence tree recursively

Reimplemented from SeqTreeObj.

Definition at line 307 of file seqacq.h.

◆ set_default_reco_index()

SeqAcqInterface& SeqAcq::set_default_reco_index	(	recoDim	dim,
		unsigned int	index
	)

virtual

Sets the default value 'index' for the reco index in dimension 'dim'. This is relevant for automatic reconstruction.

Reimplemented from SeqAcqInterface.

◆ set_kspace_traj()

void SeqAcq::set_kspace_traj ( const farray & kspaceTraj )

Specifies a an explicit k-space Trajectory for this ADC (for automatic reconstruction)

◆ set_npts()

SeqAcq& SeqAcq::set_npts ( unsigned int nAcqPoints )

Sets the number of sampling points that will be acquired during the acquisition

◆ set_readout_shape()

SeqAcqInterface& SeqAcq::set_readout_shape	(	const fvector &	shape,
		unsigned int	dstsize
	)

virtual

Specifies a regridding matrix for this ADC (for automatic reconstruction)

Reimplemented from SeqAcqInterface.

◆ set_reco_vector()

SeqAcqInterface& SeqAcq::set_reco_vector	(	recoDim	dim,
		const SeqVector &	vec,
		const dvector &	valvec = `dvector()`
	)

virtual

Specifies a vector 'vec' which indexes the data dimension 'dim'. The current index for each acquisition is retrieved from the vector. This is relevant for automatic reconstruction. An additional vector 'valvec' of double values can be given, which is attached to this dimension, e.g. different TEs in the echo dimension.

Reimplemented from SeqAcqInterface.

◆ set_reflect_flag()

SeqAcqInterface& SeqAcq::set_reflect_flag ( bool flag )

inlinevirtual

Specifies whether the data points should be reversed, only relevant for automatic reconstruction

Reimplemented from SeqAcqInterface.

Definition at line 300 of file seqacq.h.

◆ set_rel_center()

SeqAcq& SeqAcq::set_rel_center ( double relative_kspace_center )

inline

Sets the relative point in time (between 0 and 1) when k-space center is passed, the default is 0.5. Will be used in get_acquisition_center().

Definition at line 280 of file seqacq.h.

◆ set_sweepwidth()

SeqAcqInterface& SeqAcq::set_sweepwidth	(	double	sw,
		float	os_factor
	)

virtual

Sets the sweepwidth 'sw' without oversampling and oversampling factor 'os_factor' for this acquisition object, os_factor=1 means no oversampling.

Reimplemented from SeqAcqInterface.

◆ set_weight_vec()

void SeqAcq::set_weight_vec ( const cvector & weightVec )

Specifies a complex vector which is is used to weight each point in this ADC (for automatic reconstruction)

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

seqacq.h

Public Member Functions

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ SeqAcq() [1/3]

◆ SeqAcq() [2/3]

◆ SeqAcq() [3/3]

◆ ~SeqAcq()

Member Function Documentation

◆ event()

◆ get_acquisition_center()

◆ get_acquisition_duration()

◆ get_acquisition_start()

◆ get_duration()

◆ get_freqvallist()

◆ get_kcoord()

◆ get_npts()

◆ get_oversampling()

◆ get_program()

◆ get_properties()

◆ get_recovallist()

◆ get_sweep_width()

◆ get_sweepwidth()

◆ operator=()

◆ query()

◆ set_default_reco_index()

◆ set_kspace_traj()

◆ set_npts()

◆ set_readout_shape()

◆ set_reco_vector()

◆ set_reflect_flag()

◆ set_rel_center()

◆ set_sweepwidth()

◆ set_weight_vec()