STIR 6.5.0
stir::PlasmaSample Class Reference

#include "stir/modelling/PlasmaSample.h"

Public Member Functions

 PlasmaSample ()
 default constructor
 PlasmaSample (const double sample_time, const float plasma_sample_counts, const float blood_sample_counts)
 constructor, time in s
 ~PlasmaSample ()
 default destructor
Functions to get parameters
double get_time_in_s () const
 get the time of the sample
float get_blood_counts_in_kBq () const
 get the blood counts of the sample
float get_plasma_counts_in_kBq () const
 get the plasma counts of the sample

Functions to set parameters

void set_time_in_s (const double time)
 set the time of the sample
void set_blood_counts_in_kBq (const float blood_counts)
 set the blood counts of the sample
void set_plasma_counts_in_kBq (const float plasma_counts)
 set the plasma counts of the sample

Detailed Description

A class for storing radiotracer concentration in a blood sample. Concentrations in plasma and the (overall) blood-concentration are stored.

Todo
This currently assumes sampling, while in practice we often have data accumulated over time, but this can currently not be encoded.

Constructor & Destructor Documentation

◆ PlasmaSample() [1/2]

stir::PlasmaSample::PlasmaSample ( )
inline

default constructor

References PlasmaSample().

Referenced by PlasmaSample(), and PlasmaSample().

◆ PlasmaSample() [2/2]

stir::PlasmaSample::PlasmaSample ( const double sample_time,
const float plasma_sample_counts,
const float blood_sample_counts )
inline

constructor, time in s

A constructor : constructs a PlasmaSample object

Parameters
sample_timeis the time in seconds relativily to the start of the scan.
plasma_sample_countsis the activity of plasma at the sample_time (assumed to be in kBq/ml)
blood_sample_countsis the activity of blood at the sample_time (assumed to be in kBq/ml)

References PlasmaSample(), set_blood_counts_in_kBq(), set_plasma_counts_in_kBq(), and set_time_in_s().

◆ ~PlasmaSample()

stir::PlasmaSample::~PlasmaSample ( )
inline

default destructor

References ~PlasmaSample().

Referenced by ~PlasmaSample().

Member Function Documentation

◆ get_time_in_s()

double stir::PlasmaSample::get_time_in_s ( ) const
inline

get the time of the sample

References get_time_in_s().

Referenced by get_time_in_s().

◆ get_blood_counts_in_kBq()

float stir::PlasmaSample::get_blood_counts_in_kBq ( ) const
inline

get the blood counts of the sample

References get_blood_counts_in_kBq().

Referenced by get_blood_counts_in_kBq().

◆ get_plasma_counts_in_kBq()

float stir::PlasmaSample::get_plasma_counts_in_kBq ( ) const
inline

get the plasma counts of the sample

References get_plasma_counts_in_kBq().

Referenced by get_plasma_counts_in_kBq().

◆ set_time_in_s()

void stir::PlasmaSample::set_time_in_s ( const double time)
inline

set the time of the sample

References set_time_in_s().

Referenced by PlasmaSample(), and set_time_in_s().

◆ set_blood_counts_in_kBq()

void stir::PlasmaSample::set_blood_counts_in_kBq ( const float blood_counts)
inline

set the blood counts of the sample

References set_blood_counts_in_kBq().

Referenced by PlasmaSample(), and set_blood_counts_in_kBq().

◆ set_plasma_counts_in_kBq()

void stir::PlasmaSample::set_plasma_counts_in_kBq ( const float plasma_counts)
inline

set the plasma counts of the sample

get the plasma counts of the sample

References set_plasma_counts_in_kBq().

Referenced by PlasmaSample(), and set_plasma_counts_in_kBq().


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