Crops or masks an Boundingbox defined by GeometryData out of an mitk Image. More...

#include <mitkBoundingShapeCropper.h>

Inheritance diagram for mitk::BoundingShapeCropper:

Collaboration diagram for mitk::BoundingShapeCropper:

Public Member Functions
	mitkClassMacro (BoundingShapeCropper, ImageToImageFilter)

Pointer	Clone () const

void	SetGeometry (const mitk::GeometryData *geometry)
	Set geometry of the bounding object. More...

virtual void	SetOutsideValue (ScalarType _arg)
	Get geometry of the bounding object. More...

virtual ScalarType	GetOutsideValue ()

virtual void	SetUseWholeInputRegion (bool _arg)
	Sets and Gets whether a masking or cropping needs to be performed. More...

virtual bool	GetUseWholeInputRegion ()

virtual void	SetCurrentTimeStep (ScalarType _arg)
	Sets and Gets the current timestep for images with 4 dimensons. More...

virtual ScalarType	GetCurrentTimeStep ()

virtual void	SetUseCropTimeStepOnly (bool _arg)
	Sets and Gets whether only one timestep is cropped / masked. More...

virtual bool	GetUseCropTimeStepOnly ()

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

	~BoundingShapeCropper () override

virtual const PixelType	GetOutputPixelType ()

void	GenerateInputRequestedRegion () override
	Reimplemented from ImageToImageFilter. More...

void	GenerateOutputInformation () override

void	GenerateData () override

template<typename TPixel , unsigned int VImageDimension>
void	CutImage (itk::Image< TPixel, VImageDimension > *inputItkImage, int timeStep)
	Template Function for cropping and masking images with scalar pixel type. More...

virtual void	ComputeData (mitk::Image *input3D, int boTimeStep)
	Process the image and create the output. More...

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

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

Crops or masks an Boundingbox defined by GeometryData out of an mitk Image.

Documentation Input Parameters are a mitk::GeometryData and an mitk::Image Masking: Pixel on the outside of the bounding box will have a pixelvalue of m_OutsideValue Cropping: Output image has the same size as the bounding box

Definition at line 36 of file mitkBoundingShapeCropper.h.

Constructor & Destructor Documentation

◆ BoundingShapeCropper()

mitk::BoundingShapeCropper::BoundingShapeCropper ( )

protected

Definition at line 35 of file mitkBoundingShapeCropper.cpp.

◆ ~BoundingShapeCropper()

mitk::BoundingShapeCropper::~BoundingShapeCropper ( )

overrideprotected

Definition at line 48 of file mitkBoundingShapeCropper.cpp.

Member Function Documentation

◆ Clone()

Pointer mitk::BoundingShapeCropper::Clone ( ) const

◆ ComputeData()

void mitk::BoundingShapeCropper::ComputeData	(	mitk::Image *	input3D,
		int	boTimeStep
	)

protectedvirtual

Process the image and create the output.

Definition at line 259 of file mitkBoundingShapeCropper.cpp.

References AccessByItk_1, CutImage(), mitk::Image::GetDimension(), and MITK_ERROR.

Referenced by GenerateData().

◆ CutImage()

template<typename TPixel , unsigned int VImageDimension>

void mitk::BoundingShapeCropper::CutImage	(	itk::Image< TPixel, VImageDimension > *	inputItkImage,
		int	timeStep
	)

protected

Template Function for cropping and masking images with scalar pixel type.

Definition at line 51 of file mitkBoundingShapeCropper.cpp.

References mitk::StatusBar::DisplayErrorText(), mitk::BaseData::GetGeometry(), mitk::ImageToImageFilter::GetInput(), mitk::StatusBar::GetInstance(), GetOutsideValue(), mitk::BaseGeometry::IndexToWorld(), mitk::itk2vtk(), MITK_INFO, mitk::ImageToItk< TOutputImage >::New(), and mitk::vtk2itk().

Referenced by ComputeData().

◆ GenerateData()

void mitk::BoundingShapeCropper::GenerateData ( )

overrideprotected

Definition at line 272 of file mitkBoundingShapeCropper.cpp.

References ComputeData(), mitk::ImageToImageFilter::GetInput(), mitk::ImageSource::GetOutput(), mitk::BaseGeometry::IndexToWorld(), MITK_INFO, mitk::BaseGeometry::SetIndexToWorldTransform(), mitk::BaseGeometry::SetOrigin(), and mitk::vtk2itk().

◆ GenerateInputRequestedRegion()

void mitk::BoundingShapeCropper::GenerateInputRequestedRegion ( )

overrideprotected

Reimplemented from ImageToImageFilter.

Definition at line 166 of file mitkBoundingShapeCropper.cpp.

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

◆ GenerateOutputInformation()

void mitk::BoundingShapeCropper::GenerateOutputInformation ( )

overrideprotected

Definition at line 176 of file mitkBoundingShapeCropper.cpp.

References mitk::BaseGeometry::CalculateBoundingBoxRelativeToTransform(), mitk::BaseGeometry::GetIndexToWorldTransform(), mitk::ImageToImageFilter::GetInput(), mitk::ImageSource::GetOutput(), GetOutputPixelType(), GetUseCropTimeStepOnly(), mitk::itk2vtk(), max(), min(), and mitkThrow.

◆ GetCurrentTimeStep()

virtual ScalarType mitk::BoundingShapeCropper::GetCurrentTimeStep ( )

virtual

◆ GetOutputPixelType()

const mitk::PixelType mitk::BoundingShapeCropper::GetOutputPixelType ( )

protectedvirtual

Definition at line 165 of file mitkBoundingShapeCropper.cpp.

References mitk::ImageToImageFilter::GetInput(), and mitk::Image::GetPixelType().

Referenced by GenerateOutputInformation().

◆ GetOutsideValue()

virtual ScalarType mitk::BoundingShapeCropper::GetOutsideValue ( )

virtual

Referenced by CutImage().

◆ GetUseCropTimeStepOnly()

virtual bool mitk::BoundingShapeCropper::GetUseCropTimeStepOnly ( )

virtual

Referenced by GenerateOutputInformation().

◆ GetUseWholeInputRegion()

virtual bool mitk::BoundingShapeCropper::GetUseWholeInputRegion ( )

virtual

◆ mitkClassMacro()

mitk::BoundingShapeCropper::mitkClassMacro	(	BoundingShapeCropper	,
		ImageToImageFilter
	)

◆ New()

static Pointer mitk::BoundingShapeCropper::New ( )

static

◆ SetCurrentTimeStep()

virtual void mitk::BoundingShapeCropper::SetCurrentTimeStep ( ScalarType _arg )

virtual

Sets and Gets the current timestep for images with 4 dimensons.

◆ SetGeometry()

void mitk::BoundingShapeCropper::SetGeometry ( const mitk::GeometryData * geometry )

Set geometry of the bounding object.

Definition at line 153 of file mitkBoundingShapeCropper.cpp.

◆ SetOutsideValue()

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

virtual

Get geometry of the bounding object.

Sets and Gets the outside value for masking

◆ SetUseCropTimeStepOnly()

virtual void mitk::BoundingShapeCropper::SetUseCropTimeStepOnly ( bool _arg )

virtual

Sets and Gets whether only one timestep is cropped / masked.

◆ SetUseWholeInputRegion()

virtual void mitk::BoundingShapeCropper::SetUseWholeInputRegion ( bool _arg )

virtual

Sets and Gets whether a masking or cropping needs to be performed.

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

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ BoundingShapeCropper()

◆ ~BoundingShapeCropper()

Member Function Documentation

◆ Clone()

◆ ComputeData()

◆ CutImage()

◆ GenerateData()

◆ GenerateInputRequestedRegion()

◆ GenerateOutputInformation()

◆ GetCurrentTimeStep()

◆ GetOutputPixelType()

◆ GetOutsideValue()

◆ GetUseCropTimeStepOnly()

◆ GetUseWholeInputRegion()

◆ mitkClassMacro()

◆ New()

◆ SetCurrentTimeStep()

◆ SetGeometry()

◆ SetOutsideValue()

◆ SetUseCropTimeStepOnly()

◆ SetUseWholeInputRegion()