RTK  2.0.1
Reconstruction Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Attributes | List of all members
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 DirectionTypeGetDirection () const
 
PixelTypeGetImportPointer ()
 
virtual const char * GetNameOfClass () const
 
const RegionTypeGetRegion () const
 
virtual void SetDirection (const DirectionType &direction)
 
void SetImportPointer (PixelType *ptr, SizeValueType num, bool LetFilterManageMemory)
 
void SetRegion (const RegionType &region)
 
virtual void SetSpacing (SpacingType _arg)
 
virtual const SpacingTypeGetSpacing () const
 
virtual void SetSpacing (const float data[])
 
virtual void SetOrigin (OriginType _arg)
 
virtual const OriginTypeGetOrigin () 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
 
PixelTypem_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

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

Definition at line 58 of file rtkImportImageFilter.h.

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

Definition at line 121 of file rtkImportImageFilter.h.

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 67 of file rtkImportImageFilter.h.

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

Definition at line 52 of file rtkImportImageFilter.h.

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

Typedef for the output image.

Definition at line 50 of file rtkImportImageFilter.h.

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

Type of the output image pixel type.

Definition at line 78 of file rtkImportImageFilter.h.

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

Definition at line 57 of file rtkImportImageFilter.h.

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 75 of file rtkImportImageFilter.h.

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

Standard class type alias.

Definition at line 55 of file rtkImportImageFilter.h.

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 70 of file rtkImportImageFilter.h.

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

Definition at line 71 of file rtkImportImageFilter.h.

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

Definition at line 51 of file rtkImportImageFilter.h.

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

Definition at line 56 of file rtkImportImageFilter.h.

Constructor & Destructor Documentation

template<typename TImage >
rtk::ImportImageFilter< TImage >::ImportImageFilter ( )
protected
template<typename TImage >
rtk::ImportImageFilter< TImage >::~ImportImageFilter ( )
overrideprotected

Member Function Documentation

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

Reimplemented from itk::Object.

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.

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.

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.

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

Get the direction of the image

See also
SetDirection
template<typename TImage >
PixelType* rtk::ImportImageFilter< TImage >::GetImportPointer ( )

Get the pointer from which the image data is imported.

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

Run-time type information (and related methods).

Reimplemented from itk::ProcessObject.

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

Set the origin of the image.

See also
GetOrigin()
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 104 of file rtkImportImageFilter.h.

References itkSetMacro, and itk::ImportImageFilter< class, VImageDimension >::m_Region.

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()
template<typename TImage >
static Pointer rtk::ImportImageFilter< TImage >::New ( )
static

Method for creation through the object factory.

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

Reimplemented from itk::ProcessObject.

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

Set the direction of the image

See also
GetDirection()
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.

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

Set the origin of the image.

See also
GetOrigin()
template<typename TImage >
virtual void rtk::ImportImageFilter< TImage >::SetOrigin ( const float  data[])
virtual

Set the origin of the image.

See also
GetOrigin()
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 97 of file rtkImportImageFilter.h.

References itk::ImportImageFilter< class, VImageDimension >::m_Region, and itk::Object::Modified().

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()
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

template<typename TImage >
DirectionType rtk::ImportImageFilter< TImage >::m_Direction
private

Definition at line 158 of file rtkImportImageFilter.h.

template<typename TImage >
bool rtk::ImportImageFilter< TImage >::m_FilterManageMemory
private

Definition at line 161 of file rtkImportImageFilter.h.

template<typename TImage >
PixelType* rtk::ImportImageFilter< TImage >::m_ImportPointer
private

Definition at line 160 of file rtkImportImageFilter.h.

template<typename TImage >
OriginType rtk::ImportImageFilter< TImage >::m_Origin
private

Definition at line 157 of file rtkImportImageFilter.h.

template<typename TImage >
RegionType rtk::ImportImageFilter< TImage >::m_Region
private

Definition at line 155 of file rtkImportImageFilter.h.

template<typename TImage >
SizeValueType rtk::ImportImageFilter< TImage >::m_Size
private

Definition at line 162 of file rtkImportImageFilter.h.

template<typename TImage >
SpacingType rtk::ImportImageFilter< TImage >::m_Spacing
private

Definition at line 156 of file rtkImportImageFilter.h.


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