Medical Imaging Interaction Toolkit  2016.11.0
Medical Imaging Interaction Toolkit
mitk::MaskAndCutRoiImageFilter Class Reference

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

#include <mitkMaskAndCutRoiImageFilter.h>

Inheritance diagram for mitk::MaskAndCutRoiImageFilter:
Collaboration diagram for mitk::MaskAndCutRoiImageFilter:

Public Member Functions

 mitkClassMacro (MaskAndCutRoiImageFilter, ImageToImageFilter)
 
Pointer Clone () const
 
virtual mitk::ScalarType GetMaxValue ()
 
virtual mitk::ScalarType GetMinValue ()
 
void SetRegionOfInterest (mitk::BaseData *roi)
 
mitk::Image::Pointer GetOutput ()
 
- 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)
 
InputImageTypeGetInput (void)
 
InputImageTypeGetInput (unsigned int idx)
 
const InputImageTypeGetInput (void) const
 
const InputImageTypeGetInput (unsigned int idx) const
 
- Public Member Functions inherited from mitk::ImageSource
Pointer Clone () const
 
OutputTypeGetOutput ()
 Get the output data of this image source object. More...
 
const OutputTypeGetOutput () const
 
OutputTypeGetOutput (DataObjectPointerArraySizeType idx)
 
const OutputTypeGetOutput (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
OutputTypeGetOutput ()
 
const OutputTypeGetOutput () const
 
OutputTypeGetOutput (DataObjectPointerArraySizeType idx)
 
const OutputTypeGetOutput (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

 MaskAndCutRoiImageFilter ()
 
 ~MaskAndCutRoiImageFilter ()
 
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
 
virtual void GenerateInputRequestedRegion () 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

ROIFilterType::Pointer m_RoiFilter
 
mitk::AutoCropImageFilter::Pointer m_CropFilter
 
mitk::MaskImageFilter::Pointer m_MaskFilter
 
mitk::Image::Pointer m_outputImage
 
mitk::ScalarType m_MaxValue
 
mitk::ScalarType m_MinValue
 

Additional Inherited Members

- Public Types inherited from mitk::ImageToImageFilter
typedef ImageToImageFilter Self
 
typedef ImageSource Superclass
 
typedef itk::SmartPointer< SelfPointer
 
typedef itk::SmartPointer< const SelfConstPointer
 
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< SelfPointer
 
typedef itk::SmartPointer< const SelfConstPointer
 
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< SelfPointer
 
typedef itk::SmartPointer< const SelfConstPointer
 
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

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

In the first step, this filter reduces the image region of the given ROI to a minimum. Using this region, a subvolume ist cut out of the given input image. The ROI is then used to mask the subvolume. Pixel inside the ROI will have their original value, pixel outside will be replaced by m_OutsideValue

Definition at line 39 of file mitkMaskAndCutRoiImageFilter.h.

Constructor & Destructor Documentation

mitk::MaskAndCutRoiImageFilter::MaskAndCutRoiImageFilter ( )
protected
mitk::MaskAndCutRoiImageFilter::~MaskAndCutRoiImageFilter ( )
protected

Definition at line 29 of file mitkMaskAndCutRoiImageFilter.cpp.

Member Function Documentation

Pointer mitk::MaskAndCutRoiImageFilter::Clone ( ) const
void mitk::MaskAndCutRoiImageFilter::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 61 of file mitkMaskAndCutRoiImageFilter.cpp.

References mitk::CastToItkImage(), mitk::CastToMitkImage(), mitk::New(), and mitk::Image::New().

virtual mitk::ScalarType mitk::MaskAndCutRoiImageFilter::GetMaxValue ( )
virtual
virtual mitk::ScalarType mitk::MaskAndCutRoiImageFilter::GetMinValue ( )
virtual
mitk::Image::Pointer mitk::MaskAndCutRoiImageFilter::GetOutput ( )

Definition at line 56 of file mitkMaskAndCutRoiImageFilter.cpp.

mitk::MaskAndCutRoiImageFilter::mitkClassMacro ( MaskAndCutRoiImageFilter  ,
ImageToImageFilter   
)
static Pointer mitk::MaskAndCutRoiImageFilter::New ( )
static
void mitk::MaskAndCutRoiImageFilter::SetRegionOfInterest ( mitk::BaseData roi)

Member Data Documentation

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

Definition at line 68 of file mitkMaskAndCutRoiImageFilter.h.

Referenced by MaskAndCutRoiImageFilter().

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

Definition at line 69 of file mitkMaskAndCutRoiImageFilter.h.

Referenced by MaskAndCutRoiImageFilter().

mitk::ScalarType mitk::MaskAndCutRoiImageFilter::m_MaxValue
protected

Definition at line 74 of file mitkMaskAndCutRoiImageFilter.h.

mitk::ScalarType mitk::MaskAndCutRoiImageFilter::m_MinValue
protected

Definition at line 75 of file mitkMaskAndCutRoiImageFilter.h.

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

Definition at line 72 of file mitkMaskAndCutRoiImageFilter.h.

ROIFilterType::Pointer mitk::MaskAndCutRoiImageFilter::m_RoiFilter
protected

Definition at line 67 of file mitkMaskAndCutRoiImageFilter.h.

Referenced by MaskAndCutRoiImageFilter().


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