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::ScalarBufferToImageFileWriter< TBufferType, TOutputPixelType > Class Template Reference

Record an image stored in a buffer. More...

#include <otbScalarBufferToImageFileWriter.h>

+ Inheritance diagram for otb::ScalarBufferToImageFileWriter< TBufferType, TOutputPixelType >:
+ Collaboration diagram for otb::ScalarBufferToImageFileWriter< TBufferType, TOutputPixelType >:

Public Types

typedef TBufferType BufferType
 
typedef itk::SmartPointer
< const Self
ConstPointer
 
typedef otb::VectorImage
< OutputPixelType, 2 > 
ImageType
 
typedef ImageType::IndexType IndexType
 
typedef TOutputPixelType OutputPixelType
 
typedef ImageType::PixelType PixelType
 
typedef itk::SmartPointer< SelfPointer
 
typedef ImageType::RegionType RegionType
 
typedef
ScalarBufferToImageFileWriter 
Self
 
typedef ImageType::SizeType SizeType
 
typedef itk::ProcessObject Superclass
 
typedef WriterType::Pointer WriterPointer
 
typedef otb::ImageFileWriter
< ImageType
WriterType
 

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
virtual void GenerateData ()
 
virtual std::string GetFileName ()
 
virtual SizeType GetImageSize ()
 
virtual bool GetInverseXSpacing ()
 
virtual const char * GetNameOfClass () const
 
virtual unsigned int GetNumberOfChannels ()
 
void SetBuffer (BufferType *pBuff)
 
virtual void SetFileName (const std::string _arg)
 
virtual void SetImageSize (SizeType _arg)
 
virtual void SetInverseXSpacing (bool _arg)
 
virtual void SetNumberOfChannels (unsigned int _arg)
 
virtual void Update ()
 

Static Public Member Functions

static Pointer New ()
 

Protected Member Functions

 ScalarBufferToImageFileWriter ()
 
virtual ~ScalarBufferToImageFileWriter ()
 
void PrintSelf (std::ostream &os, itk::Indent indent) const
 

Private Member Functions

 ScalarBufferToImageFileWriter (const Self &)
 
void operator= (const Self &)
 

Private Attributes

BufferTypem_Buffer
 
SizeType m_ImageSize
 
bool m_InverseXSpacing
 
unsigned int m_NumberOfChannels
 
WriterPointer m_Writer
 

Detailed Description

template<class TBufferType, class TOutputPixelType = TBufferType>
class otb::ScalarBufferToImageFileWriter< TBufferType, TOutputPixelType >

Record an image stored in a buffer.

TBufferType is the scalar buffer type, TOutputPixelType is the type in which the image will be recorded. User have to precise the image size, the number of channel will be computed automatically. The SetFilename method precises the image name.

Definition at line 38 of file otbScalarBufferToImageFileWriter.h.

Member Typedef Documentation

template<class TBufferType , class TOutputPixelType = TBufferType>
typedef TBufferType otb::ScalarBufferToImageFileWriter< TBufferType, TOutputPixelType >::BufferType

INput typedefs

Definition at line 51 of file otbScalarBufferToImageFileWriter.h.

template<class TBufferType , class TOutputPixelType = TBufferType>
typedef itk::SmartPointer<const Self> otb::ScalarBufferToImageFileWriter< TBufferType, TOutputPixelType >::ConstPointer

Definition at line 45 of file otbScalarBufferToImageFileWriter.h.

template<class TBufferType , class TOutputPixelType = TBufferType>
typedef otb::VectorImage<OutputPixelType, 2> otb::ScalarBufferToImageFileWriter< TBufferType, TOutputPixelType >::ImageType

Output image type

Definition at line 58 of file otbScalarBufferToImageFileWriter.h.

template<class TBufferType , class TOutputPixelType = TBufferType>
typedef ImageType::IndexType otb::ScalarBufferToImageFileWriter< TBufferType, TOutputPixelType >::IndexType

Definition at line 62 of file otbScalarBufferToImageFileWriter.h.

template<class TBufferType , class TOutputPixelType = TBufferType>
typedef TOutputPixelType otb::ScalarBufferToImageFileWriter< TBufferType, TOutputPixelType >::OutputPixelType

Definition at line 55 of file otbScalarBufferToImageFileWriter.h.

template<class TBufferType , class TOutputPixelType = TBufferType>
typedef ImageType::PixelType otb::ScalarBufferToImageFileWriter< TBufferType, TOutputPixelType >::PixelType

Definition at line 59 of file otbScalarBufferToImageFileWriter.h.

template<class TBufferType , class TOutputPixelType = TBufferType>
typedef itk::SmartPointer<Self> otb::ScalarBufferToImageFileWriter< TBufferType, TOutputPixelType >::Pointer

Definition at line 44 of file otbScalarBufferToImageFileWriter.h.

template<class TBufferType , class TOutputPixelType = TBufferType>
typedef ImageType::RegionType otb::ScalarBufferToImageFileWriter< TBufferType, TOutputPixelType >::RegionType

Definition at line 60 of file otbScalarBufferToImageFileWriter.h.

template<class TBufferType , class TOutputPixelType = TBufferType>
typedef ScalarBufferToImageFileWriter otb::ScalarBufferToImageFileWriter< TBufferType, TOutputPixelType >::Self

Definition at line 42 of file otbScalarBufferToImageFileWriter.h.

template<class TBufferType , class TOutputPixelType = TBufferType>
typedef ImageType::SizeType otb::ScalarBufferToImageFileWriter< TBufferType, TOutputPixelType >::SizeType

Definition at line 61 of file otbScalarBufferToImageFileWriter.h.

template<class TBufferType , class TOutputPixelType = TBufferType>
typedef itk::ProcessObject otb::ScalarBufferToImageFileWriter< TBufferType, TOutputPixelType >::Superclass

Definition at line 43 of file otbScalarBufferToImageFileWriter.h.

template<class TBufferType , class TOutputPixelType = TBufferType>
typedef WriterType::Pointer otb::ScalarBufferToImageFileWriter< TBufferType, TOutputPixelType >::WriterPointer

Definition at line 66 of file otbScalarBufferToImageFileWriter.h.

template<class TBufferType , class TOutputPixelType = TBufferType>
typedef otb::ImageFileWriter<ImageType> otb::ScalarBufferToImageFileWriter< TBufferType, TOutputPixelType >::WriterType

Writer Type

Definition at line 65 of file otbScalarBufferToImageFileWriter.h.

Constructor & Destructor Documentation

template<class TBufferType , class TOutputPixelType >
otb::ScalarBufferToImageFileWriter< TBufferType, TOutputPixelType >::ScalarBufferToImageFileWriter ( )
protected

Definition at line 30 of file otbScalarBufferToImageFileWriter.txx.

References NULL.

template<class TBufferType , class TOutputPixelType = TBufferType>
virtual otb::ScalarBufferToImageFileWriter< TBufferType, TOutputPixelType >::~ScalarBufferToImageFileWriter ( )
inlineprotectedvirtual

Definition at line 99 of file otbScalarBufferToImageFileWriter.h.

template<class TBufferType , class TOutputPixelType = TBufferType>
otb::ScalarBufferToImageFileWriter< TBufferType, TOutputPixelType >::ScalarBufferToImageFileWriter ( const Self )
private

Member Function Documentation

template<class TBufferType , class TOutputPixelType = TBufferType>
virtual::itk::LightObject::Pointer otb::ScalarBufferToImageFileWriter< TBufferType, TOutputPixelType >::CreateAnother ( void  ) const
template<class TBufferType , class TOutputPixelType >
void otb::ScalarBufferToImageFileWriter< TBufferType, TOutputPixelType >::GenerateData ( void  )
virtual
template<class TBufferType , class TOutputPixelType = TBufferType>
virtual std::string otb::ScalarBufferToImageFileWriter< TBufferType, TOutputPixelType >::GetFileName ( )
virtual

Filename accessor

template<class TBufferType , class TOutputPixelType = TBufferType>
virtual SizeType otb::ScalarBufferToImageFileWriter< TBufferType, TOutputPixelType >::GetImageSize ( )
virtual

Size accessors

template<class TBufferType , class TOutputPixelType = TBufferType>
virtual bool otb::ScalarBufferToImageFileWriter< TBufferType, TOutputPixelType >::GetInverseXSpacing ( )
virtual

Inverse X spacing accessors.

template<class TBufferType , class TOutputPixelType = TBufferType>
virtual const char* otb::ScalarBufferToImageFileWriter< TBufferType, TOutputPixelType >::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods).

Reimplemented from itk::ProcessObject.

template<class TBufferType , class TOutputPixelType = TBufferType>
virtual unsigned int otb::ScalarBufferToImageFileWriter< TBufferType, TOutputPixelType >::GetNumberOfChannels ( )
virtual

Number of channels

template<class TBufferType , class TOutputPixelType = TBufferType>
static Pointer otb::ScalarBufferToImageFileWriter< TBufferType, TOutputPixelType >::New ( )
static

Method for creation through the object factory.

template<class TBufferType , class TOutputPixelType = TBufferType>
void otb::ScalarBufferToImageFileWriter< TBufferType, TOutputPixelType >::operator= ( const Self )
private
template<class TBufferType , class TOutputPixelType >
void otb::ScalarBufferToImageFileWriter< TBufferType, TOutputPixelType >::PrintSelf ( std::ostream &  os,
itk::Indent  indent 
) const
protected

Definition at line 115 of file otbScalarBufferToImageFileWriter.txx.

template<class TBufferType , class TOutputPixelType = TBufferType>
void otb::ScalarBufferToImageFileWriter< TBufferType, TOutputPixelType >::SetBuffer ( BufferType pBuff)
inline

Buffer accessors

Definition at line 85 of file otbScalarBufferToImageFileWriter.h.

template<class TBufferType , class TOutputPixelType = TBufferType>
virtual void otb::ScalarBufferToImageFileWriter< TBufferType, TOutputPixelType >::SetFileName ( const std::string  _arg)
virtual
template<class TBufferType , class TOutputPixelType = TBufferType>
virtual void otb::ScalarBufferToImageFileWriter< TBufferType, TOutputPixelType >::SetImageSize ( SizeType  _arg)
virtual
template<class TBufferType , class TOutputPixelType = TBufferType>
virtual void otb::ScalarBufferToImageFileWriter< TBufferType, TOutputPixelType >::SetInverseXSpacing ( bool  _arg)
virtual
template<class TBufferType , class TOutputPixelType = TBufferType>
virtual void otb::ScalarBufferToImageFileWriter< TBufferType, TOutputPixelType >::SetNumberOfChannels ( unsigned int  _arg)
virtual
template<class TBufferType , class TOutputPixelType = TBufferType>
virtual void otb::ScalarBufferToImageFileWriter< TBufferType, TOutputPixelType >::Update ( void  )
inlinevirtual

Definition at line 92 of file otbScalarBufferToImageFileWriter.h.

Member Data Documentation

template<class TBufferType , class TOutputPixelType = TBufferType>
BufferType* otb::ScalarBufferToImageFileWriter< TBufferType, TOutputPixelType >::m_Buffer
private

Scalar tab buffer to writer

Definition at line 112 of file otbScalarBufferToImageFileWriter.h.

template<class TBufferType , class TOutputPixelType = TBufferType>
SizeType otb::ScalarBufferToImageFileWriter< TBufferType, TOutputPixelType >::m_ImageSize
private

Output image size

Definition at line 118 of file otbScalarBufferToImageFileWriter.h.

template<class TBufferType , class TOutputPixelType = TBufferType>
bool otb::ScalarBufferToImageFileWriter< TBufferType, TOutputPixelType >::m_InverseXSpacing
private

Inverse biffer among X

Definition at line 121 of file otbScalarBufferToImageFileWriter.h.

template<class TBufferType , class TOutputPixelType = TBufferType>
unsigned int otb::ScalarBufferToImageFileWriter< TBufferType, TOutputPixelType >::m_NumberOfChannels
private

Output image number of channels

Definition at line 115 of file otbScalarBufferToImageFileWriter.h.

template<class TBufferType , class TOutputPixelType = TBufferType>
WriterPointer otb::ScalarBufferToImageFileWriter< TBufferType, TOutputPixelType >::m_Writer
private

Writer

Definition at line 109 of file otbScalarBufferToImageFileWriter.h.


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