OTB  9.0.0
Orfeo Toolbox
Public Types | Public Member Functions | Private Attributes | List of all members
otb::MultiImageFileWriter::Sink< TImage > Class Template Reference
+ Inheritance diagram for otb::MultiImageFileWriter::Sink< TImage >:
+ Collaboration diagram for otb::MultiImageFileWriter::Sink< TImage >:

Public Types

typedef std::shared_ptr< SinkPointer
 
- Public Types inherited from otb::MultiImageFileWriter::SinkBase
typedef std::shared_ptr< SinkBasePointer
 

Public Member Functions

bool CanStreamWrite () const override
 
itk::ImageRegion< 2 > GetRegionToWrite () const override
 
 Sink ()
 
 Sink (typename otb::ImageFileWriter< TImage >::Pointer writer)
 
 Sink (typename TImage::ConstPointer inputImage, const std::string &filename)
 
void Write (const RegionType &streamRegion) override
 
void WriteImageInformation () override
 
virtual ~Sink ()
 
- Public Member Functions inherited from otb::MultiImageFileWriter::SinkBase
virtual ImageBaseType::Pointer GetInput ()
 
virtual ImageBaseType::ConstPointer GetInput () const
 
 SinkBase ()
 
 SinkBase (ImageBaseType::ConstPointer inputImage)
 
virtual ~SinkBase ()
 

Private Attributes

otb::ImageIOBase::Pointer m_ImageIO
 
otb::ImageFileWriter< TImage >::Pointer m_Writer
 

Additional Inherited Members

- Protected Attributes inherited from otb::MultiImageFileWriter::SinkBase
ImageBaseType::ConstPointer m_InputImage
 

Detailed Description

template<class TImage>
class otb::MultiImageFileWriter::Sink< TImage >

Wrapper class for each ImageFileWriter

Definition at line 253 of file otbMultiImageFileWriter.h.

Member Typedef Documentation

◆ Pointer

template<class TImage >
typedef std::shared_ptr<Sink> otb::MultiImageFileWriter::Sink< TImage >::Pointer

Definition at line 269 of file otbMultiImageFileWriter.h.

Constructor & Destructor Documentation

◆ Sink() [1/3]

template<class TImage >
otb::MultiImageFileWriter::Sink< TImage >::Sink ( )
inline

Definition at line 256 of file otbMultiImageFileWriter.h.

◆ Sink() [2/3]

template<class TImage >
otb::MultiImageFileWriter::Sink< TImage >::Sink ( typename TImage::ConstPointer  inputImage,
const std::string &  filename 
)

◆ Sink() [3/3]

template<class TImage >
otb::MultiImageFileWriter::Sink< TImage >::Sink ( typename otb::ImageFileWriter< TImage >::Pointer  writer)

Definition at line 40 of file otbMultiImageFileWriter.hxx.

◆ ~Sink()

template<class TImage >
virtual otb::MultiImageFileWriter::Sink< TImage >::~Sink ( )
inlinevirtual

Definition at line 262 of file otbMultiImageFileWriter.h.

Member Function Documentation

◆ CanStreamWrite()

template<class TImage >
bool otb::MultiImageFileWriter::Sink< TImage >::CanStreamWrite ( ) const
overridevirtual

Implements otb::MultiImageFileWriter::SinkBase.

Definition at line 46 of file otbMultiImageFileWriter.hxx.

◆ GetRegionToWrite()

template<class TImage >
itk::ImageRegion< 2 > otb::MultiImageFileWriter::Sink< TImage >::GetRegionToWrite ( ) const
overridevirtual

Get the region that should be written. By default this is the largest possible region of the input image, but this might be overridden by the box extended filename parameter of the input writer

Implements otb::MultiImageFileWriter::SinkBase.

Definition at line 76 of file otbMultiImageFileWriter.hxx.

References otb::Utils::ConvertStringToVector().

◆ Write()

template<class TImage >
void otb::MultiImageFileWriter::Sink< TImage >::Write ( const RegionType streamRegion)
overridevirtual

Implements otb::MultiImageFileWriter::SinkBase.

Definition at line 61 of file otbMultiImageFileWriter.hxx.

◆ WriteImageInformation()

template<class TImage >
void otb::MultiImageFileWriter::Sink< TImage >::WriteImageInformation ( )
overridevirtual

Implements otb::MultiImageFileWriter::SinkBase.

Definition at line 54 of file otbMultiImageFileWriter.hxx.

Member Data Documentation

◆ m_ImageIO

template<class TImage >
otb::ImageIOBase::Pointer otb::MultiImageFileWriter::Sink< TImage >::m_ImageIO
private

An ImageIO used to actually write data to a file

Definition at line 281 of file otbMultiImageFileWriter.h.

◆ m_Writer

template<class TImage >
otb::ImageFileWriter<TImage>::Pointer otb::MultiImageFileWriter::Sink< TImage >::m_Writer
private

Actual writer for this image

Definition at line 278 of file otbMultiImageFileWriter.h.

Referenced by otb::MultiImageFileWriter::Sink< TImage >::Sink().


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