CASToR  3.2
Tomographic Reconstruction (PET/SPECT/CT)
Public Member Functions | Private Attributes | List of all members
oArterialInputCurve Class Reference

This class is designed to manage the Arterial Input Curve provided by the user. More...

#include <oArterialInputCurve.hh>

Collaboration diagram for oArterialInputCurve:
Collaboration graph

Public Member Functions

 oArterialInputCurve ()
 Constructor of oArterialInputCurve. Simply set all data members to default values. More...
 
 ~oArterialInputCurve ()
 Destructor of oArterialInputCurve. Free memory from all allocated tabs. More...
 
int CheckParameters ()
 This function is used to check that the required input parameters are provided from the file provided by the user. More...
 
int InitializeInputData ()
 This function is used to initialize the input arterial curve samples from the file provided by the user. More...
 
int InterpolateAIC ()
 This function performs a linear interpolation within the provided AIC range for every discrete unit of millisecond up to the end of the last requested frame. More...
 
int Downsample ()
 This function downsamples the interpolated arterial input function Currently needed to speed up convolution for the SpectralDynamicModel. More...
 
void SetInputFilePath (const string &a_pathToAICfile)
 
void SetVerbose (int a_verbose)
 
void SetFrames (int a_nbTimeFrames, uint32_t *a_frameTimeStartInMs, uint32_t *a_frameTimeStopInMs)
 
HPFLTNBGetDownsampledAIC ()
 Set the framing of the reconstruction for the AIC object. More...
 
HPFLTNBGetInterpolatedAIC ()
 Set the framing of the reconstruction for the AIC object. More...
 
 oArterialInputCurve ()
 
 ~oArterialInputCurve ()
 
int CheckParameters ()
 
int InitializeInputData ()
 
int InterpolateAIC ()
 
int Downsample ()
 
void SetInputFilePath (const string &a_pathToAICfile)
 
void SetVerbose (int a_verbose)
 
void SetFrames (int a_nbTimeFrames, uint32_t *a_frameTimeStartInMs, uint32_t *a_frameTimeStopInMs)
 
HPFLTNBGetDownsampledAIC ()
 
HPFLTNBGetInterpolatedAIC ()
 

Private Attributes

string m_pathToAICfile
 
int m_nbinputDataPoints
 
HPFLTNBmp_AICDataPoints
 
uint32_t * mp_AICDataPointsTimes
 
HPFLTNBmp_AICIntrpY
 
HPFLTNBmp_AICIntrpY_downsampled
 
int m_nbTimeFrames
 
uint32_t * mp_frameTimeStartInMs
 
uint32_t * mp_frameTimeStopInMs
 
int m_verbose
 

Detailed Description

This class is designed to manage the Arterial Input Curve provided by the user.

Definition at line 19 of file code/include/dynamic/oArterialInputCurve.hh.

Constructor & Destructor Documentation

◆ oArterialInputCurve() [1/2]

oArterialInputCurve::oArterialInputCurve ( )

Constructor of oArterialInputCurve. Simply set all data members to default values.

Definition at line 21 of file code/src/dynamic/oArterialInputCurve.cc.

◆ ~oArterialInputCurve() [1/2]

oArterialInputCurve::~oArterialInputCurve ( )

Destructor of oArterialInputCurve. Free memory from all allocated tabs.

Definition at line 41 of file code/src/dynamic/oArterialInputCurve.cc.

◆ oArterialInputCurve() [2/2]

oArterialInputCurve::oArterialInputCurve ( )

◆ ~oArterialInputCurve() [2/2]

oArterialInputCurve::~oArterialInputCurve ( )

Member Function Documentation

◆ CheckParameters() [1/2]

int oArterialInputCurve::CheckParameters ( )

This function is used to check that the required input parameters are provided from the file provided by the user.

Returns
0 if success, positive value otherwise.

Definition at line 51 of file code/src/dynamic/oArterialInputCurve.cc.

Here is the caller graph for this function:

◆ CheckParameters() [2/2]

int oArterialInputCurve::CheckParameters ( )

◆ Downsample() [1/2]

int oArterialInputCurve::Downsample ( )

This function downsamples the interpolated arterial input function Currently needed to speed up convolution for the SpectralDynamicModel.

Returns
0 if success, positive value otherwise.

Definition at line 218 of file code/src/dynamic/oArterialInputCurve.cc.

Here is the caller graph for this function:

◆ Downsample() [2/2]

int oArterialInputCurve::Downsample ( )

◆ GetDownsampledAIC() [1/2]

public void oArterialInputCurve::GetDownsampledAIC ( )
inline

Set the framing of the reconstruction for the AIC object.

Definition at line 92 of file code/include/dynamic/oArterialInputCurve.hh.

Here is the caller graph for this function:

◆ GetDownsampledAIC() [2/2]

HPFLTNB* oArterialInputCurve::GetDownsampledAIC ( )
inline

Definition at line 92 of file include/dynamic/oArterialInputCurve.hh.

◆ GetInterpolatedAIC() [1/2]

public void oArterialInputCurve::GetInterpolatedAIC ( )
inline

Set the framing of the reconstruction for the AIC object.

Definition at line 97 of file code/include/dynamic/oArterialInputCurve.hh.

Here is the caller graph for this function:

◆ GetInterpolatedAIC() [2/2]

HPFLTNB* oArterialInputCurve::GetInterpolatedAIC ( )
inline

Definition at line 97 of file include/dynamic/oArterialInputCurve.hh.

◆ InitializeInputData() [1/2]

int oArterialInputCurve::InitializeInputData ( )

This function is used to initialize the input arterial curve samples from the file provided by the user.

Returns
0 if success, positive value otherwise.

Definition at line 76 of file code/src/dynamic/oArterialInputCurve.cc.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ InitializeInputData() [2/2]

int oArterialInputCurve::InitializeInputData ( )

◆ InterpolateAIC() [1/2]

int oArterialInputCurve::InterpolateAIC ( )

This function performs a linear interpolation within the provided AIC range for every discrete unit of millisecond up to the end of the last requested frame.

Returns
0 if success, positive value otherwise.

Definition at line 147 of file code/src/dynamic/oArterialInputCurve.cc.

Here is the caller graph for this function:

◆ InterpolateAIC() [2/2]

int oArterialInputCurve::InterpolateAIC ( )

◆ SetFrames() [1/2]

void oArterialInputCurve::SetFrames ( int  a_nbTimeFrames,
uint32_t *  a_frameTimeStartInMs,
uint32_t *  a_frameTimeStopInMs 
)

◆ SetFrames() [2/2]

void oArterialInputCurve::SetFrames ( int  a_nbTimeFrames,
uint32_t *  a_frameTimeStartInMs,
uint32_t *  a_frameTimeStopInMs 
)

Definition at line 69 of file code/src/dynamic/oArterialInputCurve.cc.

Here is the caller graph for this function:

◆ SetInputFilePath() [1/2]

void oArterialInputCurve::SetInputFilePath ( const string &  a_pathToAICfile)
inline

Definition at line 75 of file code/include/dynamic/oArterialInputCurve.hh.

Here is the caller graph for this function:

◆ SetInputFilePath() [2/2]

void oArterialInputCurve::SetInputFilePath ( const string &  a_pathToAICfile)
inline

Definition at line 75 of file include/dynamic/oArterialInputCurve.hh.

◆ SetVerbose() [1/2]

void oArterialInputCurve::SetVerbose ( int  a_verbose)
inline

Definition at line 81 of file include/dynamic/oArterialInputCurve.hh.

Here is the call graph for this function:

◆ SetVerbose() [2/2]

void oArterialInputCurve::SetVerbose ( int  a_verbose)
inline

Definition at line 81 of file code/include/dynamic/oArterialInputCurve.hh.

Here is the call graph for this function:
Here is the caller graph for this function:

Member Data Documentation

◆ m_nbinputDataPoints

int oArterialInputCurve::m_nbinputDataPoints
private

Number of Arterial Input Function Datapoints

Definition at line 108 of file code/include/dynamic/oArterialInputCurve.hh.

◆ m_nbTimeFrames

int oArterialInputCurve::m_nbTimeFrames
private

Number of frames

Definition at line 116 of file code/include/dynamic/oArterialInputCurve.hh.

◆ m_pathToAICfile

string oArterialInputCurve::m_pathToAICfile
private

The string containing the path to the input AIC file

Definition at line 106 of file code/include/dynamic/oArterialInputCurve.hh.

◆ m_verbose

int oArterialInputCurve::m_verbose
private

Verbose level

Definition at line 121 of file code/include/dynamic/oArterialInputCurve.hh.

◆ mp_AICDataPoints

HPFLTNB * oArterialInputCurve::mp_AICDataPoints
private

Pointer to array of Input Function Datapoints

Definition at line 109 of file code/include/dynamic/oArterialInputCurve.hh.

◆ mp_AICDataPointsTimes

uint32_t * oArterialInputCurve::mp_AICDataPointsTimes
private

Pointer to array of Input Function Time points

Definition at line 110 of file code/include/dynamic/oArterialInputCurve.hh.

◆ mp_AICIntrpY

HPFLTNB * oArterialInputCurve::mp_AICIntrpY
private

The interpolated points of Y axis (Bq/ml) of the Arterial Input Function Each index relates to the time in milliseconds

Definition at line 112 of file code/include/dynamic/oArterialInputCurve.hh.

◆ mp_AICIntrpY_downsampled

HPFLTNB * oArterialInputCurve::mp_AICIntrpY_downsampled
private

The interpolated points of Y axis (Bq/ml) f the Arterial Input Function Downsampled

Definition at line 114 of file code/include/dynamic/oArterialInputCurve.hh.

◆ mp_frameTimeStartInMs

uint32_t * oArterialInputCurve::mp_frameTimeStartInMs
private

Pointer to the array of frames Start Times

Definition at line 117 of file code/include/dynamic/oArterialInputCurve.hh.

◆ mp_frameTimeStopInMs

uint32_t * oArterialInputCurve::mp_frameTimeStopInMs
private

Pointer to the array of frames End Times

Definition at line 118 of file code/include/dynamic/oArterialInputCurve.hh.


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