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

#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
 
typedef itk::Array< double > CurveGridType
 
typedef double CurveDescriptionParameterResultType
 
typedef std::string CurveDescriptionParameterNameType
 
typedef std::vector< CurveDescriptionParameterResultType > DescriptionParameterResultsType
 
typedef std::vector< CurveDescriptionParameterNameType > DescriptionParameterNamesType
 

Public Member Functions

virtual const char * GetClassName () const
 
DescriptionParameterResultsType GetCurveDescriptionParameter (const CurveType &curve, const CurveGridType &grid) const
 
virtual DescriptionParameterNamesType GetDescriptionParameterName () const =0
 

Protected Member Functions

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

Detailed Description

Base class for functor that compute descriptive values for a curve (e.g. like Area under the Curve, Time to peek, maximum,...)

Remarks
The derived classes must be implemented thread safe because GetCurveDescriptionParameter() and GetDescriptionParameterName() of one instance may be called in multi-threaded context (e.g. DescriptionParameterImageGeneratorBase and derived classes).

Definition at line 32 of file mitkCurveDescriptionParameterBase.h.

Member Typedef Documentation

◆ ConstPointer

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

Definition at line 38 of file mitkCurveDescriptionParameterBase.h.

◆ CurveDescriptionParameterNameType

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

Definition at line 46 of file mitkCurveDescriptionParameterBase.h.

◆ CurveDescriptionParameterResultType

typedef double mitk::CurveDescriptionParameterBase::CurveDescriptionParameterResultType

Definition at line 45 of file mitkCurveDescriptionParameterBase.h.

◆ CurveGridType

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

Definition at line 43 of file mitkCurveDescriptionParameterBase.h.

◆ CurveType

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

Definition at line 40 of file mitkCurveDescriptionParameterBase.h.

◆ DescriptionParameterNamesType

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

Definition at line 49 of file mitkCurveDescriptionParameterBase.h.

◆ DescriptionParameterResultsType

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

Definition at line 48 of file mitkCurveDescriptionParameterBase.h.

◆ Pointer

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

Definition at line 37 of file mitkCurveDescriptionParameterBase.h.

◆ Self

typedef CurveDescriptionParameterBase mitk::CurveDescriptionParameterBase::Self

Definition at line 35 of file mitkCurveDescriptionParameterBase.h.

◆ Superclass

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

Definition at line 36 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::MeanResidenceTimeDescriptionParameter, mitk::TimeToPeakCurveDescriptionParameter, mitk::AreaUnderFirstMomentDescriptionParameter, mitk::AreaUnderTheCurveDescriptionParameter, and mitk::MaximumCurveDescriptionParameter.

◆ GetClassName()

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

◆ GetCurveDescriptionParameter()

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

Returns the concrete description values for a curve.

Precondition
Curve value vector and curve grid must have the same size

◆ GetDescriptionParameterName()

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

Return the names of all descrition values that will be computed by the class.

Postcondition
The order of names equales the order of the results of GetCurveDescriptionParameter().

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

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