Medical Imaging Interaction Toolkit  2021.02.99-89548602
Medical Imaging Interaction Toolkit
mitk::BoundingObjectCutter Class Reference

Cuts an Boundingobject out of an mitk Image. More...

#include <mitkBoundingObjectCutter.h>

Inheritance diagram for mitk::BoundingObjectCutter:
Collaboration diagram for mitk::BoundingObjectCutter:

Public Member Functions

 mitkClassMacro (BoundingObjectCutter, ImageToImageFilter)
 
Pointer Clone () const
 
void SetBoundingObject (const mitk::BoundingObject *boundingObject)
 
const mitk::BoundingObjectGetBoundingObject () const
 
virtual void SetInsideValue (ScalarType _arg)
 
virtual ScalarType GetInsideValue ()
 
virtual void SetOutsideValue (ScalarType _arg)
 
virtual ScalarType GetOutsideValue ()
 
virtual void SetUseInsideValue (bool _arg)
 
virtual bool GetUseInsideValue ()
 
virtual void UseInsideValueOn ()
 
virtual void UseInsideValueOff ()
 
virtual void SetAutoOutsideValue (bool _arg)
 
virtual bool GetAutoOutsideValue ()
 
virtual void AutoOutsideValueOn ()
 
virtual void AutoOutsideValueOff ()
 
virtual unsigned int GetInsidePixelCount ()
 
virtual unsigned int GetOutsidePixelCount ()
 
virtual void SetUseWholeInputRegion (bool _arg)
 
virtual bool GetUseWholeInputRegion ()
 
- 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

 BoundingObjectCutter ()
 
 ~BoundingObjectCutter () override
 
virtual const PixelType GetOutputPixelType ()
 
void GenerateInputRequestedRegion () override
 
void GenerateOutputInformation () override
 
void GenerateData () override
 
virtual void ComputeData (mitk::Image *input3D, int boTimeStep)
 
- 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::BoundingObject::Pointer m_BoundingObject
 
ScalarType m_InsideValue
 
ScalarType m_OutsideValue
 
bool m_AutoOutsideValue
 
bool m_UseInsideValue
 
unsigned int m_OutsidePixelCount
 
unsigned int m_InsidePixelCount
 
mitk::SlicedData::RegionType m_InputRequestedRegion
 
itk::TimeStamp m_TimeOfHeaderInitialization
 
mitk::ImageTimeSelector::Pointer m_InputTimeSelector
 
mitk::ImageTimeSelector::Pointer m_OutputTimeSelector
 
bool m_UseWholeInputRegion
 

Friends

template<typename TPixel , unsigned int VImageDimension, typename TOutputPixel >
void CutImageWithOutputTypeSelect (itk::Image< TPixel, VImageDimension > *inputItkImage, mitk::BoundingObjectCutter *cutter, int boTimeStep, TOutputPixel *dummy)
 
template<typename TPixel , unsigned int VImageDimension, typename TOutputPixel >
void CutImageWithOutputTypeSelect (itk::VectorImage< TPixel, VImageDimension > *inputItkImage, mitk::BoundingObjectCutter *cutter, int boTimeStep, TOutputPixel *dummy)
 
template<typename TPixel , unsigned int VImageDimension>
void CutImage (itk::Image< TPixel, VImageDimension > *itkImage, mitk::BoundingObjectCutter *cutter, int boTimeStep)
 
template<typename TPixel , unsigned int VImageDimension>
void CutImage (itk::VectorImage< TPixel, VImageDimension > *itkImage, mitk::BoundingObjectCutter *cutter, int boTimeStep)
 

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 an Boundingobject out of an mitk Image.

Input Parameters are a mitk::BoundingObject and optionally an mitk::Image if no mitk::Image is provided, the resulting image will have m_InsideValue as pixelvalue on inside pixel, otherwise it will have the pixelvalue of the input image. Pixel on the outside of the BoundingObject will have a pixelvalue of m_OutsideValue

Definition at line 34 of file mitkBoundingObjectCutter.h.

Constructor & Destructor Documentation

◆ BoundingObjectCutter()

mitk::BoundingObjectCutter::BoundingObjectCutter ( )
protected

◆ ~BoundingObjectCutter()

mitk::BoundingObjectCutter::~BoundingObjectCutter ( )
overrideprotected

Member Function Documentation

◆ AutoOutsideValueOff()

virtual void mitk::BoundingObjectCutter::AutoOutsideValueOff ( )
virtual

◆ AutoOutsideValueOn()

virtual void mitk::BoundingObjectCutter::AutoOutsideValueOn ( )
virtual

◆ Clone()

Pointer mitk::BoundingObjectCutter::Clone ( ) const

◆ ComputeData()

virtual void mitk::BoundingObjectCutter::ComputeData ( mitk::Image input3D,
int  boTimeStep 
)
protectedvirtual

◆ GenerateData()

void mitk::BoundingObjectCutter::GenerateData ( )
overrideprotected

◆ GenerateInputRequestedRegion()

void mitk::BoundingObjectCutter::GenerateInputRequestedRegion ( )
overrideprotected

◆ GenerateOutputInformation()

void mitk::BoundingObjectCutter::GenerateOutputInformation ( )
overrideprotected

◆ GetAutoOutsideValue()

virtual bool mitk::BoundingObjectCutter::GetAutoOutsideValue ( )
virtual

◆ GetBoundingObject()

const mitk::BoundingObject* mitk::BoundingObjectCutter::GetBoundingObject ( ) const

◆ GetInsidePixelCount()

virtual unsigned int mitk::BoundingObjectCutter::GetInsidePixelCount ( )
virtual

◆ GetInsideValue()

virtual ScalarType mitk::BoundingObjectCutter::GetInsideValue ( )
virtual

◆ GetOutputPixelType()

virtual const PixelType mitk::BoundingObjectCutter::GetOutputPixelType ( )
protectedvirtual

◆ GetOutsidePixelCount()

virtual unsigned int mitk::BoundingObjectCutter::GetOutsidePixelCount ( )
virtual

◆ GetOutsideValue()

virtual ScalarType mitk::BoundingObjectCutter::GetOutsideValue ( )
virtual

◆ GetUseInsideValue()

virtual bool mitk::BoundingObjectCutter::GetUseInsideValue ( )
virtual

◆ GetUseWholeInputRegion()

virtual bool mitk::BoundingObjectCutter::GetUseWholeInputRegion ( )
virtual

◆ mitkClassMacro()

mitk::BoundingObjectCutter::mitkClassMacro ( BoundingObjectCutter  ,
ImageToImageFilter   
)

◆ New()

static Pointer mitk::BoundingObjectCutter::New ( )
static

◆ SetAutoOutsideValue()

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

◆ SetBoundingObject()

void mitk::BoundingObjectCutter::SetBoundingObject ( const mitk::BoundingObject boundingObject)

◆ SetInsideValue()

virtual void mitk::BoundingObjectCutter::SetInsideValue ( ScalarType  _arg)
virtual

◆ SetOutsideValue()

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

◆ SetUseInsideValue()

virtual void mitk::BoundingObjectCutter::SetUseInsideValue ( bool  _arg)
virtual

◆ SetUseWholeInputRegion()

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

◆ UseInsideValueOff()

virtual void mitk::BoundingObjectCutter::UseInsideValueOff ( )
virtual

◆ UseInsideValueOn()

virtual void mitk::BoundingObjectCutter::UseInsideValueOn ( )
virtual

Friends And Related Function Documentation

◆ CutImage [1/2]

template<typename TPixel , unsigned int VImageDimension>
void CutImage ( itk::Image< TPixel, VImageDimension > *  itkImage,
mitk::BoundingObjectCutter cutter,
int  boTimeStep 
)
friend

◆ CutImage [2/2]

template<typename TPixel , unsigned int VImageDimension>
void CutImage ( itk::VectorImage< TPixel, VImageDimension > *  itkImage,
mitk::BoundingObjectCutter cutter,
int  boTimeStep 
)
friend

◆ CutImageWithOutputTypeSelect [1/2]

template<typename TPixel , unsigned int VImageDimension, typename TOutputPixel >
void CutImageWithOutputTypeSelect ( itk::Image< TPixel, VImageDimension > *  inputItkImage,
mitk::BoundingObjectCutter cutter,
int  boTimeStep,
TOutputPixel *  dummy 
)
friend

◆ CutImageWithOutputTypeSelect [2/2]

template<typename TPixel , unsigned int VImageDimension, typename TOutputPixel >
void CutImageWithOutputTypeSelect ( itk::VectorImage< TPixel, VImageDimension > *  inputItkImage,
mitk::BoundingObjectCutter cutter,
int  boTimeStep,
TOutputPixel *  dummy 
)
friend

Member Data Documentation

◆ m_AutoOutsideValue

bool mitk::BoundingObjectCutter::m_AutoOutsideValue
protected

Definition at line 113 of file mitkBoundingObjectCutter.h.

◆ m_BoundingObject

mitk::BoundingObject::Pointer mitk::BoundingObjectCutter::m_BoundingObject
protected

Definition at line 99 of file mitkBoundingObjectCutter.h.

◆ m_InputRequestedRegion

mitk::SlicedData::RegionType mitk::BoundingObjectCutter::m_InputRequestedRegion
protected

Definition at line 128 of file mitkBoundingObjectCutter.h.

◆ m_InputTimeSelector

mitk::ImageTimeSelector::Pointer mitk::BoundingObjectCutter::m_InputTimeSelector
protected

Definition at line 134 of file mitkBoundingObjectCutter.h.

◆ m_InsidePixelCount

unsigned int mitk::BoundingObjectCutter::m_InsidePixelCount
protected

Definition at line 124 of file mitkBoundingObjectCutter.h.

◆ m_InsideValue

ScalarType mitk::BoundingObjectCutter::m_InsideValue
protected

Definition at line 104 of file mitkBoundingObjectCutter.h.

◆ m_OutputTimeSelector

mitk::ImageTimeSelector::Pointer mitk::BoundingObjectCutter::m_OutputTimeSelector
protected

Definition at line 135 of file mitkBoundingObjectCutter.h.

◆ m_OutsidePixelCount

unsigned int mitk::BoundingObjectCutter::m_OutsidePixelCount
protected

Definition at line 123 of file mitkBoundingObjectCutter.h.

◆ m_OutsideValue

ScalarType mitk::BoundingObjectCutter::m_OutsideValue
protected

Definition at line 109 of file mitkBoundingObjectCutter.h.

◆ m_TimeOfHeaderInitialization

itk::TimeStamp mitk::BoundingObjectCutter::m_TimeOfHeaderInitialization
protected

Definition at line 132 of file mitkBoundingObjectCutter.h.

◆ m_UseInsideValue

bool mitk::BoundingObjectCutter::m_UseInsideValue
protected

Definition at line 121 of file mitkBoundingObjectCutter.h.

◆ m_UseWholeInputRegion

bool mitk::BoundingObjectCutter::m_UseWholeInputRegion
protected

Definition at line 137 of file mitkBoundingObjectCutter.h.


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