Orfeo ToolBox  4.2
Orfeo ToolBox is not a black box
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes | List of all members
otb::ImportImageFilter< TOutputImageType > Class Template Reference

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

#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::Matrix< double,
OutputImageType::ImageDimension,
OutputImageType::ImageDimension > 
DirectionType
 
typedef itk::Index
< OutputImageType::ImageDimension > 
IndexType
 
typedef OutputImageType::PointType OriginType
 
typedef OutputImageType::Pointer OutputImagePointer
 
typedef TOutputImageType OutputImageType
 
typedef itk::SmartPointer< SelfPointer
 
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 DirectionTypeGetDirection ()
 
TPixelGetImportPointer ()
 
virtual const char * GetNameOfClass () const
 
virtual const double * GetOrigin () const
 
const RegionTypeGetRegion () const
 
virtual const double * GetSpacing () const
 
virtual void SetDirection (const DirectionType direction)
 
void SetImportPointer (TPixel *ptr, unsigned long num, bool LetFilterManageMemory)
 
virtual void SetOrigin (const double data[])
 
virtual void SetOrigin (const float data[])
 
void SetOrigin (const OriginType &origin)
 
void SetRegion (const RegionType &region)
 
virtual void SetSpacing (const double data[])
 
virtual void SetSpacing (const float data[])
 
void SetSpacing (const SpacingType &spacing)
 

Static Public Member Functions

static Pointer New ()
 
- Static Public Member Functions inherited from itk::ImageSource< TOutputImageType >
static const
ImageRegionSplitterBase
GetGlobalDefaultSplitter (void)
 

Protected Member Functions

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

Private Member Functions

 ImportImageFilter (const ImportImageFilter &)
 
void operator= (const ImportImageFilter &)
 

Private Attributes

DirectionType m_Direction
 
bool m_FilterManageMemory
 
TPixelm_ImportPointer
 
double m_Origin [OutputImageType::ImageDimension]
 
RegionType m_Region
 
unsigned long m_Size
 
double m_Spacing [OutputImageType::ImageDimension]
 

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

Member Typedef Documentation

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

Definition at line 56 of file otbImportImageFilter.h.

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

Definition at line 130 of file otbImportImageFilter.h.

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

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

Definition at line 50 of file otbImportImageFilter.h.

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

Definition at line 48 of file otbImportImageFilter.h.

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

Typedef for the output image.

Definition at line 47 of file otbImportImageFilter.h.

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

Definition at line 55 of file otbImportImageFilter.h.

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

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

Standard class typedefs.

Definition at line 53 of file otbImportImageFilter.h.

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

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

Definition at line 49 of file otbImportImageFilter.h.

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

Definition at line 54 of file otbImportImageFilter.h.

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

Type of the output image pixel type.

Definition at line 75 of file otbImportImageFilter.h.

Constructor & Destructor Documentation

template<class TOutputImage >
otb::ImportImageFilter< TOutputImage >::ImportImageFilter ( )
protected

Definition at line 35 of file otbImportImageFilter.txx.

template<class TOutputImage >
otb::ImportImageFilter< TOutputImage >::~ImportImageFilter ( )
protectedvirtual

Definition at line 56 of file otbImportImageFilter.txx.

template<typename TOutputImageType>
otb::ImportImageFilter< TOutputImageType >::ImportImageFilter ( const ImportImageFilter< TOutputImageType > &  )
private

Member Function Documentation

template<typename TOutputImageType>
virtual::itk::LightObject::Pointer otb::ImportImageFilter< TOutputImageType >::CreateAnother ( void  ) const
template<class TOutputImage >
void otb::ImportImageFilter< TOutputImage >::EnlargeOutputRequestedRegion ( itk::DataObject output)
protectedvirtual

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 142 of file otbImportImageFilter.txx.

template<class TOutputImage >
void otb::ImportImageFilter< TOutputImage >::GenerateData ( void  )
protectedvirtual

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

Definition at line 183 of file otbImportImageFilter.txx.

template<class TOutputImage >
void otb::ImportImageFilter< TOutputImage >::GenerateOutputInformation ( void  )
protectedvirtual

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 161 of file otbImportImageFilter.txx.

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

Get the direction of the image

See Also
SetDirection
template<class TOutputImage >
ImportImageFilter< TOutputImage >::TPixel * otb::ImportImageFilter< TOutputImage >::GetImportPointer ( )

Get the pointer from which the image data is imported.

Definition at line 131 of file otbImportImageFilter.txx.

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

Run-time type information (and related methods).

Reimplemented from itk::ImageSource< TOutputImageType >.

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

Get the origin of the image.

See Also
SetOrigin()
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 107 of file otbImportImageFilter.h.

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

Method for creation through the object factory.

template<typename TOutputImageType>
void otb::ImportImageFilter< TOutputImageType >::operator= ( const ImportImageFilter< TOutputImageType > &  )
private
template<class TOutputImage >
void otb::ImportImageFilter< TOutputImage >::PrintSelf ( std::ostream &  os,
itk::Indent  indent 
) const
protected

Definition at line 70 of file otbImportImageFilter.txx.

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

Set the direction of the image

See Also
GetDirection()

Definition at line 241 of file otbImportImageFilter.txx.

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 110 of file otbImportImageFilter.txx.

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

Set the origin of the image.

See Also
GetOrigin()
template<typename TOutputImageType>
virtual void otb::ImportImageFilter< TOutputImageType >::SetOrigin ( const float  data[])
virtual
template<class TOutputImage >
void otb::ImportImageFilter< TOutputImage >::SetOrigin ( const OriginType origin)

Definition at line 227 of file otbImportImageFilter.txx.

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

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
GetSpacing()
template<typename TOutputImageType>
virtual void otb::ImportImageFilter< TOutputImageType >::SetSpacing ( const float  data[])
virtual
template<class TOutputImage >
void otb::ImportImageFilter< TOutputImage >::SetSpacing ( const SpacingType spacing)

Definition at line 211 of file otbImportImageFilter.txx.

Member Data Documentation

template<typename TOutputImageType>
DirectionType otb::ImportImageFilter< TOutputImageType >::m_Direction
private

Definition at line 171 of file otbImportImageFilter.h.

template<typename TOutputImageType>
bool otb::ImportImageFilter< TOutputImageType >::m_FilterManageMemory
private

Definition at line 174 of file otbImportImageFilter.h.

template<typename TOutputImageType>
TPixel* otb::ImportImageFilter< TOutputImageType >::m_ImportPointer
private

Definition at line 173 of file otbImportImageFilter.h.

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

Definition at line 170 of file otbImportImageFilter.h.

template<typename TOutputImageType>
RegionType otb::ImportImageFilter< TOutputImageType >::m_Region
private

Definition at line 168 of file otbImportImageFilter.h.

template<typename TOutputImageType>
unsigned long otb::ImportImageFilter< TOutputImageType >::m_Size
private

Definition at line 175 of file otbImportImageFilter.h.

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

Definition at line 169 of file otbImportImageFilter.h.


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