OTB  6.7.0
Orfeo Toolbox
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Private Member Functions | Private Attributes | List of all members
otb::SimpleParallelTiffWriter< TInputImage > Class Template Reference

#include <otbSimpleParallelTiffWriter.h>

+ Inheritance diagram for otb::SimpleParallelTiffWriter< TInputImage >:
+ Collaboration diagram for otb::SimpleParallelTiffWriter< TInputImage >:

Public Types

typedef itk::SmartPointer
< const Self
ConstPointer
 
typedef
Superclass::DataObjectPointer 
DataObjectPointer
 
typedef
otb::ExtendedFilenameToWriterOptions 
FNameHelperType
 
typedef InputImageType::PixelType InputImagePixelType
 
typedef InputImageType::Pointer InputImagePointer
 
typedef InputImageType::RegionType InputImageRegionType
 
typedef TInputImage InputImageType
 
typedef InputImageType::IndexType InputIndexType
 
typedef OutputImageType::PixelType OutputImagePixelType
 
typedef OutputImageType::Pointer OutputImagePointer
 
typedef OutputImageType::RegionType OutputImageRegionType
 
typedef TInputImage OutputImageType
 
typedef itk::SmartPointer< SelfPointer
 
typedef SimpleParallelTiffWriter Self
 
typedef
StreamingManagerType::Pointer 
StreamingManagerPointerType
 
typedef otb::StreamingManager
< InputImageType
StreamingManagerType
 
typedef itk::ProcessObject Superclass
 
- 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 const otb::ImageIOBaseGetImageIO () const
 
const InputImageTypeGetInput ()
 
virtual const char * GetNameOfClass () const
 
StreamingManagerTypeGetStreamingManager (void)
 
virtual bool GetTiffTiledMode ()
 
virtual int GetTiffTileSize ()
 
virtual bool GetVerbose ()
 
virtual bool GetVirtualMode ()
 
 itkGetObjectMacro (ImageIO, otb::ImageIOBase)
 
void SetAutomaticAdaptativeStreaming (unsigned int availableRAM=0, double bias=1.0)
 
void SetAutomaticStrippedStreaming (unsigned int availableRAM=0, double bias=1.0)
 
void SetAutomaticTiledStreaming (unsigned int availableRAM=0, double bias=1.0)
 
virtual void SetFileName (const std::string &extendedFileName)
 
virtual void SetImageIO (otb::ImageIOBase *_arg)
 
virtual void SetInput (const InputImageType *input)
 
void SetNumberOfDivisionsStrippedStreaming (unsigned int nbDivisions)
 
void SetNumberOfDivisionsTiledStreaming (unsigned int nbDivisions)
 
void SetNumberOfLinesStrippedStreaming (unsigned int nbLinesPerStrip)
 
void SetStreamingManager (StreamingManagerType *streamingManager)
 
virtual void SetTiffTiledMode (bool _arg)
 
virtual void SetTiffTileSize (int _arg)
 
void SetTileDimensionTiledStreaming (unsigned int tileDimension)
 
virtual void SetVerbose (bool _arg)
 
virtual void SetVirtualMode (bool _arg)
 
virtual void Update () override
 
virtual const char * GetFileName () const
 
const bool & GetAbortGenerateData () const override
 
void SetAbortGenerateData (bool val) override
 
void SetIORegion (const itk::ImageIORegion &region)
 
virtual const itk::ImageIORegionGetIORegion () const
 
virtual void SetUseInputMetaDataDictionary (bool _arg)
 
virtual const bool & GetUseInputMetaDataDictionary () const
 
virtual void UseInputMetaDataDictionaryOn ()
 
virtual void UseInputMetaDataDictionaryOff ()
 
- Public Member Functions inherited from itk::ProcessObject
virtual void AbortGenerateDataOff ()
 
virtual void AbortGenerateDataOn ()
 
virtual void EnlargeOutputRequestedRegion (DataObject *)
 
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 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 () const
 
MetaDataDictionaryGetMetaDataDictionary ()
 
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 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) override
 
virtual void UnRegister () const noexceptoverride
 
- 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 ()
 

Static Public Attributes

static const unsigned int InputImageDimension = InputImageType::ImageDimension
 

Protected Member Functions

void PrintSelf (std::ostream &os, itk::Indent indent) const override
 
 SimpleParallelTiffWriter ()
 
virtual ~SimpleParallelTiffWriter ()
 
- Protected Member Functions inherited from itk::ProcessObject
virtual void AddInput (DataObject *input)
 
virtual void AddOutput (DataObject *output)
 
bool AddRequiredInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)
 
bool AddRequiredInputName (const DataObjectIdentifierType &)
 
virtual void CacheInputReleaseDataFlags ()
 
virtual void GenerateData ()
 
virtual void GenerateInputRequestedRegion ()
 
virtual void GenerateOutputInformation ()
 
virtual void GenerateOutputRequestedRegion (DataObject *output)
 
const DataObjectGetInput (const DataObjectIdentifierType &key) const
 
DataObjectGetInput (DataObjectPointerArraySizeType idx)
 
const DataObjectGetInput (DataObjectPointerArraySizeType idx) const
 
DataObjectGetInput (const DataObjectIdentifierType &key)
 
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 RemoveInput(DataObject *input))
 
 itkLegacyMacro (void SetNumberOfInputs(DataObjectPointerArraySizeType num))
 
 itkLegacyMacro (virtual void RemoveOutput(DataObject *output))
 
 itkLegacyMacro (void SetNumberOfOutputs(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

unsigned int GetProcFromDivision (unsigned int regionIndex)
 
void ObserveSourceFilterProgress (itk::Object *object, const itk::EventObject &event)
 
void operator= (const SimpleParallelTiffWriter &)=delete
 
unsigned int OptimizeStrippedSplittingLayout (unsigned int n)
 
 SimpleParallelTiffWriter (const SimpleParallelTiffWriter &)=delete
 
void UpdateFilterProgress ()
 

Private Attributes

unsigned int m_CurrentDivision
 
float m_DivisionProgress
 
bool m_FactorySpecifiedImageIO
 
std::string m_FileName
 
FNameHelperType::Pointer m_FilenameHelper
 
otb::ImageIOBase::Pointer m_ImageIO
 
itk::ImageIORegion m_IORegion
 
bool m_IsObserving
 
itk::SimpleFastMutexLock m_Lock
 
unsigned int m_NumberOfDivisions
 
unsigned long m_ObserverID
 
InputIndexType m_ShiftOutputIndex
 
StreamingManagerPointerType m_StreamingManager
 
bool m_TiffTiledMode
 
int m_TiffTileSize
 
bool m_UseInputMetaDataDictionary
 
bool m_UserSpecifiedImageIO
 
bool m_UserSpecifiedIORegion
 
bool m_Verbose
 
bool m_VirtualMode
 
bool m_WriteGeomFile
 

Additional Inherited Members

- Protected Attributes inherited from itk::ProcessObject
TimeStamp m_OutputInformationMTime
 
bool m_Updating
 
- Protected Attributes inherited from itk::LightObject
AtomicInt< int > m_ReferenceCount
 

Detailed Description

template<class TInputImage>
class otb::SimpleParallelTiffWriter< TInputImage >

Writes a GeoTiff image using parallel non collective operations.

SimpleParallelTiffWriter writes its input data to a single output file. SimpleParallelTiffWriter interfaces with an MPI-IO based class to write out the data with streaming process and multiple processing nodes.

SimpleParallelTiffWriter will divide the output into several pieces (controlled by SetNumberOfDivisionsStrippedStreaming, SetNumberOfLinesStrippedStreaming, SetAutomaticStrippedStreaming, SetTileDimensionTiledStreaming or SetAutomaticTiledStreaming), and call the upstream pipeline for each piece, tiling the individual outputs into one large output. This reduces the memory footprint for the application since each filter does not have to process the entire dataset at once.

SimpleParallelTiffWriter will write directly the streaming buffer in the image file, so that the output image never needs to be completely allocated

SimpleParallelTiffWriter implements a version of Simple Parallel Tiff Writer (SPTW, D.M. Mattli, USGS)

Splitting strategies are close to those implemented in ImageFileWriter, except layout is optimized for the number of MPI processes for stripped regions. TODO: optimize the splitting layout for tiled regions

See Also
ImageFileWriter

Definition at line 109 of file otbSimpleParallelTiffWriter.h.

Member Typedef Documentation

template<class TInputImage >
typedef itk::SmartPointer<const Self> otb::SimpleParallelTiffWriter< TInputImage >::ConstPointer

Definition at line 116 of file otbSimpleParallelTiffWriter.h.

template<class TInputImage >
typedef Superclass::DataObjectPointer otb::SimpleParallelTiffWriter< TInputImage >::DataObjectPointer

Definition at line 135 of file otbSimpleParallelTiffWriter.h.

template<class TInputImage >
typedef otb::ExtendedFilenameToWriterOptions otb::SimpleParallelTiffWriter< TInputImage >::FNameHelperType

The Filename Helper.

Definition at line 138 of file otbSimpleParallelTiffWriter.h.

template<class TInputImage >
typedef InputImageType::PixelType otb::SimpleParallelTiffWriter< TInputImage >::InputImagePixelType

Definition at line 128 of file otbSimpleParallelTiffWriter.h.

template<class TInputImage >
typedef InputImageType::Pointer otb::SimpleParallelTiffWriter< TInputImage >::InputImagePointer

Definition at line 126 of file otbSimpleParallelTiffWriter.h.

template<class TInputImage >
typedef InputImageType::RegionType otb::SimpleParallelTiffWriter< TInputImage >::InputImageRegionType

Definition at line 127 of file otbSimpleParallelTiffWriter.h.

template<class TInputImage >
typedef TInputImage otb::SimpleParallelTiffWriter< TInputImage >::InputImageType

Some typedefs for the input and output.

Definition at line 122 of file otbSimpleParallelTiffWriter.h.

template<class TInputImage >
typedef InputImageType::IndexType otb::SimpleParallelTiffWriter< TInputImage >::InputIndexType

Definition at line 129 of file otbSimpleParallelTiffWriter.h.

template<class TInputImage >
typedef OutputImageType::PixelType otb::SimpleParallelTiffWriter< TInputImage >::OutputImagePixelType

Definition at line 134 of file otbSimpleParallelTiffWriter.h.

template<class TInputImage >
typedef OutputImageType::Pointer otb::SimpleParallelTiffWriter< TInputImage >::OutputImagePointer

Definition at line 132 of file otbSimpleParallelTiffWriter.h.

template<class TInputImage >
typedef OutputImageType::RegionType otb::SimpleParallelTiffWriter< TInputImage >::OutputImageRegionType

Definition at line 133 of file otbSimpleParallelTiffWriter.h.

template<class TInputImage >
typedef TInputImage otb::SimpleParallelTiffWriter< TInputImage >::OutputImageType

Definition at line 131 of file otbSimpleParallelTiffWriter.h.

template<class TInputImage >
typedef itk::SmartPointer<Self> otb::SimpleParallelTiffWriter< TInputImage >::Pointer

Definition at line 115 of file otbSimpleParallelTiffWriter.h.

template<class TInputImage >
typedef SimpleParallelTiffWriter otb::SimpleParallelTiffWriter< TInputImage >::Self

Standard class typedefs.

Definition at line 113 of file otbSimpleParallelTiffWriter.h.

template<class TInputImage >
typedef StreamingManagerType::Pointer otb::SimpleParallelTiffWriter< TInputImage >::StreamingManagerPointerType

Definition at line 146 of file otbSimpleParallelTiffWriter.h.

template<class TInputImage >
typedef otb::StreamingManager<InputImageType> otb::SimpleParallelTiffWriter< TInputImage >::StreamingManagerType

Streaming manager base class pointer

Definition at line 145 of file otbSimpleParallelTiffWriter.h.

template<class TInputImage >
typedef itk::ProcessObject otb::SimpleParallelTiffWriter< TInputImage >::Superclass

Definition at line 114 of file otbSimpleParallelTiffWriter.h.

Constructor & Destructor Documentation

template<class TInputImage >
otb::SimpleParallelTiffWriter< TInputImage >::SimpleParallelTiffWriter ( )
protected

Definition at line 43 of file otbSimpleParallelTiffWriter.hxx.

template<class TInputImage >
otb::SimpleParallelTiffWriter< TInputImage >::~SimpleParallelTiffWriter ( )
protectedvirtual

Definition at line 84 of file otbSimpleParallelTiffWriter.hxx.

template<class TInputImage >
otb::SimpleParallelTiffWriter< TInputImage >::SimpleParallelTiffWriter ( const SimpleParallelTiffWriter< TInputImage > &  )
privatedelete

Member Function Documentation

template<class TInputImage >
virtual::itk::LightObject::Pointer otb::SimpleParallelTiffWriter< TInputImage >::CreateAnother ( void  ) const
virtual

Reimplemented from itk::Object.

template<class TInputImage >
const bool & otb::SimpleParallelTiffWriter< TInputImage >::GetAbortGenerateData ( ) const
overridevirtual

This override doesn't return a const ref on the actual boolean

Reimplemented from itk::ProcessObject.

Definition at line 844 of file otbSimpleParallelTiffWriter.hxx.

References otb::Utils::FalseConstant, and otb::Utils::TrueConstant.

template<class TInputImage >
const char * otb::SimpleParallelTiffWriter< TInputImage >::GetFileName ( ) const
virtual

Does the real work.

Update method : update output information of input and write to file

Parse streaming modes

Tell all Observers that the filter is starting

Grab the input

Parse region size modes

If we ended due to aborting, push the progress up to 1.0 (since it probably didn't end there)

Release any inputs if marked for release

Definition at line 836 of file otbSimpleParallelTiffWriter.hxx.

template<class TInputImage >
virtual const otb::ImageIOBase* otb::SimpleParallelTiffWriter< TInputImage >::GetImageIO ( ) const
virtual
template<class TInputImage >
const TInputImage * otb::SimpleParallelTiffWriter< TInputImage >::GetInput ( void  )

Get writer only input

Definition at line 274 of file otbSimpleParallelTiffWriter.hxx.

template<class TInputImage >
virtual const itk::ImageIORegion& otb::SimpleParallelTiffWriter< TInputImage >::GetIORegion ( ) const
virtual

Specify the region to write. If left NULL, then the whole image is written.

template<class TInputImage >
virtual const char* otb::SimpleParallelTiffWriter< TInputImage >::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods).

Reimplemented from itk::ProcessObject.

template<class TInputImage >
unsigned int otb::SimpleParallelTiffWriter< TInputImage >::GetProcFromDivision ( unsigned int  regionIndex)
private

Definition at line 91 of file otbSimpleParallelTiffWriter.hxx.

References otb::MPIConfig::Instance().

template<class TInputImage >
StreamingManagerType* otb::SimpleParallelTiffWriter< TInputImage >::GetStreamingManager ( void  )
inline

Return the StreamingManager object responsible for dividing the region to write

Definition at line 150 of file otbSimpleParallelTiffWriter.h.

template<class TInputImage >
virtual bool otb::SimpleParallelTiffWriter< TInputImage >::GetTiffTiledMode ( )
virtual
template<class TInputImage >
virtual int otb::SimpleParallelTiffWriter< TInputImage >::GetTiffTileSize ( )
virtual
template<class TInputImage >
virtual const bool& otb::SimpleParallelTiffWriter< TInputImage >::GetUseInputMetaDataDictionary ( ) const
virtual

By default the MetaDataDictionary is taken from the input image and passed to the ImageIO. In some cases, however, a user may prefer to introduce her/his own MetaDataDictionary. This is often the case of the ImageSeriesWriter. This flag defined whether the MetaDataDictionary to use will be the one from the input image or the one already set in the ImageIO object.

template<class TInputImage >
virtual bool otb::SimpleParallelTiffWriter< TInputImage >::GetVerbose ( )
virtual
template<class TInputImage >
virtual bool otb::SimpleParallelTiffWriter< TInputImage >::GetVirtualMode ( )
virtual
template<class TInputImage >
otb::SimpleParallelTiffWriter< TInputImage >::itkGetObjectMacro ( ImageIO  ,
otb::ImageIOBase   
)
template<class TInputImage >
static Pointer otb::SimpleParallelTiffWriter< TInputImage >::New ( )
static

Method for creation through the object factory.

template<class TInputImage >
void otb::SimpleParallelTiffWriter< TInputImage >::ObserveSourceFilterProgress ( itk::Object object,
const itk::EventObject event 
)
inlineprivate

Definition at line 271 of file otbSimpleParallelTiffWriter.h.

References itk::ProcessObject::GetProgress().

template<class TInputImage >
void otb::SimpleParallelTiffWriter< TInputImage >::operator= ( const SimpleParallelTiffWriter< TInputImage > &  )
privatedelete
template<class TInputImage >
unsigned int otb::SimpleParallelTiffWriter< TInputImage >::OptimizeStrippedSplittingLayout ( unsigned int  n)
private

Definition at line 104 of file otbSimpleParallelTiffWriter.hxx.

References otb::MPIConfig::Instance().

template<class TInputImage >
void otb::SimpleParallelTiffWriter< TInputImage >::PrintSelf ( std::ostream &  os,
itk::Indent  indent 
) const
overrideprotectedvirtual

Reimplemented from itk::ProcessObject.

Definition at line 210 of file otbSimpleParallelTiffWriter.hxx.

template<class TInputImage >
void otb::SimpleParallelTiffWriter< TInputImage >::SetAbortGenerateData ( bool  val)
overridevirtual

Does the real work.

Update method : update output information of input and write to file

Parse streaming modes

Tell all Observers that the filter is starting

Grab the input

Parse region size modes

If we ended due to aborting, push the progress up to 1.0 (since it probably didn't end there)

Release any inputs if marked for release

Reimplemented from itk::ProcessObject.

Definition at line 856 of file otbSimpleParallelTiffWriter.hxx.

template<class TInputImage >
void otb::SimpleParallelTiffWriter< TInputImage >::SetAutomaticAdaptativeStreaming ( unsigned int  availableRAM = 0,
double  bias = 1.0 
)

Set the streaming mode to 'adaptative' and configure the number of MB available. The actual number of divisions is computed automatically by estimating the memory consumption of the pipeline. Tiles will try to match the input file tile scheme. Setting the availableRAM parameter to 0 means that the available RAM is set from the CMake configuration option

Definition at line 194 of file otbSimpleParallelTiffWriter.hxx.

template<class TInputImage >
void otb::SimpleParallelTiffWriter< TInputImage >::SetAutomaticStrippedStreaming ( unsigned int  availableRAM = 0,
double  bias = 1.0 
)

Set the streaming mode to 'stripped' and configure the number of MB available. The actual number of divisions is computed automatically by estimating the memory consumption of the pipeline. Setting the availableRAM parameter to 0 means that the available RAM is set from the CMake configuration option. The bias parameter is a multiplier applied on the estimated memory size of the pipeline and can be used to fine tune the potential gap between estimated memory and actual memory used, which can happen because of composite filters for example

Definition at line 156 of file otbSimpleParallelTiffWriter.hxx.

template<class TInputImage >
void otb::SimpleParallelTiffWriter< TInputImage >::SetAutomaticTiledStreaming ( unsigned int  availableRAM = 0,
double  bias = 1.0 
)

Set the streaming mode to 'tiled' and configure the number of MB available. The actual number of divisions is computed automatically by estimating the memory consumption of the pipeline. Tiles will be square. Setting the availableRAM parameter to 0 means that the available RAM is set from the CMake configuration option The bias parameter is a multiplier applied on the estimated memory size of the pipeline and can be used to fine tune the potential gap between estimated memory and actual memory used, which can happen because of composite filters for example

Definition at line 181 of file otbSimpleParallelTiffWriter.hxx.

template<class TInputImage >
void otb::SimpleParallelTiffWriter< TInputImage >::SetFileName ( const std::string &  extendedFileName)
virtual

Definition at line 825 of file otbSimpleParallelTiffWriter.hxx.

template<class TInputImage >
virtual void otb::SimpleParallelTiffWriter< TInputImage >::SetImageIO ( otb::ImageIOBase _arg)
virtual
template<class TInputImage >
void otb::SimpleParallelTiffWriter< TInputImage >::SetInput ( const InputImageType input)
virtual

Definition at line 266 of file otbSimpleParallelTiffWriter.hxx.

template<class TInputImage >
void otb::SimpleParallelTiffWriter< TInputImage >::SetIORegion ( const itk::ImageIORegion region)

Specify the region to write. If left NULL, then the whole image is written.

Definition at line 252 of file otbSimpleParallelTiffWriter.hxx.

template<class TInputImage >
void otb::SimpleParallelTiffWriter< TInputImage >::SetNumberOfDivisionsStrippedStreaming ( unsigned int  nbDivisions)

Set the streaming mode to 'stripped' and configure the number of strips which will be used to stream the image

Definition at line 120 of file otbSimpleParallelTiffWriter.hxx.

template<class TInputImage >
void otb::SimpleParallelTiffWriter< TInputImage >::SetNumberOfDivisionsTiledStreaming ( unsigned int  nbDivisions)

Set the streaming mode to 'tiled' and configure the number of tiles which will be used to stream the image

Definition at line 132 of file otbSimpleParallelTiffWriter.hxx.

template<class TInputImage >
void otb::SimpleParallelTiffWriter< TInputImage >::SetNumberOfLinesStrippedStreaming ( unsigned int  nbLinesPerStrip)

Set the streaming mode to 'stripped' and configure the number of strips which will be used to stream the image with respect to a number of line per strip

Definition at line 144 of file otbSimpleParallelTiffWriter.hxx.

template<class TInputImage >
void otb::SimpleParallelTiffWriter< TInputImage >::SetStreamingManager ( StreamingManagerType streamingManager)
inline

Set a user-specified implementation of StreamingManager used to divide the largest possible region in several divisions

Definition at line 157 of file otbSimpleParallelTiffWriter.h.

template<class TInputImage >
virtual void otb::SimpleParallelTiffWriter< TInputImage >::SetTiffTiledMode ( bool  _arg)
virtual
template<class TInputImage >
virtual void otb::SimpleParallelTiffWriter< TInputImage >::SetTiffTileSize ( int  _arg)
virtual
template<class TInputImage >
void otb::SimpleParallelTiffWriter< TInputImage >::SetTileDimensionTiledStreaming ( unsigned int  tileDimension)

Set the streaming mode to 'tiled' and configure the dimension of the tiles in pixels for each dimension (square tiles will be generated)

Definition at line 169 of file otbSimpleParallelTiffWriter.hxx.

template<class TInputImage >
virtual void otb::SimpleParallelTiffWriter< TInputImage >::SetUseInputMetaDataDictionary ( bool  _arg)
virtual

By default the MetaDataDictionary is taken from the input image and passed to the ImageIO. In some cases, however, a user may prefer to introduce her/his own MetaDataDictionary. This is often the case of the ImageSeriesWriter. This flag defined whether the MetaDataDictionary to use will be the one from the input image or the one already set in the ImageIO object.

template<class TInputImage >
virtual void otb::SimpleParallelTiffWriter< TInputImage >::SetVerbose ( bool  _arg)
virtual
template<class TInputImage >
virtual void otb::SimpleParallelTiffWriter< TInputImage >::SetVirtualMode ( bool  _arg)
virtual
template<class TInputImage >
void otb::SimpleParallelTiffWriter< TInputImage >::Update ( void  )
overridevirtual

Does the real work.

Update method : update output information of input and write to file

Parse streaming modes

Tell all Observers that the filter is starting

Grab the input

Parse region size modes

If we ended due to aborting, push the progress up to 1.0 (since it probably didn't end there)

Release any inputs if marked for release

Reimplemented from itk::ProcessObject.

Definition at line 290 of file otbSimpleParallelTiffWriter.hxx.

References itk::Object::AddObserver(), otb::Stopwatch::GetElapsedMilliseconds(), otb::MPIConfig::Instance(), otb::MetaDataKey::OSSIMKeywordlistKey, otbMsgDevMacro, itk::Object::RemoveObserver(), itk::DataObjectError::SetDataObject(), itk::ExceptionObject::SetDescription(), itk::ExceptionObject::SetLocation(), itk::Size< VDimension >::SetSize(), otb::Stopwatch::Start(), otb::Stopwatch::StartNew(), otb::Stopwatch::Stop(), type, and otb::WriteGeometry().

template<class TInputImage >
void otb::SimpleParallelTiffWriter< TInputImage >::UpdateFilterProgress ( )
inlineprivate

Definition at line 287 of file otbSimpleParallelTiffWriter.h.

template<class TInputImage >
virtual void otb::SimpleParallelTiffWriter< TInputImage >::UseInputMetaDataDictionaryOff ( )
virtual

By default the MetaDataDictionary is taken from the input image and passed to the ImageIO. In some cases, however, a user may prefer to introduce her/his own MetaDataDictionary. This is often the case of the ImageSeriesWriter. This flag defined whether the MetaDataDictionary to use will be the one from the input image or the one already set in the ImageIO object.

template<class TInputImage >
virtual void otb::SimpleParallelTiffWriter< TInputImage >::UseInputMetaDataDictionaryOn ( )
virtual

By default the MetaDataDictionary is taken from the input image and passed to the ImageIO. In some cases, however, a user may prefer to introduce her/his own MetaDataDictionary. This is often the case of the ImageSeriesWriter. This flag defined whether the MetaDataDictionary to use will be the one from the input image or the one already set in the ImageIO object.

Member Data Documentation

template<class TInputImage >
const unsigned int otb::SimpleParallelTiffWriter< TInputImage >::InputImageDimension = InputImageType::ImageDimension
static

Dimension of input image.

Definition at line 142 of file otbSimpleParallelTiffWriter.h.

template<class TInputImage >
unsigned int otb::SimpleParallelTiffWriter< TInputImage >::m_CurrentDivision
private

Definition at line 303 of file otbSimpleParallelTiffWriter.h.

template<class TInputImage >
float otb::SimpleParallelTiffWriter< TInputImage >::m_DivisionProgress
private

Definition at line 304 of file otbSimpleParallelTiffWriter.h.

template<class TInputImage >
bool otb::SimpleParallelTiffWriter< TInputImage >::m_FactorySpecifiedImageIO
private

Definition at line 315 of file otbSimpleParallelTiffWriter.h.

template<class TInputImage >
std::string otb::SimpleParallelTiffWriter< TInputImage >::m_FileName
private

SimpleParallelTiffWriter Parameters

Definition at line 307 of file otbSimpleParallelTiffWriter.h.

template<class TInputImage >
FNameHelperType::Pointer otb::SimpleParallelTiffWriter< TInputImage >::m_FilenameHelper
private

Definition at line 323 of file otbSimpleParallelTiffWriter.h.

template<class TInputImage >
otb::ImageIOBase::Pointer otb::SimpleParallelTiffWriter< TInputImage >::m_ImageIO
private

Definition at line 309 of file otbSimpleParallelTiffWriter.h.

template<class TInputImage >
itk::ImageIORegion otb::SimpleParallelTiffWriter< TInputImage >::m_IORegion
private

Definition at line 313 of file otbSimpleParallelTiffWriter.h.

template<class TInputImage >
bool otb::SimpleParallelTiffWriter< TInputImage >::m_IsObserving
private

Definition at line 327 of file otbSimpleParallelTiffWriter.h.

template<class TInputImage >
itk::SimpleFastMutexLock otb::SimpleParallelTiffWriter< TInputImage >::m_Lock
private

Lock to ensure thread-safety (added for the AbortGenerateData flag)

Definition at line 337 of file otbSimpleParallelTiffWriter.h.

template<class TInputImage >
unsigned int otb::SimpleParallelTiffWriter< TInputImage >::m_NumberOfDivisions
private

Definition at line 302 of file otbSimpleParallelTiffWriter.h.

template<class TInputImage >
unsigned long otb::SimpleParallelTiffWriter< TInputImage >::m_ObserverID
private

Definition at line 328 of file otbSimpleParallelTiffWriter.h.

template<class TInputImage >
InputIndexType otb::SimpleParallelTiffWriter< TInputImage >::m_ShiftOutputIndex
private

Definition at line 329 of file otbSimpleParallelTiffWriter.h.

template<class TInputImage >
StreamingManagerPointerType otb::SimpleParallelTiffWriter< TInputImage >::m_StreamingManager
private

Definition at line 325 of file otbSimpleParallelTiffWriter.h.

template<class TInputImage >
bool otb::SimpleParallelTiffWriter< TInputImage >::m_TiffTiledMode
private

Definition at line 334 of file otbSimpleParallelTiffWriter.h.

template<class TInputImage >
int otb::SimpleParallelTiffWriter< TInputImage >::m_TiffTileSize
private

Definition at line 331 of file otbSimpleParallelTiffWriter.h.

template<class TInputImage >
bool otb::SimpleParallelTiffWriter< TInputImage >::m_UseInputMetaDataDictionary
private

Definition at line 316 of file otbSimpleParallelTiffWriter.h.

template<class TInputImage >
bool otb::SimpleParallelTiffWriter< TInputImage >::m_UserSpecifiedImageIO
private

Definition at line 311 of file otbSimpleParallelTiffWriter.h.

template<class TInputImage >
bool otb::SimpleParallelTiffWriter< TInputImage >::m_UserSpecifiedIORegion
private

Definition at line 314 of file otbSimpleParallelTiffWriter.h.

template<class TInputImage >
bool otb::SimpleParallelTiffWriter< TInputImage >::m_Verbose
private

Definition at line 332 of file otbSimpleParallelTiffWriter.h.

template<class TInputImage >
bool otb::SimpleParallelTiffWriter< TInputImage >::m_VirtualMode
private

Definition at line 333 of file otbSimpleParallelTiffWriter.h.

template<class TInputImage >
bool otb::SimpleParallelTiffWriter< TInputImage >::m_WriteGeomFile
private

Definition at line 320 of file otbSimpleParallelTiffWriter.h.


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