OTB  5.0.0
Orfeo Toolbox
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

#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 Types inherited from itk::ProcessObject
typedef SmartPointer< const SelfConstPointer
 
typedef
DataObject::DataObjectIdentifierType 
DataObjectIdentifierType
 
typedef DataObject::Pointer DataObjectPointer
 
typedef std::vector
< DataObjectPointer
DataObjectPointerArray
 
typedef
DataObjectPointerArray::size_type 
DataObjectPointerArraySizeType
 
typedef std::vector
< DataObjectIdentifierType
NameArray
 
typedef SmartPointer< SelfPointer
 
typedef ProcessObject Self
 
typedef Object Superclass
 
- Public Types inherited from itk::Object
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef Object Self
 
typedef LightObject Superclass
 
- Public Types inherited from itk::LightObject
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef LightObject Self
 

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
virtual void GenerateData ()
 
virtual const char * GetNameOfClass () const
 
void SetBuffer (BufferType *pBuff)
 
virtual void Update ()
 
 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)
 
- Public Member Functions inherited from itk::ProcessObject
virtual void AbortGenerateDataOff ()
 
virtual void AbortGenerateDataOn ()
 
virtual void EnlargeOutputRequestedRegion (DataObject *)
 
virtual const bool & GetAbortGenerateData () const
 
DataObjectPointerArray GetIndexedInputs ()
 
DataObjectPointerArray GetIndexedOutputs ()
 
NameArray GetInputNames () const
 
DataObjectPointerArray GetInputs ()
 
MultiThreader * GetMultiThreader () const
 
DataObjectPointerArraySizeType GetNumberOfIndexedInputs () const
 
DataObjectPointerArraySizeType GetNumberOfIndexedOutputs () const
 
DataObjectPointerArraySizeType GetNumberOfInputs () const
 
DataObjectPointerArraySizeType GetNumberOfOutputs () const
 
virtual const ThreadIdTypeGetNumberOfThreads () const
 
virtual
DataObjectPointerArraySizeType 
GetNumberOfValidRequiredInputs () const
 
NameArray GetOutputNames () const
 
DataObjectPointerArray GetOutputs ()
 
virtual const float & GetProgress () const
 
virtual const bool & GetReleaseDataBeforeUpdateFlag () const
 
virtual bool GetReleaseDataFlag () const
 
NameArray GetRequiredInputNames () const
 
bool HasInput (const DataObjectIdentifierType &key) const
 
bool HasOutput (const DataObjectIdentifierType &key) const
 
virtual DataObjectPointer MakeOutput (const DataObjectIdentifierType &)
 
virtual DataObjectPointer MakeOutput (DataObjectPointerArraySizeType idx)
 
virtual void PrepareOutputs ()
 
virtual void PropagateRequestedRegion (DataObject *output)
 
virtual void ReleaseDataBeforeUpdateFlagOff ()
 
virtual void ReleaseDataBeforeUpdateFlagOn ()
 
void ReleaseDataFlagOff ()
 
void ReleaseDataFlagOn ()
 
virtual void ResetPipeline ()
 
virtual void SetAbortGenerateData (bool _arg)
 
virtual void SetNumberOfThreads (ThreadIdType _arg)
 
void SetProgress (float progress)
 
virtual void SetReleaseDataBeforeUpdateFlag (bool _arg)
 
virtual void SetReleaseDataFlag (bool flag)
 
virtual void UpdateLargestPossibleRegion ()
 
virtual void UpdateOutputData (DataObject *output)
 
virtual void UpdateOutputInformation ()
 
void UpdateProgress (float progress)
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *)
 
unsigned long AddObserver (const EventObject &event, Command *) const
 
virtual void DebugOff () const
 
virtual void DebugOn () const
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
const MetaDataDictionaryGetMetaDataDictionary (void) const
 
MetaDataDictionaryGetMetaDataDictionary (void)
 
virtual ModifiedTimeType GetMTime () const
 
virtual const std::string & GetObjectName () const
 
virtual const TimeStampGetTimeStamp () const
 
bool HasObserver (const EventObject &event) const
 
void InvokeEvent (const EventObject &)
 
void InvokeEvent (const EventObject &) const
 
virtual void Modified () const
 
virtual void Register () const ITK_OVERRIDE
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag)
 
void SetDebug (bool debugFlag) const
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
virtual void SetObjectName (std::string _arg)
 
virtual void SetReferenceCount (int) ITK_OVERRIDE
 
virtual void UnRegister () const ITK_OVERRIDE
 
- Public Member Functions inherited from itk::LightObject
virtual void Delete ()
 
virtual int GetReferenceCount () const
 
 itkCloneMacro (Self)
 
void Print (std::ostream &os, Indent indent=0) const
 

Static Public Member Functions

static Pointer New ()
 
- Static Public Member Functions inherited from itk::Object
static bool GetGlobalWarningDisplay ()
 
static void GlobalWarningDisplayOff ()
 
static void GlobalWarningDisplayOn ()
 
static Pointer New ()
 
static void SetGlobalWarningDisplay (bool flag)
 
- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()
 
static Pointer New ()
 

Protected Member Functions

void PrintSelf (std::ostream &os, itk::Indent indent) const
 
 ScalarBufferToImageFileWriter ()
 
virtual ~ScalarBufferToImageFileWriter ()
 
- Protected Member Functions inherited from itk::ProcessObject
virtual void AddInput (DataObject *input)
 
virtual void AddOutput (DataObject *output)
 
bool AddRequiredInputName (const DataObjectIdentifierType &)
 
bool AddRequiredInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)
 
virtual void CacheInputReleaseDataFlags ()
 
virtual void GenerateInputRequestedRegion ()
 
virtual void GenerateOutputInformation ()
 
virtual void GenerateOutputRequestedRegion (DataObject *output)
 
DataObjectGetInput (const DataObjectIdentifierType &key)
 
const DataObjectGetInput (const DataObjectIdentifierType &key) const
 
DataObjectGetInput (DataObjectPointerArraySizeType idx)
 
const DataObjectGetInput (DataObjectPointerArraySizeType idx) const
 
virtual const
DataObjectPointerArraySizeType
GetNumberOfRequiredInputs () const
 
virtual const
DataObjectPointerArraySizeType
GetNumberOfRequiredOutputs () const
 
DataObjectGetOutput (const DataObjectIdentifierType &key)
 
const DataObjectGetOutput (const DataObjectIdentifierType &key) const
 
DataObjectGetOutput (DataObjectPointerArraySizeType idx)
 
const DataObjectGetOutput (DataObjectPointerArraySizeType idx) const
 
DataObjectGetPrimaryInput ()
 
const DataObjectGetPrimaryInput () const
 
virtual const char * GetPrimaryInputName (void) const
 
DataObjectGetPrimaryOutput ()
 
const DataObjectGetPrimaryOutput () const
 
virtual const char * GetPrimaryOutputName (void) const
 
bool IsIndexedInputName (const DataObjectIdentifierType &) const
 
bool IsIndexedOutputName (const DataObjectIdentifierType &) const
 
bool IsRequiredInputName (const DataObjectIdentifierType &) const
 
 itkLegacyMacro (virtual void RemoveOutput(DataObject *output))
 
 itkLegacyMacro (void SetNumberOfOutputs(DataObjectPointerArraySizeType num))
 
 itkLegacyMacro (virtual void RemoveInput(DataObject *input))
 
 itkLegacyMacro (void SetNumberOfInputs(DataObjectPointerArraySizeType num))
 
DataObjectPointerArraySizeType MakeIndexFromInputName (const DataObjectIdentifierType &name) const
 
DataObjectPointerArraySizeType MakeIndexFromOutputName (const DataObjectIdentifierType &name) const
 
DataObjectIdentifierType MakeNameFromInputIndex (DataObjectPointerArraySizeType idx) const
 
DataObjectIdentifierType MakeNameFromOutputIndex (DataObjectPointerArraySizeType idx) const
 
virtual void PopBackInput ()
 
virtual void PopFrontInput ()
 
 ProcessObject ()
 
virtual void PropagateResetPipeline ()
 
virtual void PushBackInput (const DataObject *input)
 
virtual void PushFrontInput (const DataObject *input)
 
virtual void ReleaseInputs ()
 
virtual void RemoveInput (const DataObjectIdentifierType &key)
 
virtual void RemoveInput (DataObjectPointerArraySizeType)
 
virtual void RemoveOutput (const DataObjectIdentifierType &key)
 
virtual void RemoveOutput (DataObjectPointerArraySizeType idx)
 
bool RemoveRequiredInputName (const DataObjectIdentifierType &)
 
virtual void RestoreInputReleaseDataFlags ()
 
virtual void SetInput (const DataObjectIdentifierType &key, DataObject *input)
 
virtual void SetNthInput (DataObjectPointerArraySizeType num, DataObject *input)
 
virtual void SetNthOutput (DataObjectPointerArraySizeType num, DataObject *output)
 
void SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)
 
void SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)
 
virtual void SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)
 
virtual void SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)
 
virtual void SetOutput (const DataObjectIdentifierType &key, DataObject *output)
 
virtual void SetPrimaryInput (DataObject *input)
 
virtual void SetPrimaryInputName (const DataObjectIdentifierType &key)
 
virtual void SetPrimaryOutput (DataObject *output)
 
virtual void SetPrimaryOutputName (const DataObjectIdentifierType &key)
 
void SetRequiredInputNames (const NameArray &)
 
virtual void VerifyInputInformation ()
 
virtual void VerifyPreconditions ()
 
 ~ProcessObject ()
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &time)
 
virtual ~Object ()
 
- Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer InternalClone () const
 
 LightObject ()
 
virtual void PrintHeader (std::ostream &os, Indent indent) const
 
virtual void PrintTrailer (std::ostream &os, Indent indent) const
 
virtual ~LightObject ()
 

Private Member Functions

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

Private Attributes

BufferTypem_Buffer
 
SizeType m_ImageSize
 
bool m_InverseXSpacing
 
unsigned int m_NumberOfChannels
 
WriterPointer m_Writer
 

Additional Inherited Members

- Protected Types inherited from itk::LightObject
typedef int InternalReferenceCountType
 
- Protected Attributes inherited from itk::ProcessObject
TimeStamp m_OutputInformationMTime
 
bool m_Updating
 
- Protected Attributes inherited from itk::LightObject
InternalReferenceCountType m_ReferenceCount
 
SimpleFastMutexLock m_ReferenceCountLock
 

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

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

Definition at line 46 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 59 of file otbScalarBufferToImageFileWriter.h.

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

Definition at line 63 of file otbScalarBufferToImageFileWriter.h.

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

Definition at line 56 of file otbScalarBufferToImageFileWriter.h.

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

Definition at line 60 of file otbScalarBufferToImageFileWriter.h.

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

Definition at line 45 of file otbScalarBufferToImageFileWriter.h.

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

Definition at line 61 of file otbScalarBufferToImageFileWriter.h.

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

Definition at line 43 of file otbScalarBufferToImageFileWriter.h.

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

Definition at line 62 of file otbScalarBufferToImageFileWriter.h.

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

Definition at line 44 of file otbScalarBufferToImageFileWriter.h.

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

Definition at line 67 of file otbScalarBufferToImageFileWriter.h.

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

Writer Type

Definition at line 66 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 104 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
virtual

Reimplemented from itk::Object.

template<class TBufferType , class TOutputPixelType >
void otb::ScalarBufferToImageFileWriter< TBufferType, TOutputPixelType >::GenerateData ( void  )
virtual
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 = TBufferType>
otb::ScalarBufferToImageFileWriter< TBufferType, TOutputPixelType >::otbGetObjectMemberMacro ( Writer  ,
FileName  ,
std::string   
)

Filename accessor

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

Filename accessor

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

Reimplemented from itk::ProcessObject.

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

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

Size accessors

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

Inverse X spacing accessors.

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

Number of channels

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

Reimplemented from itk::ProcessObject.

Definition at line 97 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 117 of file otbScalarBufferToImageFileWriter.h.

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

Output image size

Definition at line 123 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 126 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 120 of file otbScalarBufferToImageFileWriter.h.

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

Writer

Definition at line 114 of file otbScalarBufferToImageFileWriter.h.


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