Medical Imaging Interaction Toolkit  2023.04.00
Medical Imaging Interaction Toolkit
mitk::PlaneGeometryDataToSurfaceFilter Class Reference

Superclass of all classes having a PlaneGeometryData as input and generating Images as output. More...

#include <mitkPlaneGeometryDataToSurfaceFilter.h>

Inheritance diagram for mitk::PlaneGeometryDataToSurfaceFilter:
Collaboration diagram for mitk::PlaneGeometryDataToSurfaceFilter:

Public Types

typedef PlaneGeometryDataToSurfaceFilter Self
 
typedef SurfaceSource Superclass
 
typedef itk::SmartPointer< SelfPointer
 
typedef itk::SmartPointer< const SelfConstPointer
 
- Public Types inherited from mitk::SurfaceSource
typedef SurfaceSource Self
 
typedef BaseDataSource Superclass
 
typedef itk::SmartPointer< SelfPointer
 
typedef itk::SmartPointer< const SelfConstPointer
 
typedef Surface OutputType
 
- Public Types inherited from mitk::BaseDataSource
typedef BaseDataSource Self
 
typedef itk::ProcessObject Superclass
 
typedef itk::SmartPointer< SelfPointer
 
typedef itk::SmartPointer< const SelfConstPointer
 
typedef BaseData OutputType
 
typedef itk::DataObject::DataObjectIdentifierType DataObjectIdentifierType
 

Public Member Functions

virtual std::vector< std::string > GetClassHierarchy () const override
 
virtual const char * GetClassName () const
 
Pointer Clone () const
 
void GenerateOutputInformation () override
 
void GenerateData () override
 
const PlaneGeometryDataGetInput (void)
 
const PlaneGeometryDataGetInput (unsigned int idx)
 
virtual void SetInput (const PlaneGeometryData *image)
 
virtual void SetInput (unsigned int index, const PlaneGeometryData *image)
 
virtual bool GetUseGeometryParametricBounds ()
 If true (default), use Geometry3D::GetParametricBounds() to define the resolution in parameter space, otherwise use m_XResolution and m_YResolution. More...
 
virtual void SetUseGeometryParametricBounds (bool _arg)
 If true (default), use Geometry3D::GetParametricBounds() to define the resolution in parameter space, otherwise use m_XResolution and m_YResolution. More...
 
virtual int GetXResolution ()
 Get x-resolution in parameter space. More...
 
virtual void SetXResolution (int _arg)
 Set x-resolution in parameter space. More...
 
virtual int GetYResolution ()
 Get y-resolution in parameter space. More...
 
virtual void SetYResolution (int _arg)
 Set y-resolution in parameter space. More...
 
virtual bool GetPlaceByGeometry () const
 Get whether the Surface is at the origin and placed using the Geometry. More...
 
virtual void SetPlaceByGeometry (bool _arg)
 Set whether the Surface is at the origin and placed using the Geometry. More...
 
virtual void PlaceByGeometryOn ()
 
virtual void PlaceByGeometryOff ()
 
virtual bool GetUseBoundingBox () const
 
virtual void SetUseBoundingBox (bool _arg)
 
virtual void UseBoundingBoxOn ()
 
virtual void UseBoundingBoxOff ()
 
void SetBoundingBox (const BoundingBox *boundingBox)
 
const BoundingBoxGetBoundingBox () const
 
- Public Member Functions inherited from mitk::SurfaceSource
Pointer Clone () const
 
OutputTypeGetOutput ()
 
const OutputTypeGetOutput () const
 
OutputTypeGetOutput (DataObjectPointerArraySizeType idx)
 
const OutputTypeGetOutput (DataObjectPointerArraySizeType idx) const
 
itk::DataObject::Pointer MakeOutput (DataObjectPointerArraySizeType idx) override
 
itk::DataObject::Pointer MakeOutput (const DataObjectIdentifierType &name) override
 
- Public Member Functions inherited from mitk::BaseDataSource
OutputTypeGetOutput ()
 
const OutputTypeGetOutput () const
 
OutputTypeGetOutput (DataObjectPointerArraySizeType idx)
 
const OutputTypeGetOutput (DataObjectPointerArraySizeType idx) const
 
virtual void GraftOutput (OutputType *output)
 Graft the specified BaseData onto this BaseDataSource's output. More...
 
virtual void GraftOutput (const DataObjectIdentifierType &key, OutputType *output)
 
virtual void GraftNthOutput (unsigned int idx, OutputType *output)
 Graft the specified base data object onto this BaseDataSource's idx'th output. More...
 
bool Updating () const
 Access itk::ProcessObject::m_Updating. More...
 

Static Public Member Functions

static const char * GetStaticNameOfClass ()
 
static Pointer New ()
 
- Static Public Member Functions inherited from mitk::SurfaceSource
static const char * GetStaticNameOfClass ()
 
static Pointer New ()
 
- Static Public Member Functions inherited from mitk::BaseDataSource
static const char * GetStaticNameOfClass ()
 

Protected Member Functions

 PlaneGeometryDataToSurfaceFilter ()
 
 ~PlaneGeometryDataToSurfaceFilter () override
 
- Protected Member Functions inherited from mitk::SurfaceSource
 SurfaceSource ()
 
 ~SurfaceSource () override
 
- Protected Member Functions inherited from mitk::BaseDataSource
 BaseDataSource ()
 
 ~BaseDataSource () override
 

Protected Attributes

vtkPlaneSource * m_PlaneSource
 Source to create the vtk-representation of the parameter space rectangle of the PlaneGeometry. More...
 
vtkTransformPolyDataFilter * m_VtkTransformPlaneFilter
 Filter to create the vtk-representation of the PlaneGeometry, which is a transformation of the m_PlaneSource. More...
 
bool m_UseGeometryParametricBounds
 If true, use Geometry3D::GetParametricBounds() to define the resolution in parameter space, otherwise use m_XResolution and m_YResolution. More...
 
int m_XResolution
 X-resolution in parameter space. More...
 
int m_YResolution
 Y-resolution in parameter space. More...
 
bool m_PlaceByGeometry
 Define whether the Surface is at the origin and placed using the Geometry. More...
 
bool m_UseBoundingBox
 
BoundingBox::ConstPointer m_BoundingBox
 
vtkCubeSource * m_CubeSource
 
vtkTransform * m_Transform
 
vtkTransformPolyDataFilter * m_PolyDataTransformer
 
vtkPlane * m_Plane
 
vtkCutter * m_PlaneCutter
 
vtkStripper * m_PlaneStripper
 
vtkPolyData * m_PlanePolyData
 
vtkPPolyDataNormals * m_NormalsUpdater
 
vtkTriangleFilter * m_PlaneTriangler
 
vtkTextureMapToPlane * m_TextureMapToPlane
 
vtkBox * m_Box
 
vtkClipPolyData * m_PlaneClipper
 

Additional Inherited Members

- Static Protected Member Functions inherited from mitk::BaseDataSource
static Pointer New ()
 

Detailed Description

Superclass of all classes having a PlaneGeometryData as input and generating Images as output.

Currently implemented for PlaneGeometry and AbstractTransformGeometry. Currently, this class does not really have subclasses, but does the job for itself. It checks which kind of PlaneGeometry is stored in the PlaneGeometryData and - if it knows how - it generates the respective Surface. Of course, this has the disadvantage that for any new type of PlaneGeometry this class (PlaneGeometryDataToSurfaceFilter) has to be changed/extended. The idea is to move the type specific generation code in subclasses, and internally (within this class) use a factory to create an instance of the required subclass and delegate the surface generation to it.

See also
mitk::DeformablePlane

Definition at line 58 of file mitkPlaneGeometryDataToSurfaceFilter.h.

Member Typedef Documentation

◆ ConstPointer

◆ Pointer

◆ Self

◆ Superclass

Constructor & Destructor Documentation

◆ PlaneGeometryDataToSurfaceFilter()

mitk::PlaneGeometryDataToSurfaceFilter::PlaneGeometryDataToSurfaceFilter ( )
protected

◆ ~PlaneGeometryDataToSurfaceFilter()

mitk::PlaneGeometryDataToSurfaceFilter::~PlaneGeometryDataToSurfaceFilter ( )
overrideprotected

Member Function Documentation

◆ Clone()

Pointer mitk::PlaneGeometryDataToSurfaceFilter::Clone ( ) const

◆ GenerateData()

void mitk::PlaneGeometryDataToSurfaceFilter::GenerateData ( )
override

◆ GenerateOutputInformation()

void mitk::PlaneGeometryDataToSurfaceFilter::GenerateOutputInformation ( )
override

◆ GetBoundingBox()

const BoundingBox* mitk::PlaneGeometryDataToSurfaceFilter::GetBoundingBox ( ) const

◆ GetClassHierarchy()

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

Reimplemented from mitk::SurfaceSource.

Definition at line 61 of file mitkPlaneGeometryDataToSurfaceFilter.h.

◆ GetClassName()

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

Reimplemented from mitk::SurfaceSource.

◆ GetInput() [1/2]

const PlaneGeometryData* mitk::PlaneGeometryDataToSurfaceFilter::GetInput ( unsigned int  idx)

◆ GetInput() [2/2]

const PlaneGeometryData* mitk::PlaneGeometryDataToSurfaceFilter::GetInput ( void  )

◆ GetPlaceByGeometry()

virtual bool mitk::PlaneGeometryDataToSurfaceFilter::GetPlaceByGeometry ( ) const
virtual

Get whether the Surface is at the origin and placed using the Geometry.

Default is false, i.e., the transform of the Geometry is the identity, thus the points within the Surface are at their final position. Otherwise (m_PlaceByGeometry==true), the first cornerpoint of the created Surface is at the origin and the actual position is determined by the transform of the Geometry.

See also
m_PlaceByGeometry

◆ GetStaticNameOfClass()

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

Definition at line 61 of file mitkPlaneGeometryDataToSurfaceFilter.h.

◆ GetUseBoundingBox()

virtual bool mitk::PlaneGeometryDataToSurfaceFilter::GetUseBoundingBox ( ) const
virtual

◆ GetUseGeometryParametricBounds()

virtual bool mitk::PlaneGeometryDataToSurfaceFilter::GetUseGeometryParametricBounds ( )
virtual

If true (default), use Geometry3D::GetParametricBounds() to define the resolution in parameter space, otherwise use m_XResolution and m_YResolution.

◆ GetXResolution()

virtual int mitk::PlaneGeometryDataToSurfaceFilter::GetXResolution ( )
virtual

Get x-resolution in parameter space.

The m_PlaneSource will create this many sub-rectangles in x-direction (see vtkPlaneSource::SetXResolution)

Note
Only used, when GetUseGeometryParametricBounds() is false, otherwise the the x-bounds of Geometry3D::GetParametricBounds() are used.
See also
m_XResolution

◆ GetYResolution()

virtual int mitk::PlaneGeometryDataToSurfaceFilter::GetYResolution ( )
virtual

Get y-resolution in parameter space.

The m_PlaneSource will create this many sub-rectangles in y-direction (see vtkPlaneSource::SetYResolution)

Note
Only used, when GetUseGeometryParametricBounds() is false, otherwise the the y-bounds of Geometry3D::GetParametricBounds() are used.
See also
m_YResolution

◆ New()

static Pointer mitk::PlaneGeometryDataToSurfaceFilter::New ( )
static

◆ PlaceByGeometryOff()

virtual void mitk::PlaneGeometryDataToSurfaceFilter::PlaceByGeometryOff ( )
virtual

◆ PlaceByGeometryOn()

virtual void mitk::PlaneGeometryDataToSurfaceFilter::PlaceByGeometryOn ( )
virtual

◆ SetBoundingBox()

void mitk::PlaneGeometryDataToSurfaceFilter::SetBoundingBox ( const BoundingBox boundingBox)

◆ SetInput() [1/2]

virtual void mitk::PlaneGeometryDataToSurfaceFilter::SetInput ( const PlaneGeometryData image)
virtual

◆ SetInput() [2/2]

virtual void mitk::PlaneGeometryDataToSurfaceFilter::SetInput ( unsigned int  index,
const PlaneGeometryData image 
)
virtual

◆ SetPlaceByGeometry()

virtual void mitk::PlaneGeometryDataToSurfaceFilter::SetPlaceByGeometry ( bool  _arg)
virtual

Set whether the Surface is at the origin and placed using the Geometry.

Default is false, i.e., the transform of the Geometry is the identity, thus the points within the Surface are at their final position. Otherwise (m_PlaceByGeometry==true), the first cornerpoint of the created Surface is at the origin and the actual position is determined by the transform of the Geometry.

See also
m_PlaceByGeometry

◆ SetUseBoundingBox()

virtual void mitk::PlaneGeometryDataToSurfaceFilter::SetUseBoundingBox ( bool  _arg)
virtual

◆ SetUseGeometryParametricBounds()

virtual void mitk::PlaneGeometryDataToSurfaceFilter::SetUseGeometryParametricBounds ( bool  _arg)
virtual

If true (default), use Geometry3D::GetParametricBounds() to define the resolution in parameter space, otherwise use m_XResolution and m_YResolution.

◆ SetXResolution()

virtual void mitk::PlaneGeometryDataToSurfaceFilter::SetXResolution ( int  _arg)
virtual

Set x-resolution in parameter space.

The m_PlaneSource will create this many sub-rectangles in x-direction (see vtkPlaneSource::SetXResolution)

Note
Only used, when GetUseGeometryParametricBounds() is false, otherwise the the x-bounds of Geometry3D::GetParametricBounds() are used.
See also
m_XResolution

◆ SetYResolution()

virtual void mitk::PlaneGeometryDataToSurfaceFilter::SetYResolution ( int  _arg)
virtual

Set y-resolution in parameter space.

The m_PlaneSource will create this many sub-rectangles in y-direction (see vtkPlaneSource::SetYResolution)

Note
Only used, when GetUseGeometryParametricBounds() is false, otherwise the the y-bounds of Geometry3D::GetParametricBounds() are used.
See also
m_YResolution

◆ UseBoundingBoxOff()

virtual void mitk::PlaneGeometryDataToSurfaceFilter::UseBoundingBoxOff ( )
virtual

◆ UseBoundingBoxOn()

virtual void mitk::PlaneGeometryDataToSurfaceFilter::UseBoundingBoxOn ( )
virtual

Member Data Documentation

◆ m_BoundingBox

BoundingBox::ConstPointer mitk::PlaneGeometryDataToSurfaceFilter::m_BoundingBox
protected

Definition at line 204 of file mitkPlaneGeometryDataToSurfaceFilter.h.

◆ m_Box

vtkBox* mitk::PlaneGeometryDataToSurfaceFilter::m_Box
protected

Definition at line 218 of file mitkPlaneGeometryDataToSurfaceFilter.h.

◆ m_CubeSource

vtkCubeSource* mitk::PlaneGeometryDataToSurfaceFilter::m_CubeSource
protected

Definition at line 206 of file mitkPlaneGeometryDataToSurfaceFilter.h.

◆ m_NormalsUpdater

vtkPPolyDataNormals* mitk::PlaneGeometryDataToSurfaceFilter::m_NormalsUpdater
protected

Definition at line 214 of file mitkPlaneGeometryDataToSurfaceFilter.h.

◆ m_PlaceByGeometry

bool mitk::PlaneGeometryDataToSurfaceFilter::m_PlaceByGeometry
protected

Define whether the Surface is at the origin and placed using the Geometry.

Default is false, i.e., the transform of the Geometry is the identity, thus the points within the Surface are at their final position. Otherwise (m_PlaceByGeometry==true), the first cornerpoint of the created Surface is at the origin and the actual position is determined by the transform of the Geometry.

Definition at line 200 of file mitkPlaneGeometryDataToSurfaceFilter.h.

◆ m_Plane

vtkPlane* mitk::PlaneGeometryDataToSurfaceFilter::m_Plane
protected

Definition at line 210 of file mitkPlaneGeometryDataToSurfaceFilter.h.

◆ m_PlaneClipper

vtkClipPolyData* mitk::PlaneGeometryDataToSurfaceFilter::m_PlaneClipper
protected

Definition at line 219 of file mitkPlaneGeometryDataToSurfaceFilter.h.

◆ m_PlaneCutter

vtkCutter* mitk::PlaneGeometryDataToSurfaceFilter::m_PlaneCutter
protected

Definition at line 211 of file mitkPlaneGeometryDataToSurfaceFilter.h.

◆ m_PlanePolyData

vtkPolyData* mitk::PlaneGeometryDataToSurfaceFilter::m_PlanePolyData
protected

Definition at line 213 of file mitkPlaneGeometryDataToSurfaceFilter.h.

◆ m_PlaneSource

vtkPlaneSource* mitk::PlaneGeometryDataToSurfaceFilter::m_PlaneSource
protected

Source to create the vtk-representation of the parameter space rectangle of the PlaneGeometry.

Definition at line 161 of file mitkPlaneGeometryDataToSurfaceFilter.h.

◆ m_PlaneStripper

vtkStripper* mitk::PlaneGeometryDataToSurfaceFilter::m_PlaneStripper
protected

Definition at line 212 of file mitkPlaneGeometryDataToSurfaceFilter.h.

◆ m_PlaneTriangler

vtkTriangleFilter* mitk::PlaneGeometryDataToSurfaceFilter::m_PlaneTriangler
protected

Definition at line 215 of file mitkPlaneGeometryDataToSurfaceFilter.h.

◆ m_PolyDataTransformer

vtkTransformPolyDataFilter* mitk::PlaneGeometryDataToSurfaceFilter::m_PolyDataTransformer
protected

Definition at line 208 of file mitkPlaneGeometryDataToSurfaceFilter.h.

◆ m_TextureMapToPlane

vtkTextureMapToPlane* mitk::PlaneGeometryDataToSurfaceFilter::m_TextureMapToPlane
protected

Definition at line 216 of file mitkPlaneGeometryDataToSurfaceFilter.h.

◆ m_Transform

vtkTransform* mitk::PlaneGeometryDataToSurfaceFilter::m_Transform
protected

Definition at line 207 of file mitkPlaneGeometryDataToSurfaceFilter.h.

◆ m_UseBoundingBox

bool mitk::PlaneGeometryDataToSurfaceFilter::m_UseBoundingBox
protected

Definition at line 202 of file mitkPlaneGeometryDataToSurfaceFilter.h.

◆ m_UseGeometryParametricBounds

bool mitk::PlaneGeometryDataToSurfaceFilter::m_UseGeometryParametricBounds
protected

If true, use Geometry3D::GetParametricBounds() to define the resolution in parameter space, otherwise use m_XResolution and m_YResolution.

Definition at line 171 of file mitkPlaneGeometryDataToSurfaceFilter.h.

◆ m_VtkTransformPlaneFilter

vtkTransformPolyDataFilter* mitk::PlaneGeometryDataToSurfaceFilter::m_VtkTransformPlaneFilter
protected

Filter to create the vtk-representation of the PlaneGeometry, which is a transformation of the m_PlaneSource.

Definition at line 166 of file mitkPlaneGeometryDataToSurfaceFilter.h.

◆ m_XResolution

int mitk::PlaneGeometryDataToSurfaceFilter::m_XResolution
protected

X-resolution in parameter space.

The m_PlaneSource will create this many sub-rectangles in x-direction (see vtkPlaneSource::SetXResolution)

Note
Only used, when GetUseGeometryParametricBounds() is false, otherwise the the x-bounds of Geometry3D::GetParametricBounds() are used.
See also
m_XResolution

Definition at line 181 of file mitkPlaneGeometryDataToSurfaceFilter.h.

◆ m_YResolution

int mitk::PlaneGeometryDataToSurfaceFilter::m_YResolution
protected

Y-resolution in parameter space.

The m_PlaneSource will create this many sub-rectangles in y-direction (see vtkPlaneSource::SetYResolution)

Note
Only used, when GetUseGeometryParametricBounds() is false, otherwise the the y-bounds of Geometry3D::GetParametricBounds() are used.

Definition at line 190 of file mitkPlaneGeometryDataToSurfaceFilter.h.


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