NavigationDataEvaluationFilter calculates statistical data (mean value, mean error, etc.) on the input navigation data. Input navigation data are set 1:1 on output navigation data. More...

#include <mitkNavigationDataEvaluationFilter.h>

Inheritance diagram for mitk::NavigationDataEvaluationFilter:

Public Member Functions
	mitkClassMacro (NavigationDataEvaluationFilter, NavigationDataToNavigationDataFilter)

	itkFactorylessNewMacro (Self)

	itkCloneMacro (Self)

void	ResetStatistic ()
	Resets all statistics and starts again.

int	GetNumberOfAnalysedNavigationData (int input)

int	GetNumberOfInvalidSamples (int input)

double	GetPercentageOfInvalidSamples (int input)

mitk::Point3D	GetPositionMean (int input)

mitk::Vector3D	GetPositionStandardDeviation (int input)

mitk::Vector3D	GetPositionSampleStandardDeviation (int input)

mitk::Quaternion	GetQuaternionMean (int input)

mitk::Quaternion	GetQuaternionStandardDeviation (int input)

mitk::Vector3D	GetEulerAnglesMean (int input)

double	GetEulerAnglesRMS (int input)

double	GetEulerAnglesRMSDegree (int input)

double	GetPositionErrorMean (int input)

double	GetPositionErrorStandardDeviation (int input)

double	GetPositionErrorSampleStandardDeviation (int input)

double	GetPositionErrorRMS (int input)

double	GetPositionErrorMedian (int input)

double	GetPositionErrorMax (int input)

double	GetPositionErrorMin (int input)

mitk::Point3D	GetLoggedPosition (unsigned int i, int input)

mitk::Quaternion	GetLoggedOrientation (unsigned int i, int input)

Public Member Functions inherited from mitk::NavigationDataToNavigationDataFilter
	mitkClassMacro (NavigationDataToNavigationDataFilter, NavigationDataSource)

virtual void	SetInput (const NavigationData *nd)
	Set the input of this filter.

virtual void	SetInput (unsigned int idx, const NavigationData *nd)
	Set input with id idx of this filter.

const NavigationData *	GetInput (void) const
	Get the input of this filter.

const NavigationData *	GetInput (unsigned int idx) const
	Get the input with id idx of this filter.

const NavigationData *	GetInput (std::string navDataName) const
	Get the input with name navDataName of this filter.

DataObjectPointerArraySizeType	GetInputIndex (std::string navDataName)
	return the index of the input with name navDataName, throw std::invalid_argument exception if that name was not found

virtual void	ConnectTo (mitk::NavigationDataSource *UpstreamFilter)
	Connects the input of this filter to the outputs of the given NavigationDataSource.

Public Member Functions inherited from mitk::NavigationDataSource
	mitkClassMacroItkParent (NavigationDataSource, itk::ProcessObject)

	itkGetMacro (Name, std::string)

	itkSetMacro (Name, std::string)
	Sets the human readable name of this source. There is also a default name, but you can use this method if you need to define it on your own.

NavigationData *	GetOutput (void)
	return the output (output with id 0) of the filter

NavigationData *	GetOutput (DataObjectPointerArraySizeType idx)
	return the output with id idx of the filter

NavigationData *	GetOutput (const std::string &navDataName)
	return the output with name navDataName of the filter

NavigationTool::Pointer	GetToolMetaData (DataObjectPointerArraySizeType idx)

NavigationTool::Pointer	GetToolMetaData (const std::string &navDataName)

	itkGetMacro (ToolMetaDataCollection, mitk::NavigationToolStorage::Pointer)

	itkSetMacro (ToolMetaDataCollection, mitk::NavigationToolStorage::Pointer)

DataObjectPointerArraySizeType	GetOutputIndex (std::string navDataName)
	return the index of the output with name navDataName, -1 if no output with that name was found

virtual void	RegisterAsMicroservice ()
	Registers this object as a Microservice, making it available to every module and/or plugin. To unregister, call UnregisterMicroservice().

virtual void	UnRegisterMicroservice ()
	Registers this object as a Microservice, making it available to every module and/or plugin.

std::string	GetMicroserviceID ()
	Returns the id that this device is registered with. The id will only be valid, if the NavigationDataSource has been registered using RegisterAsMicroservice().

virtual void	GraftNthOutput (unsigned int idx, itk::DataObject *graft)
	Graft the specified DataObject onto this ProcessObject's output.

virtual void	GraftOutput (itk::DataObject *graft)
	Graft the specified DataObject onto this ProcessObject's output.

itk::DataObject::Pointer	MakeOutput (DataObjectPointerArraySizeType idx) override

itk::DataObject::Pointer	MakeOutput (const DataObjectIdentifierType &name) override

virtual void	SetParameters (const mitk::PropertyList *)
	Set all filter parameters as the PropertyList p.

virtual mitk::PropertyList::ConstPointer	GetParameters () const
	Get all filter parameters as a PropertyList.

virtual void	Freeze ()

virtual void	UnFreeze ()

	itkGetMacro (IsFrozen, bool)

Protected Member Functions
	NavigationDataEvaluationFilter ()

	~NavigationDataEvaluationFilter () override

void	GenerateData () override
	filter execute method

void	CreateMembersForAllInputs ()
	Creates the member variables which store all the statistical data for every input.

mitk::Quaternion	GetMean (std::vector< mitk::Quaternion > list)

mitk::PointSet::Pointer	VectorToPointSet (std::vector< mitk::Point3D > pSet)

mitk::PointSet::Pointer	VectorToPointSet (std::vector< mitk::Vector3D > pSet)

std::vector< mitk::Vector3D >	QuaternionsToEulerAngles (std::vector< mitk::Quaternion > quaterions)
	Converts a list of quaterions to a list of euler angles (theta_x, theta_y, theta_z)

std::vector< mitk::Vector3D >	QuaternionsToEulerAnglesGrad (std::vector< mitk::Quaternion > quaterions)

Protected Member Functions inherited from mitk::NavigationDataToNavigationDataFilter
	NavigationDataToNavigationDataFilter ()

	~NavigationDataToNavigationDataFilter () override

void	CreateOutputsForAllInputs ()
	Create an output for each input.

Protected Member Functions inherited from mitk::NavigationDataSource
	NavigationDataSource ()

	~NavigationDataSource () override

Protected Attributes
std::map< std::size_t, std::vector< mitk::Point3D > >	m_LoggedPositions

std::map< std::size_t, std::vector< mitk::Quaternion > >	m_LoggedQuaternions

std::map< std::size_t, int >	m_InvalidSamples

Protected Attributes inherited from mitk::NavigationDataSource
std::string	m_Name

bool	m_IsFrozen

NavigationToolStorage::Pointer	m_ToolMetaDataCollection

Additional Inherited Members
Static Public Attributes inherited from mitk::NavigationDataSource
static const std::string	US_INTERFACE_NAME = "org.mitk.services.NavigationDataSource"
	These Constants are used in conjunction with Microservices.

static const std::string	US_PROPKEY_DEVICENAME = US_INTERFACE_NAME + ".devicename"

static const std::string	US_PROPKEY_ID = US_INTERFACE_NAME + ".id"

static const std::string	US_PROPKEY_ISACTIVE = US_INTERFACE_NAME + ".isActive"

Detailed Description

NavigationDataEvaluationFilter calculates statistical data (mean value, mean error, etc.) on the input navigation data. Input navigation data are set 1:1 on output navigation data.

Documentation

Definition at line 31 of file mitkNavigationDataEvaluationFilter.h.

Constructor & Destructor Documentation

◆ NavigationDataEvaluationFilter()

mitk::NavigationDataEvaluationFilter::NavigationDataEvaluationFilter ( )

protected

Definition at line 16 of file mitkNavigationDataEvaluationFilter.cpp.

◆ ~NavigationDataEvaluationFilter()

mitk::NavigationDataEvaluationFilter::~NavigationDataEvaluationFilter ( )

overrideprotected

Definition at line 21 of file mitkNavigationDataEvaluationFilter.cpp.

Member Function Documentation

◆ CreateMembersForAllInputs()

void mitk::NavigationDataEvaluationFilter::CreateMembersForAllInputs ( )

protected

Creates the member variables which store all the statistical data for every input.

Definition at line 53 of file mitkNavigationDataEvaluationFilter.cpp.

◆ GenerateData()

void mitk::NavigationDataEvaluationFilter::GenerateData ( )

overrideprotected

filter execute method

Documentation

transforms navigation data

Definition at line 25 of file mitkNavigationDataEvaluationFilter.cpp.

◆ GetEulerAnglesMean()

mitk::Vector3D mitk::NavigationDataEvaluationFilter::GetEulerAnglesMean ( int input )

Returns: Returns the mean euler angles (theta_x, theta_y, theta_z) of the specified input since the start of the statistic (last call of ResetStatistic())

Definition at line 129 of file mitkNavigationDataEvaluationFilter.cpp.

◆ GetEulerAnglesRMS()

double mitk::NavigationDataEvaluationFilter::GetEulerAnglesRMS ( int input )

Returns: Returns the RMS of the error of the euler angles (theta_x, theta_y, theta_z) in radians of the specified input since the start of the statistic (last call of ResetStatistic())

Definition at line 139 of file mitkNavigationDataEvaluationFilter.cpp.

◆ GetEulerAnglesRMSDegree()

double mitk::NavigationDataEvaluationFilter::GetEulerAnglesRMSDegree ( int input )

Returns: Returns the RMS of the error of the euler angles (theta_x, theta_y, theta_z) in degree of the specified input since the start of the statistic (last call of ResetStatistic())

Definition at line 145 of file mitkNavigationDataEvaluationFilter.cpp.

◆ GetLoggedOrientation()

mitk::Quaternion mitk::NavigationDataEvaluationFilter::GetLoggedOrientation	(	unsigned int	i,
		int	input )

Returns: Returns a logged orientation on position i of the specified input. If there is no orientation on position i the method returns [0,0,0,0]

Definition at line 288 of file mitkNavigationDataEvaluationFilter.cpp.

◆ GetLoggedPosition()

mitk::Point3D mitk::NavigationDataEvaluationFilter::GetLoggedPosition	(	unsigned int	i,
		int	input )

Returns: Returns a logged point on position i of the specified input. If there is no point on position i the method returns [0,0,0]

Definition at line 280 of file mitkNavigationDataEvaluationFilter.cpp.

◆ GetMean()

mitk::Quaternion mitk::NavigationDataEvaluationFilter::GetMean ( std::vector< mitk::Quaternion > list )

protected

Definition at line 203 of file mitkNavigationDataEvaluationFilter.cpp.

◆ GetNumberOfAnalysedNavigationData()

int mitk::NavigationDataEvaluationFilter::GetNumberOfAnalysedNavigationData ( int input )

Returns: Returns the number of analysed navigation datas for the specified input (without invalid samples).

Definition at line 79 of file mitkNavigationDataEvaluationFilter.cpp.

◆ GetNumberOfInvalidSamples()

int mitk::NavigationDataEvaluationFilter::GetNumberOfInvalidSamples ( int input )

Returns: Returns the number of invalid samples for the specified input. Invalid samples are ignored for the statistical calculation.

Definition at line 193 of file mitkNavigationDataEvaluationFilter.cpp.

◆ GetPercentageOfInvalidSamples()

double mitk::NavigationDataEvaluationFilter::GetPercentageOfInvalidSamples ( int input )

Returns: Returns the percentage of invalid samples in relation to all samples for the specified input.

Definition at line 198 of file mitkNavigationDataEvaluationFilter.cpp.

◆ GetPositionErrorMax()

double mitk::NavigationDataEvaluationFilter::GetPositionErrorMax ( int input )

Returns: Returns the maximum of the errors of all positions to the specified input.

Definition at line 181 of file mitkNavigationDataEvaluationFilter.cpp.

◆ GetPositionErrorMean()

double mitk::NavigationDataEvaluationFilter::GetPositionErrorMean ( int input )

Returns: Returns the mean distance to the mean postion (=mean error) to the specified input.

Definition at line 151 of file mitkNavigationDataEvaluationFilter.cpp.

◆ GetPositionErrorMedian()

double mitk::NavigationDataEvaluationFilter::GetPositionErrorMedian ( int input )

Returns: Returns the median of the errors of all positions to the specified input.

Definition at line 175 of file mitkNavigationDataEvaluationFilter.cpp.

◆ GetPositionErrorMin()

double mitk::NavigationDataEvaluationFilter::GetPositionErrorMin ( int input )

Returns: Returns the minimum of the errors of all positions to the specified input.

Definition at line 187 of file mitkNavigationDataEvaluationFilter.cpp.

◆ GetPositionErrorRMS()

double mitk::NavigationDataEvaluationFilter::GetPositionErrorRMS ( int input )

Returns: Returns the RMS of the errors of all positions to the specified input.

Definition at line 169 of file mitkNavigationDataEvaluationFilter.cpp.

◆ GetPositionErrorSampleStandardDeviation()

double mitk::NavigationDataEvaluationFilter::GetPositionErrorSampleStandardDeviation ( int input )

Returns: Returns the sample standard derivation of the errors of all positions to the specified input.

Definition at line 163 of file mitkNavigationDataEvaluationFilter.cpp.

◆ GetPositionErrorStandardDeviation()

double mitk::NavigationDataEvaluationFilter::GetPositionErrorStandardDeviation ( int input )

Returns: Returns the standard derivation of the errors of all positions to the specified input.

Definition at line 157 of file mitkNavigationDataEvaluationFilter.cpp.

◆ GetPositionMean()

mitk::Point3D mitk::NavigationDataEvaluationFilter::GetPositionMean ( int input )

Returns: Returns the mean position of the specified input since the start of the statistic (last call of ResetStatistic())

Definition at line 84 of file mitkNavigationDataEvaluationFilter.cpp.

◆ GetPositionSampleStandardDeviation()

mitk::Vector3D mitk::NavigationDataEvaluationFilter::GetPositionSampleStandardDeviation ( int input )

Returns: Returns the sample standard derivation of each component (x, y and z) of the specified input since the start of the statistic (last call of ResetStatistic())

Definition at line 96 of file mitkNavigationDataEvaluationFilter.cpp.

◆ GetPositionStandardDeviation()

mitk::Vector3D mitk::NavigationDataEvaluationFilter::GetPositionStandardDeviation ( int input )

Returns: Returns the standard derivation of each component (x, y and z) of the specified input since the start of the statistic (last call of ResetStatistic())

Definition at line 90 of file mitkNavigationDataEvaluationFilter.cpp.

◆ GetQuaternionMean()

mitk::Quaternion mitk::NavigationDataEvaluationFilter::GetQuaternionMean ( int input )

Returns: Returns the mean quaternion of the specified input since the start of the statistic (last call of ResetStatistic())

Definition at line 102 of file mitkNavigationDataEvaluationFilter.cpp.

◆ GetQuaternionStandardDeviation()

mitk::Quaternion mitk::NavigationDataEvaluationFilter::GetQuaternionStandardDeviation ( int input )

Returns: Returns the standard derivation of each component of the specified input since the start of the statistic (last call of ResetStatistic())

Definition at line 107 of file mitkNavigationDataEvaluationFilter.cpp.

◆ itkCloneMacro()

mitk::NavigationDataEvaluationFilter::itkCloneMacro ( Self )

◆ itkFactorylessNewMacro()

mitk::NavigationDataEvaluationFilter::itkFactorylessNewMacro ( Self )

◆ mitkClassMacro()

mitk::NavigationDataEvaluationFilter::mitkClassMacro	(	NavigationDataEvaluationFilter	,
		NavigationDataToNavigationDataFilter	)

◆ QuaternionsToEulerAngles()

std::vector< mitk::Vector3D > mitk::NavigationDataEvaluationFilter::QuaternionsToEulerAngles ( std::vector< mitk::Quaternion > quaterions )

protected

Converts a list of quaterions to a list of euler angles (theta_x, theta_y, theta_z)

Definition at line 249 of file mitkNavigationDataEvaluationFilter.cpp.

◆ QuaternionsToEulerAnglesGrad()

std::vector< mitk::Vector3D > mitk::NavigationDataEvaluationFilter::QuaternionsToEulerAnglesGrad ( std::vector< mitk::Quaternion > quaterions )

protected

Definition at line 265 of file mitkNavigationDataEvaluationFilter.cpp.

◆ ResetStatistic()

void mitk::NavigationDataEvaluationFilter::ResetStatistic ( )

Resets all statistics and starts again.

Definition at line 72 of file mitkNavigationDataEvaluationFilter.cpp.

◆ VectorToPointSet() [1/2]

mitk::PointSet::Pointer mitk::NavigationDataEvaluationFilter::VectorToPointSet ( std::vector< mitk::Point3D > pSet )

protected

Definition at line 228 of file mitkNavigationDataEvaluationFilter.cpp.

◆ VectorToPointSet() [2/2]

mitk::PointSet::Pointer mitk::NavigationDataEvaluationFilter::VectorToPointSet ( std::vector< mitk::Vector3D > pSet )

protected

Definition at line 235 of file mitkNavigationDataEvaluationFilter.cpp.

Member Data Documentation

◆ m_InvalidSamples

std::map<std::size_t,int> mitk::NavigationDataEvaluationFilter::m_InvalidSamples

protected

Definition at line 106 of file mitkNavigationDataEvaluationFilter.h.

◆ m_LoggedPositions

std::map<std::size_t,std::vector<mitk::Point3D> > mitk::NavigationDataEvaluationFilter::m_LoggedPositions

protected

Definition at line 104 of file mitkNavigationDataEvaluationFilter.h.

◆ m_LoggedQuaternions

std::map<std::size_t,std::vector<mitk::Quaternion> > mitk::NavigationDataEvaluationFilter::m_LoggedQuaternions

protected

Definition at line 105 of file mitkNavigationDataEvaluationFilter.h.

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

Modules/IGT/Algorithms/mitkNavigationDataEvaluationFilter.h
Modules/IGT/Algorithms/mitkNavigationDataEvaluationFilter.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ NavigationDataEvaluationFilter()

◆ ~NavigationDataEvaluationFilter()

Member Function Documentation

◆ CreateMembersForAllInputs()

◆ GenerateData()

◆ GetEulerAnglesMean()

◆ GetEulerAnglesRMS()

◆ GetEulerAnglesRMSDegree()

◆ GetLoggedOrientation()

◆ GetLoggedPosition()

◆ GetMean()

◆ GetNumberOfAnalysedNavigationData()

◆ GetNumberOfInvalidSamples()

◆ GetPercentageOfInvalidSamples()

◆ GetPositionErrorMax()

◆ GetPositionErrorMean()

◆ GetPositionErrorMedian()

◆ GetPositionErrorMin()

◆ GetPositionErrorRMS()

◆ GetPositionErrorSampleStandardDeviation()

◆ GetPositionErrorStandardDeviation()

◆ GetPositionMean()

◆ GetPositionSampleStandardDeviation()

◆ GetPositionStandardDeviation()

◆ GetQuaternionMean()

◆ GetQuaternionStandardDeviation()

◆ itkCloneMacro()

◆ itkFactorylessNewMacro()

◆ mitkClassMacro()

◆ QuaternionsToEulerAngles()

◆ QuaternionsToEulerAnglesGrad()

◆ ResetStatistic()

◆ VectorToPointSet() [1/2]

◆ VectorToPointSet() [2/2]

Member Data Documentation

◆ m_InvalidSamples

◆ m_LoggedPositions

◆ m_LoggedQuaternions