Medical Imaging Interaction Toolkit  2018.04.99-3ec0dd08
Medical Imaging Interaction Toolkit
mitk::MaskImageFilter Class Reference

#include <mitkMaskImageFilter.h>

Inheritance diagram for mitk::MaskImageFilter:
Collaboration diagram for mitk::MaskImageFilter:

Public Member Functions

 mitkClassMacro (MaskImageFilter, ImageToImageFilter)
 
Pointer Clone () const
 
void SetMask (const mitk::Image *mask)
 
const mitk::ImageGetMask () const
 
virtual mitk::ScalarType GetMinValue ()
 
virtual void SetMinValue (mitk::ScalarType _arg)
 
virtual mitk::ScalarType GetMaxValue ()
 
virtual void SetMaxValue (mitk::ScalarType _arg)
 
virtual void SetOutsideValue (mitk::ScalarType _arg)
 
virtual mitk::ScalarType GetOutsideValue ()
 
virtual void SetOverrideOutsideValue (bool _arg)
 
virtual bool GetOverrideOutsideValue ()
 
virtual void OverrideOutsideValueOn ()
 
virtual void OverrideOutsideValueOff ()
 
- 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
 
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
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

 MaskImageFilter ()
 
 ~MaskImageFilter () override
 
void GenerateInputRequestedRegion () override
 
void GenerateOutputInformation () override
 
void GenerateData () override
 
template<typename TPixel , unsigned int VImageDimension>
void InternalComputeMask (itk::Image< TPixel, VImageDimension > *itkImage)
 
- 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::Image::Pointer m_Mask
 
mitk::ImageTimeSelector::Pointer m_InputTimeSelector
 
mitk::ImageTimeSelector::Pointer m_MaskTimeSelector
 
mitk::ImageTimeSelector::Pointer m_OutputTimeSelector
 
itk::TimeStamp m_TimeOfHeaderInitialization
 
mitk::ScalarType m_OutsideValue
 
mitk::ScalarType m_MinValue
 
mitk::ScalarType m_MaxValue
 
bool m_OverrideOutsideValue
 

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

Definition at line 28 of file mitkMaskImageFilter.h.

Constructor & Destructor Documentation

◆ MaskImageFilter()

mitk::MaskImageFilter::MaskImageFilter ( )
protected

◆ ~MaskImageFilter()

mitk::MaskImageFilter::~MaskImageFilter ( )
overrideprotected

Member Function Documentation

◆ Clone()

Pointer mitk::MaskImageFilter::Clone ( ) const

◆ GenerateData()

void mitk::MaskImageFilter::GenerateData ( )
overrideprotected

◆ GenerateInputRequestedRegion()

void mitk::MaskImageFilter::GenerateInputRequestedRegion ( )
overrideprotected

◆ GenerateOutputInformation()

void mitk::MaskImageFilter::GenerateOutputInformation ( )
overrideprotected

◆ GetMask()

const mitk::Image* mitk::MaskImageFilter::GetMask ( ) const

◆ GetMaxValue()

virtual mitk::ScalarType mitk::MaskImageFilter::GetMaxValue ( )
virtual

get/set the max Value of the original image in the masked area

◆ GetMinValue()

virtual mitk::ScalarType mitk::MaskImageFilter::GetMinValue ( )
virtual

get/set the min Value of the original image in the masked area

◆ GetOutsideValue()

virtual mitk::ScalarType mitk::MaskImageFilter::GetOutsideValue ( )
virtual

This value is used as outside value. This only works if OverrideOutsideValue is set to true. Default is 0.

◆ GetOverrideOutsideValue()

virtual bool mitk::MaskImageFilter::GetOverrideOutsideValue ( )
virtual

If OverrideOutsideValue is set to false, this minimum of the pixel type of the output image is taken as outside value. If set to true, the value set via SetOutsideValue is used as background.

◆ InternalComputeMask()

template<typename TPixel , unsigned int VImageDimension>
void mitk::MaskImageFilter::InternalComputeMask ( itk::Image< TPixel, VImageDimension > *  itkImage)
protected

◆ mitkClassMacro()

mitk::MaskImageFilter::mitkClassMacro ( MaskImageFilter  ,
ImageToImageFilter   
)

◆ New()

static Pointer mitk::MaskImageFilter::New ( )
static

◆ OverrideOutsideValueOff()

virtual void mitk::MaskImageFilter::OverrideOutsideValueOff ( )
virtual

◆ OverrideOutsideValueOn()

virtual void mitk::MaskImageFilter::OverrideOutsideValueOn ( )
virtual

◆ SetMask()

void mitk::MaskImageFilter::SetMask ( const mitk::Image mask)

◆ SetMaxValue()

virtual void mitk::MaskImageFilter::SetMaxValue ( mitk::ScalarType  _arg)
virtual

◆ SetMinValue()

virtual void mitk::MaskImageFilter::SetMinValue ( mitk::ScalarType  _arg)
virtual

◆ SetOutsideValue()

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

This value is used as outside value. This only works if OverrideOutsideValue is set to true. Default is 0.

◆ SetOverrideOutsideValue()

virtual void mitk::MaskImageFilter::SetOverrideOutsideValue ( bool  _arg)
virtual

If OverrideOutsideValue is set to false, this minimum of the pixel type of the output image is taken as outside value. If set to true, the value set via SetOutsideValue is used as background.

Member Data Documentation

◆ m_InputTimeSelector

mitk::ImageTimeSelector::Pointer mitk::MaskImageFilter::m_InputTimeSelector
protected

Definition at line 95 of file mitkMaskImageFilter.h.

◆ m_Mask

mitk::Image::Pointer mitk::MaskImageFilter::m_Mask
protected

Definition at line 94 of file mitkMaskImageFilter.h.

◆ m_MaskTimeSelector

mitk::ImageTimeSelector::Pointer mitk::MaskImageFilter::m_MaskTimeSelector
protected

Definition at line 96 of file mitkMaskImageFilter.h.

◆ m_MaxValue

mitk::ScalarType mitk::MaskImageFilter::m_MaxValue
protected

Definition at line 105 of file mitkMaskImageFilter.h.

◆ m_MinValue

mitk::ScalarType mitk::MaskImageFilter::m_MinValue
protected

Definition at line 104 of file mitkMaskImageFilter.h.

◆ m_OutputTimeSelector

mitk::ImageTimeSelector::Pointer mitk::MaskImageFilter::m_OutputTimeSelector
protected

Definition at line 97 of file mitkMaskImageFilter.h.

◆ m_OutsideValue

mitk::ScalarType mitk::MaskImageFilter::m_OutsideValue
protected

Definition at line 103 of file mitkMaskImageFilter.h.

◆ m_OverrideOutsideValue

bool mitk::MaskImageFilter::m_OverrideOutsideValue
protected

Definition at line 106 of file mitkMaskImageFilter.h.

◆ m_TimeOfHeaderInitialization

itk::TimeStamp mitk::MaskImageFilter::m_TimeOfHeaderInitialization
protected

Definition at line 101 of file mitkMaskImageFilter.h.


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