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

Image filter that casts RGB images to RGBA by adding a fully opaque alpha channel. More...

#include <mitkRGBToRGBACastImageFilter.h>

Inheritance diagram for mitk::RGBToRGBACastImageFilter:
Collaboration diagram for mitk::RGBToRGBACastImageFilter:

Public Member Functions

 mitkClassMacro (RGBToRGBACastImageFilter, ImageToImageFilter)
 
Pointer Clone () const
 
- 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 bool IsRGBImage (const mitk::Image *image)
 Checks if the passed mitk::Image is an RGB image supported by this filter. More...
 
- 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 Types

typedef itk::RGBPixel< unsigned char > UCRGBPixelType
 
typedef itk::RGBPixel< unsigned short > USRGBPixelType
 
typedef itk::RGBPixel< float > FloatRGBPixelType
 
typedef itk::RGBPixel< double > DoubleRGBPixelType
 

Protected Member Functions

 RGBToRGBACastImageFilter ()
 
 ~RGBToRGBACastImageFilter () override
 
void GenerateInputRequestedRegion () override
 
void GenerateOutputInformation () override
 
void GenerateData () override
 
template<typename TPixel , unsigned int VImageDimension>
void InternalCast (itk::Image< TPixel, VImageDimension > *itkImage, mitk::RGBToRGBACastImageFilter *addComponentFilter, typename TPixel::ComponentType defaultAlpha)
 
- 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...
 

Protected Attributes

mitk::ImageTimeSelector::Pointer m_InputTimeSelector
 
mitk::ImageTimeSelector::Pointer m_OutputTimeSelector
 
itk::TimeStamp m_TimeOfHeaderInitialization
 Time when the output header was last initialized. 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

Image filter that casts RGB images to RGBA by adding a fully opaque alpha channel.

This filter takes a mitk::Image with RGB pixel type (unsigned char, unsigned short, float, or double components) and produces an output image with an RGBA pixel type where the alpha channel is set to the maximum value for the component type.

See also
ImageToImageFilter

Definition at line 40 of file mitkRGBToRGBACastImageFilter.h.

Member Typedef Documentation

◆ DoubleRGBPixelType

typedef itk::RGBPixel<double> mitk::RGBToRGBACastImageFilter::DoubleRGBPixelType
protected

Definition at line 64 of file mitkRGBToRGBACastImageFilter.h.

◆ FloatRGBPixelType

typedef itk::RGBPixel<float> mitk::RGBToRGBACastImageFilter::FloatRGBPixelType
protected

Definition at line 63 of file mitkRGBToRGBACastImageFilter.h.

◆ UCRGBPixelType

typedef itk::RGBPixel<unsigned char> mitk::RGBToRGBACastImageFilter::UCRGBPixelType
protected

Definition at line 61 of file mitkRGBToRGBACastImageFilter.h.

◆ USRGBPixelType

typedef itk::RGBPixel<unsigned short> mitk::RGBToRGBACastImageFilter::USRGBPixelType
protected

Definition at line 62 of file mitkRGBToRGBACastImageFilter.h.

Constructor & Destructor Documentation

◆ RGBToRGBACastImageFilter()

mitk::RGBToRGBACastImageFilter::RGBToRGBACastImageFilter ( )
protected

◆ ~RGBToRGBACastImageFilter()

mitk::RGBToRGBACastImageFilter::~RGBToRGBACastImageFilter ( )
overrideprotected

Member Function Documentation

◆ Clone()

Pointer mitk::RGBToRGBACastImageFilter::Clone ( ) const

◆ GenerateData()

void mitk::RGBToRGBACastImageFilter::GenerateData ( )
overrideprotected

◆ GenerateInputRequestedRegion()

void mitk::RGBToRGBACastImageFilter::GenerateInputRequestedRegion ( )
overrideprotected

◆ GenerateOutputInformation()

void mitk::RGBToRGBACastImageFilter::GenerateOutputInformation ( )
overrideprotected

◆ InternalCast()

template<typename TPixel , unsigned int VImageDimension>
void mitk::RGBToRGBACastImageFilter::InternalCast ( itk::Image< TPixel, VImageDimension > *  itkImage,
mitk::RGBToRGBACastImageFilter *  addComponentFilter,
typename TPixel::ComponentType  defaultAlpha 
)
protected

◆ IsRGBImage()

static bool mitk::RGBToRGBACastImageFilter::IsRGBImage ( const mitk::Image *  image)
static

Checks if the passed mitk::Image is an RGB image supported by this filter.

Supported component types are unsigned char, unsigned short, float, and double. Returns false for RGBA and all other pixel types.

Parameters
imagethe image to check.
Returns
True if the image has an RGB pixel type with a supported component type.

◆ mitkClassMacro()

mitk::RGBToRGBACastImageFilter::mitkClassMacro ( RGBToRGBACastImageFilter  ,
ImageToImageFilter   
)

◆ New()

static Pointer mitk::RGBToRGBACastImageFilter::New ( )
static

Member Data Documentation

◆ m_InputTimeSelector

mitk::ImageTimeSelector::Pointer mitk::RGBToRGBACastImageFilter::m_InputTimeSelector
protected

Definition at line 81 of file mitkRGBToRGBACastImageFilter.h.

◆ m_OutputTimeSelector

mitk::ImageTimeSelector::Pointer mitk::RGBToRGBACastImageFilter::m_OutputTimeSelector
protected

Definition at line 82 of file mitkRGBToRGBACastImageFilter.h.

◆ m_TimeOfHeaderInitialization

itk::TimeStamp mitk::RGBToRGBACastImageFilter::m_TimeOfHeaderInitialization
protected

Time when the output header was last initialized.

Definition at line 85 of file mitkRGBToRGBACastImageFilter.h.


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