Medical Imaging Interaction Toolkit  2018.4.99-12ad79a3
Medical Imaging Interaction Toolkit
mitk::NodePredicateGeometry Class Reference

Predicate that evaluates if the given DataNode's data object has the same geometry (in terms of spacing, origin, orientation) like the reference geometry. One can either check the whole time geometry of the date node by defining a referenc time geometry or check against one given reference base geometry. If the predicate should check against a base geometry, you can specify the timepoint of the data's time geometry that should be checked. If no timepoint is defined the predicate will evaluate the data geometry in the first timestep. Evaluates to "false" for unsupported or undefined data objects/geometries. More...

#include <mitkNodePredicateGeometry.h>

Inheritance diagram for mitk::NodePredicateGeometry:
Collaboration diagram for mitk::NodePredicateGeometry:

Public Types

typedef NodePredicateGeometry Self
 
typedef NodePredicateBase Superclass
 
typedef itk::SmartPointer< SelfPointer
 
typedef itk::SmartPointer< const SelfConstPointer
 
- Public Types inherited from mitk::NodePredicateBase
typedef NodePredicateBase Self
 
typedef itk::Object Superclass
 
typedef itk::SmartPointer< SelfPointer
 
typedef itk::SmartPointer< const SelfConstPointer
 

Public Member Functions

virtual std::vector< std::string > GetClassHierarchy () const override
 
virtual const char * GetClassName () const
 
virtual void SetCheckPrecision (mitk::ScalarType _arg)
 
virtual mitk::ScalarType GetCheckPrecision ()
 
 ~NodePredicateGeometry () override
 
bool CheckNode (const mitk::DataNode *node) const override
 This method will be used to evaluate the node. Has to be overwritten in subclasses. More...
 
- Public Member Functions inherited from mitk::NodePredicateBase
 ~NodePredicateBase () override
 Standard Destructor. More...
 

Static Public Member Functions

static const char * GetStaticNameOfClass ()
 
static Pointer New (const TimeGeometry *_arg)
 
static Pointer New (const BaseGeometry *_arg)
 
static Pointer New (const BaseGeometry *_arga, TimePointType _argb)
 
- Static Public Member Functions inherited from mitk::NodePredicateBase
static const char * GetStaticNameOfClass ()
 

Protected Member Functions

 NodePredicateGeometry (const BaseGeometry *refGeometry)
 
 NodePredicateGeometry (const BaseGeometry *refGeometry, TimePointType relevantTimePoint)
 
 NodePredicateGeometry (const TimeGeometry *refGeometry)
 

Protected Attributes

BaseGeometry::ConstPointer m_RefGeometry
 
TimeGeometry::ConstPointer m_RefTimeGeometry
 
TimePointType m_TimePoint
 
bool m_UseTimePoint
 
mitk::ScalarType m_CheckPrecision
 

Detailed Description

Predicate that evaluates if the given DataNode's data object has the same geometry (in terms of spacing, origin, orientation) like the reference geometry. One can either check the whole time geometry of the date node by defining a referenc time geometry or check against one given reference base geometry. If the predicate should check against a base geometry, you can specify the timepoint of the data's time geometry that should be checked. If no timepoint is defined the predicate will evaluate the data geometry in the first timestep. Evaluates to "false" for unsupported or undefined data objects/geometries.

Documentation

Definition at line 35 of file mitkNodePredicateGeometry.h.

Member Typedef Documentation

◆ ConstPointer

◆ Pointer

◆ Self

◆ Superclass

Constructor & Destructor Documentation

◆ ~NodePredicateGeometry()

mitk::NodePredicateGeometry::~NodePredicateGeometry ( )
override

Definition at line 35 of file mitkNodePredicateGeometry.cpp.

◆ NodePredicateGeometry() [1/3]

mitk::NodePredicateGeometry::NodePredicateGeometry ( const BaseGeometry refGeometry)
protected

Constructor that is used configures the predicate to check against the the refernce geometry against the first data timepoint.

Definition at line 23 of file mitkNodePredicateGeometry.cpp.

References m_RefGeometry, and mitkThrow.

◆ NodePredicateGeometry() [2/3]

mitk::NodePredicateGeometry::NodePredicateGeometry ( const BaseGeometry refGeometry,
TimePointType  relevantTimePoint 
)
protected

Constructor allows to define the timepoint that should be evaluated against the reference.

Definition at line 17 of file mitkNodePredicateGeometry.cpp.

References m_RefGeometry, and mitkThrow.

◆ NodePredicateGeometry() [3/3]

mitk::NodePredicateGeometry::NodePredicateGeometry ( const TimeGeometry refGeometry)
protected

Constructor that is used configures the predicate to check against the whole time geometry.

Definition at line 29 of file mitkNodePredicateGeometry.cpp.

References m_RefTimeGeometry, and mitkThrow.

Member Function Documentation

◆ CheckNode()

bool mitk::NodePredicateGeometry::CheckNode ( const mitk::DataNode node) const
overridevirtual

◆ GetCheckPrecision()

virtual mitk::ScalarType mitk::NodePredicateGeometry::GetCheckPrecision ( )
virtual

◆ GetClassHierarchy()

virtual std::vector<std::string> mitk::NodePredicateGeometry::GetClassHierarchy ( ) const
inlineoverridevirtual

Reimplemented from mitk::NodePredicateBase.

Definition at line 38 of file mitkNodePredicateGeometry.h.

◆ GetClassName()

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

Reimplemented from mitk::NodePredicateBase.

◆ GetStaticNameOfClass()

static const char* mitk::NodePredicateGeometry::GetStaticNameOfClass ( )
inlinestatic

Definition at line 38 of file mitkNodePredicateGeometry.h.

◆ New() [1/3]

static Pointer mitk::NodePredicateGeometry::New ( const TimeGeometry _arg)
inlinestatic

◆ New() [2/3]

static Pointer mitk::NodePredicateGeometry::New ( const BaseGeometry _arg)
inlinestatic

Definition at line 40 of file mitkNodePredicateGeometry.h.

◆ New() [3/3]

static Pointer mitk::NodePredicateGeometry::New ( const BaseGeometry _arga,
TimePointType  _argb 
)
inlinestatic

Definition at line 41 of file mitkNodePredicateGeometry.h.

◆ SetCheckPrecision()

virtual void mitk::NodePredicateGeometry::SetCheckPrecision ( mitk::ScalarType  _arg)
virtual

Member Data Documentation

◆ m_CheckPrecision

mitk::ScalarType mitk::NodePredicateGeometry::m_CheckPrecision
protected

Precision that should be used for the equal checks.

Definition at line 65 of file mitkNodePredicateGeometry.h.

Referenced by CheckNode().

◆ m_RefGeometry

BaseGeometry::ConstPointer mitk::NodePredicateGeometry::m_RefGeometry
protected

Definition at line 59 of file mitkNodePredicateGeometry.h.

Referenced by CheckNode(), and NodePredicateGeometry().

◆ m_RefTimeGeometry

TimeGeometry::ConstPointer mitk::NodePredicateGeometry::m_RefTimeGeometry
protected

Definition at line 60 of file mitkNodePredicateGeometry.h.

Referenced by CheckNode(), and NodePredicateGeometry().

◆ m_TimePoint

TimePointType mitk::NodePredicateGeometry::m_TimePoint
protected

Definition at line 61 of file mitkNodePredicateGeometry.h.

Referenced by CheckNode().

◆ m_UseTimePoint

bool mitk::NodePredicateGeometry::m_UseTimePoint
protected

Indicates if m_TimePoint should be regarded or always the first timestep should be used.

Definition at line 63 of file mitkNodePredicateGeometry.h.

Referenced by CheckNode().


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