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

#include <mitkRGBToRGBACastImageFilter.h>

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

Public Types

typedef RGBToRGBACastImageFilter Self
 
typedef ImageToImageFilter Superclass
 
typedef itk::SmartPointer< SelfPointer
 
typedef itk::SmartPointer< const SelfConstPointer
 
- 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

virtual std::vector< std::string > GetClassHierarchy () const override
 
virtual const char * GetClassName () const
 
Pointer Clone () const
 
- Public Member Functions inherited from mitk::ImageToImageFilter
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
 
virtual itk::DataObject::Pointer MakeOutput (DataObjectPointerArraySizeType idx) override
 Make a DataObject of the correct type to used as the specified output. More...
 
virtual 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 const char * GetStaticNameOfClass ()
 
static Pointer New ()
 
static bool IsRGBImage (const mitk::Image *image)
 
- 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 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 ()
 
virtual void GenerateInputRequestedRegion () override
 
virtual void GenerateOutputInformation () override
 
virtual void GenerateData () override
 A version of GenerateData() specific for image processing filters. More...
 
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 ()
 
virtual ~ImageToImageFilter ()
 
virtual void PrintSelf (std::ostream &os, itk::Indent indent) const override
 
- Protected Member Functions inherited from mitk::ImageSource
 ImageSource ()
 
virtual ~ImageSource ()
 
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...
 
virtual 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 ()
 
virtual ~BaseDataSource ()
 

Protected Attributes

mitk::ImageTimeSelector::Pointer m_InputTimeSelector
 
mitk::ImageTimeSelector::Pointer m_OutputTimeSelector
 
itk::TimeStamp m_TimeOfHeaderInitialization
 

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

Definition at line 37 of file mitkRGBToRGBACastImageFilter.h.

Member Typedef Documentation

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

Definition at line 56 of file mitkRGBToRGBACastImageFilter.h.

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

Definition at line 55 of file mitkRGBToRGBACastImageFilter.h.

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

Definition at line 53 of file mitkRGBToRGBACastImageFilter.h.

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

Definition at line 54 of file mitkRGBToRGBACastImageFilter.h.

Constructor & Destructor Documentation

mitk::RGBToRGBACastImageFilter::RGBToRGBACastImageFilter ( )
protected
mitk::RGBToRGBACastImageFilter::~RGBToRGBACastImageFilter ( )
protected

Definition at line 37 of file mitkRGBToRGBACastImageFilter.cpp.

Member Function Documentation

Pointer mitk::RGBToRGBACastImageFilter::Clone ( ) const
void mitk::RGBToRGBACastImageFilter::GenerateData ( )
overrideprotectedvirtual

A version of GenerateData() specific for image processing filters.

This implementation will split the processing across multiple threads. The buffer is allocated by this method. Then the BeforeThreadedGenerateData() method is called (if provided). Then, a series of threads are spawned each calling ThreadedGenerateData(). After all the threads have completed processing, the AfterThreadedGenerateData() method is called (if provided). If an image processing filter cannot be threaded, the filter should provide an implementation of GenerateData(). That implementation is responsible for allocating the output buffer. If a filter an be threaded, it should NOT provide a GenerateData() method but should provide a ThreadedGenerateData() instead.

See also
ThreadedGenerateData()

Reimplemented from mitk::ImageSource.

Definition at line 117 of file mitkRGBToRGBACastImageFilter.cpp.

References AccessFixedPixelTypeByItk_2, mitk::Image::GetPixelType(), mitk::MakePixelType(), mitk::TimeGeometry::TimePointToTimeStep(), and mitk::TimeGeometry::TimeStepToTimePoint().

void mitk::RGBToRGBACastImageFilter::GenerateInputRequestedRegion ( )
overrideprotectedvirtual

What is the input requested region that is required to produce the output requested region? The base assumption for image processing filters is that the input requested region can be set to match the output requested region. If a filter requires more input (for instance a filter that uses neighborhoods needs more input than output to avoid introducing artificial boundary conditions) or less input (for instance a magnify filter) will have to override this method. In doing so, it should call its superclass' implementation as its first step. Note that this imaging filters operate differently than the classes to this point in the class hierachy. Up till now, the base assumption has been that the largest possible region will be requested of the input.

See also
ProcessObject::GenerateInputRequestedRegion(), ImageSource::GenerateInputRequestedRegion()

Reimplemented from mitk::ImageToImageFilter.

Definition at line 57 of file mitkRGBToRGBACastImageFilter.cpp.

References mitk::BaseData::IsInitialized(), and mitk::SlicedData::SetRequestedRegionToLargestPossibleRegion().

void mitk::RGBToRGBACastImageFilter::GenerateOutputInformation ( )
overrideprotectedvirtual

Definition at line 73 of file mitkRGBToRGBACastImageFilter.cpp.

virtual std::vector<std::string> mitk::RGBToRGBACastImageFilter::GetClassHierarchy ( ) const
inlineoverridevirtual

Reimplemented from mitk::ImageToImageFilter.

Definition at line 40 of file mitkRGBToRGBACastImageFilter.h.

virtual const char* mitk::RGBToRGBACastImageFilter::GetClassName ( ) const
virtual

Reimplemented from mitk::ImageToImageFilter.

static const char* mitk::RGBToRGBACastImageFilter::GetStaticNameOfClass ( )
inlinestatic

Definition at line 40 of file mitkRGBToRGBACastImageFilter.h.

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

Static convenience method to check if the passed mitk::Image is an RGB image in the sense of this converter filter.

Returns falsefor RGBA and all other images.

Definition at line 41 of file mitkRGBToRGBACastImageFilter.cpp.

References mitk::PixelType::GetComponentType(), mitk::PixelType::GetPixelType(), and mitk::Image::GetPixelType().

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

Member Data Documentation

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

Definition at line 73 of file mitkRGBToRGBACastImageFilter.h.

Referenced by RGBToRGBACastImageFilter().

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

Definition at line 74 of file mitkRGBToRGBACastImageFilter.h.

Referenced by InternalCast(), and RGBToRGBACastImageFilter().

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

Definition at line 78 of file mitkRGBToRGBACastImageFilter.h.


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