mitk::CurveParameterFunctor Class Reference

Functor that aggregates multiple CurveDescriptionParameterBase instances and computes all registered descriptors. More...

#include <mitkCurveParameterFunctor.h>

Inheritance diagram for mitk::CurveParameterFunctor:

Collaboration diagram for mitk::CurveParameterFunctor:

Public Types
typedef CurveParameterFunctor	Self
typedef itk::Object	Superclass
typedef itk::SmartPointer< Self >	Pointer
typedef itk::SmartPointer< const Self >	ConstPointer
typedef CurveDescriptionParameterBase::CurveDescriptionParameterNameType	ParameterNameType
typedef CurveDescriptionParameterBase::DescriptionParameterNamesType	ParameterNamesType
using	GridArrayType = SimpleFunctorBase::GridArrayType
Public Types inherited from mitk::SimpleFunctorBase
typedef SimpleFunctorBase	Self
typedef itk::Object	Superclass
typedef itk::SmartPointer< Self >	Pointer
typedef itk::SmartPointer< const Self >	ConstPointer
typedef ScalarType	InputImagePixelType
typedef std::vector< InputImagePixelType >	InputPixelVectorType
typedef std::vector< InputImagePixelType >	OutputPixelVectorType
typedef itk::Array< double >	GridArrayType

Public Member Functions
virtual const char *	GetClassName () const
SimpleFunctorBase::OutputPixelVectorType	Compute (const InputPixelVectorType &value) const override
	Computes all registered description parameters for the given input curve values. More...
unsigned int	GetNumberOfOutputs () const override
	Returns the total number of output values across all registered descriptors. More...
GridArrayType	GetGrid () const override
	Returns the currently set time grid. More...
virtual void	SetGrid (GridArrayType _arg)
	Sets the time grid for curve descriptor computation. More...
ParameterNamesType	GetDescriptionParameterNames () const
	Returns the names of all registered description parameters. More...
void	ResetDescriptionParameters ()
	Removes all registered description parameter functions. More...
void	RegisterDescriptionParameter (const ParameterNameType &parameterName, CurveDescriptionParameterBase *parameterFunction)
	Registers a new description parameter function under the given name. More...
const CurveDescriptionParameterBase *	GetDescriptionParameterFunction (const ParameterNameType &parameterName) const
	Returns the descriptor function registered under the given name. More...

Static Public Member Functions
static Pointer	New ()

Protected Member Functions
	CurveParameterFunctor ()
	~CurveParameterFunctor () override
Protected Member Functions inherited from mitk::SimpleFunctorBase
	SimpleFunctorBase ()
	~SimpleFunctorBase () override

Detailed Description

Functor that aggregates multiple CurveDescriptionParameterBase instances and computes all registered descriptors.

This functor can be used with itkMultiOutputNaryImageFilter for pixel-wise curve descriptor computation. Register any number of CurveDescriptionParameterBase instances; the functor will compute all their values for each input curve.

Warning

The functor's Compute method and registered descriptor instances must be thread-safe.

See also

CurveDescriptionParameterBase, PixelBasedDescriptionParameterImageGenerator, SimpleFunctorBase

Definition at line 33 of file mitkCurveParameterFunctor.h.

Member Typedef Documentation

ConstPointer

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

Definition at line 39 of file mitkCurveParameterFunctor.h.

GridArrayType

using mitk::CurveParameterFunctor::GridArrayType = SimpleFunctorBase::GridArrayType

Definition at line 46 of file mitkCurveParameterFunctor.h.

ParameterNamesType

typedef CurveDescriptionParameterBase::DescriptionParameterNamesType mitk::CurveParameterFunctor::ParameterNamesType

Definition at line 45 of file mitkCurveParameterFunctor.h.

ParameterNameType

typedef CurveDescriptionParameterBase::CurveDescriptionParameterNameType mitk::CurveParameterFunctor::ParameterNameType

Definition at line 44 of file mitkCurveParameterFunctor.h.

Pointer

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

Definition at line 38 of file mitkCurveParameterFunctor.h.

Self

typedef CurveParameterFunctor mitk::CurveParameterFunctor::Self

Definition at line 36 of file mitkCurveParameterFunctor.h.

Superclass

typedef itk::Object mitk::CurveParameterFunctor::Superclass

Definition at line 37 of file mitkCurveParameterFunctor.h.

Constructor & Destructor Documentation

CurveParameterFunctor()

mitk::CurveParameterFunctor::CurveParameterFunctor ( )

protected

~CurveParameterFunctor()

mitk::CurveParameterFunctor::~CurveParameterFunctor ( )

overrideprotected

Member Function Documentation

Compute()

SimpleFunctorBase::OutputPixelVectorType mitk::CurveParameterFunctor::Compute ( const InputPixelVectorType &  value ) const

overridevirtual

Computes all registered description parameters for the given input curve values.

Parameters

[in]

value

The input pixel vector representing the curve values over time.

Returns

Vector of all computed descriptor values from all registered parameters.

Exceptions

itk::ExceptionObject

if no grid or no descriptors are set.

Implements mitk::SimpleFunctorBase.

GetClassName()

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

virtual

Reimplemented from mitk::SimpleFunctorBase.

GetDescriptionParameterFunction()

const CurveDescriptionParameterBase* mitk::CurveParameterFunctor::GetDescriptionParameterFunction

(

const ParameterNameType &

parameterName

)

const

Returns the descriptor function registered under the given name.

Parameters

[in]

parameterName

The name to look up.

Returns

Pointer to the descriptor function, or nullptr if not found.

Warning

Not thread-safe. Do not call while Compute is running.

GetDescriptionParameterNames()

ParameterNamesType mitk::CurveParameterFunctor::GetDescriptionParameterNames

(

)

const

Returns the names of all registered description parameters.

If a descriptor produces multiple values, its name is prefixed to each sub-parameter name.

Returns

Vector of all parameter names.

GetGrid()

GridArrayType mitk::CurveParameterFunctor::GetGrid ( ) const

overridevirtual

Returns the currently set time grid.

Returns

The time grid array.

Implements mitk::SimpleFunctorBase.

GetNumberOfOutputs()

unsigned int mitk::CurveParameterFunctor::GetNumberOfOutputs ( ) const

overridevirtual

Returns the total number of output values across all registered descriptors.

Returns

The number of output values.

Implements mitk::SimpleFunctorBase.

New()

static Pointer mitk::CurveParameterFunctor::New ( )

static

RegisterDescriptionParameter()

void mitk::CurveParameterFunctor::RegisterDescriptionParameter	(	const ParameterNameType &	parameterName,
		CurveDescriptionParameterBase *	parameterFunction
	)

Registers a new description parameter function under the given name.

Parameters

[in]	parameterName	The name to register the parameter under.
[in]	parameterFunction	Pointer to the descriptor function to register.

Warning

Not thread-safe. Do not call while Compute is running.

ResetDescriptionParameters()

void mitk::CurveParameterFunctor::ResetDescriptionParameters

(

)

Removes all registered description parameter functions.

Warning

Not thread-safe. Do not call while Compute is running.

SetGrid()

virtual void mitk::CurveParameterFunctor::SetGrid ( GridArrayType  _arg )

virtual

Sets the time grid for curve descriptor computation.

Parameters

[in]

_arg

The time grid array (in seconds).

---

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

• mitkCurveParameterFunctor.h