Cuts and masks a region of interest (ROI) out of an image. More...

#include <mitkMaskAndCutRoiImageFilter.h>

Inheritance diagram for mitk::MaskAndCutRoiImageFilter:

[legend]

Collaboration diagram for mitk::MaskAndCutRoiImageFilter:

[legend]

Public Member Functions
	mitkClassMacro (MaskAndCutRoiImageFilter, ImageToImageFilter)

Pointer	Clone () const

void	SetRegionOfInterest (mitk::BaseData *roi)
	Set the region of interest. More...

mitk::Image::Pointer	GetOutput ()
	Get the output image. More...

Public Member Functions inherited from mitk::ImageToImageFilter
	mitkClassMacro (ImageToImageFilter, ImageSource)

Pointer	Clone () const

virtual void	SetInput (const InputImageType *image)
	Set the image input of this process object. More...

virtual void	SetInput (unsigned int idx, const InputImageType *image)
	Set the image input at the specified index. More...

InputImageType *	GetInput (void)
	Get the input image (non-const). More...

InputImageType *	GetInput (unsigned int idx)
	Get the input image at the specified index (non-const). More...

const InputImageType *	GetInput (void) const
	Get the input image (const). More...

const InputImageType *	GetInput (unsigned int idx) const
	Get the input image at the specified index (const). More...

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

Pointer	Clone () const

mitkBaseDataSourceGetOutputDeclarations itk::DataObject::Pointer	MakeOutput (DataObjectPointerArraySizeType idx) override
	Get the output data of this image source object. More...

itk::DataObject::Pointer	MakeOutput (const DataObjectIdentifierType &name) override

virtual vtkImageData *	GetVtkImageData ()
	Get the output as VTK image data (non-const version). More...

virtual const vtkImageData *	GetVtkImageData () const
	Get the output as VTK image data (const version). 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::ImageToImageFilter
static Pointer	New ()
	Method for creation through the object factory. More...

Static Public Member Functions inherited from mitk::ImageSource
static Pointer	New ()
	Method for creation through the object factory. More...

Protected Member Functions
	MaskAndCutRoiImageFilter ()

	~MaskAndCutRoiImageFilter () override

void	GenerateData () override

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

	~ImageToImageFilter () override

void	PrintSelf (std::ostream &os, itk::Indent indent) const override
	Print self information to the given stream. More...

void	GenerateInputRequestedRegion () override
	Determine the input requested region to produce the output requested region. More...

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 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 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 ()
	Constructor. More...

	~BaseDataSource () override
	Destructor. More...

Protected Attributes
ROIFilterType::Pointer	m_RoiFilter

mitk::AutoCropImageFilter::Pointer	m_CropFilter

mitk::MaskImageFilter::Pointer	m_MaskFilter

mitk::Image::Pointer	m_outputImage

Additional Inherited Members
Public Types inherited from mitk::ImageToImageFilter
typedef Superclass::OutputImageRegionType	OutputImageRegionType
	Superclass typedefs. More...

typedef mitk::Image	InputImageType
	Some convenient typedefs. More...

typedef InputImageType::Pointer	InputImagePointer

typedef InputImageType::ConstPointer	InputImageConstPointer

typedef SlicedData::RegionType	InputImageRegionType

Public Types inherited from mitk::ImageSource
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 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::ImageSource
static itk::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

Cuts and masks a region of interest (ROI) out of an image.

This filter performs a three-step operation:

The ROI mask image is auto-cropped to its minimal bounding region.
The corresponding subvolume is extracted from the input image.
The subvolume is masked with the ROI so that pixels outside the ROI are replaced by an outside value (-32765).

The ROI can be provided as a mitk::Image (binary mask) or as a mitk::BoundingObject, which is internally converted to a binary mask.

See also: AutoCropImageFilter; MaskImageFilter; BoundingObjectToSegmentationFilter

Definition at line 43 of file mitkMaskAndCutRoiImageFilter.h.

Constructor & Destructor Documentation

◆ MaskAndCutRoiImageFilter()

mitk::MaskAndCutRoiImageFilter::MaskAndCutRoiImageFilter ( )

protected

◆ ~MaskAndCutRoiImageFilter()

mitk::MaskAndCutRoiImageFilter::~MaskAndCutRoiImageFilter ( )

overrideprotected

Member Function Documentation

◆ Clone()

Pointer mitk::MaskAndCutRoiImageFilter::Clone ( ) const

◆ GenerateData()

void mitk::MaskAndCutRoiImageFilter::GenerateData ( )

overrideprotected

◆ GetOutput()

mitk::Image::Pointer mitk::MaskAndCutRoiImageFilter::GetOutput ( )

Get the output image.

Returns: Smart pointer to the masked and cut output image.

◆ mitkClassMacro()

mitk::MaskAndCutRoiImageFilter::mitkClassMacro	(	MaskAndCutRoiImageFilter	,
		ImageToImageFilter
	)

◆ New()

static Pointer mitk::MaskAndCutRoiImageFilter::New ( )

static

◆ SetRegionOfInterest()

void mitk::MaskAndCutRoiImageFilter::SetRegionOfInterest ( mitk::BaseData * roi )

Set the region of interest.

The ROI can be either a mitk::Image (used directly as a binary mask) or a mitk::BoundingObject (internally converted to a binary mask using BoundingObjectToSegmentationFilter).

Parameters

[in] roi The region of interest as a BaseData (Image or BoundingObject).

Member Data Documentation

◆ m_CropFilter

mitk::AutoCropImageFilter::Pointer mitk::MaskAndCutRoiImageFilter::m_CropFilter

protected

Definition at line 79 of file mitkMaskAndCutRoiImageFilter.h.

◆ m_MaskFilter

mitk::MaskImageFilter::Pointer mitk::MaskAndCutRoiImageFilter::m_MaskFilter

protected

Definition at line 80 of file mitkMaskAndCutRoiImageFilter.h.

◆ m_outputImage

mitk::Image::Pointer mitk::MaskAndCutRoiImageFilter::m_outputImage

protected

Definition at line 83 of file mitkMaskAndCutRoiImageFilter.h.

◆ m_RoiFilter

ROIFilterType::Pointer mitk::MaskAndCutRoiImageFilter::m_RoiFilter

protected

Definition at line 78 of file mitkMaskAndCutRoiImageFilter.h.

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

mitkMaskAndCutRoiImageFilter.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ MaskAndCutRoiImageFilter()

◆ ~MaskAndCutRoiImageFilter()

Member Function Documentation

◆ Clone()

◆ GenerateData()

◆ GetOutput()

◆ mitkClassMacro()

◆ New()

◆ SetRegionOfInterest()

Member Data Documentation

◆ m_CropFilter

◆ m_MaskFilter

◆ m_outputImage

◆ m_RoiFilter