Medical Imaging Interaction Toolkit  2016.11.0
Medical Imaging Interaction Toolkit
mitk::NavigationDataEvaluationFilter Class Reference

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:
Collaboration diagram for mitk::NavigationDataEvaluationFilter:

Public Member Functions

 mitkClassMacro (NavigationDataEvaluationFilter, NavigationDataToNavigationDataFilter)
 
Pointer Clone () const
 
void ResetStatistic ()
 Resets all statistics and starts again. More...
 
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. More...
 
virtual void SetInput (unsigned int idx, const NavigationData *nd)
 Set input with id idx of this filter. More...
 
const NavigationDataGetInput (void) const
 Get the input of this filter. More...
 
const NavigationDataGetInput (unsigned int idx) const
 Get the input with id idx of this filter. More...
 
const NavigationDataGetInput (std::string navDataName) const
 Get the input with name navDataName of this filter. More...
 
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 More...
 
virtual void ConnectTo (mitk::NavigationDataSource *UpstreamFilter)
 Connects the input of this filter to the outputs of the given NavigationDataSource. More...
 
- Public Member Functions inherited from mitk::NavigationDataSource
 mitkClassMacroItkParent (NavigationDataSource, itk::ProcessObject)
 
virtual std::string GetName ()
 
virtual void SetName (std::string _arg)
 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. More...
 
NavigationDataGetOutput (void)
 return the output (output with id 0) of the filter More...
 
NavigationDataGetOutput (DataObjectPointerArraySizeType idx)
 return the output with id idx of the filter More...
 
NavigationDataGetOutput (const std::string &navDataName)
 return the output with name navDataName of the filter More...
 
DataObjectPointerArraySizeType GetOutputIndex (std::string navDataName)
 return the index of the output with name navDataName, -1 if no output with that name was found More...
 
virtual void RegisterAsMicroservice ()
 Registers this object as a Microservice, making it available to every module and/or plugin. To unregister, call UnregisterMicroservice(). More...
 
virtual void UnRegisterMicroservice ()
 Registers this object as a Microservice, making it available to every module and/or plugin. More...
 
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(). More...
 
virtual void GraftNthOutput (unsigned int idx, itk::DataObject *graft)
 Graft the specified DataObject onto this ProcessObject's output. More...
 
virtual void GraftOutput (itk::DataObject *graft)
 Graft the specified DataObject onto this ProcessObject's output. More...
 
virtual itk::DataObject::Pointer MakeOutput (DataObjectPointerArraySizeType idx) override
 
virtual itk::DataObject::Pointer MakeOutput (const DataObjectIdentifierType &name) override
 
virtual void SetParameters (const mitk::PropertyList *)
 Set all filter parameters as the PropertyList p. More...
 
virtual mitk::PropertyList::ConstPointer GetParameters () const
 Get all filter parameters as a PropertyList. More...
 
virtual void Freeze ()
 
virtual void UnFreeze ()
 
virtual bool GetIsFrozen ()
 

Static Public Member Functions

static Pointer New ()
 

Protected Member Functions

 NavigationDataEvaluationFilter ()
 
virtual ~NavigationDataEvaluationFilter ()
 
virtual void GenerateData () override
 filter execute method More...
 
void CreateMembersForAllInputs ()
 Creates the member variables which store all the statistical data for every input. More...
 
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::Vector3DQuaternionsToEulerAngles (std::vector< mitk::Quaternion > quaterions)
 Converts a list of quaterions to a list of euler angles (theta_x, theta_y, theta_z) More...
 
std::vector< mitk::Vector3DQuaternionsToEulerAnglesGrad (std::vector< mitk::Quaternion > quaterions)
 
- Protected Member Functions inherited from mitk::NavigationDataToNavigationDataFilter
 NavigationDataToNavigationDataFilter ()
 
virtual ~NavigationDataToNavigationDataFilter ()
 
void CreateOutputsForAllInputs ()
 Create an output for each input. More...
 
- Protected Member Functions inherited from mitk::NavigationDataSource
 NavigationDataSource ()
 
virtual ~NavigationDataSource ()
 

Protected Attributes

std::map< std::vcl_size_t, std::vector< mitk::Point3D > > m_LoggedPositions
 
std::map< std::vcl_size_t, std::vector< mitk::Quaternion > > m_LoggedQuaternions
 
std::map< std::vcl_size_t, int > m_InvalidSamples
 
- Protected Attributes inherited from mitk::NavigationDataSource
std::string m_Name
 
bool m_IsFrozen
 

Additional Inherited Members

- Static Public Attributes inherited from mitk::NavigationDataSource
static const std::string US_INTERFACE_NAME
 These Constants are used in conjunction with Microservices. More...
 
static const std::string US_PROPKEY_DEVICENAME
 
static const std::string US_PROPKEY_ID
 
static const std::string US_PROPKEY_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 35 of file mitkNavigationDataEvaluationFilter.h.

Constructor & Destructor Documentation

mitk::NavigationDataEvaluationFilter::NavigationDataEvaluationFilter ( )
protected

Definition at line 23 of file mitkNavigationDataEvaluationFilter.cpp.

mitk::NavigationDataEvaluationFilter::~NavigationDataEvaluationFilter ( )
protectedvirtual

Definition at line 30 of file mitkNavigationDataEvaluationFilter.cpp.

Member Function Documentation

Pointer mitk::NavigationDataEvaluationFilter::Clone ( ) const
void mitk::NavigationDataEvaluationFilter::CreateMembersForAllInputs ( )
protected

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

Definition at line 65 of file mitkNavigationDataEvaluationFilter.cpp.

void mitk::NavigationDataEvaluationFilter::GenerateData ( )
overrideprotectedvirtual
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 144 of file mitkNavigationDataEvaluationFilter.cpp.

References mitk::PointSetStatisticsCalculator::New().

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 154 of file mitkNavigationDataEvaluationFilter.cpp.

References mitk::PointSetStatisticsCalculator::New().

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 160 of file mitkNavigationDataEvaluationFilter.cpp.

References mitk::PointSetStatisticsCalculator::New().

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 308 of file mitkNavigationDataEvaluationFilter.cpp.

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 299 of file mitkNavigationDataEvaluationFilter.cpp.

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

Definition at line 221 of file mitkNavigationDataEvaluationFilter.cpp.

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

Definition at line 93 of file mitkNavigationDataEvaluationFilter.cpp.

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 211 of file mitkNavigationDataEvaluationFilter.cpp.

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 216 of file mitkNavigationDataEvaluationFilter.cpp.

double mitk::NavigationDataEvaluationFilter::GetPositionErrorMax ( int  input)
Returns
Returns the maximum of the errors of all positions to the specified input.

Definition at line 199 of file mitkNavigationDataEvaluationFilter.cpp.

References mitk::PointSetStatisticsCalculator::New().

double mitk::NavigationDataEvaluationFilter::GetPositionErrorMean ( int  input)
Returns
Returns the mean distance to the mean postion (=mean error) to the specified input.

Definition at line 168 of file mitkNavigationDataEvaluationFilter.cpp.

References mitk::PointSetStatisticsCalculator::New().

double mitk::NavigationDataEvaluationFilter::GetPositionErrorMedian ( int  input)
Returns
Returns the median of the errors of all positions to the specified input.

Definition at line 193 of file mitkNavigationDataEvaluationFilter.cpp.

References mitk::PointSetStatisticsCalculator::New().

double mitk::NavigationDataEvaluationFilter::GetPositionErrorMin ( int  input)
Returns
Returns the minimum of the errors of all positions to the specified input.

Definition at line 205 of file mitkNavigationDataEvaluationFilter.cpp.

References mitk::PointSetStatisticsCalculator::New().

double mitk::NavigationDataEvaluationFilter::GetPositionErrorRMS ( int  input)
Returns
Returns the RMS of the errors of all positions to the specified input.

Definition at line 187 of file mitkNavigationDataEvaluationFilter.cpp.

References mitk::PointSetStatisticsCalculator::New().

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 180 of file mitkNavigationDataEvaluationFilter.cpp.

References mitk::PointSetStatisticsCalculator::New().

double mitk::NavigationDataEvaluationFilter::GetPositionErrorStandardDeviation ( int  input)
Returns
Returns the standard derivation of the errors of all positions to the specified input.

Definition at line 174 of file mitkNavigationDataEvaluationFilter.cpp.

References mitk::PointSetStatisticsCalculator::New().

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 99 of file mitkNavigationDataEvaluationFilter.cpp.

References mitk::PointSetStatisticsCalculator::New().

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 111 of file mitkNavigationDataEvaluationFilter.cpp.

References mitk::PointSetStatisticsCalculator::New().

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 105 of file mitkNavigationDataEvaluationFilter.cpp.

References mitk::PointSetStatisticsCalculator::New().

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 117 of file mitkNavigationDataEvaluationFilter.cpp.

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 122 of file mitkNavigationDataEvaluationFilter.cpp.

References mitk::PointSetStatisticsCalculator::New().

mitk::NavigationDataEvaluationFilter::mitkClassMacro ( NavigationDataEvaluationFilter  ,
NavigationDataToNavigationDataFilter   
)
static Pointer mitk::NavigationDataEvaluationFilter::New ( )
static
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 267 of file mitkNavigationDataEvaluationFilter.cpp.

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

Definition at line 283 of file mitkNavigationDataEvaluationFilter.cpp.

References M_PI, and PI.

void mitk::NavigationDataEvaluationFilter::ResetStatistic ( )

Resets all statistics and starts again.

Definition at line 86 of file mitkNavigationDataEvaluationFilter.cpp.

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

Definition at line 246 of file mitkNavigationDataEvaluationFilter.cpp.

References mitk::PointSet::New().

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

Definition at line 253 of file mitkNavigationDataEvaluationFilter.cpp.

References mitk::PointSet::New().

Member Data Documentation

std::map<std::vcl_size_t,int> mitk::NavigationDataEvaluationFilter::m_InvalidSamples
protected

Definition at line 110 of file mitkNavigationDataEvaluationFilter.h.

std::map<std::vcl_size_t,std::vector<mitk::Point3D> > mitk::NavigationDataEvaluationFilter::m_LoggedPositions
protected

Definition at line 108 of file mitkNavigationDataEvaluationFilter.h.

std::map<std::vcl_size_t,std::vector<mitk::Quaternion> > mitk::NavigationDataEvaluationFilter::m_LoggedQuaternions
protected

Definition at line 109 of file mitkNavigationDataEvaluationFilter.h.


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