rtk::ImportImageFilter< TImage > Class Template Reference

#include <rtkImportImageFilter.h>

Inheritance diagram for rtk::ImportImageFilter< TImage >:

Collaboration diagram for rtk::ImportImageFilter< TImage >:

Public Types
using	ConstPointer = itk::SmartPointer< const Self >
using	DirectionType = itk::Matrix< double, TImage::ImageDimension, TImage::ImageDimension >
using	IndexType = itk::Index< TImage::ImageDimension >
using	OriginType = typename TImage::PointType
using	OutputImagePointer = typename TImage::Pointer
using	PixelType = typename TImage::PixelType
using	Pointer = itk::SmartPointer< Self >
using	RegionType = itk::ImageRegion< TImage::ImageDimension >
using	Self = ImportImageFilter
using	SizeType = itk::Size< TImage::ImageDimension >
using	SizeValueType = typename SizeType::SizeValueType
using	SpacingType = typename TImage::SpacingType
using	Superclass = itk::ImageSource< TImage >

Public Member Functions
virtual ::itk::LightObject::Pointer	CreateAnother () const
virtual const DirectionType &	GetDirection () const
PixelType *	GetImportPointer ()
const RegionType &	GetRegion () const
virtual void	SetDirection (const DirectionType &direction)
void	SetImportPointer (PixelType *ptr, SizeValueType num, bool LetFilterManageMemory)
virtual const char *	GetNameOfClass () const
void	SetRegion (const RegionType &region)
virtual void	SetSpacing (SpacingType _arg)
virtual const SpacingType &	GetSpacing () const
virtual void	SetSpacing (const float data[])
virtual void	SetOrigin (OriginType _arg)
virtual const OriginType &	GetOrigin () const
virtual void	SetOrigin (const float data[])

Static Public Member Functions
static Pointer	New ()

Protected Member Functions
void	EnlargeOutputRequestedRegion (itk::DataObject *output) override
void	GenerateData () override
void	GenerateOutputInformation () override
	ImportImageFilter ()
void	PrintSelf (std::ostream &os, itk::Indent indent) const override
	~ImportImageFilter () override

Private Attributes
DirectionType	m_Direction
bool	m_FilterManageMemory
PixelType *	m_ImportPointer
OriginType	m_Origin
RegionType	m_Region
SizeValueType	m_Size
SpacingType	m_Spacing

Detailed Description

template<typename TImage>
class rtk::ImportImageFilter< TImage >

Import data from a standard C array into an itk::Image.

ImportImageFilter provides a mechanism for importing data into a TImage. ImportImageFilter is an image source, so it behaves like any other pipeline object.

This class is templated over the image type of the output image, unlike itk::ImportImageFilter which is templated over the pixel type and the dimension and is therefore incompatible with itk::CudaImage.

Author

Marc Vila

Definition at line 44 of file rtkImportImageFilter.h.

Member Typedef Documentation

ConstPointer

template<typename TImage >

using rtk::ImportImageFilter< TImage >::ConstPointer = itk::SmartPointer<const Self>

Definition at line 58 of file rtkImportImageFilter.h.

DirectionType

template<typename TImage >

using rtk::ImportImageFilter< TImage >::DirectionType = itk::Matrix<double, TImage::ImageDimension, TImage::ImageDimension>

Definition at line 138 of file rtkImportImageFilter.h.

IndexType

template<typename TImage >

using rtk::ImportImageFilter< TImage >::IndexType = itk::Index<TImage::ImageDimension>

Index type alias support. An index is used to access pixel values.

Definition at line 72 of file rtkImportImageFilter.h.

OriginType

template<typename TImage >

using rtk::ImportImageFilter< TImage >::OriginType = typename TImage::PointType

Definition at line 52 of file rtkImportImageFilter.h.

OutputImagePointer

template<typename TImage >

using rtk::ImportImageFilter< TImage >::OutputImagePointer = typename TImage::Pointer

Typedef for the output image.

Definition at line 50 of file rtkImportImageFilter.h.

PixelType

template<typename TImage >

using rtk::ImportImageFilter< TImage >::PixelType = typename TImage::PixelType

Type of the output image pixel type.

Definition at line 83 of file rtkImportImageFilter.h.

Pointer

template<typename TImage >

using rtk::ImportImageFilter< TImage >::Pointer = itk::SmartPointer<Self>

Definition at line 57 of file rtkImportImageFilter.h.

RegionType

template<typename TImage >

using rtk::ImportImageFilter< TImage >::RegionType = itk::ImageRegion<TImage::ImageDimension>

Region type alias support. A region is used to specify a subset of an image.

Definition at line 80 of file rtkImportImageFilter.h.

Self

template<typename TImage >

using rtk::ImportImageFilter< TImage >::Self = ImportImageFilter

Standard class type alias.

Definition at line 55 of file rtkImportImageFilter.h.

SizeType

template<typename TImage >

using rtk::ImportImageFilter< TImage >::SizeType = itk::Size<TImage::ImageDimension>

Size type alias support. A size is used to define region bounds.

Definition at line 75 of file rtkImportImageFilter.h.

SizeValueType

template<typename TImage >

using rtk::ImportImageFilter< TImage >::SizeValueType = typename SizeType::SizeValueType

Definition at line 76 of file rtkImportImageFilter.h.

SpacingType

template<typename TImage >

using rtk::ImportImageFilter< TImage >::SpacingType = typename TImage::SpacingType

Definition at line 51 of file rtkImportImageFilter.h.

Superclass

template<typename TImage >

using rtk::ImportImageFilter< TImage >::Superclass = itk::ImageSource<TImage>

Definition at line 56 of file rtkImportImageFilter.h.

Constructor & Destructor Documentation

ImportImageFilter()

template<typename TImage >

rtk::ImportImageFilter< TImage >::ImportImageFilter ( )

protected

~ImportImageFilter()

template<typename TImage >

rtk::ImportImageFilter< TImage >::~ImportImageFilter ( )

overrideprotected

Member Function Documentation

CreateAnother()

template<typename TImage >

virtual::itk::LightObject::Pointer rtk::ImportImageFilter< TImage >::CreateAnother ( ) const

virtual

Reimplemented from itk::Object.

EnlargeOutputRequestedRegion()

template<typename TImage >

void rtk::ImportImageFilter< TImage >::EnlargeOutputRequestedRegion ( itk::DataObject *  output )

overrideprotectedvirtual

This filter can only produce the amount of data that it is given, so we must override ProcessObject::EnlargeOutputRequestedRegion() (The default implementation of a source produces the amount of data requested. This source, however, can only produce what it is given.)

See also

ProcessObject::EnlargeOutputRequestedRegion()

Reimplemented from itk::ProcessObject.

GenerateData()

template<typename TImage >

void rtk::ImportImageFilter< TImage >::GenerateData ( )

overrideprotectedvirtual

This filter does not actually "produce" any data, rather it "wraps" the user supplied data into an itk::Image.

Reimplemented from itk::ProcessObject.

GenerateOutputInformation()

template<typename TImage >

void rtk::ImportImageFilter< TImage >::GenerateOutputInformation ( )

overrideprotectedvirtual

This is a source, so it must set the spacing, size, and largest possible region for the output image that it will produce.

See also

ProcessObject::GenerateOutputInformation()

Reimplemented from itk::ProcessObject.

GetDirection()

template<typename TImage >

virtual const DirectionType& rtk::ImportImageFilter< TImage >::GetDirection ( ) const

virtual

Get the direction of the image

See also

SetDirection

GetImportPointer()

template<typename TImage >

PixelType* rtk::ImportImageFilter< TImage >::GetImportPointer

(

)

Get the pointer from which the image data is imported.

GetNameOfClass()

template<typename TImage >

virtual const char* rtk::ImportImageFilter< TImage >::GetNameOfClass ( ) const

virtual

Run-time type information (and related methods).

Reimplemented from itk::ProcessObject.

GetOrigin()

template<typename TImage >

virtual const OriginType& rtk::ImportImageFilter< TImage >::GetOrigin ( ) const

virtual

Set the origin of the image.

See also

GetOrigin()

GetRegion()

template<typename TImage >

const RegionType& rtk::ImportImageFilter< TImage >::GetRegion ( ) const

inline

Get the region object that defines the size and starting index for the imported image. This will serve as the LargestPossibleRegion, the BufferedRegion, and the RequestedRegion.

See also

ImageRegion

Definition at line 119 of file rtkImportImageFilter.h.

GetSpacing()

template<typename TImage >

virtual const SpacingType& rtk::ImportImageFilter< TImage >::GetSpacing ( ) const

virtual

Set the spacing (size of a pixel) of the image.

See also

GetSpacing()

New()

template<typename TImage >

static Pointer rtk::ImportImageFilter< TImage >::New ( )

static

Method for creation through the object factory.

PrintSelf()

template<typename TImage >

void rtk::ImportImageFilter< TImage >::PrintSelf ( std::ostream &  os, itk::Indent  indent  ) const

overrideprotectedvirtual

Reimplemented from itk::ProcessObject.

SetDirection()

template<typename TImage >

virtual void rtk::ImportImageFilter< TImage >::SetDirection ( const DirectionType &  direction )

virtual

Set the direction of the image

See also

GetDirection()

SetImportPointer()

template<typename TImage >

void rtk::ImportImageFilter< TImage >::SetImportPointer	(	PixelType *	ptr,
		SizeValueType	num,
		bool	LetFilterManageMemory
	)

Set the pointer from which the image data is imported. "num" is the number of pixels in the block of memory. If "LetFilterManageMemory" is false, then the this filter will not free the memory in its destructor and the application providing the buffer retains the responsibility of freeing the memory for this image data. If "LetFilterManageMemory" is true, then this class will free the memory when this object is destroyed.

SetOrigin() [1/2]

template<typename TImage >

virtual void rtk::ImportImageFilter< TImage >::SetOrigin ( OriginType  _arg )

virtual

Set the origin of the image.

See also

GetOrigin()

SetOrigin() [2/2]

template<typename TImage >

virtual void rtk::ImportImageFilter< TImage >::SetOrigin ( const float  data[] )

virtual

Set the origin of the image.

See also

GetOrigin()

SetRegion()

template<typename TImage >

void rtk::ImportImageFilter< TImage >::SetRegion ( const RegionType &  region )

inline

Set the region object that defines the size and starting index for the imported image. This will serve as the LargestPossibleRegion, the BufferedRegion, and the RequestedRegion.

See also

ImageRegion

Definition at line 104 of file rtkImportImageFilter.h.

SetSpacing() [1/2]

template<typename TImage >

virtual void rtk::ImportImageFilter< TImage >::SetSpacing ( SpacingType  _arg )

virtual

Set the spacing (size of a pixel) of the image.

See also

GetSpacing()

SetSpacing() [2/2]

template<typename TImage >

virtual void rtk::ImportImageFilter< TImage >::SetSpacing ( const float  data[] )

virtual

Set the spacing (size of a pixel) of the image.

See also

GetSpacing()

Member Data Documentation

m_Direction

template<typename TImage >

DirectionType rtk::ImportImageFilter< TImage >::m_Direction

private

Definition at line 180 of file rtkImportImageFilter.h.

m_FilterManageMemory

template<typename TImage >

bool rtk::ImportImageFilter< TImage >::m_FilterManageMemory

private

Definition at line 183 of file rtkImportImageFilter.h.

m_ImportPointer

template<typename TImage >

PixelType* rtk::ImportImageFilter< TImage >::m_ImportPointer

private

Definition at line 182 of file rtkImportImageFilter.h.

m_Origin

template<typename TImage >

OriginType rtk::ImportImageFilter< TImage >::m_Origin

private

Definition at line 179 of file rtkImportImageFilter.h.

m_Region

template<typename TImage >

RegionType rtk::ImportImageFilter< TImage >::m_Region

private

Definition at line 177 of file rtkImportImageFilter.h.

m_Size

template<typename TImage >

SizeValueType rtk::ImportImageFilter< TImage >::m_Size

private

Definition at line 184 of file rtkImportImageFilter.h.

m_Spacing

template<typename TImage >

SpacingType rtk::ImportImageFilter< TImage >::m_Spacing

private

Definition at line 178 of file rtkImportImageFilter.h.

---

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

• rtkImportImageFilter.h