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

#include <mitkPlaneGeometryDataToSurfaceFilter.h>

Inheritance diagram for mitk::PlaneGeometryDataToSurfaceFilter:

[legend]

Collaboration diagram for mitk::PlaneGeometryDataToSurfaceFilter:

[legend]

Public Member Functions
	mitkClassMacro (PlaneGeometryDataToSurfaceFilter, SurfaceSource)

Pointer	Clone () const

void	GenerateOutputInformation () override
	Generate information about the output (size, spacing, etc.). More...

void	GenerateData () override
	Generate the Surface output from the PlaneGeometryData input. More...

const PlaneGeometryData *	GetInput (void)
	Get the first PlaneGeometryData input. More...

const PlaneGeometryData *	GetInput (unsigned int idx)
	Get the PlaneGeometryData input at the given index. More...

virtual void	SetInput (const PlaneGeometryData *image)
	Set the PlaneGeometryData input (at index 0). More...

virtual void	SetInput (unsigned int index, const PlaneGeometryData *image)
	Set the PlaneGeometryData input at the given index. More...

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
	Get whether a bounding box is used to clip the generated surface. More...

virtual void	SetUseBoundingBox (bool _arg)
	Set whether a bounding box should be used to clip the generated surface. More...

virtual void	UseBoundingBoxOn ()
	Toggle use of bounding box for clipping. More...

virtual void	UseBoundingBoxOff ()

void	SetBoundingBox (const BoundingBox *boundingBox)
	Set the bounding box used to clip the generated surface. More...

const BoundingBox *	GetBoundingBox () const
	Get the bounding box used to clip the generated surface. More...

Public Member Functions inherited from mitk::SurfaceSource
	mitkClassMacro (SurfaceSource, BaseDataSource)

Pointer	Clone () const

mitkBaseDataSourceGetOutputDeclarations itk::DataObject::Pointer	MakeOutput (DataObjectPointerArraySizeType idx) override
	Allocate a new output object and return it. More...

itk::DataObject::Pointer	MakeOutput (const DataObjectIdentifierType &name) override
	Allocate a new output object by name. More...

Public Member Functions inherited from mitk::BaseDataSource
	mitkClassMacroItkParent (BaseDataSource, itk::ProcessObject)

OutputType *	GetOutput ()

const OutputType *	GetOutput () const

OutputType *	GetOutput (DataObjectPointerArraySizeType idx)

const OutputType *	GetOutput (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)
	Graft the specified base data object onto a named output. More...

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
	Check whether the pipeline is currently executing. More...

Static Public Member Functions
static Pointer	New ()

Static Public Member Functions inherited from mitk::SurfaceSource
static Pointer	New ()

Protected Member Functions
	PlaneGeometryDataToSurfaceFilter ()

	~PlaneGeometryDataToSurfaceFilter () override

Protected Member Functions inherited from mitk::SurfaceSource
	SurfaceSource ()

	~SurfaceSource () override

Protected Member Functions inherited from mitk::BaseDataSource
	BaseDataSource ()
	Constructor. More...

	~BaseDataSource () override
	Destructor. More...

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

vtkContourTriangulator *	m_ContourTriangulator

vtkPPolyDataNormals *	m_NormalsUpdater

vtkTextureMapToPlane *	m_TextureMapToPlane

vtkBox *	m_Box

vtkClipPolyData *	m_PlaneClipper

Additional Inherited Members
Public Types inherited from mitk::SurfaceSource
typedef Surface	OutputType

Public Types inherited from mitk::BaseDataSource
typedef BaseData	OutputType
	Output data type. More...

typedef itk::DataObject::DataObjectIdentifierType	DataObjectIdentifierType
	Identifier type for named data objects. More...

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 54 of file mitkPlaneGeometryDataToSurfaceFilter.h.

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

Generate the Surface output from the PlaneGeometryData input.

◆ GenerateOutputInformation()

void mitk::PlaneGeometryDataToSurfaceFilter::GenerateOutputInformation ( )

override

Generate information about the output (size, spacing, etc.).

◆ GetBoundingBox()

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

Get the bounding box used to clip the generated surface.

Returns: The current bounding box, or nullptr if none is set.

◆ GetInput() [1/2]

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

Get the PlaneGeometryData input at the given index.

Parameters

idx	The input index.

◆ GetInput() [2/2]

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

Get the first PlaneGeometryData input.

◆ 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

◆ GetUseBoundingBox()

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

virtual

Get whether a bounding box is used to clip the generated surface.

◆ 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

◆ mitkClassMacro()

mitk::PlaneGeometryDataToSurfaceFilter::mitkClassMacro	(	PlaneGeometryDataToSurfaceFilter	,
		SurfaceSource
	)

◆ 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 )

Set the bounding box used to clip the generated surface.

Parameters

boundingBox The bounding box. Only used when UseBoundingBox is true.

◆ SetInput() [1/2]

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

virtual

Set the PlaneGeometryData input (at index 0).

Parameters

image The PlaneGeometryData to use as input.

◆ SetInput() [2/2]

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

virtual

Set the PlaneGeometryData input at the given index.

Parameters

index	The input index.
image	The PlaneGeometryData to use as input.

◆ 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

Set whether a bounding box should be used to clip the generated surface.

◆ 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

Toggle use of bounding box for clipping.

Member Data Documentation

◆ m_BoundingBox

BoundingBox::ConstPointer mitk::PlaneGeometryDataToSurfaceFilter::m_BoundingBox

protected

Definition at line 230 of file mitkPlaneGeometryDataToSurfaceFilter.h.

◆ m_Box

vtkBox* mitk::PlaneGeometryDataToSurfaceFilter::m_Box

protected

Definition at line 242 of file mitkPlaneGeometryDataToSurfaceFilter.h.

◆ m_ContourTriangulator

vtkContourTriangulator* mitk::PlaneGeometryDataToSurfaceFilter::m_ContourTriangulator

protected

Definition at line 238 of file mitkPlaneGeometryDataToSurfaceFilter.h.

◆ m_CubeSource

vtkCubeSource* mitk::PlaneGeometryDataToSurfaceFilter::m_CubeSource

protected

Definition at line 232 of file mitkPlaneGeometryDataToSurfaceFilter.h.

◆ m_NormalsUpdater

vtkPPolyDataNormals* mitk::PlaneGeometryDataToSurfaceFilter::m_NormalsUpdater

protected

Definition at line 239 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 226 of file mitkPlaneGeometryDataToSurfaceFilter.h.

◆ m_Plane

vtkPlane* mitk::PlaneGeometryDataToSurfaceFilter::m_Plane

protected

Definition at line 236 of file mitkPlaneGeometryDataToSurfaceFilter.h.

◆ m_PlaneClipper

vtkClipPolyData* mitk::PlaneGeometryDataToSurfaceFilter::m_PlaneClipper

protected

Definition at line 243 of file mitkPlaneGeometryDataToSurfaceFilter.h.

◆ m_PlaneCutter

vtkCutter* mitk::PlaneGeometryDataToSurfaceFilter::m_PlaneCutter

protected

Definition at line 237 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 187 of file mitkPlaneGeometryDataToSurfaceFilter.h.

◆ m_PolyDataTransformer

vtkTransformPolyDataFilter* mitk::PlaneGeometryDataToSurfaceFilter::m_PolyDataTransformer

protected

Definition at line 234 of file mitkPlaneGeometryDataToSurfaceFilter.h.

◆ m_TextureMapToPlane

vtkTextureMapToPlane* mitk::PlaneGeometryDataToSurfaceFilter::m_TextureMapToPlane

protected

Definition at line 240 of file mitkPlaneGeometryDataToSurfaceFilter.h.

◆ m_Transform

vtkTransform* mitk::PlaneGeometryDataToSurfaceFilter::m_Transform

protected

Definition at line 233 of file mitkPlaneGeometryDataToSurfaceFilter.h.

◆ m_UseBoundingBox

bool mitk::PlaneGeometryDataToSurfaceFilter::m_UseBoundingBox

protected

Definition at line 228 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 197 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 192 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 207 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 216 of file mitkPlaneGeometryDataToSurfaceFilter.h.

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

mitkPlaneGeometryDataToSurfaceFilter.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ PlaneGeometryDataToSurfaceFilter()

◆ ~PlaneGeometryDataToSurfaceFilter()

Member Function Documentation

◆ Clone()

◆ GenerateData()

◆ GenerateOutputInformation()

◆ GetBoundingBox()

◆ GetInput() [1/2]

◆ GetInput() [2/2]

◆ GetPlaceByGeometry()

◆ GetUseBoundingBox()

◆ GetUseGeometryParametricBounds()

◆ GetXResolution()

◆ GetYResolution()

◆ mitkClassMacro()

◆ New()

◆ PlaceByGeometryOff()

◆ PlaceByGeometryOn()

◆ SetBoundingBox()

◆ SetInput() [1/2]

◆ SetInput() [2/2]

◆ SetPlaceByGeometry()

◆ SetUseBoundingBox()

◆ SetUseGeometryParametricBounds()

◆ SetXResolution()

◆ SetYResolution()

◆ UseBoundingBoxOff()

◆ UseBoundingBoxOn()

Member Data Documentation

◆ m_BoundingBox

◆ m_Box

◆ m_ContourTriangulator

◆ m_CubeSource

◆ m_NormalsUpdater

◆ m_PlaceByGeometry

◆ m_Plane

◆ m_PlaneClipper

◆ m_PlaneCutter

◆ m_PlaneSource

◆ m_PolyDataTransformer

◆ m_TextureMapToPlane

◆ m_Transform

◆ m_UseBoundingBox

◆ m_UseGeometryParametricBounds

◆ m_VtkTransformPlaneFilter

◆ m_XResolution

◆ m_YResolution