#include <otbImportImageFilter.h>

Inheritance diagram for otb::ImportImageFilter< TOutputImageType >:

Collaboration diagram for otb::ImportImageFilter< TOutputImageType >:

Public Types
typedef itk::SmartPointer< const Self >	ConstPointer

typedef itk::Index< OutputImageType::ImageDimension >	IndexType

typedef OutputImageType::PointType	OriginType

typedef OutputImageType::Pointer	OutputImagePointer

typedef TOutputImageType	OutputImageType

typedef itk::SmartPointer< Self >	Pointer

typedef itk::ImageRegion< OutputImageType::ImageDimension >	RegionType

typedef ImportImageFilter	Self

typedef itk::Size< OutputImageType::ImageDimension >	SizeType

typedef OutputImageType::SpacingType	SpacingType

typedef itk::ImageSource< OutputImageType >	Superclass

typedef OutputImageType::PixelType	TPixel

Public Member Functions
virtual ::itk::LightObject::Pointer	CreateAnother (void) const

virtual const char *	GetNameOfClass () const


TPixel *	GetImportPointer ()

void	SetImportPointer (TPixel *ptr, unsigned long num, bool LetFilterManageMemory)

Static Public Member Functions
static Pointer	New ()

typedef itk::Matrix< double, OutputImageType::ImageDimension, OutputImageType::ImageDimension >	DirectionType

RegionType	m_Region

double	m_Spacing [OutputImageType::ImageDimension]

double	m_Origin [OutputImageType::ImageDimension]

DirectionType	m_Direction

TPixel *	m_ImportPointer

bool	m_FilterManageMemory

unsigned long	m_Size

void	SetRegion (const RegionType &region)

const RegionType &	GetRegion () const

virtual void	SetSpacing (const double data[])

virtual void	SetSpacing (const float data[])

virtual const double *	GetSpacing () const

void	SetSpacing (const SpacingType &spacing)

virtual void	SetOrigin (const double data[])

virtual void	SetOrigin (const float data[])

void	SetOrigin (const OriginType &origin)

virtual const double *	GetOrigin () const

virtual void	SetDirection (const DirectionType direction)

virtual const DirectionType &	GetDirection () const

	ImportImageFilter ()

	~ImportImageFilter () override

void	PrintSelf (std::ostream &os, itk::Indent indent) const override

void	GenerateData () override

void	GenerateOutputInformation () override

void	EnlargeOutputRequestedRegion (itk::DataObject *output) override

	ImportImageFilter (const ImportImageFilter &)=delete

void	operator= (const ImportImageFilter &)=delete

Detailed Description

template<typename TOutputImageType>
class otb::ImportImageFilter< TOutputImageType >

Import data from a standard C array into an Image Type.

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

This class is templated over the output Image Type

Definition at line 45 of file otbImportImageFilter.h.

Member Typedef Documentation

◆ ConstPointer

template<typename TOutputImageType >

typedef itk::SmartPointer<const Self> otb::ImportImageFilter< TOutputImageType >::ConstPointer

Definition at line 58 of file otbImportImageFilter.h.

◆ DirectionType

template<typename TOutputImageType >

typedef itk::Matrix<double, OutputImageType::ImageDimension, OutputImageType::ImageDimension> otb::ImportImageFilter< TOutputImageType >::DirectionType

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 135 of file otbImportImageFilter.h.

◆ IndexType

template<typename TOutputImageType >

typedef itk::Index<OutputImageType::ImageDimension> otb::ImportImageFilter< TOutputImageType >::IndexType

Index typedef support. An index is used to access pixel values.

Definition at line 64 of file otbImportImageFilter.h.

◆ OriginType

template<typename TOutputImageType >

typedef OutputImageType::PointType otb::ImportImageFilter< TOutputImageType >::OriginType

Definition at line 52 of file otbImportImageFilter.h.

◆ OutputImagePointer

template<typename TOutputImageType >

typedef OutputImageType::Pointer otb::ImportImageFilter< TOutputImageType >::OutputImagePointer

Definition at line 50 of file otbImportImageFilter.h.

◆ OutputImageType

template<typename TOutputImageType >

typedef TOutputImageType otb::ImportImageFilter< TOutputImageType >::OutputImageType

Typedef for the output image.

Definition at line 49 of file otbImportImageFilter.h.

◆ Pointer

template<typename TOutputImageType >

typedef itk::SmartPointer<Self> otb::ImportImageFilter< TOutputImageType >::Pointer

Definition at line 57 of file otbImportImageFilter.h.

◆ RegionType

template<typename TOutputImageType >

typedef itk::ImageRegion<OutputImageType::ImageDimension> otb::ImportImageFilter< TOutputImageType >::RegionType

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

Definition at line 74 of file otbImportImageFilter.h.

◆ Self

template<typename TOutputImageType >

typedef ImportImageFilter otb::ImportImageFilter< TOutputImageType >::Self

Standard class typedefs.

Definition at line 55 of file otbImportImageFilter.h.

◆ SizeType

template<typename TOutputImageType >

typedef itk::Size<OutputImageType::ImageDimension> otb::ImportImageFilter< TOutputImageType >::SizeType

Size typedef support. A size is used to define region bounds.

Definition at line 70 of file otbImportImageFilter.h.

◆ SpacingType

template<typename TOutputImageType >

typedef OutputImageType::SpacingType otb::ImportImageFilter< TOutputImageType >::SpacingType

Definition at line 51 of file otbImportImageFilter.h.

◆ Superclass

template<typename TOutputImageType >

typedef itk::ImageSource<OutputImageType> otb::ImportImageFilter< TOutputImageType >::Superclass

Definition at line 56 of file otbImportImageFilter.h.

◆ TPixel

template<typename TOutputImageType >

typedef OutputImageType::PixelType otb::ImportImageFilter< TOutputImageType >::TPixel

Type of the output image pixel type.

Definition at line 77 of file otbImportImageFilter.h.

Constructor & Destructor Documentation

◆ ImportImageFilter() [1/2]

template<class TOutputImage >

otb::ImportImageFilter< TOutputImage >::ImportImageFilter

protected

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 35 of file otbImportImageFilter.hxx.

◆ ~ImportImageFilter()

template<class TOutputImage >

otb::ImportImageFilter< TOutputImage >::~ImportImageFilter

overrideprotected

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 55 of file otbImportImageFilter.hxx.

◆ ImportImageFilter() [2/2]

template<typename TOutputImageType >

otb::ImportImageFilter< TOutputImageType >::ImportImageFilter ( const ImportImageFilter< TOutputImageType > & )

privatedelete

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

Member Function Documentation

◆ CreateAnother()

template<typename TOutputImageType >

virtual::itk::LightObject::Pointer otb::ImportImageFilter< TOutputImageType >::CreateAnother ( void ) const

◆ EnlargeOutputRequestedRegion()

template<class TOutputImage >

void otb::ImportImageFilter< TOutputImage >::EnlargeOutputRequestedRegion ( itk::DataObject * output )

overrideprotected

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

Definition at line 135 of file otbImportImageFilter.hxx.

◆ GenerateData()

template<class TOutputImage >

void otb::ImportImageFilter< TOutputImage >::GenerateData

overrideprotected

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

Definition at line 172 of file otbImportImageFilter.hxx.

◆ GenerateOutputInformation()

template<class TOutputImage >

void otb::ImportImageFilter< TOutputImage >::GenerateOutputInformation

overrideprotected

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

Definition at line 152 of file otbImportImageFilter.hxx.

◆ GetDirection()

template<typename TOutputImageType >

virtual const DirectionType& otb::ImportImageFilter< TOutputImageType >::GetDirection ( ) const

virtual

Get the direction of the image

See also: SetDirection

◆ GetImportPointer()

template<class TOutputImage >

ImportImageFilter< TOutputImage >::TPixel * otb::ImportImageFilter< TOutputImage >::GetImportPointer

Get the pointer from which the image data is imported.

Definition at line 126 of file otbImportImageFilter.hxx.

◆ GetNameOfClass()

template<typename TOutputImageType >

virtual const char* otb::ImportImageFilter< TOutputImageType >::GetNameOfClass ( ) const

virtual

Run-time type information (and related methods).

◆ GetOrigin()

template<typename TOutputImageType >

virtual const double* otb::ImportImageFilter< TOutputImageType >::GetOrigin ( ) const

virtual

Get the origin of the image.

See also: SetOrigin()

◆ GetRegion()

template<typename TOutputImageType >

const RegionType& otb::ImportImageFilter< TOutputImageType >::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 109 of file otbImportImageFilter.h.

◆ GetSpacing()

template<typename TOutputImageType >

virtual const double* otb::ImportImageFilter< TOutputImageType >::GetSpacing ( ) const

virtual

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

See also: SetSpacing()

◆ New()

template<typename TOutputImageType >

static Pointer otb::ImportImageFilter< TOutputImageType >::New ( )

static

Method for creation through the object factory.

◆ operator=()

template<typename TOutputImageType >

void otb::ImportImageFilter< TOutputImageType >::operator= ( const ImportImageFilter< TOutputImageType > & )

privatedelete

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

◆ PrintSelf()

template<class TOutputImage >

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

overrideprotected

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 68 of file otbImportImageFilter.hxx.

◆ SetDirection()

template<class TOutputImage >

void otb::ImportImageFilter< TOutputImage >::SetDirection ( const DirectionType direction )

virtual

Set the direction of the image

See also: GetDirection()

Definition at line 225 of file otbImportImageFilter.hxx.

◆ SetImportPointer()

template<class TOutputImage >

void otb::ImportImageFilter< TOutputImage >::SetImportPointer	(	TPixel *	ptr,
		unsigned long	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.

Definition at line 106 of file otbImportImageFilter.hxx.

◆ SetOrigin() [1/3]

template<typename TOutputImageType >

virtual void otb::ImportImageFilter< TOutputImageType >::SetOrigin ( const double data[] )

virtual

Set the origin of the image.

See also: GetOrigin()

◆ SetOrigin() [2/3]

template<typename TOutputImageType >

virtual void otb::ImportImageFilter< TOutputImageType >::SetOrigin ( const float data[] )

virtual

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

◆ SetOrigin() [3/3]

template<class TOutputImage >

void otb::ImportImageFilter< TOutputImage >::SetOrigin ( const OriginType & origin )

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 212 of file otbImportImageFilter.hxx.

◆ SetRegion()

template<typename TOutputImageType >

void otb::ImportImageFilter< TOutputImageType >::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 95 of file otbImportImageFilter.h.

◆ SetSpacing() [1/3]

template<typename TOutputImageType >

virtual void otb::ImportImageFilter< TOutputImageType >::SetSpacing ( const double data[] )

virtual

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

See also: GetSignedSpacing()

◆ SetSpacing() [2/3]

template<typename TOutputImageType >

virtual void otb::ImportImageFilter< TOutputImageType >::SetSpacing ( const float data[] )

virtual

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

◆ SetSpacing() [3/3]

template<class TOutputImage >

void otb::ImportImageFilter< TOutputImage >::SetSpacing ( const SpacingType & spacing )

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 197 of file otbImportImageFilter.hxx.

Member Data Documentation

◆ m_Direction

template<typename TOutputImageType >

DirectionType otb::ImportImageFilter< TOutputImageType >::m_Direction

private

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 177 of file otbImportImageFilter.h.

◆ m_FilterManageMemory

template<typename TOutputImageType >

bool otb::ImportImageFilter< TOutputImageType >::m_FilterManageMemory

private

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 180 of file otbImportImageFilter.h.

◆ m_ImportPointer

template<typename TOutputImageType >

TPixel* otb::ImportImageFilter< TOutputImageType >::m_ImportPointer

private

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 179 of file otbImportImageFilter.h.

◆ m_Origin

template<typename TOutputImageType >

double otb::ImportImageFilter< TOutputImageType >::m_Origin[OutputImageType::ImageDimension]

private

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 176 of file otbImportImageFilter.h.

◆ m_Region

template<typename TOutputImageType >

RegionType otb::ImportImageFilter< TOutputImageType >::m_Region

private

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 174 of file otbImportImageFilter.h.

◆ m_Size

template<typename TOutputImageType >

unsigned long otb::ImportImageFilter< TOutputImageType >::m_Size

private

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 181 of file otbImportImageFilter.h.

◆ m_Spacing

template<typename TOutputImageType >

double otb::ImportImageFilter< TOutputImageType >::m_Spacing[OutputImageType::ImageDimension]

private

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 175 of file otbImportImageFilter.h.

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

Public Types

Public Member Functions

Static Public Member Functions

Detailed Description

template<typename TOutputImageType> class otb::ImportImageFilter< TOutputImageType >

Member Typedef Documentation

◆ ConstPointer

◆ DirectionType

◆ IndexType

◆ OriginType

◆ OutputImagePointer

◆ OutputImageType

◆ Pointer

◆ RegionType

◆ Self

◆ SizeType

◆ SpacingType

◆ Superclass

◆ TPixel

Constructor & Destructor Documentation

◆ ImportImageFilter() [1/2]

◆ ~ImportImageFilter()

◆ ImportImageFilter() [2/2]

Member Function Documentation

◆ CreateAnother()

◆ EnlargeOutputRequestedRegion()

◆ GenerateData()

◆ GenerateOutputInformation()

◆ GetDirection()

◆ GetImportPointer()

◆ GetNameOfClass()

◆ GetOrigin()

◆ GetRegion()

◆ GetSpacing()

◆ New()

◆ operator=()

◆ PrintSelf()

◆ SetDirection()

◆ SetImportPointer()

◆ SetOrigin() [1/3]

◆ SetOrigin() [2/3]

◆ SetOrigin() [3/3]

◆ SetRegion()

◆ SetSpacing() [1/3]

◆ SetSpacing() [2/3]

◆ SetSpacing() [3/3]

Member Data Documentation

◆ m_Direction

◆ m_FilterManageMemory

◆ m_ImportPointer

◆ m_Origin

◆ m_Region

◆ m_Size

◆ m_Spacing

template<typename TOutputImageType>
class otb::ImportImageFilter< TOutputImageType >