mitk::NodePredicateDimension Class Reference

Predicate that evaluates if the given DataNode's data object has the specified dimension, for datasets where dimension is applicable. More...

#include <mitkNodePredicateDimension.h>

Inheritance diagram for mitk::NodePredicateDimension:

Collaboration diagram for mitk::NodePredicateDimension:

Public Member Functions
	mitkClassMacro (NodePredicateDimension, NodePredicateBase)
	mitkNewMacro1Param (NodePredicateDimension, unsigned int)
	mitkNewMacro2Param (NodePredicateDimension, unsigned int, int)
	~NodePredicateDimension () override
	Standard Destructor. More...
bool	CheckNode (const mitk::DataNode *node) const override
	Checks if the node's data object has the specified dimension. More...
Public Member Functions inherited from mitk::NodePredicateBase
	mitkClassMacroItkParent (NodePredicateBase, itk::Object)
	~NodePredicateBase () override
	Virtual destructor. More...

Protected Member Functions
	NodePredicateDimension (unsigned int dimension)
	Constructor with dimension only (pixel components defaults to 1). More...
	NodePredicateDimension (unsigned int dimension, int pixelComponents)
	Constructor with dimension and pixel component count. More...

Protected Attributes
unsigned int	m_Dimension
std::size_t	m_PixelComponents

Detailed Description

Predicate that evaluates if the given DataNode's data object has the specified dimension, for datasets where dimension is applicable.

For Image data, both the image dimension and pixel component count are checked. For non-Image data, the dimension is inferred from the TimeGeometry if the pixel component count is the default value (1). Evaluates to "false" for unsupported datasets.

Definition at line 32 of file mitkNodePredicateDimension.h.

Constructor & Destructor Documentation

~NodePredicateDimension()

mitk::NodePredicateDimension::~NodePredicateDimension ( )

override

Standard Destructor.

NodePredicateDimension() [1/2]

mitk::NodePredicateDimension::NodePredicateDimension ( unsigned int  dimension )

protected

Constructor with dimension only (pixel components defaults to 1).

Parameters

dimension

The required image dimension.

NodePredicateDimension() [2/2]

mitk::NodePredicateDimension::NodePredicateDimension ( unsigned int  dimension, int  pixelComponents  )

protected

Constructor with dimension and pixel component count.

Parameters

dimension	The required image dimension.
pixelComponents	The required number of pixel components.

Member Function Documentation

CheckNode()

bool mitk::NodePredicateDimension::CheckNode ( const mitk::DataNode *  node ) const

overridevirtual

Checks if the node's data object has the specified dimension.

Parameters

node	The DataNode to check.

Returns

True if the data object dimension and pixel components match.

Implements mitk::NodePredicateBase.

mitkClassMacro()

mitk::NodePredicateDimension::mitkClassMacro	(	NodePredicateDimension	,
		NodePredicateBase
	)

mitkNewMacro1Param()

mitk::NodePredicateDimension::mitkNewMacro1Param	(	NodePredicateDimension	,
		unsigned int
	)

mitkNewMacro2Param()

mitk::NodePredicateDimension::mitkNewMacro2Param	(	NodePredicateDimension	,
		unsigned int	,
		int
	)

Member Data Documentation

m_Dimension

unsigned int mitk::NodePredicateDimension::m_Dimension

protected

Definition at line 63 of file mitkNodePredicateDimension.h.

m_PixelComponents

std::size_t mitk::NodePredicateDimension::m_PixelComponents

protected

Definition at line 64 of file mitkNodePredicateDimension.h.

---

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

• mitkNodePredicateDimension.h