otb::ImportVectorImageFilter< TOutputImageType > Class Template Reference

#include <otbImportVectorImageFilter.h>

Inheritance diagram for otb::ImportVectorImageFilter< TOutputImageType >:

Collaboration diagram for otb::ImportVectorImageFilter< 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 ImportVectorImageFilter	Self
typedef itk::Size< OutputImageType::ImageDimension >	SizeType
typedef OutputImageType::SpacingType	SpacingType
typedef itk::ImageSource< OutputImageType >	Superclass
typedef OutputImageType::PixelType	TOutputPixel
typedef TOutputPixel::ValueType	TPixel

Public Member Functions
virtual ::itk::LightObject::Pointer	CreateAnother (void) const
virtual const char *	GetNameOfClass () const
TPixel *	GetImportPointer ()
virtual 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 int	m_NumberOfComponents
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 unsigned int	GetNumberOfComponents ()
virtual void	SetNumberOfComponents (unsigned int _arg)
virtual const double *	GetOrigin () const
virtual void	SetDirection (const DirectionType direction)
virtual const DirectionType &	GetDirection () const
	ImportVectorImageFilter ()
virtual	~ImportVectorImageFilter ()
void	PrintSelf (std::ostream &os, itk::Indent indent) const override
void	GenerateData () override
void	GenerateOutputInformation () override
void	EnlargeOutputRequestedRegion (itk::DataObject *output) override
	ImportVectorImageFilter (const ImportVectorImageFilter &)=delete
void	operator= (const ImportVectorImageFilter &)=delete

Detailed Description

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

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

ImportVectorImageFilter provides a mechanism for importing data into an Image Type. ImportVectorImageFilter 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 otbImportVectorImageFilter.h.

Member Typedef Documentation

ConstPointer

template<typename TOutputImageType >

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

Definition at line 58 of file otbImportVectorImageFilter.h.

DirectionType

template<typename TOutputImageType >

typedef itk::Matrix<double, OutputImageType::ImageDimension, OutputImageType::ImageDimension> otb::ImportVectorImageFilter< 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 139 of file otbImportVectorImageFilter.h.

IndexType

template<typename TOutputImageType >

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

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

Definition at line 64 of file otbImportVectorImageFilter.h.

OriginType

template<typename TOutputImageType >

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

Definition at line 52 of file otbImportVectorImageFilter.h.

OutputImagePointer

template<typename TOutputImageType >

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

Definition at line 50 of file otbImportVectorImageFilter.h.

OutputImageType

template<typename TOutputImageType >

typedef TOutputImageType otb::ImportVectorImageFilter< TOutputImageType >::OutputImageType

Typedef for the output image.

Definition at line 49 of file otbImportVectorImageFilter.h.

Pointer

template<typename TOutputImageType >

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

Definition at line 57 of file otbImportVectorImageFilter.h.

RegionType

template<typename TOutputImageType >

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

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

Definition at line 74 of file otbImportVectorImageFilter.h.

Self

template<typename TOutputImageType >

typedef ImportVectorImageFilter otb::ImportVectorImageFilter< TOutputImageType >::Self

Standard class typedefs.

Definition at line 55 of file otbImportVectorImageFilter.h.

SizeType

template<typename TOutputImageType >

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

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

Definition at line 70 of file otbImportVectorImageFilter.h.

SpacingType

template<typename TOutputImageType >

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

Definition at line 51 of file otbImportVectorImageFilter.h.

Superclass

template<typename TOutputImageType >

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

Definition at line 56 of file otbImportVectorImageFilter.h.

TOutputPixel

template<typename TOutputImageType >

typedef OutputImageType::PixelType otb::ImportVectorImageFilter< TOutputImageType >::TOutputPixel

Type of the output image pixel type.

Definition at line 77 of file otbImportVectorImageFilter.h.

TPixel

template<typename TOutputImageType >

typedef TOutputPixel::ValueType otb::ImportVectorImageFilter< TOutputImageType >::TPixel

Definition at line 78 of file otbImportVectorImageFilter.h.

Constructor & Destructor Documentation

ImportVectorImageFilter() [1/2]

template<class TOutputImage >

otb::ImportVectorImageFilter< TOutputImage >::ImportVectorImageFilter

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 otbImportVectorImageFilter.hxx.

~ImportVectorImageFilter()

template<class TOutputImage >

otb::ImportVectorImageFilter< TOutputImage >::~ImportVectorImageFilter

protectedvirtual

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 otbImportVectorImageFilter.hxx.

ImportVectorImageFilter() [2/2]

template<typename TOutputImageType >

otb::ImportVectorImageFilter< TOutputImageType >::ImportVectorImageFilter ( const ImportVectorImageFilter< 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::ImportVectorImageFilter< TOutputImageType >::CreateAnother

(

void

)

const

EnlargeOutputRequestedRegion()

template<class TOutputImage >

void otb::ImportVectorImageFilter< 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 otbImportVectorImageFilter.hxx.

GenerateData()

template<class TOutputImage >

void otb::ImportVectorImageFilter< 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 181 of file otbImportVectorImageFilter.hxx.

GenerateOutputInformation()

template<class TOutputImage >

void otb::ImportVectorImageFilter< 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 otbImportVectorImageFilter.hxx.

GetDirection()

template<typename TOutputImageType >

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

virtual

Get the direction of the image

See also

SetDirection

GetImportPointer()

template<class TOutputImage >

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

Get the pointer from which the image data is imported.

Definition at line 126 of file otbImportVectorImageFilter.hxx.

GetNameOfClass()

template<typename TOutputImageType >

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

virtual

Run-time type information (and related methods).

GetNumberOfComponents()

template<typename TOutputImageType >

virtual unsigned int otb::ImportVectorImageFilter< TOutputImageType >::GetNumberOfComponents ( )

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

GetOrigin()

template<typename TOutputImageType >

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

virtual

Get the origin of the image.

See also

SetOrigin()

GetRegion()

template<typename TOutputImageType >

const RegionType& otb::ImportVectorImageFilter< 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 110 of file otbImportVectorImageFilter.h.

GetSpacing()

template<typename TOutputImageType >

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

virtual

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

See also

SetSpacing()

New()

template<typename TOutputImageType >

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

static

Method for creation through the object factory.

operator=()

template<typename TOutputImageType >

void otb::ImportVectorImageFilter< TOutputImageType >::operator= ( const ImportVectorImageFilter< 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::ImportVectorImageFilter< 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 otbImportVectorImageFilter.hxx.

SetDirection()

template<class TOutputImage >

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

virtual

Set the direction of the image

See also

GetDirection()

Definition at line 234 of file otbImportVectorImageFilter.hxx.

SetImportPointer()

template<class TOutputImage >

void otb::ImportVectorImageFilter< TOutputImage >::SetImportPointer ( TPixel *  ptr, unsigned long  num, bool  LetFilterManageMemory  )

virtual

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 107 of file otbImportVectorImageFilter.hxx.

SetNumberOfComponents()

template<typename TOutputImageType >

virtual void otb::ImportVectorImageFilter< TOutputImageType >::SetNumberOfComponents ( unsigned int  _arg )

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() [1/3]

template<typename TOutputImageType >

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

virtual

Set the origin of the image.

See also

GetOrigin()

SetOrigin() [2/3]

template<typename TOutputImageType >

virtual void otb::ImportVectorImageFilter< 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::ImportVectorImageFilter< 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 221 of file otbImportVectorImageFilter.hxx.

SetRegion()

template<typename TOutputImageType >

void otb::ImportVectorImageFilter< 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 96 of file otbImportVectorImageFilter.h.

SetSpacing() [1/3]

template<typename TOutputImageType >

virtual void otb::ImportVectorImageFilter< 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::ImportVectorImageFilter< 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::ImportVectorImageFilter< 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 206 of file otbImportVectorImageFilter.hxx.

Member Data Documentation

m_Direction

template<typename TOutputImageType >

DirectionType otb::ImportVectorImageFilter< 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 181 of file otbImportVectorImageFilter.h.

m_FilterManageMemory

template<typename TOutputImageType >

bool otb::ImportVectorImageFilter< 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 184 of file otbImportVectorImageFilter.h.

m_ImportPointer

template<typename TOutputImageType >

TPixel* otb::ImportVectorImageFilter< 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 183 of file otbImportVectorImageFilter.h.

m_NumberOfComponents

template<typename TOutputImageType >

unsigned int otb::ImportVectorImageFilter< TOutputImageType >::m_NumberOfComponents

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 185 of file otbImportVectorImageFilter.h.

m_Origin

template<typename TOutputImageType >

double otb::ImportVectorImageFilter< 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 180 of file otbImportVectorImageFilter.h.

m_Region

template<typename TOutputImageType >

RegionType otb::ImportVectorImageFilter< 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 178 of file otbImportVectorImageFilter.h.

m_Size

template<typename TOutputImageType >

unsigned long otb::ImportVectorImageFilter< 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 186 of file otbImportVectorImageFilter.h.

m_Spacing

template<typename TOutputImageType >

double otb::ImportVectorImageFilter< 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 179 of file otbImportVectorImageFilter.h.

---

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

• otbImportVectorImageFilter.h
• otbImportVectorImageFilter.hxx