Medical Imaging Interaction Toolkit  2018.4.99-bd7b41ba
Medical Imaging Interaction Toolkit
mitk::CurveDescriptionParameterBase Class Referenceabstract

#include <mitkCurveDescriptionParameterBase.h>

Inheritance diagram for mitk::CurveDescriptionParameterBase:
Collaboration diagram for mitk::CurveDescriptionParameterBase:

Public Types

typedef CurveDescriptionParameterBase Self
 
typedef itk::Object Superclass
 
typedef itk::SmartPointer< SelfPointer
 
typedef itk::SmartPointer< const SelfConstPointer
 
typedef itk::Array< double > CurveType
 
typedef itk::Array< double > CurveGridType
 
typedef double CurveDescriptionParameterResultType
 
typedef std::string CurveDescriptionParameterNameType
 
typedef std::vector< CurveDescriptionParameterResultTypeDescriptionParameterResultsType
 
typedef std::vector< CurveDescriptionParameterNameTypeDescriptionParameterNamesType
 

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

◆ CurveDescriptionParameterNameType

◆ CurveDescriptionParameterResultType

◆ CurveGridType

Definition at line 43 of file mitkCurveDescriptionParameterBase.h.

◆ CurveType

Definition at line 40 of file mitkCurveDescriptionParameterBase.h.

◆ DescriptionParameterNamesType

◆ DescriptionParameterResultsType

◆ Pointer

◆ Self

◆ Superclass

Constructor & Destructor Documentation

◆ CurveDescriptionParameterBase()

mitk::CurveDescriptionParameterBase::CurveDescriptionParameterBase ( )
protected

Definition at line 19 of file mitkCurveDescriptionParameterBase.cpp.

◆ ~CurveDescriptionParameterBase()

mitk::CurveDescriptionParameterBase::~CurveDescriptionParameterBase ( )
overrideprotected

Definition at line 23 of file mitkCurveDescriptionParameterBase.cpp.

Member Function Documentation

◆ ComputeCurveDescriptionParameter()

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

◆ GetClassName()

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

◆ GetCurveDescriptionParameter()

mitk::CurveDescriptionParameterBase::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

Definition at line 27 of file mitkCurveDescriptionParameterBase.cpp.

References ComputeCurveDescriptionParameter().

Referenced by mitk::CurveParameterFunctor::Compute().

◆ 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 files: