mitk::GeometryClipImageFilter Class Reference

Filter for clipping an image with a PlaneGeometry. More...

#include <mitkGeometryClipImageFilter.h>

Inheritance diagram for mitk::GeometryClipImageFilter:

Collaboration diagram for mitk::GeometryClipImageFilter:

Public Member Functions
	mitkClassMacro (GeometryClipImageFilter, ImageToImageFilter)
Pointer	Clone () const
void	SetClippingGeometry (const mitk::BaseGeometry *aClippingGeometry)
void	SetClippingGeometry (const mitk::TimeGeometry *aClippingGeometry)
const mitk::BaseGeometry *	GetClippingGeometry () const
const mitk::TimeGeometry *	GetClippingTimeGeometry () const
virtual bool	GetClipPartAboveGeometry () const
virtual void	SetClipPartAboveGeometry (bool _arg)
virtual void	ClipPartAboveGeometryOn ()
virtual void	ClipPartAboveGeometryOff ()
virtual void	SetOutsideValue (ScalarType _arg)
virtual ScalarType	GetOutsideValue () const
virtual void	SetAutoOutsideValue (bool _arg)
virtual bool	GetAutoOutsideValue () const
virtual void	AutoOutsideValueOn ()
virtual void	AutoOutsideValueOff ()
virtual void	SetAutoOrientLabels (bool _arg)
virtual bool	GetAutoOrientLabels () const
virtual void	SetLabelBothSides (bool _arg)
virtual bool	GetLabelBothSides () const
virtual void	LabelBothSidesOn ()
virtual void	LabelBothSidesOff ()
virtual void	SetAboveGeometryLabel (ScalarType _arg)
virtual ScalarType	GetAboveGeometryLabel () const
virtual void	SetBelowGeometryLabel (ScalarType _arg)
virtual ScalarType	GetBelowGeometryLabel () const
Public Member Functions inherited from mitk::ImageToImageFilter
virtual std::vector< std::string >	GetClassHierarchy () const override
virtual const char *	GetClassName () const
Pointer	Clone () const
virtual void	SetInput (const InputImageType *image)
virtual void	SetInput (unsigned int, const InputImageType *image)
InputImageType *	GetInput (void)
InputImageType *	GetInput (unsigned int idx)
const InputImageType *	GetInput (void) const
const InputImageType *	GetInput (unsigned int idx) const
Public Member Functions inherited from mitk::ImageSource
Pointer	Clone () const
OutputType *	GetOutput ()
	Get the output data of this image source object. More...
const OutputType *	GetOutput () const
OutputType *	GetOutput (DataObjectPointerArraySizeType idx)
const OutputType *	GetOutput (DataObjectPointerArraySizeType idx) const
itk::DataObject::Pointer	MakeOutput (DataObjectPointerArraySizeType idx) override
	Make a DataObject of the correct type to used as the specified output. More...
itk::DataObject::Pointer	MakeOutput (const DataObjectIdentifierType &name) override
virtual vtkImageData *	GetVtkImageData ()
virtual const vtkImageData *	GetVtkImageData () const
Public Member Functions inherited from mitk::BaseDataSource
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)
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 Pointer	New ()
Static Public Member Functions inherited from mitk::ImageToImageFilter
static const char *	GetStaticNameOfClass ()
static Pointer	New ()
Static Public Member Functions inherited from mitk::ImageSource
static const char *	GetStaticNameOfClass ()
static Pointer	New ()
	Method for creation through the object factory. More...
Static Public Member Functions inherited from mitk::BaseDataSource
static const char *	GetStaticNameOfClass ()

Protected Member Functions
	GeometryClipImageFilter ()
	~GeometryClipImageFilter () override
void	GenerateInputRequestedRegion () override
void	GenerateOutputInformation () override
void	GenerateData () override
template<typename TPixel , unsigned int VImageDimension>
void	_InternalComputeClippedImage (itk::Image< TPixel, VImageDimension > *itkImage, mitk::GeometryClipImageFilter *geometryClipper, const mitk::PlaneGeometry *clippingPlaneGeometry)
Protected Member Functions inherited from mitk::ImageToImageFilter
	ImageToImageFilter ()
	~ImageToImageFilter () override
void	PrintSelf (std::ostream &os, itk::Indent indent) const override
void	GenerateInputRequestedRegion () override
Protected Member Functions inherited from mitk::ImageSource
	ImageSource ()
	~ImageSource () override
void	GenerateData () override
	A version of GenerateData() specific for image processing filters. More...
virtual void	ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, itk::ThreadIdType threadId)
	If an imaging filter can be implemented as a multithreaded algorithm, the filter will provide an implementation of ThreadedGenerateData(). More...
void	PrepareOutputs () override
	This method is intentionally left blank. More...
virtual void	AllocateOutputs ()
	The GenerateData method normally allocates the buffers for all of the outputs of a filter. More...
virtual void	BeforeThreadedGenerateData ()
	If an imaging filter needs to perform processing after the buffer has been allocated but before threads are spawned, the filter can can provide an implementation for BeforeThreadedGenerateData(). More...
virtual void	AfterThreadedGenerateData ()
	If an imaging filter needs to perform processing after all processing threads have completed, the filter can can provide an implementation for AfterThreadedGenerateData(). More...
virtual unsigned int	SplitRequestedRegion (unsigned int i, unsigned int num, OutputImageRegionType &splitRegion)
	Split the output's RequestedRegion into "num" pieces, returning region "i" as "splitRegion". More...
Protected Member Functions inherited from mitk::BaseDataSource
	BaseDataSource ()
	~BaseDataSource () override

Protected Attributes
mitk::BaseGeometry::ConstPointer	m_ClippingGeometry
mitk::GeometryData::Pointer	m_ClippingGeometryData
mitk::TimeGeometry::ConstPointer	m_TimeClippingGeometry
mitk::ImageTimeSelector::Pointer	m_InputTimeSelector
mitk::ImageTimeSelector::Pointer	m_OutputTimeSelector
bool	m_ClipPartAboveGeometry
ScalarType	m_OutsideValue
bool	m_AutoOutsideValue
bool	m_LabelBothSides
bool	m_AutoOrientLabels
	Orient above like vtkPolyDataNormals does with AutoOrientNormals. More...
ScalarType	m_AboveGeometryLabel
ScalarType	m_BelowGeometryLabel
itk::TimeStamp	m_TimeOfHeaderInitialization

Additional Inherited Members
Public Types inherited from mitk::ImageToImageFilter
typedef ImageToImageFilter	Self
typedef ImageSource	Superclass
typedef itk::SmartPointer< Self >	Pointer
typedef itk::SmartPointer< const Self >	ConstPointer
typedef Superclass::OutputImageRegionType	OutputImageRegionType
typedef mitk::Image	InputImageType
typedef InputImageType::Pointer	InputImagePointer
typedef InputImageType::ConstPointer	InputImageConstPointer
typedef SlicedData::RegionType	InputImageRegionType
Public Types inherited from mitk::ImageSource
typedef ImageSource	Self
typedef BaseDataSource	Superclass
typedef itk::SmartPointer< Self >	Pointer
typedef itk::SmartPointer< const Self >	ConstPointer
typedef mitk::Image	OutputImageType
	Some convenient typedefs. More...
typedef OutputImageType	OutputType
typedef OutputImageType::Pointer	OutputImagePointer
typedef SlicedData::RegionType	OutputImageRegionType
Public Types inherited from mitk::BaseDataSource
typedef BaseDataSource	Self
typedef itk::ProcessObject	Superclass
typedef itk::SmartPointer< Self >	Pointer
typedef itk::SmartPointer< const Self >	ConstPointer
typedef BaseData	OutputType
typedef itk::DataObject::DataObjectIdentifierType	DataObjectIdentifierType
Static Protected Member Functions inherited from mitk::ImageSource
static ITK_THREAD_RETURN_TYPE	ThreaderCallback (void *arg)
	Static function used as a "callback" by the MultiThreader. More...
Static Protected Member Functions inherited from mitk::BaseDataSource
static Pointer	New ()

Detailed Description

Filter for clipping an image with a PlaneGeometry.

The given geometry for clipping can be either a PlaneGeometry or a TimeGeometry containing multiple instances of PlaneGeometry

Definition at line 43 of file mitkGeometryClipImageFilter.h.

Constructor & Destructor Documentation

GeometryClipImageFilter()

mitk::GeometryClipImageFilter::GeometryClipImageFilter ( )

protected

Definition at line 25 of file mitkGeometryClipImageFilter.cpp.

References m_ClippingGeometryData, m_InputTimeSelector, m_OutputTimeSelector, mitk::GeometryData::New(), and mitk::ImageTimeSelector::New().

~GeometryClipImageFilter()

mitk::GeometryClipImageFilter::~GeometryClipImageFilter ( )

overrideprotected

Definition at line 42 of file mitkGeometryClipImageFilter.cpp.

Member Function Documentation

_InternalComputeClippedImage()

template<typename TPixel , unsigned int VImageDimension>

void mitk::GeometryClipImageFilter::_InternalComputeClippedImage ( itk::Image< TPixel, VImageDimension > *  itkImage, mitk::GeometryClipImageFilter *  geometryClipper, const mitk::PlaneGeometry *  clippingPlaneGeometry  )

protected

Definition at line 115 of file mitkGeometryClipImageFilter.cpp.

References GetAboveGeometryLabel(), GetAutoOrientLabels(), GetBelowGeometryLabel(), GetLabelBothSides(), mitk::PlaneGeometry::IsAbove(), m_AutoOutsideValue, m_ClipPartAboveGeometry, m_InputTimeSelector, m_OutputTimeSelector, m_OutsideValue, min(), MITK_INFO, and mitk::ImageToItk< TOutputImage >::New().

Referenced by GenerateData().

AutoOutsideValueOff()

virtual void mitk::GeometryClipImageFilter::AutoOutsideValueOff ( )

virtual

AutoOutsideValueOn()

virtual void mitk::GeometryClipImageFilter::AutoOutsideValueOn ( )

virtual

ClipPartAboveGeometryOff()

virtual void mitk::GeometryClipImageFilter::ClipPartAboveGeometryOff ( )

virtual

ClipPartAboveGeometryOn()

virtual void mitk::GeometryClipImageFilter::ClipPartAboveGeometryOn ( )

virtual

Clone()

Pointer mitk::GeometryClipImageFilter::Clone

(

)

const

GenerateData()

void mitk::GeometryClipImageFilter::GenerateData ( )

overrideprotected

Definition at line 200 of file mitkGeometryClipImageFilter.cpp.

References _InternalComputeClippedImage(), AccessByItk_2, mitk::ImageToImageFilter::GetInput(), mitk::ImageSource::GetOutput(), m_ClippingGeometry, m_InputTimeSelector, m_OutputTimeSelector, m_TimeClippingGeometry, m_TimeOfHeaderInitialization, mitk::TimeGeometry::TimePointToTimeStep(), and mitk::TimeGeometry::TimeStepToTimePoint().

GenerateInputRequestedRegion()

void mitk::GeometryClipImageFilter::GenerateInputRequestedRegion ( )

overrideprotected

Definition at line 73 of file mitkGeometryClipImageFilter.cpp.

References mitk::GenerateTimeInInputRegion(), mitk::ImageToImageFilter::GetInput(), mitk::ImageSource::GetOutput(), mitk::BaseData::IsInitialized(), m_ClippingGeometry, and mitk::SlicedData::SetRequestedRegionToLargestPossibleRegion().

GenerateOutputInformation()

void mitk::GeometryClipImageFilter::GenerateOutputInformation ( )

overrideprotected

Definition at line 87 of file mitkGeometryClipImageFilter.cpp.

References mitk::ImageToImageFilter::GetInput(), mitk::ImageSource::GetOutput(), and m_TimeOfHeaderInitialization.

GetAboveGeometryLabel()

virtual ScalarType mitk::GeometryClipImageFilter::GetAboveGeometryLabel ( ) const

virtual

Referenced by _InternalComputeClippedImage().

GetAutoOrientLabels()

virtual bool mitk::GeometryClipImageFilter::GetAutoOrientLabels ( ) const

virtual

Referenced by _InternalComputeClippedImage().

GetAutoOutsideValue()

virtual bool mitk::GeometryClipImageFilter::GetAutoOutsideValue ( ) const

virtual

GetBelowGeometryLabel()

virtual ScalarType mitk::GeometryClipImageFilter::GetBelowGeometryLabel ( ) const

virtual

Referenced by _InternalComputeClippedImage().

GetClipPartAboveGeometry()

virtual bool mitk::GeometryClipImageFilter::GetClipPartAboveGeometry ( ) const

virtual

GetClippingGeometry()

const mitk::BaseGeometry * mitk::GeometryClipImageFilter::GetClippingGeometry

(

)

const

Definition at line 63 of file mitkGeometryClipImageFilter.cpp.

References m_ClippingGeometry.

GetClippingTimeGeometry()

const mitk::TimeGeometry * mitk::GeometryClipImageFilter::GetClippingTimeGeometry

(

)

const

Definition at line 68 of file mitkGeometryClipImageFilter.cpp.

References m_TimeClippingGeometry.

GetLabelBothSides()

virtual bool mitk::GeometryClipImageFilter::GetLabelBothSides ( ) const

virtual

Referenced by _InternalComputeClippedImage().

GetOutsideValue()

virtual ScalarType mitk::GeometryClipImageFilter::GetOutsideValue ( ) const

virtual

LabelBothSidesOff()

virtual void mitk::GeometryClipImageFilter::LabelBothSidesOff ( )

virtual

LabelBothSidesOn()

virtual void mitk::GeometryClipImageFilter::LabelBothSidesOn ( )

virtual

mitkClassMacro()

mitk::GeometryClipImageFilter::mitkClassMacro	(	GeometryClipImageFilter	,
		ImageToImageFilter
	)

New()

static Pointer mitk::GeometryClipImageFilter::New ( )

static

SetAboveGeometryLabel()

virtual void mitk::GeometryClipImageFilter::SetAboveGeometryLabel ( ScalarType  _arg )

virtual

SetAutoOrientLabels()

virtual void mitk::GeometryClipImageFilter::SetAutoOrientLabels ( bool  _arg )

virtual

SetAutoOutsideValue()

virtual void mitk::GeometryClipImageFilter::SetAutoOutsideValue ( bool  _arg )

virtual

SetBelowGeometryLabel()

virtual void mitk::GeometryClipImageFilter::SetBelowGeometryLabel ( ScalarType  _arg )

virtual

SetClipPartAboveGeometry()

virtual void mitk::GeometryClipImageFilter::SetClipPartAboveGeometry ( bool  _arg )

virtual

SetClippingGeometry() [1/2]

void mitk::GeometryClipImageFilter::SetClippingGeometry

(

const mitk::BaseGeometry *

aClippingGeometry

)

Set the geometry to be used for clipping

The given geometry for clipping must be a PlaneGeometry.

Definition at line 52 of file mitkGeometryClipImageFilter.cpp.

References m_ClippingGeometry, and m_ClippingGeometryData.

Referenced by SetClippingGeometry().

SetClippingGeometry() [2/2]

void mitk::GeometryClipImageFilter::SetClippingGeometry

(

const mitk::TimeGeometry *

aClippingGeometry

)

Set the geometry to be used for clipping

The given geometry for clipping must a TimeGeometry containing multiple instances of PlaneGeometry

Definition at line 46 of file mitkGeometryClipImageFilter.cpp.

References mitk::TimeGeometry::GetGeometryForTimeStep(), m_TimeClippingGeometry, and SetClippingGeometry().

SetLabelBothSides()

virtual void mitk::GeometryClipImageFilter::SetLabelBothSides ( bool  _arg )

virtual

SetOutsideValue()

virtual void mitk::GeometryClipImageFilter::SetOutsideValue ( ScalarType  _arg )

virtual

Member Data Documentation

m_AboveGeometryLabel

ScalarType mitk::GeometryClipImageFilter::m_AboveGeometryLabel

protected

Definition at line 168 of file mitkGeometryClipImageFilter.h.

m_AutoOrientLabels

bool mitk::GeometryClipImageFilter::m_AutoOrientLabels

protected

Orient above like vtkPolyDataNormals does with AutoOrientNormals.

Definition at line 163 of file mitkGeometryClipImageFilter.h.

m_AutoOutsideValue

bool mitk::GeometryClipImageFilter::m_AutoOutsideValue

protected

Definition at line 153 of file mitkGeometryClipImageFilter.h.

Referenced by _InternalComputeClippedImage().

m_BelowGeometryLabel

ScalarType mitk::GeometryClipImageFilter::m_BelowGeometryLabel

protected

Definition at line 173 of file mitkGeometryClipImageFilter.h.

m_ClipPartAboveGeometry

bool mitk::GeometryClipImageFilter::m_ClipPartAboveGeometry

protected

Definition at line 143 of file mitkGeometryClipImageFilter.h.

Referenced by _InternalComputeClippedImage().

m_ClippingGeometry

mitk::BaseGeometry::ConstPointer mitk::GeometryClipImageFilter::m_ClippingGeometry

protected

Definition at line 134 of file mitkGeometryClipImageFilter.h.

Referenced by GenerateData(), GenerateInputRequestedRegion(), GetClippingGeometry(), and SetClippingGeometry().

m_ClippingGeometryData

mitk::GeometryData::Pointer mitk::GeometryClipImageFilter::m_ClippingGeometryData

protected

Definition at line 135 of file mitkGeometryClipImageFilter.h.

Referenced by GeometryClipImageFilter(), and SetClippingGeometry().

m_InputTimeSelector

mitk::ImageTimeSelector::Pointer mitk::GeometryClipImageFilter::m_InputTimeSelector

protected

Definition at line 137 of file mitkGeometryClipImageFilter.h.

Referenced by _InternalComputeClippedImage(), GenerateData(), and GeometryClipImageFilter().

m_LabelBothSides

bool mitk::GeometryClipImageFilter::m_LabelBothSides

protected

Definition at line 158 of file mitkGeometryClipImageFilter.h.

m_OutputTimeSelector

mitk::ImageTimeSelector::Pointer mitk::GeometryClipImageFilter::m_OutputTimeSelector

protected

Definition at line 138 of file mitkGeometryClipImageFilter.h.

Referenced by _InternalComputeClippedImage(), GenerateData(), and GeometryClipImageFilter().

m_OutsideValue

ScalarType mitk::GeometryClipImageFilter::m_OutsideValue

protected

Definition at line 149 of file mitkGeometryClipImageFilter.h.

Referenced by _InternalComputeClippedImage().

m_TimeClippingGeometry

mitk::TimeGeometry::ConstPointer mitk::GeometryClipImageFilter::m_TimeClippingGeometry

protected

Definition at line 136 of file mitkGeometryClipImageFilter.h.

Referenced by GenerateData(), GetClippingTimeGeometry(), and SetClippingGeometry().

m_TimeOfHeaderInitialization

itk::TimeStamp mitk::GeometryClipImageFilter::m_TimeOfHeaderInitialization

protected

Definition at line 177 of file mitkGeometryClipImageFilter.h.

Referenced by GenerateData(), and GenerateOutputInformation().

---

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

• mitkGeometryClipImageFilter.h
• mitkGeometryClipImageFilter.cpp