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::StreamingImageVirtualWriter< TInputImage > Class Template Reference

#include <otbStreamingImageVirtualWriter.h>

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

Public Types

typedef itk::SmartPointer
< const Self
ConstPointer
 
typedef InputImageType::PixelType InputImagePixelType
 
typedef InputImageType::Pointer InputImagePointer
 
typedef InputImageType::RegionType InputImageRegionType
 
typedef TInputImage InputImageType
 
typedef itk::SmartPointer< SelfPointer
 
typedef StreamingImageVirtualWriter Self
 
typedef
StreamingManagerType::Pointer 
StreamingManagerPointerType
 
typedef StreamingManager
< InputImageType
StreamingManagerType
 
typedef
itk::ImageToImageFilter
< TInputImage, TInputImage > 
Superclass
 
- Public Types inherited from itk::ImageToImageFilter< TInputImage, TInputImage >
typedef SmartPointer< const SelfConstPointer
 
typedef
InputImageType::ConstPointer 
InputImageConstPointer
 
typedef InputImageType::PixelType InputImagePixelType
 
typedef InputImageType::Pointer InputImagePointer
 
typedef InputImageType::RegionType InputImageRegionType
 
typedef TInputImage InputImageType
 
typedef
Superclass::OutputImagePixelType 
OutputImagePixelType
 
typedef
Superclass::OutputImageRegionType 
OutputImageRegionType
 
typedef SmartPointer< SelfPointer
 
typedef ImageToImageFilter Self
 
typedef ImageSource< TInputImage > Superclass
 
- Public Types inherited from itk::ImageSource< TOutputImage >
typedef SmartPointer< const SelfConstPointer
 
typedef
Superclass::DataObjectIdentifierType 
DataObjectIdentifierType
 
typedef DataObject::Pointer DataObjectPointer
 
typedef
Superclass::DataObjectPointerArraySizeType 
DataObjectPointerArraySizeType
 
typedef OutputImageType::PixelType OutputImagePixelType
 
typedef OutputImageType::Pointer OutputImagePointer
 
typedef OutputImageType::RegionType OutputImageRegionType
 
typedef TOutputImage OutputImageType
 
typedef SmartPointer< SelfPointer
 
typedef ImageSource Self
 
typedef 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
 
const bool & GetAbortGenerateData () const override
 
virtual const char * GetNameOfClass () const
 
StreamingManagerTypeGetStreamingManager (void)
 
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)
 
void SetNumberOfDivisionsStrippedStreaming (unsigned int nbDivisions)
 
void SetNumberOfDivisionsTiledStreaming (unsigned int nbDivisions)
 
void SetNumberOfLinesStrippedStreaming (unsigned int nbLinesPerStrip)
 
void SetStreamingManager (StreamingManagerType *streamingManager)
 
void SetTileDimensionTiledStreaming (unsigned int tileDimension)
 
void Update () override
 
- Public Member Functions inherited from itk::ImageToImageFilter< TInputImage, TInputImage >
virtual double GetCoordinateTolerance () const
 
virtual double GetDirectionTolerance () const
 
const InputImageTypeGetInput () const
 
const InputImageTypeGetInput (unsigned int idx) const
 
virtual void PopBackInput () override
 
virtual void PopFrontInput () override
 
virtual void PushBackInput (const InputImageType *image)
 
virtual void PushFrontInput (const InputImageType *image)
 
virtual void SetCoordinateTolerance (double _arg)
 
virtual void SetDirectionTolerance (double _arg)
 
virtual void SetInput (const InputImageType *image)
 
virtual void SetInput (unsigned int, const TInputImage *image)
 
- Public Member Functions inherited from itk::ImageSource< TOutputImage >
OutputImageTypeGetOutput (unsigned int idx)
 
OutputImageTypeGetOutput ()
 
const OutputImageTypeGetOutput () const
 
virtual void GraftNthOutput (unsigned int idx, DataObject *output)
 
virtual void GraftOutput (const DataObjectIdentifierType &key, DataObject *output)
 
virtual void GraftOutput (DataObject *output)
 
virtual
ProcessObject::DataObjectPointer 
MakeOutput (ProcessObject::DataObjectPointerArraySizeType idx) override
 
virtual
ProcessObject::DataObjectPointer 
MakeOutput (const ProcessObject::DataObjectIdentifierType &) override
 
- 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 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
 
- Static Public Attributes inherited from itk::ImageToImageFilter< TInputImage, TInputImage >
static const unsigned int InputImageDimension
 
static const unsigned int OutputImageDimension
 
- Static Public Attributes inherited from itk::ImageSource< TOutputImage >
static const unsigned int OutputImageDimension
 

Protected Member Functions

void GenerateInputRequestedRegion (void) override
 
void PrintSelf (std::ostream &os, itk::Indent indent) const override
 
 StreamingImageVirtualWriter ()
 
 ~StreamingImageVirtualWriter () override
 
- Protected Member Functions inherited from itk::ImageToImageFilter< TInputImage, TInputImage >
virtual void CallCopyInputRegionToOutputRegion (OutputImageRegionType &destRegion, const InputImageRegionType &srcRegion)
 
virtual void CallCopyOutputRegionToInputRegion (InputImageRegionType &destRegion, const OutputImageRegionType &srcRegion)
 
 ImageToImageFilter ()
 
void PushBackInput (const DataObject *input) override
 
void PushFrontInput (const DataObject *input) override
 
virtual void VerifyInputInformation () override
 
 ~ImageToImageFilter ()
 
- Protected Member Functions inherited from itk::ImageSource< TOutputImage >
virtual void AfterThreadedGenerateData ()
 
virtual void AllocateOutputs ()
 
virtual void BeforeThreadedGenerateData ()
 
virtual const
ImageRegionSplitterBase
GetImageRegionSplitter () const
 
 ImageSource ()
 
virtual unsigned int SplitRequestedRegion (unsigned int i, unsigned int pieces, OutputImageRegionType &splitRegion)
 
virtual void ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, ThreadIdType threadId)
 
virtual ~ImageSource ()
 
- 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 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
 
 ProcessObject ()
 
virtual void PropagateResetPipeline ()
 
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 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 ObserveSourceFilterProgress (itk::Object *object, const itk::EventObject &event)
 
void operator= (const StreamingImageVirtualWriter &)=delete
 
 StreamingImageVirtualWriter (const StreamingImageVirtualWriter &)=delete
 
void UpdateFilterProgress ()
 

Private Attributes

unsigned int m_CurrentDivision
 
float m_DivisionProgress
 
bool m_IsObserving
 
itk::SimpleFastMutexLock m_Lock
 
unsigned int m_NumberOfDivisions
 
unsigned long m_ObserverID
 
StreamingManagerPointerType m_StreamingManager
 
void SetAbortGenerateData (const bool val) override
 
void GenerateData (void) override
 

Additional Inherited Members

- Protected Types inherited from itk::ImageToImageFilter< TInputImage, TInputImage >
typedef
ImageToImageFilterDetail::ImageRegionCopier
< itkGetStaticConstMacro(OutputImageDimension),
itkGetStaticConstMacro(InputImageDimension) > 
InputToOutputRegionCopierType
 
typedef
ImageToImageFilterDetail::ImageRegionCopier
< itkGetStaticConstMacro(InputImageDimension),
itkGetStaticConstMacro(OutputImageDimension) > 
OutputToInputRegionCopierType
 
- Static Protected Member Functions inherited from itk::ImageSource< TOutputImage >
static const
ImageRegionSplitterBase
GetGlobalDefaultSplitter ()
 
static ITK_THREAD_RETURN_TYPE ThreaderCallback (void *arg)
 
- 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::StreamingImageVirtualWriter< TInputImage >

This class acts like a StreamingImageFileWriter, but without actually writing data to the disk.

This allows streaming the whole image through persistent filters such as PersitentStatisticsImageFilter in order to get the global statistics of an image.

This filter is not intended to be used with classic ImageToImageFilter, though it will not generate any error.

The computation of divisions can be done following different strategies by setting the StreamingManager attributes with SetStreamingManager. A set of behaviors are available with the following methods :

It is used in the PersistentFilterStreamingDecorator helper class to propose an easy way to stream an image through a persistent filter.

See Also
PersistentImageFilter
PersistentStatisticsImageFilter
PersistentImageStreamingDecorator.

Definition at line 60 of file otbStreamingImageVirtualWriter.h.

Member Typedef Documentation

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

Definition at line 67 of file otbStreamingImageVirtualWriter.h.

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

Definition at line 79 of file otbStreamingImageVirtualWriter.h.

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

Definition at line 77 of file otbStreamingImageVirtualWriter.h.

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

Definition at line 78 of file otbStreamingImageVirtualWriter.h.

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

Some typedefs for the input and output.

Definition at line 73 of file otbStreamingImageVirtualWriter.h.

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

Definition at line 66 of file otbStreamingImageVirtualWriter.h.

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

Standard class typedefs.

Definition at line 64 of file otbStreamingImageVirtualWriter.h.

Definition at line 83 of file otbStreamingImageVirtualWriter.h.

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

Streaming manager base class pointer

Definition at line 82 of file otbStreamingImageVirtualWriter.h.

template<class TInputImage >
typedef itk::ImageToImageFilter<TInputImage, TInputImage> otb::StreamingImageVirtualWriter< TInputImage >::Superclass

Definition at line 65 of file otbStreamingImageVirtualWriter.h.

Constructor & Destructor Documentation

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

Definition at line 42 of file otbStreamingImageVirtualWriter.hxx.

template<class TInputImage >
otb::StreamingImageVirtualWriter< TInputImage >::~StreamingImageVirtualWriter ( )
overrideprotected

Definition at line 56 of file otbStreamingImageVirtualWriter.hxx.

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

Member Function Documentation

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

Reimplemented from itk::Object.

template<class TInputImage >
void otb::StreamingImageVirtualWriter< TInputImage >::GenerateData ( void  )
overrideprotectedvirtual

Prepare all the outputs. This may deallocate previous bulk data.

Tell all Observers that the filter is starting

Grab the input

Determine of number of pieces to divide the input. This will be the minimum of what the user specified via SetNumberOfDivisionsStrippedStreaming() and what the Splitter thinks is a reasonable value.

Register to the ProgressEvent of the source filter

Loop over the number of pieces, execute the upstream pipeline on each piece, and copy the results into the output image.

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

Now we have to mark the data as up to data.

Release any inputs if marked for release

Reimplemented from itk::ImageSource< TOutputImage >.

Definition at line 184 of file otbStreamingImageVirtualWriter.hxx.

References itk::Object::AddObserver(), otb::Logger::Instance(), otbLogMacro, itk::Object::RemoveObserver(), itk::ExceptionObject::SetDescription(), and itk::ExceptionObject::SetLocation().

template<class TInputImage >
void otb::StreamingImageVirtualWriter< TInputImage >::GenerateInputRequestedRegion ( void  )
overrideprotectedvirtual
template<class TInputImage >
const bool & otb::StreamingImageVirtualWriter< TInputImage >::GetAbortGenerateData ( ) const
overridevirtual

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

Reimplemented from itk::ProcessObject.

Definition at line 307 of file otbStreamingImageVirtualWriter.hxx.

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

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

Run-time type information (and related methods).

Reimplemented from itk::ImageToImageFilter< TInputImage, TInputImage >.

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

Return the StreamingManager object responsible for dividing the region to write

Definition at line 91 of file otbStreamingImageVirtualWriter.h.

template<class TInputImage >
static Pointer otb::StreamingImageVirtualWriter< TInputImage >::New ( )
static

Method for creation through the object factory.

template<class TInputImage >
void otb::StreamingImageVirtualWriter< TInputImage >::ObserveSourceFilterProgress ( itk::Object object,
const itk::EventObject event 
)
inlineprivate
template<class TInputImage >
void otb::StreamingImageVirtualWriter< TInputImage >::operator= ( const StreamingImageVirtualWriter< TInputImage > &  )
privatedelete
template<class TInputImage >
void otb::StreamingImageVirtualWriter< TInputImage >::PrintSelf ( std::ostream &  os,
itk::Indent  indent 
) const
overrideprotectedvirtual
template<class TInputImage >
void otb::StreamingImageVirtualWriter< TInputImage >::SetAbortGenerateData ( const bool  val)
overridevirtual

Prepare all the outputs. This may deallocate previous bulk data.

Tell all Observers that the filter is starting

Grab the input

Determine of number of pieces to divide the input. This will be the minimum of what the user specified via SetNumberOfDivisionsStrippedStreaming() and what the Splitter thinks is a reasonable value.

Register to the ProgressEvent of the source filter

Loop over the number of pieces, execute the upstream pipeline on each piece, and copy the results into the output image.

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

Now we have to mark the data as up to data.

Release any inputs if marked for release

Reimplemented from itk::ProcessObject.

Definition at line 319 of file otbStreamingImageVirtualWriter.hxx.

template<class TInputImage >
void otb::StreamingImageVirtualWriter< 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 143 of file otbStreamingImageVirtualWriter.hxx.

template<class TInputImage >
void otb::StreamingImageVirtualWriter< 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

Definition at line 107 of file otbStreamingImageVirtualWriter.hxx.

template<class TInputImage >
void otb::StreamingImageVirtualWriter< 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

Definition at line 131 of file otbStreamingImageVirtualWriter.hxx.

template<class TInputImage >
void otb::StreamingImageVirtualWriter< 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 71 of file otbStreamingImageVirtualWriter.hxx.

template<class TInputImage >
void otb::StreamingImageVirtualWriter< 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 83 of file otbStreamingImageVirtualWriter.hxx.

template<class TInputImage >
void otb::StreamingImageVirtualWriter< 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

Definition at line 95 of file otbStreamingImageVirtualWriter.hxx.

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

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

Definition at line 98 of file otbStreamingImageVirtualWriter.h.

template<class TInputImage >
void otb::StreamingImageVirtualWriter< 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 119 of file otbStreamingImageVirtualWriter.hxx.

template<class TInputImage >
void otb::StreamingImageVirtualWriter< TInputImage >::Update ( void  )
overridevirtual

Override Update() from ProcessObject This filter does not produce an output

Reimplemented from itk::ProcessObject.

Definition at line 155 of file otbStreamingImageVirtualWriter.hxx.

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

Definition at line 182 of file otbStreamingImageVirtualWriter.h.

Member Data Documentation

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

Dimension of input image.

Definition at line 87 of file otbStreamingImageVirtualWriter.h.

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

Definition at line 188 of file otbStreamingImageVirtualWriter.h.

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

Definition at line 189 of file otbStreamingImageVirtualWriter.h.

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

Definition at line 193 of file otbStreamingImageVirtualWriter.h.

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

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

Definition at line 197 of file otbStreamingImageVirtualWriter.h.

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

Definition at line 187 of file otbStreamingImageVirtualWriter.h.

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

Definition at line 194 of file otbStreamingImageVirtualWriter.h.

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

Definition at line 191 of file otbStreamingImageVirtualWriter.h.


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