mitk::ITKImageImport< TInputImage > Class Template Reference

Pipelined import of itk::Image. More...

#include <mitkITKImageImport.h>

Inheritance diagram for mitk::ITKImageImport< TInputImage >:

Collaboration diagram for mitk::ITKImageImport< TInputImage >:

Public Types
typedef ITKImageImport	Self
typedef ImageSource	Superclass
typedef itk::SmartPointer< Self >	Pointer
typedef itk::SmartPointer< const Self >	ConstPointer
typedef TInputImage	InputImageType
	The type of the input image. More...
typedef InputImageType::Pointer	InputImagePointer
typedef InputImageType::ConstPointer	InputImageConstPointer
typedef InputImageType::RegionType	InputImageRegionType
typedef InputImageType::PixelType	InputImagePixelType
Public Types inherited from mitk::ImageSource
typedef ImageSource	Self
typedef BaseDataSource	Superclass
typedef itk::SmartPointer< Self >	Pointer
typedef itk::SmartPointer< const Self >	ConstPointer
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< Self >	Pointer
typedef itk::SmartPointer< const Self >	ConstPointer
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
	itkStaticConstMacro (InputImageDimension, unsigned int, TInputImage::ImageDimension)
	itkStaticConstMacro (RegionDimension, unsigned int, mitk::SlicedData::RegionDimension)
InputImageType *	GetInput (void)
	Set the input itk::Image of this image importer. More...
void	SetInput (const InputImageType *)
	Set the input itk::Image of this image importer. More...
void	SetGeometry (const BaseGeometry *geometry)
	Set the Geometry of the result image (optional) More...
Public Member Functions inherited from mitk::ImageSource
Pointer	Clone () const
OutputType *	GetOutput ()
	Get the output data of this image source object. More...
const OutputType *	GetOutput () const
OutputType *	GetOutput (DataObjectPointerArraySizeType idx)
const OutputType *	GetOutput (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
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)
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 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::ImageToImageFilterDetail::ImageRegionCopier< itkGetStaticConstMacro(InputImageDimension), itkGetStaticConstMacro(RegionDimension)>	OutputToInputRegionCopierType

Protected Member Functions
	ITKImageImport ()
virtual	~ITKImageImport ()
virtual void	GenerateOutputInformation () override
virtual void	GenerateInputRequestedRegion () override
virtual void	GenerateData () override
	A version of GenerateData() specific for image processing filters. More...
virtual void	SetNthOutput (DataObjectPointerArraySizeType num, itk::DataObject *output) 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
BaseGeometry::Pointer	m_Geometry

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

template<class TInputImage>
class mitk::ITKImageImport< TInputImage >

Pipelined import of itk::Image.

The image data contained in the itk::Image is referenced, not copied. The easiest way of use is by the function mitk::ImportItkImage

mitkImage = mitk::ImportItkImage(itkImage);

See also

ImportItkImage

Definition at line 40 of file mitkITKImageImport.h.

Member Typedef Documentation

template<class TInputImage >

typedef itk::SmartPointer<const Self> mitk::ITKImageImport< TInputImage >::ConstPointer

Definition at line 43 of file mitkITKImageImport.h.

template<class TInputImage >

typedef InputImageType::ConstPointer mitk::ITKImageImport< TInputImage >::InputImageConstPointer

Definition at line 48 of file mitkITKImageImport.h.

template<class TInputImage >

typedef InputImageType::PixelType mitk::ITKImageImport< TInputImage >::InputImagePixelType

Definition at line 50 of file mitkITKImageImport.h.

template<class TInputImage >

typedef InputImageType::Pointer mitk::ITKImageImport< TInputImage >::InputImagePointer

Definition at line 47 of file mitkITKImageImport.h.

template<class TInputImage >

typedef InputImageType::RegionType mitk::ITKImageImport< TInputImage >::InputImageRegionType

Definition at line 49 of file mitkITKImageImport.h.

template<class TInputImage >

typedef TInputImage mitk::ITKImageImport< TInputImage >::InputImageType

The type of the input image.

Definition at line 46 of file mitkITKImageImport.h.

template<class TInputImage >

typedef itk::ImageToImageFilterDetail::ImageRegionCopier<itkGetStaticConstMacro(InputImageDimension), itkGetStaticConstMacro(RegionDimension)> mitk::ITKImageImport< TInputImage >::OutputToInputRegionCopierType

protected

Typedef for the region copier function object that converts an output region to an input region.

Definition at line 93 of file mitkITKImageImport.h.

template<class TInputImage >

typedef itk::SmartPointer<Self> mitk::ITKImageImport< TInputImage >::Pointer

Definition at line 43 of file mitkITKImageImport.h.

template<class TInputImage >

typedef ITKImageImport mitk::ITKImageImport< TInputImage >::Self

Definition at line 43 of file mitkITKImageImport.h.

template<class TInputImage >

typedef ImageSource mitk::ITKImageImport< TInputImage >::Superclass

Definition at line 43 of file mitkITKImageImport.h.

Constructor & Destructor Documentation

template<class TInputImage >

mitk::ITKImageImport< TInputImage >::ITKImageImport ( )

protected

template<class TInputImage >

virtual mitk::ITKImageImport< TInputImage >::~ITKImageImport ( )

protectedvirtual

Member Function Documentation

template<class TInputImage >

Pointer mitk::ITKImageImport< TInputImage >::Clone

(

)

const

template<class TInputImage >

virtual void mitk::ITKImageImport< TInputImage >::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.

template<class TInputImage >

virtual void mitk::ITKImageImport< TInputImage >::GenerateInputRequestedRegion ( )

overrideprotectedvirtual

template<class TInputImage >

virtual void mitk::ITKImageImport< TInputImage >::GenerateOutputInformation ( )

overrideprotectedvirtual

template<class TInputImage >

virtual std::vector<std::string> mitk::ITKImageImport< TInputImage >::GetClassHierarchy ( ) const

inlineoverridevirtual

Reimplemented from mitk::ImageSource.

Definition at line 43 of file mitkITKImageImport.h.

template<class TInputImage >

virtual const char* mitk::ITKImageImport< TInputImage >::GetClassName ( ) const

virtual

Reimplemented from mitk::ImageSource.

template<class TInputImage >

InputImageType* mitk::ITKImageImport< TInputImage >::GetInput

(

void

)

Set the input itk::Image of this image importer.

template<class TInputImage >

static const char* mitk::ITKImageImport< TInputImage >::GetStaticNameOfClass ( )

inlinestatic

Definition at line 43 of file mitkITKImageImport.h.

template<class TInputImage >

mitk::ITKImageImport< TInputImage >::itkStaticConstMacro	(	InputImageDimension	,
		unsigned	int,
		TInputImage::ImageDimension
	)

ImageDimension constants

template<class TInputImage >

mitk::ITKImageImport< TInputImage >::itkStaticConstMacro	(	RegionDimension	,
		unsigned	int,
		mitk::SlicedData::RegionDimension
	)

template<class TInputImage >

static Pointer mitk::ITKImageImport< TInputImage >::New ( )

static

template<class TInputImage >

void mitk::ITKImageImport< TInputImage >::SetGeometry

(

const BaseGeometry *

geometry

)

Set the Geometry of the result image (optional)

The Geometry has to fit the dimension and size of the input image. The Geometry will be cloned, not referenced!

Providing the Geometry is optional. The default behavior is to set the geometry by the itk::Image::GetDirection() information.

template<class TInputImage >

void mitk::ITKImageImport< TInputImage >::SetInput

(

const InputImageType *

)

Set the input itk::Image of this image importer.

template<class TInputImage >

virtual void mitk::ITKImageImport< TInputImage >::SetNthOutput ( DataObjectPointerArraySizeType  num, itk::DataObject *  output  )

overrideprotectedvirtual

Member Data Documentation

template<class TInputImage >

BaseGeometry::Pointer mitk::ITKImageImport< TInputImage >::m_Geometry

protected

Definition at line 95 of file mitkITKImageImport.h.

---

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

• mitkITKImageImport.h