Medical Imaging Interaction Toolkit  2026.06.00
Medical Imaging Interaction Toolkit
mitk::PadImageFilter Class Reference

PadImageFilter class pads the first input image to the size of the second input image. Two Images have to be set. The first image is the image to pad. The second image defines the pad size. It is also possible to use an included binary filter. More...

#include <mitkPadImageFilter.h>

Inheritance diagram for mitk::PadImageFilter:
Collaboration diagram for mitk::PadImageFilter:

Public Member Functions

 mitkClassMacro (PadImageFilter, ImageToImageFilter)
 
Pointer Clone () const
 
virtual void SetPadConstant (int _arg)
 Set the intensity value used for padded pixels (default: -32766). More...
 
virtual void SetBinaryFilter (bool _arg)
 Enable or disable the binary threshold filter applied after padding. More...
 
virtual void SetLowerThreshold (int _arg)
 Set the lower threshold of the binary filter. More...
 
virtual void SetUpperThreshold (int _arg)
 Set the upper threshold of the binary filter. 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

 PadImageFilter ()
 
 ~PadImageFilter () 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...
 

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

PadImageFilter class pads the first input image to the size of the second input image. Two Images have to be set. The first image is the image to pad. The second image defines the pad size. It is also possible to use an included binary filter.

Definition at line 33 of file mitkPadImageFilter.h.

Constructor & Destructor Documentation

◆ PadImageFilter()

mitk::PadImageFilter::PadImageFilter ( )
protected

◆ ~PadImageFilter()

mitk::PadImageFilter::~PadImageFilter ( )
overrideprotected

Member Function Documentation

◆ Clone()

Pointer mitk::PadImageFilter::Clone ( ) const

◆ GenerateData()

void mitk::PadImageFilter::GenerateData ( )
overrideprotected

◆ mitkClassMacro()

mitk::PadImageFilter::mitkClassMacro ( PadImageFilter  ,
ImageToImageFilter   
)

◆ New()

static Pointer mitk::PadImageFilter::New ( )
static

◆ SetBinaryFilter()

virtual void mitk::PadImageFilter::SetBinaryFilter ( bool  _arg)
virtual

Enable or disable the binary threshold filter applied after padding.

When enabled, the padded image is binarized using LowerThreshold and UpperThreshold, producing an unsigned char output.

Parameters
[in]_argTrue to enable the binary filter, false to disable.

◆ SetLowerThreshold()

virtual void mitk::PadImageFilter::SetLowerThreshold ( int  _arg)
virtual

Set the lower threshold of the binary filter.

Pixels with values at or above this threshold (and at or below UpperThreshold) are set to 1; others are set to 0.

Parameters
[in]_argThe lower threshold value (default: -32766).

◆ SetPadConstant()

virtual void mitk::PadImageFilter::SetPadConstant ( int  _arg)
virtual

Set the intensity value used for padded pixels (default: -32766).

Parameters
[in]_argThe pad constant value.

◆ SetUpperThreshold()

virtual void mitk::PadImageFilter::SetUpperThreshold ( int  _arg)
virtual

Set the upper threshold of the binary filter.

Pixels with values at or below this threshold (and at or above LowerThreshold) are set to 1; others are set to 0.

Parameters
[in]_argThe upper threshold value (default: -32765).

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