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

Filter for clipping an image with an height-field represented by an mitk::Surface. More...

#include <mitkHeightFieldSurfaceClipImageFilter.h>

Inheritance diagram for mitk::HeightFieldSurfaceClipImageFilter:
Collaboration diagram for mitk::HeightFieldSurfaceClipImageFilter:

Public Types

enum  { CLIPPING_MODE_CONSTANT, CLIPPING_MODE_MULTIPLYBYFACTOR, CLIPPING_MODE_MULTIPLANE }
 
typedef std::vector< mitk::Surface * > ClippingPlaneList
 
- 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
 

Public Member Functions

 mitkClassMacro (HeightFieldSurfaceClipImageFilter, ImageToImageFilter)
 
Pointer Clone () const
 
void SetClippingSurface (Surface *clippingSurface)
 Set/Get the surface defining a height field as a triangle mesh. More...
 
void SetClippingSurfaces (ClippingPlaneList planeList)
 Set/Get the surfaces defining a height field as a triangle mesh. More...
 
const SurfaceGetClippingSurface () const
 Set/Get the surface defining a height field as a triangle mesh. More...
 
void SetClippingMode (int mode)
 Specifies whether clipped part of the image shall be replaced by a constant or multiplied by a user-set factor. More...
 
int GetClippingMode ()
 Specifies whether clipped part of the image shall be replaced by a constant or multiplied by a user-set factor. More...
 
void SetClippingModeToConstant ()
 Specifies whether clipped part of the image shall be replaced by a constant or multiplied by a user-set factor. More...
 
void SetClippingModeToMultiplyByFactor ()
 Specifies whether clipped part of the image shall be replaced by a constant or multiplied by a user-set factor. More...
 
void SetClippingModeToMultiPlaneValue ()
 
virtual void SetClippingConstant (ScalarType _arg)
 Set/Get constant gray-value for clipping in CONSTANT mode. More...
 
virtual ScalarType GetClippingConstant () const
 Set/Get constant gray-value for clipping in CONSTANT mode. More...
 
virtual void SetMultiplicationFactor (ScalarType _arg)
 Set/Get multiplaction factor for clipping in MULTIPLYBYFACTOR mode. More...
 
virtual ScalarType GetMultiplicationFactor () const
 Set/Get multiplaction factor for clipping in MULTIPLYBYFACTOR mode. More...
 
virtual void SetHeightFieldResolutionX (unsigned int _arg)
 Set/Get x-resolution of height-field sampling (default: 256). More...
 
virtual unsigned int GetHeightFieldResolutionX () const
 Set/Get x-resolution of height-field sampling (default: 256). More...
 
virtual void SetHeightFieldResolutionY (unsigned int _arg)
 Set/Get y-resolution of height-field sampling (default: 256). More...
 
virtual unsigned int GetHeightFieldResolutionY () const
 Set/Get y-resolution of height-field sampling (default: 256). More...
 
- 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

 HeightFieldSurfaceClipImageFilter ()
 
 ~HeightFieldSurfaceClipImageFilter () override
 
void GenerateInputRequestedRegion () override
 
void GenerateOutputInformation () override
 
void GenerateData () override
 
template<typename TPixel , unsigned int VImageDimension>
void _InternalComputeClippedImage (itk::Image< TPixel, VImageDimension > *itkImage, HeightFieldSurfaceClipImageFilter *clipImageFilter, vtkPolyData *clippingPolyData, AffineTransform3D *imageToPlaneTransform)
 
- 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

ImageTimeSelector::Pointer m_InputTimeSelector
 
ImageTimeSelector::Pointer m_OutputTimeSelector
 
int m_ClippingMode
 
ScalarType m_ClippingConstant
 
ScalarType m_MultiplicationFactor
 
unsigned m_MultiPlaneValue
 
unsigned int m_HeightFieldResolutionX
 
unsigned int m_HeightFieldResolutionY
 
double m_MaxHeight
 
itk::TimeStamp m_TimeOfHeaderInitialization
 Time when Header was last initialized. More...
 

Additional Inherited Members

- 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

Filter for clipping an image with an height-field represented by an mitk::Surface.

The filter assumes that the surface represents a height field as seen from the plane defined by (1.0/0.0/0.0), (0.0/1.0/0.0). All voxels lying on one side of the height field will be clipped, i.e., set to 0. In addition, any voxels which are out of bounds when projected on this plane will be clipped as well.

Definition at line 43 of file mitkHeightFieldSurfaceClipImageFilter.h.

Member Typedef Documentation

◆ ClippingPlaneList

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
Enumerator
CLIPPING_MODE_CONSTANT 
CLIPPING_MODE_MULTIPLYBYFACTOR 
CLIPPING_MODE_MULTIPLANE 

Definition at line 63 of file mitkHeightFieldSurfaceClipImageFilter.h.

Constructor & Destructor Documentation

◆ HeightFieldSurfaceClipImageFilter()

mitk::HeightFieldSurfaceClipImageFilter::HeightFieldSurfaceClipImageFilter ( )
protected

◆ ~HeightFieldSurfaceClipImageFilter()

mitk::HeightFieldSurfaceClipImageFilter::~HeightFieldSurfaceClipImageFilter ( )
overrideprotected

Member Function Documentation

◆ _InternalComputeClippedImage()

template<typename TPixel , unsigned int VImageDimension>
void mitk::HeightFieldSurfaceClipImageFilter::_InternalComputeClippedImage ( itk::Image< TPixel, VImageDimension > *  itkImage,
HeightFieldSurfaceClipImageFilter clipImageFilter,
vtkPolyData *  clippingPolyData,
AffineTransform3D imageToPlaneTransform 
)
protected

◆ Clone()

Pointer mitk::HeightFieldSurfaceClipImageFilter::Clone ( ) const

◆ GenerateData()

void mitk::HeightFieldSurfaceClipImageFilter::GenerateData ( )
overrideprotected

◆ GenerateInputRequestedRegion()

void mitk::HeightFieldSurfaceClipImageFilter::GenerateInputRequestedRegion ( )
overrideprotected

◆ GenerateOutputInformation()

void mitk::HeightFieldSurfaceClipImageFilter::GenerateOutputInformation ( )
overrideprotected

◆ GetClippingConstant()

virtual ScalarType mitk::HeightFieldSurfaceClipImageFilter::GetClippingConstant ( ) const
virtual

Set/Get constant gray-value for clipping in CONSTANT mode.

◆ GetClippingMode()

int mitk::HeightFieldSurfaceClipImageFilter::GetClippingMode ( )

Specifies whether clipped part of the image shall be replaced by a constant or multiplied by a user-set factor.

◆ GetClippingSurface()

const Surface* mitk::HeightFieldSurfaceClipImageFilter::GetClippingSurface ( ) const

Set/Get the surface defining a height field as a triangle mesh.

◆ GetHeightFieldResolutionX()

virtual unsigned int mitk::HeightFieldSurfaceClipImageFilter::GetHeightFieldResolutionX ( ) const
virtual

Set/Get x-resolution of height-field sampling (default: 256).

◆ GetHeightFieldResolutionY()

virtual unsigned int mitk::HeightFieldSurfaceClipImageFilter::GetHeightFieldResolutionY ( ) const
virtual

Set/Get y-resolution of height-field sampling (default: 256).

◆ GetMultiplicationFactor()

virtual ScalarType mitk::HeightFieldSurfaceClipImageFilter::GetMultiplicationFactor ( ) const
virtual

Set/Get multiplaction factor for clipping in MULTIPLYBYFACTOR mode.

◆ mitkClassMacro()

mitk::HeightFieldSurfaceClipImageFilter::mitkClassMacro ( HeightFieldSurfaceClipImageFilter  ,
ImageToImageFilter   
)

◆ New()

static Pointer mitk::HeightFieldSurfaceClipImageFilter::New ( )
static

◆ SetClippingConstant()

virtual void mitk::HeightFieldSurfaceClipImageFilter::SetClippingConstant ( ScalarType  _arg)
virtual

Set/Get constant gray-value for clipping in CONSTANT mode.

◆ SetClippingMode()

void mitk::HeightFieldSurfaceClipImageFilter::SetClippingMode ( int  mode)

Specifies whether clipped part of the image shall be replaced by a constant or multiplied by a user-set factor.

◆ SetClippingModeToConstant()

void mitk::HeightFieldSurfaceClipImageFilter::SetClippingModeToConstant ( )

Specifies whether clipped part of the image shall be replaced by a constant or multiplied by a user-set factor.

◆ SetClippingModeToMultiPlaneValue()

void mitk::HeightFieldSurfaceClipImageFilter::SetClippingModeToMultiPlaneValue ( )

◆ SetClippingModeToMultiplyByFactor()

void mitk::HeightFieldSurfaceClipImageFilter::SetClippingModeToMultiplyByFactor ( )

Specifies whether clipped part of the image shall be replaced by a constant or multiplied by a user-set factor.

◆ SetClippingSurface()

void mitk::HeightFieldSurfaceClipImageFilter::SetClippingSurface ( Surface clippingSurface)

Set/Get the surface defining a height field as a triangle mesh.

◆ SetClippingSurfaces()

void mitk::HeightFieldSurfaceClipImageFilter::SetClippingSurfaces ( ClippingPlaneList  planeList)

Set/Get the surfaces defining a height field as a triangle mesh.

◆ SetHeightFieldResolutionX()

virtual void mitk::HeightFieldSurfaceClipImageFilter::SetHeightFieldResolutionX ( unsigned int  _arg)
virtual

Set/Get x-resolution of height-field sampling (default: 256).

◆ SetHeightFieldResolutionY()

virtual void mitk::HeightFieldSurfaceClipImageFilter::SetHeightFieldResolutionY ( unsigned int  _arg)
virtual

Set/Get y-resolution of height-field sampling (default: 256).

◆ SetMultiplicationFactor()

virtual void mitk::HeightFieldSurfaceClipImageFilter::SetMultiplicationFactor ( ScalarType  _arg)
virtual

Set/Get multiplaction factor for clipping in MULTIPLYBYFACTOR mode.

Member Data Documentation

◆ m_ClippingConstant

ScalarType mitk::HeightFieldSurfaceClipImageFilter::m_ClippingConstant
protected

Definition at line 134 of file mitkHeightFieldSurfaceClipImageFilter.h.

◆ m_ClippingMode

int mitk::HeightFieldSurfaceClipImageFilter::m_ClippingMode
protected

Definition at line 132 of file mitkHeightFieldSurfaceClipImageFilter.h.

◆ m_HeightFieldResolutionX

unsigned int mitk::HeightFieldSurfaceClipImageFilter::m_HeightFieldResolutionX
protected

Definition at line 138 of file mitkHeightFieldSurfaceClipImageFilter.h.

◆ m_HeightFieldResolutionY

unsigned int mitk::HeightFieldSurfaceClipImageFilter::m_HeightFieldResolutionY
protected

Definition at line 139 of file mitkHeightFieldSurfaceClipImageFilter.h.

◆ m_InputTimeSelector

ImageTimeSelector::Pointer mitk::HeightFieldSurfaceClipImageFilter::m_InputTimeSelector
protected

Definition at line 129 of file mitkHeightFieldSurfaceClipImageFilter.h.

◆ m_MaxHeight

double mitk::HeightFieldSurfaceClipImageFilter::m_MaxHeight
protected

Definition at line 141 of file mitkHeightFieldSurfaceClipImageFilter.h.

◆ m_MultiPlaneValue

unsigned mitk::HeightFieldSurfaceClipImageFilter::m_MultiPlaneValue
protected

Definition at line 136 of file mitkHeightFieldSurfaceClipImageFilter.h.

◆ m_MultiplicationFactor

ScalarType mitk::HeightFieldSurfaceClipImageFilter::m_MultiplicationFactor
protected

Definition at line 135 of file mitkHeightFieldSurfaceClipImageFilter.h.

◆ m_OutputTimeSelector

ImageTimeSelector::Pointer mitk::HeightFieldSurfaceClipImageFilter::m_OutputTimeSelector
protected

Definition at line 130 of file mitkHeightFieldSurfaceClipImageFilter.h.

◆ m_TimeOfHeaderInitialization

itk::TimeStamp mitk::HeightFieldSurfaceClipImageFilter::m_TimeOfHeaderInitialization
protected

Time when Header was last initialized.

Definition at line 144 of file mitkHeightFieldSurfaceClipImageFilter.h.


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