NifTK  16.4.1 - 0798f20
CMIC's Translational Medical Imaging Platform
Public Types | Public Member Functions | Protected Member Functions | List of all members
niftk::ITKRegionParametersDataNodeProperty Class Reference

MITK data-node property suitable for holding an ITK Region, consisting of a "valid" flag, plus 6 parameters containing the index and size, as a simple vector of integers. More...

Inheritance diagram for niftk::ITKRegionParametersDataNodeProperty:
Inheritance graph
[legend]
Collaboration diagram for niftk::ITKRegionParametersDataNodeProperty:
Collaboration graph
[legend]

Public Types

typedef std::vector< intParametersType
 Parameters are 6 integers, corresponding to index[X, Y, Z] and size[X, Y, Z]. More...
 

Public Member Functions

 mitkClassMacro (ITKRegionParametersDataNodeProperty, mitk::BaseProperty) static Pointer New()
 
const ParametersTypeGetITKRegionParameters () const
 Get the region parameters from this property object where index[X, Y, Z] = [0-2], and size[X, Y, Z] = [3-5]. More...
 
void SetITKRegionParameters (const ParametersType &parameters)
 Set the region parameters on this property object where index[X, Y, Z] = [0-2], and size[X, Y, Z] = [3-5]. More...
 
bool HasVolume () const
 Returns true of the size of the volume is at least 1 voxel (eg. 1x1x1). More...
 
void SetIndex (int x, int y, int z)
 Sets the index. More...
 
void SetSize (int x, int y, int z)
 Sets the size. More...
 
bool IsValid () const
 Gets the 'valid' status flag. More...
 
void SetValid (bool valid)
 Sets the 'valid' status flag. More...
 
virtual std::string GetValueAsString () const override
 Defined in base class, returns the current value as a string for display in property view. More...
 
virtual void Identity ()
 Method to set these parameters back to identity, which is [false, 0, 0, 0, 0, 0, 0]. More...
 

Protected Member Functions

virtual ~ITKRegionParametersDataNodeProperty ()
 
 ITKRegionParametersDataNodeProperty ()
 
 ITKRegionParametersDataNodeProperty (const ITKRegionParametersDataNodeProperty &other)
 
virtual bool IsEqual (const mitk::BaseProperty &property) const override
 
virtual bool Assign (const mitk::BaseProperty &) override
 

Detailed Description

MITK data-node property suitable for holding an ITK Region, consisting of a "valid" flag, plus 6 parameters containing the index and size, as a simple vector of integers.

Member Typedef Documentation

Parameters are 6 integers, corresponding to index[X, Y, Z] and size[X, Y, Z].

Constructor & Destructor Documentation

niftk::ITKRegionParametersDataNodeProperty::~ITKRegionParametersDataNodeProperty ( )
protectedvirtual
niftk::ITKRegionParametersDataNodeProperty::ITKRegionParametersDataNodeProperty ( )
protected
niftk::ITKRegionParametersDataNodeProperty::ITKRegionParametersDataNodeProperty ( const ITKRegionParametersDataNodeProperty other)
protected

Member Function Documentation

bool niftk::ITKRegionParametersDataNodeProperty::Assign ( const mitk::BaseProperty &  property)
overrideprotectedvirtual
See also
mitk::BaseProperty::Assign()
const ITKRegionParametersDataNodeProperty::ParametersType & niftk::ITKRegionParametersDataNodeProperty::GetITKRegionParameters ( ) const

Get the region parameters from this property object where index[X, Y, Z] = [0-2], and size[X, Y, Z] = [3-5].

std::string niftk::ITKRegionParametersDataNodeProperty::GetValueAsString ( ) const
overridevirtual

Defined in base class, returns the current value as a string for display in property view.

bool niftk::ITKRegionParametersDataNodeProperty::HasVolume ( ) const

Returns true of the size of the volume is at least 1 voxel (eg. 1x1x1).

void niftk::ITKRegionParametersDataNodeProperty::Identity ( )
virtual

Method to set these parameters back to identity, which is [false, 0, 0, 0, 0, 0, 0].

bool niftk::ITKRegionParametersDataNodeProperty::IsEqual ( const mitk::BaseProperty &  property) const
overrideprotectedvirtual
See also
mitk::BaseProperty::IsEqual()
bool niftk::ITKRegionParametersDataNodeProperty::IsValid ( ) const

Gets the 'valid' status flag.

niftk::ITKRegionParametersDataNodeProperty::mitkClassMacro ( ITKRegionParametersDataNodeProperty  ,
mitk::BaseProperty   
)
void niftk::ITKRegionParametersDataNodeProperty::SetIndex ( int  x,
int  y,
int  z 
)

Sets the index.

void niftk::ITKRegionParametersDataNodeProperty::SetITKRegionParameters ( const ParametersType parameters)

Set the region parameters on this property object where index[X, Y, Z] = [0-2], and size[X, Y, Z] = [3-5].

void niftk::ITKRegionParametersDataNodeProperty::SetSize ( int  x,
int  y,
int  z 
)

Sets the size.

void niftk::ITKRegionParametersDataNodeProperty::SetValid ( bool  valid)

Sets the 'valid' status flag.


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