Medical Imaging Interaction Toolkit  2026.06.00
Medical Imaging Interaction Toolkit
Public Types | Public Member Functions | Protected Member Functions | List of all members
mitk::CurveDescriptionParameterBase Class Referenceabstract

Abstract base class for functors that compute descriptive scalar values for a time-concentration curve. More...

#include <mitkCurveDescriptionParameterBase.h>

Inheritance diagram for mitk::CurveDescriptionParameterBase:
Inheritance graph
[legend]
Collaboration diagram for mitk::CurveDescriptionParameterBase:
Collaboration graph
[legend]

Public Types

typedef CurveDescriptionParameterBase Self
 
typedef itk::Object Superclass
 
typedef itk::SmartPointer< Self > Pointer
 
typedef itk::SmartPointer< const Self > ConstPointer
 
typedef itk::Array< double > CurveType
 Array type for curve values. More...
 
typedef itk::Array< double > CurveGridType
 Array type for the curve time grid. More...
 
typedef double CurveDescriptionParameterResultType
 Scalar result type for a single description parameter value. More...
 
typedef std::string CurveDescriptionParameterNameType
 String type for description parameter names. More...
 
typedef std::vector< CurveDescriptionParameterResultType > DescriptionParameterResultsType
 Vector of computed description parameter results. More...
 
typedef std::vector< CurveDescriptionParameterNameType > DescriptionParameterNamesType
 Vector of description parameter names. More...
 

Public Member Functions

virtual const char * GetClassName () const
 
DescriptionParameterResultsType GetCurveDescriptionParameter (const CurveType &curve, const CurveGridType &grid) const
 Computes and returns the description parameter values for the given curve. More...
 
virtual DescriptionParameterNamesType GetDescriptionParameterName () const =0
 Returns the names of all description parameters computed by this class. More...
 

Protected Member Functions

virtual DescriptionParameterResultsType ComputeCurveDescriptionParameter (const CurveType &curve, const CurveGridType &grid) const =0
 
 CurveDescriptionParameterBase ()
 
 ~CurveDescriptionParameterBase () override
 

Detailed Description

Abstract base class for functors that compute descriptive scalar values for a time-concentration curve.

Derived classes implement specific curve descriptors such as Area Under the Curve (AUC), Time to Peak, Maximum, Mean Residence Time, etc. Each descriptor can produce one or more named result values.

Note
Derived classes must be thread-safe because GetCurveDescriptionParameter() and GetDescriptionParameterName() may be called concurrently from multi-threaded generators (e.g. PixelBasedDescriptionParameterImageGenerator).
See also
AreaUnderTheCurveDescriptionParameter, AreaUnderFirstMomentDescriptionParameter, MaximumCurveDescriptionParameter, TimeToPeakCurveDescriptionParameter, MeanResidenceTimeDescriptionParameter, CurveParameterFunctor

Definition at line 41 of file mitkCurveDescriptionParameterBase.h.

Member Typedef Documentation

◆ ConstPointer

typedef itk::SmartPointer< const Self > mitk::CurveDescriptionParameterBase::ConstPointer

Definition at line 47 of file mitkCurveDescriptionParameterBase.h.

◆ CurveDescriptionParameterNameType

typedef std::string mitk::CurveDescriptionParameterBase::CurveDescriptionParameterNameType

String type for description parameter names.

Definition at line 59 of file mitkCurveDescriptionParameterBase.h.

◆ CurveDescriptionParameterResultType

typedef double mitk::CurveDescriptionParameterBase::CurveDescriptionParameterResultType

Scalar result type for a single description parameter value.

Definition at line 57 of file mitkCurveDescriptionParameterBase.h.

◆ CurveGridType

typedef itk::Array<double> mitk::CurveDescriptionParameterBase::CurveGridType

Array type for the curve time grid.

Definition at line 54 of file mitkCurveDescriptionParameterBase.h.

◆ CurveType

typedef itk::Array<double> mitk::CurveDescriptionParameterBase::CurveType

Array type for curve values.

Definition at line 52 of file mitkCurveDescriptionParameterBase.h.

◆ DescriptionParameterNamesType

typedef std::vector<CurveDescriptionParameterNameType> mitk::CurveDescriptionParameterBase::DescriptionParameterNamesType

Vector of description parameter names.

Definition at line 64 of file mitkCurveDescriptionParameterBase.h.

◆ DescriptionParameterResultsType

typedef std::vector<CurveDescriptionParameterResultType> mitk::CurveDescriptionParameterBase::DescriptionParameterResultsType

Vector of computed description parameter results.

Definition at line 62 of file mitkCurveDescriptionParameterBase.h.

◆ Pointer

typedef itk::SmartPointer< Self > mitk::CurveDescriptionParameterBase::Pointer

Definition at line 46 of file mitkCurveDescriptionParameterBase.h.

◆ Self

typedef CurveDescriptionParameterBase mitk::CurveDescriptionParameterBase::Self

Definition at line 44 of file mitkCurveDescriptionParameterBase.h.

◆ Superclass

typedef itk::Object mitk::CurveDescriptionParameterBase::Superclass

Definition at line 45 of file mitkCurveDescriptionParameterBase.h.

Constructor & Destructor Documentation

◆ CurveDescriptionParameterBase()

mitk::CurveDescriptionParameterBase::CurveDescriptionParameterBase ( )
protected

◆ ~CurveDescriptionParameterBase()

mitk::CurveDescriptionParameterBase::~CurveDescriptionParameterBase ( )
overrideprotected

Member Function Documentation

◆ ComputeCurveDescriptionParameter()

virtual DescriptionParameterResultsType mitk::CurveDescriptionParameterBase::ComputeCurveDescriptionParameter ( const CurveType &  curve,
const CurveGridType &  grid 
) const
protectedpure virtual

Slot to implement the computation of the descriptor values.

Implemented in mitk::TimeToPeakCurveDescriptionParameter, mitk::MeanResidenceTimeDescriptionParameter, mitk::MaximumCurveDescriptionParameter, mitk::AreaUnderTheCurveDescriptionParameter, and mitk::AreaUnderFirstMomentDescriptionParameter.

◆ GetClassName()

virtual const char* mitk::CurveDescriptionParameterBase::GetClassName ( ) const
virtual

◆ GetCurveDescriptionParameter()

DescriptionParameterResultsType mitk::CurveDescriptionParameterBase::GetCurveDescriptionParameter ( const CurveType &  curve,
const CurveGridType &  grid 
) const

Computes and returns the description parameter values for the given curve.

Parameters
[in]curveThe curve values (e.g. concentration over time).
[in]gridThe time grid corresponding to the curve values.
Precondition
curve and grid must have the same size.
Returns
Vector of computed description parameter values.

◆ GetDescriptionParameterName()

virtual DescriptionParameterNamesType mitk::CurveDescriptionParameterBase::GetDescriptionParameterName ( ) const
pure virtual

Returns the names of all description parameters computed by this class.

Postcondition
The order of names matches the order of results returned by GetCurveDescriptionParameter().
Returns
Vector of parameter name strings.

Implemented in mitk::TimeToPeakCurveDescriptionParameter, mitk::MeanResidenceTimeDescriptionParameter, mitk::MaximumCurveDescriptionParameter, mitk::AreaUnderTheCurveDescriptionParameter, and mitk::AreaUnderFirstMomentDescriptionParameter.

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