OTB  9.0.0
Orfeo Toolbox
Public Types | Public Member Functions | Static Public Member Functions | List of all members
otb::ScalarBufferToImageFileWriter< TBufferType, TOutputPixelType > Class Template Reference

#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 SelfConstPointer
 
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< ImageTypeWriterType
 

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
virtual const char * GetNameOfClass () const
 

Static Public Member Functions

static Pointer New ()
 
WriterPointer m_Writer
 
BufferTypem_Buffer
 
unsigned int m_NumberOfChannels
 
SizeType m_ImageSize
 
bool m_InverseXSpacing
 
 otbGetObjectMemberMacro (Writer, FileName, std::string)
 
 otbSetObjectMemberMacro (Writer, FileName, std::string)
 
virtual SizeType GetImageSize ()
 
virtual void SetImageSize (SizeType _arg)
 
virtual unsigned int GetNumberOfChannels ()
 
virtual void SetNumberOfChannels (unsigned int _arg)
 
virtual bool GetInverseXSpacing ()
 
virtual void SetInverseXSpacing (bool _arg)
 
void SetBuffer (BufferType *pBuff)
 
void GenerateData () override
 
void Update () override
 
 ScalarBufferToImageFileWriter ()
 
 ~ScalarBufferToImageFileWriter () override
 
void PrintSelf (std::ostream &os, itk::Indent indent) const override
 
 ScalarBufferToImageFileWriter (const Self &)=delete
 
void operator= (const Self &)=delete
 

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 43 of file otbScalarBufferToImageFileWriter.h.

Member Typedef Documentation

◆ BufferType

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

INput typedefs

Definition at line 55 of file otbScalarBufferToImageFileWriter.h.

◆ ConstPointer

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

Definition at line 49 of file otbScalarBufferToImageFileWriter.h.

◆ ImageType

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

Output image type

Definition at line 62 of file otbScalarBufferToImageFileWriter.h.

◆ IndexType

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

Definition at line 66 of file otbScalarBufferToImageFileWriter.h.

◆ OutputPixelType

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

Definition at line 59 of file otbScalarBufferToImageFileWriter.h.

◆ PixelType

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

Definition at line 63 of file otbScalarBufferToImageFileWriter.h.

◆ Pointer

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

Definition at line 48 of file otbScalarBufferToImageFileWriter.h.

◆ RegionType

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

Definition at line 64 of file otbScalarBufferToImageFileWriter.h.

◆ Self

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

Definition at line 46 of file otbScalarBufferToImageFileWriter.h.

◆ SizeType

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

Definition at line 65 of file otbScalarBufferToImageFileWriter.h.

◆ Superclass

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

Definition at line 47 of file otbScalarBufferToImageFileWriter.h.

◆ WriterPointer

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

Definition at line 70 of file otbScalarBufferToImageFileWriter.h.

◆ WriterType

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

Writer Type

Definition at line 69 of file otbScalarBufferToImageFileWriter.h.

Constructor & Destructor Documentation

◆ ScalarBufferToImageFileWriter() [1/2]

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

◆ ~ScalarBufferToImageFileWriter()

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

Writer

Definition at line 107 of file otbScalarBufferToImageFileWriter.h.

◆ ScalarBufferToImageFileWriter() [2/2]

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

Writer

Member Function Documentation

◆ CreateAnother()

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

◆ GenerateData()

template<class TBufferType , class TOutputPixelType >
void otb::ScalarBufferToImageFileWriter< TBufferType, TOutputPixelType >::GenerateData
override

Writer

Definition at line 42 of file otbScalarBufferToImageFileWriter.hxx.

◆ GetImageSize()

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

Size accessors

◆ GetInverseXSpacing()

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

Inverse X spacing accessors.

◆ GetNameOfClass()

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

Run-time type information (and related methods).

◆ GetNumberOfChannels()

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

Number of channels

◆ New()

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

Method for creation through the object factory.

◆ operator=()

template<class TBufferType , class TOutputPixelType = TBufferType>
void otb::ScalarBufferToImageFileWriter< TBufferType, TOutputPixelType >::operator= ( const Self )
privatedelete

Writer

◆ otbGetObjectMemberMacro()

template<class TBufferType , class TOutputPixelType = TBufferType>
otb::ScalarBufferToImageFileWriter< TBufferType, TOutputPixelType >::otbGetObjectMemberMacro ( Writer  ,
FileName  ,
std::string   
)

Filename accessor

◆ otbSetObjectMemberMacro()

template<class TBufferType , class TOutputPixelType = TBufferType>
otb::ScalarBufferToImageFileWriter< TBufferType, TOutputPixelType >::otbSetObjectMemberMacro ( Writer  ,
FileName  ,
std::string   
)

Writer

◆ PrintSelf()

template<class TBufferType , class TOutputPixelType >
void otb::ScalarBufferToImageFileWriter< TBufferType, TOutputPixelType >::PrintSelf ( std::ostream &  os,
itk::Indent  indent 
) const
overrideprotected

Writer

Definition at line 116 of file otbScalarBufferToImageFileWriter.hxx.

◆ SetBuffer()

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

Buffer accessors

Definition at line 93 of file otbScalarBufferToImageFileWriter.h.

◆ SetImageSize()

template<class TBufferType , class TOutputPixelType = TBufferType>
virtual void otb::ScalarBufferToImageFileWriter< TBufferType, TOutputPixelType >::SetImageSize ( SizeType  _arg)
virtual

Writer

◆ SetInverseXSpacing()

template<class TBufferType , class TOutputPixelType = TBufferType>
virtual void otb::ScalarBufferToImageFileWriter< TBufferType, TOutputPixelType >::SetInverseXSpacing ( bool  _arg)
virtual

Writer

◆ SetNumberOfChannels()

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

Writer

◆ Update()

template<class TBufferType , class TOutputPixelType = TBufferType>
void otb::ScalarBufferToImageFileWriter< TBufferType, TOutputPixelType >::Update ( )
inlineoverride

Writer

Definition at line 100 of file otbScalarBufferToImageFileWriter.h.

Member Data Documentation

◆ m_Buffer

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

Scalar tab buffer to writer

Definition at line 121 of file otbScalarBufferToImageFileWriter.h.

◆ m_ImageSize

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

◆ m_InverseXSpacing

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

Inverse biffer among X

Definition at line 130 of file otbScalarBufferToImageFileWriter.h.

◆ m_NumberOfChannels

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

Output image number of channels

Definition at line 124 of file otbScalarBufferToImageFileWriter.h.

◆ m_Writer

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

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