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

virtual itk::DataObject::Pointer	MakeOutput (DataObjectPointerArraySizeType idx) override
	Make a DataObject of the correct type to used as the specified output. More...

virtual 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 ()

virtual void	GenerateInputRequestedRegion () override

virtual void	GenerateOutputInformation () override

virtual void	GenerateData () override
	A version of GenerateData() specific for image processing filters. More...

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

virtual	~ImageToImageFilter ()

virtual void	PrintSelf (std::ostream &os, itk::Indent indent) const override

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

virtual	~ImageSource ()

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...

virtual 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 ()

virtual	~BaseDataSource ()

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

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

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 47 of file mitkGeometryClipImageFilter.h.

Constructor & Destructor Documentation

mitk::GeometryClipImageFilter::GeometryClipImageFilter ( )

protected

Definition at line 29 of file mitkGeometryClipImageFilter.cpp.

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

mitk::GeometryClipImageFilter::~GeometryClipImageFilter ( )

protected

Definition at line 46 of file mitkGeometryClipImageFilter.cpp.

Member Function Documentation

virtual void mitk::GeometryClipImageFilter::AutoOutsideValueOff ( )

virtual

virtual void mitk::GeometryClipImageFilter::AutoOutsideValueOn ( )

virtual

virtual void mitk::GeometryClipImageFilter::ClipPartAboveGeometryOff ( )

virtual

virtual void mitk::GeometryClipImageFilter::ClipPartAboveGeometryOn ( )

virtual

Pointer mitk::GeometryClipImageFilter::Clone ( ) const

void mitk::GeometryClipImageFilter::GenerateData ( )

overrideprotectedvirtual

A version of GenerateData() specific for image processing filters.

This implementation will split the processing across multiple threads. The buffer is allocated by this method. Then the BeforeThreadedGenerateData() method is called (if provided). Then, a series of threads are spawned each calling ThreadedGenerateData(). After all the threads have completed processing, the AfterThreadedGenerateData() method is called (if provided). If an image processing filter cannot be threaded, the filter should provide an implementation of GenerateData(). That implementation is responsible for allocating the output buffer. If a filter an be threaded, it should NOT provide a GenerateData() method but should provide a ThreadedGenerateData() instead.

See also: ThreadedGenerateData()

Reimplemented from mitk::ImageSource.

Definition at line 204 of file mitkGeometryClipImageFilter.cpp.

References AccessByItk_2, mitk::TimeGeometry::TimePointToTimeStep(), and mitk::TimeGeometry::TimeStepToTimePoint().

void mitk::GeometryClipImageFilter::GenerateInputRequestedRegion ( )

overrideprotectedvirtual

What is the input requested region that is required to produce the output requested region? The base assumption for image processing filters is that the input requested region can be set to match the output requested region. If a filter requires more input (for instance a filter that uses neighborhoods needs more input than output to avoid introducing artificial boundary conditions) or less input (for instance a magnify filter) will have to override this method. In doing so, it should call its superclass' implementation as its first step. Note that this imaging filters operate differently than the classes to this point in the class hierachy. Up till now, the base assumption has been that the largest possible region will be requested of the input.

See also: ProcessObject::GenerateInputRequestedRegion(), ImageSource::GenerateInputRequestedRegion()

Reimplemented from mitk::ImageToImageFilter.

Definition at line 77 of file mitkGeometryClipImageFilter.cpp.

References mitk::GenerateTimeInInputRegion(), mitk::BaseData::IsInitialized(), and mitk::SlicedData::SetRequestedRegionToLargestPossibleRegion().

void mitk::GeometryClipImageFilter::GenerateOutputInformation ( )

overrideprotectedvirtual

Definition at line 91 of file mitkGeometryClipImageFilter.cpp.

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

virtual

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

virtual

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

virtual

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

virtual

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

virtual

const mitk::BaseGeometry * mitk::GeometryClipImageFilter::GetClippingGeometry ( ) const

Definition at line 67 of file mitkGeometryClipImageFilter.cpp.

const mitk::TimeGeometry * mitk::GeometryClipImageFilter::GetClippingTimeGeometry ( ) const

Definition at line 72 of file mitkGeometryClipImageFilter.cpp.

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

virtual

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

virtual

virtual void mitk::GeometryClipImageFilter::LabelBothSidesOff ( )

virtual

virtual void mitk::GeometryClipImageFilter::LabelBothSidesOn ( )

virtual

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

static Pointer mitk::GeometryClipImageFilter::New ( )

static

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

virtual

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

virtual

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

virtual

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

virtual

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

virtual

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 56 of file mitkGeometryClipImageFilter.cpp.

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 50 of file mitkGeometryClipImageFilter.cpp.

References mitk::TimeGeometry::GetGeometryForTimeStep().

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

virtual

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

virtual

Friends And Related Function Documentation

template<typename TPixel , unsigned int VImageDimension>

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