Writes image data to a single file with streaming process. More...

#include <otbImageFileWriter.h>

Inheritance diagram for otb::ImageFileWriter< TInputImage >:

Collaboration diagram for otb::ImageFileWriter< TInputImage >:

Public Types
typedef itk::SmartPointer < const Self >	ConstPointer

typedef Superclass::DataObjectPointer	DataObjectPointer

typedef std::vector < DataObjectPointer >	DataObjectPointerArray

typedef DataObjectPointerArray::size_type	DataObjectPointerArraySizeType

typedef 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< Self >	Pointer

typedef ImageFileWriter	Self

typedef StreamingManagerType::Pointer	StreamingManagerPointerType

typedef StreamingManager < InputImageType >	StreamingManagerType

typedef itk::ProcessObject	Superclass

Public Member Functions
virtual void	AbortGenerateDataOff ()

virtual void	AbortGenerateDataOn ()

unsigned long	AddObserver (const EventObject &event, Command *)

unsigned long	AddObserver (const EventObject &event, Command *) const

virtual ::itk::LightObject::Pointer	CreateAnother (void) const

virtual void	DebugOff () const

virtual void	DebugOn () const

virtual void	Delete ()

virtual void	EnlargeOutputRequestedRegion (DataObject *)

virtual const bool &	GetAbortGenerateData ()

Command *	GetCommand (unsigned long tag)

bool	GetDebug () const

virtual const char *	GetFileName () const

virtual otb::ImageIOBase *	GetImageIO ()

virtual const otb::ImageIOBase *	GetImageIO ()

const InputImageType *	GetInput ()

DataObjectPointerArray &	GetInputs ()

virtual const itk::ImageIORegion &	GetIORegion ()

MetaDataDictionary &	GetMetaDataDictionary (void)

const MetaDataDictionary &	GetMetaDataDictionary (void) const

virtual unsigned long	GetMTime () const

MultiThreader *	GetMultiThreader ()

virtual const char *	GetNameOfClass () const

DataObjectPointerArraySizeType	GetNumberOfInputs () const

DataObjectPointerArraySizeType	GetNumberOfOutputs () const

virtual const int &	GetNumberOfThreads ()

virtual DataObjectPointerArraySizeType	GetNumberOfValidRequiredInputs () const

DataObjectPointerArray &	GetOutputs ()

virtual const float &	GetProgress ()

virtual int	GetReferenceCount () const

virtual const bool &	GetReleaseDataBeforeUpdateFlag ()

virtual bool	GetReleaseDataFlag () const

StreamingManagerType *	GetStreamingManager (void)

virtual const bool &	GetUseCompression ()

virtual const bool &	GetUseInputMetaDataDictionary ()

bool	HasObserver (const EventObject &event) const

void	InvokeEvent (const EventObject &)

void	InvokeEvent (const EventObject &) const

virtual DataObjectPointer	MakeOutput (unsigned int idx)

virtual void	Modified () const

virtual void	PrepareOutputs ()

void	Print (std::ostream &os, Indent indent=0) const

virtual void	PropagateRequestedRegion (DataObject *output)

virtual void	Register () const

virtual void	ReleaseDataBeforeUpdateFlagOff ()

virtual void	ReleaseDataBeforeUpdateFlagOn ()

void	ReleaseDataFlagOff ()

void	ReleaseDataFlagOn ()

void	RemoveAllObservers ()

void	RemoveObserver (unsigned long tag)

virtual void	ResetPipeline ()

virtual void	SetAbortGenerateData (bool _arg)

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	SetDebug (bool debugFlag) const

virtual void	SetFileName (const char *extendedFileName)

virtual void	SetFileName (std::string extendedFileName)

virtual void	SetImageIO (otb::ImageIOBase *_arg)

virtual void	SetInput (const InputImageType *input)

void	SetIORegion (const itk::ImageIORegion &region)

void	SetMetaDataDictionary (const MetaDataDictionary &rhs)

void	SetNumberOfDivisionsStrippedStreaming (unsigned int nbDivisions)

void	SetNumberOfDivisionsTiledStreaming (unsigned int nbDivisions)

void	SetNumberOfLinesStrippedStreaming (unsigned int nbLinesPerStrip)

virtual void	SetNumberOfThreads (int _arg)

virtual void	SetProgress (float _arg)

virtual void	SetReferenceCount (int)

virtual void	SetReleaseDataBeforeUpdateFlag (bool _arg)

virtual void	SetReleaseDataFlag (bool flag)

void	SetStreamingManager (StreamingManagerType *streamingManager)

void	SetTileDimensionTiledStreaming (unsigned int tileDimension)

virtual void	SetUseCompression (bool _arg)

virtual void	SetUseInputMetaDataDictionary (bool _arg)

virtual void	UnRegister () const

virtual void	Update ()

virtual void	UpdateLargestPossibleRegion ()

virtual void	UpdateOutputData (DataObject *output)

virtual void	UpdateOutputInformation ()

void	UpdateProgress (float amount)

virtual void	UseCompressionOff ()

virtual void	UseCompressionOn ()

virtual void	UseInputMetaDataDictionaryOff ()

virtual void	UseInputMetaDataDictionaryOn ()

Static Public Member Functions
static void	BreakOnError ()

static bool	GetGlobalWarningDisplay ()

static void	GlobalWarningDisplayOff ()

static void	GlobalWarningDisplayOn ()

static Pointer	New ()

static void	SetGlobalWarningDisplay (bool flag)

Static Public Attributes
static const unsigned int	InputImageDimension = InputImageType::ImageDimension

Protected Types
typedef int	InternalReferenceCountType

Protected Member Functions
	ImageFileWriter ()

virtual	~ImageFileWriter ()

virtual void	AddInput (DataObject *input)

virtual void	AddOutput (DataObject *output)

virtual void	CacheInputReleaseDataFlags ()

virtual void	GenerateData (void)

virtual void	GenerateInputRequestedRegion ()

virtual void	GenerateOutputInformation ()

virtual void	GenerateOutputRequestedRegion (DataObject *output)

DataObject *	GetInput (unsigned int idx)

const DataObject *	GetInput (unsigned int idx) const

virtual const unsigned int &	GetNumberOfRequiredInputs ()

virtual const unsigned int &	GetNumberOfRequiredOutputs ()

DataObject *	GetOutput (unsigned int idx)

const DataObject *	GetOutput (unsigned int idx) const

virtual void	PopBackInput ()

virtual void	PopFrontInput ()

virtual void	PrintHeader (std::ostream &os, Indent indent) const

bool	PrintObservers (std::ostream &os, Indent indent) const

void	PrintSelf (std::ostream &os, itk::Indent indent) const

virtual void	PrintTrailer (std::ostream &os, Indent indent) const

virtual void	PropagateResetPipeline ()

virtual void	PushBackInput (const DataObject *input)

virtual void	PushFrontInput (const DataObject *input)

virtual void	ReleaseInputs ()

virtual void	RemoveInput (DataObject *input)

virtual void	RemoveOutput (DataObject *output)

virtual void	RestoreInputReleaseDataFlags ()

virtual void	SetNthInput (unsigned int num, DataObject *input)

virtual void	SetNthOutput (unsigned int num, DataObject *output)

void	SetNumberOfInputs (unsigned int num)

void	SetNumberOfOutputs (unsigned int num)

virtual void	SetNumberOfRequiredInputs (unsigned int _arg)

virtual void	SetNumberOfRequiredOutputs (unsigned int _arg)

Protected Attributes
TimeStamp	m_OutputInformationMTime

InternalReferenceCountType	m_ReferenceCount

SimpleFastMutexLock	m_ReferenceCountLock

bool	m_Updating

Private Member Functions
	ImageFileWriter (const ImageFileWriter &)

void	ObserveSourceFilterProgress (itk::Object *object, const itk::EventObject &event)

void	operator= (const ImageFileWriter &)

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

unsigned int	m_NumberOfDivisions

unsigned long	m_ObserverID

InputIndexType	m_ShiftOutputIndex

StreamingManagerPointerType	m_StreamingManager

bool	m_UseCompression

bool	m_UseInputMetaDataDictionary

bool	m_UserSpecifiedImageIO

bool	m_UserSpecifiedIORegion

bool	m_WriteGeomFile

Detailed Description

template<class TInputImage>
class otb::ImageFileWriter< TInputImage >

Writes image data to a single file with streaming process.

ImageFileWriter writes its input data to a single output file. ImageFileWriter interfaces with an ImageIO class to write out the data whith streaming process.

ImageFileWriter 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.

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

ImageFileWriter supports extended filenames, which allow to control some properties of the output file. See http://wiki.orfeo-toolbox.org/index.php/ExtendedFileName for more information.

See Also: ImageFileReader; ImageSeriesReader; ImageIOBase; ExtendedFilenameToReaderOptions

Examples:: BasicFilters/DEMToRainbowExample.cxx, BasicFilters/HillShadingExample.cxx, ChangeDetection/ChangeDetectionFrameworkExample.cxx, DisparityMap/FineRegistrationImageFilterExample.cxx, DisparityMap/NCCRegistrationFilterExample.cxx, Examples/Iterators/ImageLinearIteratorWithIndex.cxx, FeatureExtraction/CloudDetectionExample.cxx, FeatureExtraction/ExtractRoadByStepsExample.cxx, FeatureExtraction/ExtractRoadExample.cxx, Fusion/BayesianFusionImageFilter.cxx, Fusion/PanSharpeningExample.cxx, IO/DEMToImageGenerator.cxx, Iterators/ImageRegionIterator.cxx, Iterators/ImageRegionIteratorWithIndex.cxx, Markov/MarkovClassification1Example.cxx, Markov/MarkovClassification2Example.cxx, Markov/MarkovRegularizationExample.cxx, Markov/MarkovRestaurationExample.cxx, Projections/OrthoRectificationExample.cxx, and Radiometry/AtmosphericCorrectionSequencement.cxx.

Definition at line 58 of file otbImageFileWriter.h.

Member Typedef Documentation

template<class TInputImage>

typedef itk::SmartPointer<const Self> otb::ImageFileWriter< TInputImage >::ConstPointer

Definition at line 65 of file otbImageFileWriter.h.

template<class TInputImage>

typedef Superclass::DataObjectPointer otb::ImageFileWriter< TInputImage >::DataObjectPointer

Definition at line 83 of file otbImageFileWriter.h.

typedef std::vector<DataObjectPointer> itk::ProcessObject::DataObjectPointerArray

inherited

STL Array of SmartPointers to DataObjects

Definition at line 103 of file itkProcessObject.h.

typedef DataObjectPointerArray::size_type itk::ProcessObject::DataObjectPointerArraySizeType

inherited

Size type of an std::vector

Definition at line 112 of file itkProcessObject.h.

template<class TInputImage>

typedef ExtendedFilenameToWriterOptions otb::ImageFileWriter< TInputImage >::FNameHelperType

The Filename Helper.

Definition at line 86 of file otbImageFileWriter.h.

template<class TInputImage>

typedef InputImageType::PixelType otb::ImageFileWriter< TInputImage >::InputImagePixelType

Definition at line 77 of file otbImageFileWriter.h.

template<class TInputImage>

typedef InputImageType::Pointer otb::ImageFileWriter< TInputImage >::InputImagePointer

Definition at line 75 of file otbImageFileWriter.h.

template<class TInputImage>

typedef InputImageType::RegionType otb::ImageFileWriter< TInputImage >::InputImageRegionType

Definition at line 76 of file otbImageFileWriter.h.

template<class TInputImage>

typedef TInputImage otb::ImageFileWriter< TInputImage >::InputImageType

Some typedefs for the input and output.

Definition at line 71 of file otbImageFileWriter.h.

template<class TInputImage>

typedef InputImageType::IndexType otb::ImageFileWriter< TInputImage >::InputIndexType

Definition at line 78 of file otbImageFileWriter.h.

typedef int itk::LightObject::InternalReferenceCountType

protectedinherited

Define the type of the reference count according to the target. This allows the use of atomic operations

Definition at line 137 of file itkLightObject.h.

template<class TInputImage>

typedef OutputImageType::PixelType otb::ImageFileWriter< TInputImage >::OutputImagePixelType

Definition at line 82 of file otbImageFileWriter.h.

template<class TInputImage>

typedef OutputImageType::Pointer otb::ImageFileWriter< TInputImage >::OutputImagePointer

Definition at line 80 of file otbImageFileWriter.h.

template<class TInputImage>

typedef OutputImageType::RegionType otb::ImageFileWriter< TInputImage >::OutputImageRegionType

Definition at line 81 of file otbImageFileWriter.h.

template<class TInputImage>

typedef TInputImage otb::ImageFileWriter< TInputImage >::OutputImageType

Definition at line 79 of file otbImageFileWriter.h.

template<class TInputImage>

typedef itk::SmartPointer<Self> otb::ImageFileWriter< TInputImage >::Pointer

Definition at line 64 of file otbImageFileWriter.h.

template<class TInputImage>

typedef ImageFileWriter otb::ImageFileWriter< TInputImage >::Self

Standard class typedefs.

Definition at line 62 of file otbImageFileWriter.h.

template<class TInputImage>

typedef StreamingManagerType::Pointer otb::ImageFileWriter< TInputImage >::StreamingManagerPointerType

Definition at line 94 of file otbImageFileWriter.h.

template<class TInputImage>

typedef StreamingManager<InputImageType> otb::ImageFileWriter< TInputImage >::StreamingManagerType

Streaming manager base class pointer

Definition at line 93 of file otbImageFileWriter.h.

template<class TInputImage>

typedef itk::ProcessObject otb::ImageFileWriter< TInputImage >::Superclass

Definition at line 63 of file otbImageFileWriter.h.

Constructor & Destructor Documentation

template<class TInputImage >

otb::ImageFileWriter< TInputImage >::ImageFileWriter ( )

protected

Definition at line 57 of file otbImageFileWriter.txx.

template<class TInputImage >

otb::ImageFileWriter< TInputImage >::~ImageFileWriter ( )

protectedvirtual

Definition at line 86 of file otbImageFileWriter.txx.

template<class TInputImage>

otb::ImageFileWriter< TInputImage >::ImageFileWriter ( const ImageFileWriter< TInputImage > & )

private

Member Function Documentation

virtual void itk::ProcessObject::AbortGenerateDataOff ( )

virtualinherited

virtual void itk::ProcessObject::AbortGenerateDataOn ( )

virtualinherited

Turn on and off the AbortGenerateData flag.

void itk::ProcessObject::AddInput ( DataObject * input )

protectedvirtualinherited

Adds an input to the first null position in the input list. Expands the list memory if necessary

Reimplemented in otb::ObjectDetectionClassifier< TInputImage, TOutputVectorData, TLabel, TFunctionPrecision, TCoordRep >, otb::DescriptorsListSampleGenerator< TInputImage, TVectorData, TListSample, TLabelListSample, TOutputPrecision, TCoordRep >, otb::PersistentDescriptorsListSampleGenerator< TInputImage, TVectorData, TFunctionType, TListSample, TLabelListSample >, and otb::PersistentObjectDetectionClassifier< TInputImage, TOutputVectorData, TLabel, TFunctionType >.

Definition at line 144 of file itkProcessObject.cxx.

unsigned long itk::Object::AddObserver	(	const EventObject &	event,
		Command *	cmd
	)

inherited

Allow people to add/remove/invoke observers (callbacks) to any ITK object. This is an implementation of the subject/observer design pattern. An observer is added by specifying an event to respond to and an itk::Command to execute. It returns an unsigned long tag which can be used later to remove the event or retrieve the command. The memory for the Command becomes the responsibility of this object, so don't pass the same instance of a command to two different objects

Definition at line 389 of file itkObject.cxx.

References itk::SubjectImplementation::AddObserver().

Referenced by otb::StreamingImageVirtualWriter< TInputImage >::GenerateData(), itk::ProgressAccumulator::RegisterInternalFilter(), otb::ImageFileWriter< TInputImage >::Update(), and otb::WriterWatcherBase::WriterWatcherBase().

unsigned long itk::Object::AddObserver	(	const EventObject &	event,
		Command *	cmd
	)		const

inherited

Definition at line 401 of file itkObject.cxx.

References itk::SubjectImplementation::AddObserver().

void itk::ProcessObject::AddOutput ( DataObject * output )

protectedvirtualinherited

Adds an output to the first null position in the output list. Expands the list memory if necessary

Definition at line 390 of file itkProcessObject.cxx.

References itk::DataObject::ConnectSource().

void itk::LightObject::BreakOnError ( )

staticinherited

This method is called when itkExceptionMacro executes. It allows the debugger to break on error.

Definition at line 149 of file itkLightObject.cxx.

void itk::ProcessObject::CacheInputReleaseDataFlags ( )

protectedvirtualinherited

Cache the state of any ReleaseDataFlag's on the inputs. While the filter is executing, we need to set the ReleaseDataFlag's on the inputs to false in case the current filter is implemented using a mini-pipeline (which will try to release the inputs). After the filter finishes, we restore the state of the ReleaseDataFlag's before the call to ReleaseInputs().

Definition at line 1050 of file itkProcessObject.cxx.

template<class TInputImage>

virtual::itk::LightObject::Pointer otb::ImageFileWriter< TInputImage >::CreateAnother ( void ) const

virtual

Create an object from an instance, potentially deferring to a factory. This method allows you to create an instance of an object that is exactly the same type as the referring object. This is useful in cases where an object has been cast back to a base class.

Reimplemented from itk::Object.

Reimplemented in otb::StreamingImageFileWriter< TInputImage >.

void itk::Object::DebugOff ( ) const

virtualinherited

Turn debugging output off.

Definition at line 253 of file itkObject.cxx.

void itk::Object::DebugOn ( ) const

virtualinherited

Turn debugging output on.

Definition at line 242 of file itkObject.cxx.

void itk::LightObject::Delete ( )

virtualinherited

Delete an itk object. This method should always be used to delete an object when the new operator was used to create it. Using the C delete method will not work with reference counting.

Delete a itk object. This method should always be used to delete an object when the new operator was used to create it. Using the C++ delete method will not work with reference counting.

Definition at line 88 of file itkLightObject.cxx.

virtual void itk::ProcessObject::EnlargeOutputRequestedRegion ( DataObject * )

inlinevirtualinherited

Give the process object a chance to indictate that it will produce more output than it was requested to produce. For example, many imaging filters must compute the entire output at once or can only produce output in complete slices. Such filters cannot handle smaller requested regions. These filters must provide an implementation of this method, setting the output requested region to the size they will produce. By default, a process object does not modify the size of the output requested region.

Definition at line 224 of file itkProcessObject.h.

template<class TInputImage >

void otb::ImageFileWriter< TInputImage >::GenerateData ( void )

protectedvirtual

Does the real work.

Reimplemented from itk::ProcessObject.

Definition at line 684 of file otbImageFileWriter.txx.

References otb::MetaDataKey::OSSIMKeywordlistKey, itk::ExceptionObject::SetDescription(), itk::ExceptionObject::SetLocation(), and otb::WriteGeometry().

void itk::ProcessObject::GenerateInputRequestedRegion ( void )

protectedvirtualinherited

What is the input requested region that is required to produce the output requested region? By default, the largest possible region is always required but this is overridden in many subclasses. For instance, for an image processing filter where an output pixel is a simple function of an input pixel, the input requested region will be set to the output requested region. For an image processing filter where an output pixel is a function of the pixels in a neighborhood of an input pixel, then the input requested region will need to be larger than the output requested region (to avoid introducing artificial boundary conditions). This function should never request an input region that is outside the the input largest possible region (i.e. implementations of this method should crop the input requested region at the boundaries of the input largest possible region).

By default we require all the input to produce the output. This is overridden in the subclasses since we can often produce the output with just a portion of the input data.

Definition at line 828 of file itkProcessObject.cxx.

void itk::ProcessObject::GenerateOutputInformation ( void )

protectedvirtualinherited

Generate the information decribing the output data. The default implementation of this method will copy information from the input to the output. A filter may override this method if its output will have different information than its input. For instance, a filter that shrinks an image will need to provide an implementation for this method that changes the spacing of the pixels. Such filters should call their superclass' implementation of this method prior to changing the information values they need (i.e. GenerateOutputInformation() should call Superclass::GenerateOutputInformation() prior to changing the information.

Default implementation - copy information from first input to all outputs

Examples:: Fusion/BayesianFusionImageFilter.cxx.

Definition at line 1095 of file itkProcessObject.cxx.

Referenced by main().

void itk::ProcessObject::GenerateOutputRequestedRegion ( DataObject * output )

protectedvirtualinherited

Given one output whose requested region has been set, how should the requested regions for the remaining outputs of the process object be set? By default, all the outputs are set to the same requested region. If a filter needs to produce different requested regions for each output, for instance an image processing filter producing several outputs at different resolutions, then that filter may override this method and set the requested regions appropriatedly.

Note that a filter producing multiple outputs of different types is required to override this method. The default implementation can only correctly handle multiple outputs of the same type.

By default we set all the output requested regions to be the same.

Reimplemented in otb::watershed::Segmenter< TInputImage >, itk::watershed::Segmenter< TInputImage >, otb::watershed::Segmenter< InputImageType >, itk::watershed::Segmenter< InputImageType >, itk::watershed::SegmentTreeGenerator< TScalarType >, itk::watershed::SegmentTreeGenerator< ScalarType >, itk::MultiResolutionPyramidImageFilter< TInputImage, TOutputImage >, otb::watershed::Relabeler< TScalarType, TImageDimension >, itk::watershed::Relabeler< TScalarType, TImageDimension >, otb::watershed::Relabeler< ScalarType, itkGetStaticConstMacro(ImageDimension)>, itk::watershed::Relabeler< ScalarType, itkGetStaticConstMacro(ImageDimension)>, otb::watershed::BoundaryResolver< TPixelType, TDimension >, itk::watershed::BoundaryResolver< TPixelType, TDimension >, otb::watershed::EquivalenceRelabeler< TScalarType, TImageDimension >, itk::watershed::EquivalenceRelabeler< TScalarType, TImageDimension >, and itk::RecursiveMultiResolutionPyramidImageFilter< TInputImage, TOutputImage >.

Definition at line 846 of file itkProcessObject.cxx.

virtual const bool& itk::ProcessObject::GetAbortGenerateData ( )

virtualinherited

Get the AbortGenerateData flag for the process object. Process objects may handle premature termination of execution in different ways.

Referenced by itk::ParallelSparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::IterateThreaderCallback().

Command * itk::Object::GetCommand ( unsigned long tag )

inherited

Get the command associated with the given tag. NOTE: This returns a pointer to a Command, but it is safe to asign this to a Command::Pointer. Since Command inherits from LightObject, at this point in the code, only a pointer or a reference to the Command can be used.

Definition at line 414 of file itkObject.cxx.

References itk::Object::GetCommand(), and NULL.

Referenced by itk::Object::GetCommand().

bool itk::Object::GetDebug ( ) const

inherited

Get the value of the debug flag.

Definition at line 264 of file itkObject.cxx.

Referenced by otb::ogr::ImageReference< double >::GetDebug().

template<class TInputImage >

const char * otb::ImageFileWriter< TInputImage >::GetFileName ( ) const

virtual

Definition at line 800 of file otbImageFileWriter.txx.

bool itk::Object::GetGlobalWarningDisplay ( )

staticinherited

Get the value of the global debug output control flag.

Definition at line 381 of file itkObject.cxx.

template<class TInputImage>

virtual otb::ImageIOBase* otb::ImageFileWriter< TInputImage >::GetImageIO ( )

virtual

template<class TInputImage>

virtual const otb::ImageIOBase* otb::ImageFileWriter< TInputImage >::GetImageIO ( )

virtual

template<class TInputImage >

const TInputImage * otb::ImageFileWriter< TInputImage >::GetInput ( void )

Get writer only input

Definition at line 254 of file otbImageFileWriter.txx.

DataObject * itk::ProcessObject::GetInput ( unsigned int idx )

protectedinherited

Method used internally for getting an input.

Definition at line 470 of file itkProcessObject.cxx.

References NULL.

const DataObject * itk::ProcessObject::GetInput ( unsigned int idx ) const

protectedinherited

Definition at line 482 of file itkProcessObject.cxx.

References NULL.

DataObjectPointerArray& itk::ProcessObject::GetInputs ( )

inlineinherited

Return an array with all the inputs of this process object. This is useful for tracing back in the pipeline to construct graphs etc.

Definition at line 108 of file itkProcessObject.h.

Referenced by otb::PipelineMemoryPrintCalculator::EvaluateProcessObjectPrintRecursive().

template<class TInputImage>

virtual const itk::ImageIORegion& otb::ImageFileWriter< TInputImage >::GetIORegion ( )

virtual

MetaDataDictionary & itk::Object::GetMetaDataDictionary ( void )

inherited

Returns: A reference to this objects MetaDataDictionary.

Warning: This reference may be changed.

Definition at line 532 of file itkObject.cxx.

References NULL.

const MetaDataDictionary & itk::Object::GetMetaDataDictionary ( void ) const

inherited

Returns: A constant reference to this objects MetaDataDictionary.

Definition at line 543 of file itkObject.cxx.

References NULL.

unsigned long itk::Object::GetMTime ( void ) const

virtualinherited

Return this objects modified time.

Return the modification for this object.

Definition at line 286 of file itkObject.cxx.

Referenced by itk::DeformationFieldSource< TOutputImage >::GetMTime(), itk::BoundingBox< TPointIdentifier, VPointDimension, TCoordRep, TPointsContainer >::GetMTime(), itk::InverseDeformationFieldImageFilter< TInputImage, TOutputImage >::GetMTime(), otb::InverseDeformationFieldImageFilter< TInputImage, TOutputImage >::GetMTime(), itk::TransformToDeformationFieldSource< TOutputImage, TTransformPrecisionType >::GetMTime(), itk::VectorResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::GetMTime(), itk::SpatialObject< TDimension >::GetMTime(), itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::GetMTime(), itk::SpatialObject< ::itk::GetMeshDimension< TMesh >::PointDimension >::GetObjectMTime(), otb::Function::NoStretchRenderingFunction< TPixel, TRGBPixel, TPixelRepresentationFunction, TTransferFunction >::Initialize(), otb::Function::StandardRenderingFunction< TPixel, TRGBPixel, TPixelRepresentationFunction, TTransferFunction >::Initialize(), itk::VTKImageExportBase::PipelineModifiedCallback(), and itk::ProcessObject::UpdateOutputInformation().

MultiThreader* itk::ProcessObject::GetMultiThreader ( )

inlineinherited

Return the multithreader used by this class.

Definition at line 280 of file itkProcessObject.h.

template<class TInputImage>

virtual const char* otb::ImageFileWriter< TInputImage >::GetNameOfClass ( ) const

virtual

Run-time type information (and related methods).

Reimplemented from itk::ProcessObject.

Reimplemented in otb::StreamingImageFileWriter< TInputImage >.

DataObjectPointerArraySizeType itk::ProcessObject::GetNumberOfInputs ( ) const

inlineinherited

Get the size of the input vector. This is merely the size of the input vector, not the number of inputs that have valid DataObject's assigned. Use GetNumberOfValidRequiredInputs() to determine how many inputs are non-null.

Definition at line 118 of file itkProcessObject.h.

Referenced by otb::PipelineMemoryPrintCalculator::EvaluateProcessObjectPrintRecursive().

DataObjectPointerArraySizeType itk::ProcessObject::GetNumberOfOutputs ( ) const

inlineinherited

Definition at line 135 of file itkProcessObject.h.

Referenced by otb::PipelineMemoryPrintCalculator::EvaluateProcessObjectPrintRecursive().

virtual const unsigned int& itk::ProcessObject::GetNumberOfRequiredInputs ( )

protectedvirtualinherited

virtual const unsigned int& itk::ProcessObject::GetNumberOfRequiredOutputs ( )

protectedvirtualinherited

virtual const int& itk::ProcessObject::GetNumberOfThreads ( )

virtualinherited

Referenced by itk::BSplineScatteredDataPointSetToImageFilter< TInputPointSet, TOutputImage >::SplitRequestedRegion().

ProcessObject::DataObjectPointerArraySizeType itk::ProcessObject::GetNumberOfValidRequiredInputs ( ) const

virtualinherited

Get the number of valid inputs. This is the number of non-null entries in the input vector in the first NumberOfRequiredInputs slots. This method is used to determine whether the necessary required inputs have been set. Subclasses of ProcessObject may override this implementation if the required inputs are not the first slots in input vector.

Get the number of specified inputs

Reimplemented in itk::MultiResolutionPDEDeformableRegistration< TFixedImage, TMovingImage, TDeformationField, TRealType >, and itk::PDEDeformableRegistrationFilter< TFixedImage, TMovingImage, TDeformationField >.

Definition at line 112 of file itkProcessObject.cxx.

DataObject * itk::ProcessObject::GetOutput ( unsigned int idx )

protectedinherited

Method used internally for getting an output.

Definition at line 442 of file itkProcessObject.cxx.

References NULL.

const DataObject * itk::ProcessObject::GetOutput ( unsigned int idx ) const

protectedinherited

Definition at line 454 of file itkProcessObject.cxx.

References NULL.

DataObjectPointerArray& itk::ProcessObject::GetOutputs ( )

inlineinherited

Return an array with all the outputs of this process object. This is useful for tracing forward in the pipeline to contruct graphs etc.

Definition at line 133 of file itkProcessObject.h.

Referenced by otb::PipelineMemoryPrintCalculator::EvaluateProcessObjectPrintRecursive().

virtual const float& itk::ProcessObject::GetProgress ( )

virtualinherited

Get the execution progress of a process object. The progress is a floating number in [0,1] with 0 meaning no progress and 1 meaning the filter has completed execution.

Referenced by itk::WatershedMiniPipelineProgressCommand::Execute(), otb::StreamingImageVirtualWriter< TInputImage >::ObserveSourceFilterProgress(), otb::ImageFileWriter< TInputImage >::ObserveSourceFilterProgress(), itk::LaplacianRecursiveGaussianImageFilter< TInputImage, TOutputImage >::ReportProgress(), and itk::XMLFilterWatcher::ShowProgress().

virtual int itk::LightObject::GetReferenceCount ( ) const

inlinevirtualinherited

Gets the reference count on this object.

Definition at line 105 of file itkLightObject.h.

virtual const bool& itk::ProcessObject::GetReleaseDataBeforeUpdateFlag ( )

virtualinherited

bool itk::ProcessObject::GetReleaseDataFlag ( ) const

virtualinherited

Definition at line 512 of file itkProcessObject.cxx.

template<class TInputImage>

StreamingManagerType* otb::ImageFileWriter< TInputImage >::GetStreamingManager ( void )

inline

Return the StreamingManager object responsible for dividing the region to write

Definition at line 98 of file otbImageFileWriter.h.

template<class TInputImage>

virtual const bool& otb::ImageFileWriter< TInputImage >::GetUseCompression ( )

virtual

template<class TInputImage>

virtual const bool& otb::ImageFileWriter< TInputImage >::GetUseInputMetaDataDictionary ( )

virtual

static void itk::Object::GlobalWarningDisplayOff ( )

inlinestaticinherited

Definition at line 100 of file itkObject.h.

References itk::Object::SetGlobalWarningDisplay().

Referenced by itk::OutputWindow::DisplayText(), itk::Win32OutputWindow::PromptText(), and itk::Win32OutputWindow::WndProc().

static void itk::Object::GlobalWarningDisplayOn ( )

inlinestaticinherited

Definition at line 98 of file itkObject.h.

References itk::Object::SetGlobalWarningDisplay().

bool itk::Object::HasObserver ( const EventObject & event ) const

inherited

Return true if an observer is registered for this event.

Definition at line 467 of file itkObject.cxx.

void itk::Object::InvokeEvent ( const EventObject & event )

inherited

Call Execute on all the Commands observing this event id.

Definition at line 446 of file itkObject.cxx.

Referenced by otb::Wrapper::Application::AddProcess(), itk::ParallelSparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::IterateThreaderCallback(), and itk::VTKImageExportBase::UpdateDataCallback().

void itk::Object::InvokeEvent ( const EventObject & event ) const

inherited

Call Execute on all the Commands observing this event id. The actions triggered by this call doesn't modify this object.

Definition at line 457 of file itkObject.cxx.

DataObject::Pointer itk::ProcessObject::MakeOutput ( unsigned int idx )

virtualinherited

Make a DataObject of the correct type to used as the specified output. Every ProcessObject subclass must be able to create a DataObject that can be used as a specified output. This method is automatically called when DataObject::DisconnectPipeline() is called. DataObject::DisconnectPipeline, disconnects a data object from being an output of its current source. When the data object is disconnected, the ProcessObject needs to construct a replacement output data object so that the ProcessObject is in a valid state. So DataObject::DisconnectPipeline eventually calls ProcessObject::MakeOutput. Note that MakeOutput always returns a itkSmartPointer to a DataObject. ImageSource and MeshSource override this method to create the correct type of image and mesh respectively. If a filter has multiple outputs of different types, then that filter must provide an implementation of MakeOutput().

This is a default implementation to make sure we have something. Once all the subclasses of ProcessObject provide an appopriate MakeOutput(), then ProcessObject::MakeOutput() can be made pure virtual.

Definition at line 59 of file itkProcessObject.cxx.

References itk::SmartPointer< TObjectType >::GetPointer(), and itk::Object::New().

void itk::Object::Modified ( void ) const

virtualinherited

Update the modification time for this object. Many filters rely on the modification time to determine if they need to recompute their data.

Make sure this object's modified time is greater than all others.

Definition at line 297 of file itkObject.cxx.

template<class TInputImage>

static Pointer otb::ImageFileWriter< TInputImage >::New ( )

static

Method for creation through the object factory.

Referenced by otb::Wrapper::ComplexOutputImageParameter::InitializeWriters(), and otb::Wrapper::OutputImageParameter::InitializeWriters().

template<class TInputImage>

void otb::ImageFileWriter< TInputImage >::ObserveSourceFilterProgress	(	itk::Object *	object,
		const itk::EventObject &	event
	)

inlineprivate

Definition at line 209 of file otbImageFileWriter.h.

References itk::ProcessObject::GetProgress().

template<class TInputImage>

void otb::ImageFileWriter< TInputImage >::operator= ( const ImageFileWriter< TInputImage > & )

private

void itk::ProcessObject::PopBackInput ( )

protectedvirtualinherited

Model a stack on the input list by providing a pop back

Definition at line 245 of file itkProcessObject.cxx.

Referenced by otb::JointMassOfBeliefFilter< TMassFunction >::PopBackInput(), and itk::ImageToImageFilter< TInputImage, TOutputImage >::PopBackInput().

void itk::ProcessObject::PopFrontInput ( )

protectedvirtualinherited

Definition at line 280 of file itkProcessObject.cxx.

Referenced by otb::JointMassOfBeliefFilter< TMassFunction >::PopFrontInput(), and itk::ImageToImageFilter< TInputImage, TOutputImage >::PopFrontInput().

void itk::ProcessObject::PrepareOutputs ( )

virtualinherited

An opportunity to deallocate a ProcessObject's bulk data storage. Some filters may wish to reuse existing bulk data storage to avoid unnecessary deallocation/allocation sequences. The default implementation calls Initialize() on each output. DataObject::Initialize() frees its bulk data by default.

Reimplemented in itk::WatershedImageFilter< TInputImage >, otb::WatershedImageFilter< TInputImage >, and otb::GeometriesSource.

Definition at line 864 of file itkProcessObject.cxx.

void itk::LightObject::Print	(	std::ostream &	os,
		Indent	indent = `0`
	)		const

inherited

Cause the object to print itself out.

Avoid DLL boundary problems. This function will be common to all itk objects. It just calls the header/self/trailer virtual print methods, which can be overriden by subclasses (any itk object).

Definition at line 135 of file itkLightObject.cxx.

References itk::Indent::GetNextIndent().

Referenced by itk::operator<<().

void itk::LightObject::PrintHeader	(	std::ostream &	os,
		Indent	indent
	)		const

protectedvirtualinherited

Define a default print header for all objects.

Definition at line 320 of file itkLightObject.cxx.

bool itk::Object::PrintObservers	(	std::ostream &	os,
		Indent	indent
	)		const

protectedinherited

Definition at line 478 of file itkObject.cxx.

template<class TInputImage >

void otb::ImageFileWriter< TInputImage >::PrintSelf	(	std::ostream &	os,
		itk::Indent	indent
	)		const

protectedvirtual

Methods invoked by Print() to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Chaining method to print an object's instance variables, as well as its superclasses.

Reimplemented from itk::Object.

Definition at line 181 of file otbImageFileWriter.txx.

void itk::LightObject::PrintTrailer	(	std::ostream &	os,
		Indent	indent
	)		const

protectedvirtualinherited

Define a default print trailer for all objects.

Definition at line 331 of file itkLightObject.cxx.

void itk::ProcessObject::PropagateRequestedRegion ( DataObject * output )

virtualinherited

Send the requested region information back up the pipeline (to the filters that preceed this one).

check flag to avoid executing forever if there is a loop

Give the subclass a chance to indicate that it will provide more data then required for the output. This can happen, for example, when a source can only produce the whole output. Although this is being called for a specific output, the source may need to enlarge all outputs.

Give the subclass a chance to define how to set the requested regions for each of its outputs, given this output's requested region. The default implementation is to make all the output requested regions the same. A subclass may need to override this method if each output is a different resolution.

Give the subclass a chance to request a larger requested region on the inputs. This is necessary when, for example, a filter requires more data at the "internal" boundaries to produce the boundary values - such as an image filter that derives a new pixel value by applying some operation to a neighborhood of surrounding original values.

Now that we know the input requested region, propagate this through all the inputs.

Reimplemented in itk::VTKImageImport< TOutputImage >, and itk::StreamingImageFilter< TInputImage, TOutputImage >.

Definition at line 766 of file itkProcessObject.cxx.

void itk::ProcessObject::PropagateResetPipeline ( )

protectedvirtualinherited

Called to allocate the input array. Copies old inputs. Propagate a call to ResetPipeline() up the pipeline. Called only from DataObject.

Propagate the ResetPipeline call

Definition at line 631 of file itkProcessObject.cxx.

void itk::ProcessObject::PushBackInput ( const DataObject * input )

protectedvirtualinherited

Push/Pop an input of this process object. These methods allow a filter to model its input vector as a queue or stack. These routines may not be appropriate for all filters, especially filters with different types of inputs. These routines follow the semantics of STL.

Model a queue on the input list by providing a push back

Definition at line 234 of file itkProcessObject.cxx.

Referenced by otb::OGRDataSourceToLabelImageFilter< TOutputImage >::AddOGRDataSource(), otb::VectorDataToLabelImageFilter< TVectorData, TOutputImage >::AddVectorData(), otb::RasterizeVectorDataFilter< TVectorData, TInputImage, TOutputImage >::AddVectorData(), otb::JointMassOfBeliefFilter< TMassFunction >::PushBackInput(), and itk::ImageToImageFilter< TInputImage, TOutputImage >::PushBackInput().

void itk::ProcessObject::PushFrontInput ( const DataObject * input )

protectedvirtualinherited

Definition at line 259 of file itkProcessObject.cxx.

Referenced by otb::JointMassOfBeliefFilter< TMassFunction >::PushFrontInput(), and itk::ImageToImageFilter< TInputImage, TOutputImage >::PushFrontInput().

void itk::Object::Register ( ) const

virtualinherited

Increase the reference count (mark as used by another object).

Reimplemented from itk::LightObject.

Definition at line 309 of file itkObject.cxx.

Referenced by itk::ObjectFactoryBase::RegisterFactory().

virtual void itk::ProcessObject::ReleaseDataBeforeUpdateFlagOff ( )

virtualinherited

virtual void itk::ProcessObject::ReleaseDataBeforeUpdateFlagOn ( )

virtualinherited

void itk::ProcessObject::ReleaseDataFlagOff ( )

inlineinherited

Definition at line 256 of file itkProcessObject.h.

void itk::ProcessObject::ReleaseDataFlagOn ( )

inlineinherited

Definition at line 255 of file itkProcessObject.h.

void itk::ProcessObject::ReleaseInputs ( )

protectedvirtualinherited

A filter may need to release its input's bulk data after it has finished calculating a new output. The filter may need to release the inputs because the user has turned on the ReleaseDataFlag or it may need to release the inputs because the filter is an "in place" filter and it has overwritten its input with its output data. The implementation here simply checks the ReleaseDataFlag of the inputs. InPlaceImageFilter overrides this method so release the input it has overwritten.

See Also: InPlaceImageFilter::ReleaseInputs()

Definition at line 886 of file itkProcessObject.cxx.

Referenced by otb::LabelMapSVMClassifier< TInputLabelMap >::ReleaseInputs(), itk::InPlaceImageFilter< TInputImage, TOutputImage >::ReleaseInputs(), and itk::InPlaceLabelMapFilter< TInputImage >::ReleaseInputs().

void itk::Object::RemoveAllObservers ( )

inherited

Remove all observers .

Definition at line 435 of file itkObject.cxx.

void itk::ProcessObject::RemoveInput ( DataObject * input )

protectedvirtualinherited

Remove an input.

Removes the first occurence of the given OutputObject from the inputs to this ProcessObject. If it's the last object on the list, shortens the list.

Definition at line 173 of file itkProcessObject.cxx.

void itk::Object::RemoveObserver ( unsigned long tag )

inherited

Remove the observer with this tag value.

Definition at line 425 of file itkObject.cxx.

Referenced by otb::StreamingImageVirtualWriter< TInputImage >::GenerateData(), and otb::ImageFileWriter< TInputImage >::Update().

void itk::ProcessObject::RemoveOutput ( DataObject * output )

protectedvirtualinherited

Definition at line 294 of file itkProcessObject.cxx.

void itk::ProcessObject::ResetPipeline ( )

virtualinherited

Reset the pipeline. If an exception is thrown during an Update(), the pipeline may be in an inconsistent state. This method clears the internal state of the pipeline so Update() can be called.

Definition at line 621 of file itkProcessObject.cxx.

Referenced by itk::ParallelSparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::IterateThreaderCallback().

void itk::ProcessObject::RestoreInputReleaseDataFlags ( )

protectedvirtualinherited

Restore the cached input ReleaseDataFlags.

Definition at line 1075 of file itkProcessObject.cxx.

virtual void itk::ProcessObject::SetAbortGenerateData ( bool _arg )

virtualinherited

Set the AbortGenerateData flag for the process object. Process objects may handle premature termination of execution in different ways.

template<class TInputImage >

void otb::ImageFileWriter< 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 166 of file otbImageFileWriter.txx.

template<class TInputImage >

void otb::ImageFileWriter< 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 129 of file otbImageFileWriter.txx.

template<class TInputImage >

void otb::ImageFileWriter< 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 154 of file otbImageFileWriter.txx.

void itk::Object::SetDebug ( bool debugFlag ) const

inherited

Set the value of the debug flag. A non-zero value turns debugging on.

Definition at line 275 of file itkObject.cxx.

template<class TInputImage >

void otb::ImageFileWriter< TInputImage >::SetFileName ( const char * extendedFileName )

virtual

ImageFileWriter Methods

Definition at line 789 of file otbImageFileWriter.txx.

References NULL.

template<class TInputImage >

void otb::ImageFileWriter< TInputImage >::SetFileName ( std::string extendedFileName )

virtual

Definition at line 781 of file otbImageFileWriter.txx.

void itk::Object::SetGlobalWarningDisplay ( bool val )

staticinherited

This is a global flag that controls whether any debug, warning or error messages are displayed.

Set the value of the global debug output control flag.

Definition at line 370 of file itkObject.cxx.

Referenced by itk::Object::GlobalWarningDisplayOff(), and itk::Object::GlobalWarningDisplayOn().

template<class TInputImage>

virtual void otb::ImageFileWriter< TInputImage >::SetImageIO ( otb::ImageIOBase * _arg )

virtual

template<class TInputImage >

void otb::ImageFileWriter< TInputImage >::SetInput ( const InputImageType * input )

virtual

Set the only input of the writer

Definition at line 246 of file otbImageFileWriter.txx.

template<class TInputImage >

void otb::ImageFileWriter< TInputImage >::SetIORegion ( const itk::ImageIORegion & region )

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

Definition at line 232 of file otbImageFileWriter.txx.

void itk::Object::SetMetaDataDictionary ( const MetaDataDictionary & rhs )

inherited

Returns: Set the MetaDataDictionary

Definition at line 554 of file itkObject.cxx.

References NULL.

Referenced by otb::VectorImage< TPixel, VImageDimension >::CopyInformation(), and otb::Image< TPixel, VImageDimension >::CopyInformation().

void itk::ProcessObject::SetNthInput	(	unsigned int	idx,
		DataObject *	input
	)

protectedvirtualinherited

Protected methods for setting inputs. Subclasses make use of them for setting input.

Set an Input of this filter. This method does Register()/UnRegister() manually to deal with the fact that smart pointers aren't around to do the reference counting.

Reimplemented in itk::ImageToVectorImageFilter< TInputImage >.

Definition at line 210 of file itkProcessObject.cxx.

void itk::ProcessObject::SetNthOutput	(	unsigned int	idx,
		DataObject *	output
	)

protectedvirtualinherited

Protected methods for setting outputs. Subclasses make use of them for getting output.

Set an output of this filter. This method specifically does not do a Register()/UnRegister() because of the desire to break the reference counting loop.

Definition at line 333 of file itkProcessObject.cxx.

References itk::DataObject::ConnectSource().

template<class TInputImage >

void otb::ImageFileWriter< 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 93 of file otbImageFileWriter.txx.

template<class TInputImage >

void otb::ImageFileWriter< 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 105 of file otbImageFileWriter.txx.

void itk::ProcessObject::SetNumberOfInputs ( unsigned int num )

protectedinherited

Called to allocate the input array. Copies old inputs.

Called by constructor to set up input array.

Definition at line 96 of file itkProcessObject.cxx.

Referenced by otb::WaveletPacketTransform< TInputImage, TOutputImage, TFilter, Wavelet::FORWARD, TCost >::WaveletPacketTransform(), otb::WaveletPacketTransform< TInputImage, TOutputImage, TFilter, Wavelet::INVERSE, FullyDecomposedWaveletPacketCost< TInputImage > >::WaveletPacketTransform(), otb::WaveletTransform< TInputImage, TOutputImage, TFilter, Wavelet::FORWARD >::WaveletTransform(), and otb::WaveletTransform< TInputImage, TOutputImage, TFilter, Wavelet::INVERSE >::WaveletTransform().

template<class TInputImage >

void otb::ImageFileWriter< 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 117 of file otbImageFileWriter.txx.

void itk::ProcessObject::SetNumberOfOutputs ( unsigned int num )

protectedinherited

Called to allocate the output array. Copies old outputs.

Called by constructor to set up output array.

Definition at line 424 of file itkProcessObject.cxx.

Referenced by otb::MeanShiftSmoothingImageFilter< TInputImage, TOutputImage, TKernel, TOutputIterationImage >::MeanShiftSmoothingImageFilter(), otb::WaveletPacketTransform< TInputImage, TOutputImage, TFilter, Wavelet::FORWARD, TCost >::WaveletPacketTransform(), otb::WaveletPacketTransform< TInputImage, TOutputImage, TFilter, Wavelet::INVERSE, FullyDecomposedWaveletPacketCost< TInputImage > >::WaveletPacketTransform(), otb::WaveletTransform< TInputImage, TOutputImage, TFilter, Wavelet::FORWARD >::WaveletTransform(), and otb::WaveletTransform< TInputImage, TOutputImage, TFilter, Wavelet::INVERSE >::WaveletTransform().

virtual void itk::ProcessObject::SetNumberOfRequiredInputs ( unsigned int _arg )

protectedvirtualinherited

Referenced by itk::DeformableSimplexMesh3DFilter< TInputMesh, TOutputMesh >::DeformableSimplexMesh3DFilter(), itk::ExtensionVelocitiesImageFilter< TLevelSet, TAuxValue, VAuxDimension >::ExtensionVelocitiesImageFilter(), itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::FastMarchingImageFilter(), otb::FillGapsFilter::FillGapsFilter(), otb::ImageToLabelMapWithAttributesFilter< TInputImage, TLabeledImage, TLabel, TLabelObject >::ImageToLabelMapWithAttributesFilter(), itk::ImageToMeshFilter< TInputImage, TOutputMesh >::ImageToMeshFilter(), itk::PasteImageFilter< TInputImage, TSourceImage, TOutputImage >::PasteImageFilter(), otb::WaveletPacketTransform< TInputImage, TOutputImage, TFilter, Wavelet::FORWARD, TCost >::WaveletPacketTransform(), otb::WaveletPacketTransform< TInputImage, TOutputImage, TFilter, Wavelet::INVERSE, FullyDecomposedWaveletPacketCost< TInputImage > >::WaveletPacketTransform(), otb::WaveletTransform< TInputImage, TOutputImage, TFilter, Wavelet::FORWARD >::WaveletTransform(), and otb::WaveletTransform< TInputImage, TOutputImage, TFilter, Wavelet::INVERSE >::WaveletTransform().

virtual void itk::ProcessObject::SetNumberOfRequiredOutputs ( unsigned int _arg )

protectedvirtualinherited

Referenced by itk::AutomaticTopologyMeshSource< TOutputMesh >::AutomaticTopologyMeshSource(), itk::BalloonForceFilter< TInputMesh, TOutputMesh >::BalloonForceFilter(), itk::CoreAtomImageToDistanceMatrixProcess< TSourceImage >::CoreAtomImageToDistanceMatrixProcess(), itk::CoreAtomImageToUnaryCorrespondenceMatrixProcess< TSourceImage >::CoreAtomImageToUnaryCorrespondenceMatrixProcess(), itk::DeformableMesh3DFilter< TInputMesh, TOutputMesh >::DeformableMesh3DFilter(), itk::DeformableSimplexMesh3DFilter< TInputMesh, TOutputMesh >::DeformableSimplexMesh3DFilter(), itk::ExtensionVelocitiesImageFilter< TLevelSet, TAuxValue, VAuxDimension >::ExtensionVelocitiesImageFilter(), itk::FastMarchingExtensionImageFilter< TLevelSet, TAuxValue, VAuxDimension, TSpeedImage >::FastMarchingExtensionImageFilter(), otb::FillGapsFilter::FillGapsFilter(), otb::GeometriesSource::GeometriesSource(), itk::ImageSource< TOutputImage >::ImageSource(), itk::ImageToMeshFilter< TInputImage, TOutputMesh >::ImageToMeshFilter(), itk::MedialNodePairCorrespondenceProcess< TSourceImage >::MedialNodePairCorrespondenceProcess(), itk::MedialNodeTripletCorrespondenceProcess< TSourceImage >::MedialNodeTripletCorrespondenceProcess(), itk::MeshSource< TOutputMesh >::MeshSource(), itk::MultiScaleHessianBasedMeasureImageFilter< TInputImage, THessianImage, TOutputImage >::MultiScaleHessianBasedMeasureImageFilter(), otb::OSMDataToVectorDataGenerator::OSMDataToVectorDataGenerator(), itk::PathSource< TOutputPath >::PathSource(), itk::RegularSphereMeshSource< TOutputMesh >::RegularSphereMeshSource(), otb::watershed::Relabeler< TScalarType, TImageDimension >::Relabeler(), itk::watershed::Relabeler< TScalarType, TImageDimension >::Relabeler(), itk::SimplexMeshAdaptTopologyFilter< TInputMesh, TOutputMesh >::SimplexMeshAdaptTopologyFilter(), itk::SphereMeshSource< TOutputMesh >::SphereMeshSource(), itk::TriangleMeshToSimplexMeshFilter< TInputMesh, TOutputMesh >::TriangleMeshToSimplexMeshFilter(), itk::TwoOutputExampleImageFilter< TImage >::TwoOutputExampleImageFilter(), and itk::VTKPolyDataReader< TOutputMesh >::VTKPolyDataReader().

virtual void itk::ProcessObject::SetNumberOfThreads ( int _arg )

virtualinherited

Get/Set the number of threads to create when executing.

Referenced by itk::CannyEdgeDetectionImageFilter< TInputImage, TOutputImage >::Compute2ndDerivative(), itk::CannyEdgeDetectionImageFilter< TInputImage, TOutputImage >::Compute2ndDerivativePos(), and itk::FiniteDifferenceSparseImageFilter< TInputImageType, TSparseOutputImageType >::PrecalculateChange().

virtual void itk::ProcessObject::SetProgress ( float _arg )

virtualinherited

Set the execution progress of a process object. The progress is a floating number in [0,1] with 0 meaning no progress and 1 meaning the filter has completed execution. The ProgressEvent is NOT invoked.

void itk::Object::SetReferenceCount ( int ref )

virtualinherited

Sets the reference count (use with care)

If there is a delete method, invoke it.

Reimplemented from itk::LightObject.

Definition at line 347 of file itkObject.cxx.

virtual void itk::ProcessObject::SetReleaseDataBeforeUpdateFlag ( bool _arg )

virtualinherited

Turn on/off the flags to control whether the bulk data belonging to the outputs of this ProcessObject are released/reallocated during an Update(). In limited memory scenarios, a user may want to force the elements of a pipeline to release any bulk data that is going to be regenerated anyway during an Update() in order to control peak memory allocation. Note that this flag is different from the ReleaseDataFlag. ReleaseDataFlag manages the deallocation of a ProcessObject's bulk output data once that data has been consumed by a downstream ProcessObject. The ReleaseDataBeforeUpdateFlag manages the deallocation/reallocation of bulk data during a pipeline update to control peak memory utilization. Default value is on.

void itk::ProcessObject::SetReleaseDataFlag ( bool flag )

virtualinherited

Turn on/off the flags to control whether the bulk data belonging to the outputs of this ProcessObject are released after being used by a downstream ProcessObject. Default value is off. Another options for controlling memory utilization is the ReleaseDataBeforeUpdateFlag.

Definition at line 528 of file itkProcessObject.cxx.

template<class TInputImage>

void otb::ImageFileWriter< 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 105 of file otbImageFileWriter.h.

template<class TInputImage >

void otb::ImageFileWriter< 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 142 of file otbImageFileWriter.txx.

template<class TInputImage>

virtual void otb::ImageFileWriter< TInputImage >::SetUseCompression ( bool _arg )

virtual

Set the compression On or Off

template<class TInputImage>

virtual void otb::ImageFileWriter< 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.

void itk::Object::UnRegister ( ) const

virtualinherited

Decrease the reference count (release by another object).

If there is a delete method, invoke it.

Reimplemented from itk::LightObject.

Definition at line 324 of file itkObject.cxx.

Referenced by itk::Object::New(), and itk::ObjectFactoryBase::UnRegisterFactory().

template<class TInputImage >

void otb::ImageFileWriter< TInputImage >::Update ( void )

virtual

Override Update() from ProcessObject because this filter has no output.

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

Parse streaming modes

Tell all Observers that the filter is starting

Prepare ImageIO : create ImageFactory

End of Prepare ImageIO : create ImageFactory

Grab the input

Parse region size modes

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.

Control if the ImageIO is CanStreamWrite

Compare the buffered region with the inputRegion which is the largest possible region or a user defined region through extended filename Not sure that if this modification is needed

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

Create Image file

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 270 of file otbImageFileWriter.txx.

References itk::Object::AddObserver(), itk::ObjectFactoryBase::CreateAllInstance(), otb::ImageIOFactory::CreateImageIO(), otb::ImageIOBase::GetNameOfClass(), otbMsgDebugMacro, otbMsgDevMacro, otbWarningMacro, itk::Object::RemoveObserver(), itk::DataObjectError::SetDataObject(), itk::ExceptionObject::SetDescription(), itk::ImageIORegion::SetIndex(), itk::ExceptionObject::SetLocation(), itk::ImageIORegion::SetSize(), and otb::ImageIOFactory::WriteMode.

template<class TInputImage>

void otb::ImageFileWriter< TInputImage >::UpdateFilterProgress ( )

inlineprivate

Definition at line 225 of file otbImageFileWriter.h.

void itk::ProcessObject::UpdateLargestPossibleRegion ( )

virtualinherited

Like Update(), but sets the output requested region to the largest possible region for the output. This is the method users should call if they want the entire dataset to be processed. If a user wants to update the same output region as a previous call to Update() or a previous call to UpdateLargestPossibleRegion(), then they should call the method Update().

Definition at line 1120 of file itkProcessObject.cxx.

void itk::ProcessObject::UpdateOutputData ( DataObject * output )

virtualinherited

Actually generate new output

prevent chasing our tail

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

Propagate the update call - make sure everything we might rely on is up-to-date Must call PropagateRequestedRegion before UpdateOutputData if multiple inputs since they may lead back to the same data object.

Cache the state of any ReleaseDataFlag's on the inputs. While the filter is executing, we need to set the ReleaseDataFlag's on the inputs to false in case the current filter is implemented using a mini-pipeline (which will try to release the inputs). After the filter finishes, we restore the state of the ReleaseDataFlag's before the call to ReleaseInputs().

Tell all Observers that the filter is starting

GenerateData this object - we have not aborted yet, and our progress before we start to execute is 0.0.

Count the number of required inputs which have been assigned

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

Notify end event observers

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

Restore the state of any input ReleaseDataFlags

Release any inputs if marked for release

Reimplemented in itk::StreamingImageFilter< TInputImage, TOutputImage >.

Definition at line 908 of file itkProcessObject.cxx.

void itk::ProcessObject::UpdateOutputInformation ( void )

virtualinherited

Update the information decribing the output data. This method transverses up the pipeline gathering modified time information. On the way back down the pipeline, this method calls GenerateOutputInformation() to set any necessary information about the output data objects. For instance, a filter that shrinks an image will need to provide an implementation for GenerateOutputInformation() that changes the spacing of the pixels. Such filters should call their superclass' implementation of GenerateOutputInformation prior to changing the information values they need (i.e. GenerateOutputInformation() should call Superclass::GenerateOutputInformation() prior to changing the information.

Watch out for loops in the pipeline

Since we are in a loop, we will want to update. But if we don't modify this filter, then we will not execute because our OutputInformationMTime will be more recent than the MTime of our output.

We now wish to set the PipelineMTime of each output DataObject to the largest of this ProcessObject's MTime, all input DataObject's PipelineMTime, and all input's MTime. We begin with the MTime of this ProcessObject.

Loop through the inputs

Propagate the UpdateOutputInformation call

What is the PipelineMTime of this input? Compare this against our current computation to find the largest one.

Pipeline MTime of the input does not include the MTime of the data object itself. Factor these mtimes into the next PipelineMTime

Call GenerateOutputInformation for subclass specific information. Since UpdateOutputInformation propagates all the way up the pipeline, we need to be careful here to call GenerateOutputInformation only if necessary. Otherwise, we may cause this source to be modified which will cause it to execute again on the next update.

Keep track of the last time GenerateOutputInformation() was called

Reimplemented in otb::watershed::Segmenter< TInputImage >, itk::watershed::Segmenter< TInputImage >, otb::watershed::Segmenter< InputImageType >, itk::watershed::Segmenter< InputImageType >, and itk::VTKImageImport< TOutputImage >.

Definition at line 664 of file itkProcessObject.cxx.

References itk::Object::GetMTime(), itk::DataObject::GetPipelineMTime(), itk::DataObject::SetPipelineMTime(), and itk::DataObject::UpdateOutputInformation().

Referenced by itk::VTKImageExportBase::UpdateInformationCallback().

void itk::ProcessObject::UpdateProgress ( float amount )

inherited

Update the progress of the process object.

Sets the Progress ivar to amount and invokes any observers for the ProgressEvent. The parameter amount should be in [0,1] and is the cumulative (not incremental) progress.

Update the progress of the process object. If a ProgressMethod exists, execute it. Then set the Progress ivar to amount. The parameter amount should range between (0,1).

Definition at line 500 of file itkProcessObject.cxx.

Referenced by itk::WatershedMiniPipelineProgressCommand::Execute(), otb::otb_UpdateGDALProgress(), itk::ProgressReporter::ProgressReporter(), and itk::ProgressReporter::~ProgressReporter().

template<class TInputImage>

virtual void otb::ImageFileWriter< TInputImage >::UseCompressionOff ( )

virtual

template<class TInputImage>

virtual void otb::ImageFileWriter< TInputImage >::UseCompressionOn ( )

virtual

template<class TInputImage>

virtual void otb::ImageFileWriter< TInputImage >::UseInputMetaDataDictionaryOff ( )

virtual

template<class TInputImage>

virtual void otb::ImageFileWriter< TInputImage >::UseInputMetaDataDictionaryOn ( )

virtual

Member Data Documentation

template<class TInputImage>

const unsigned int otb::ImageFileWriter< TInputImage >::InputImageDimension = InputImageType::ImageDimension

static

Dimension of input image.

Definition at line 90 of file otbImageFileWriter.h.

template<class TInputImage>

unsigned int otb::ImageFileWriter< TInputImage >::m_CurrentDivision

private

Definition at line 231 of file otbImageFileWriter.h.

template<class TInputImage>

float otb::ImageFileWriter< TInputImage >::m_DivisionProgress

private

Definition at line 232 of file otbImageFileWriter.h.

template<class TInputImage>

bool otb::ImageFileWriter< TInputImage >::m_FactorySpecifiedImageIO

private

Definition at line 243 of file otbImageFileWriter.h.

template<class TInputImage>

std::string otb::ImageFileWriter< TInputImage >::m_FileName

private

ImageFileWriter Parameters

Definition at line 235 of file otbImageFileWriter.h.

template<class TInputImage>

FNameHelperType::Pointer otb::ImageFileWriter< TInputImage >::m_FilenameHelper

private

Definition at line 252 of file otbImageFileWriter.h.

template<class TInputImage>

otb::ImageIOBase::Pointer otb::ImageFileWriter< TInputImage >::m_ImageIO

private

Definition at line 237 of file otbImageFileWriter.h.

template<class TInputImage>

itk::ImageIORegion otb::ImageFileWriter< TInputImage >::m_IORegion

private

Definition at line 241 of file otbImageFileWriter.h.

template<class TInputImage>

bool otb::ImageFileWriter< TInputImage >::m_IsObserving

private

Definition at line 256 of file otbImageFileWriter.h.

template<class TInputImage>

unsigned int otb::ImageFileWriter< TInputImage >::m_NumberOfDivisions

private

Definition at line 230 of file otbImageFileWriter.h.

template<class TInputImage>

unsigned long otb::ImageFileWriter< TInputImage >::m_ObserverID

private

Definition at line 257 of file otbImageFileWriter.h.

TimeStamp itk::ProcessObject::m_OutputInformationMTime

protectedinherited

Time when GenerateOutputInformation was last called.

Definition at line 421 of file itkProcessObject.h.

InternalReferenceCountType itk::LightObject::m_ReferenceCount

mutableprotectedinherited

Number of uses of this object by other objects.

Definition at line 141 of file itkLightObject.h.

SimpleFastMutexLock itk::LightObject::m_ReferenceCountLock

mutableprotectedinherited

Mutex lock to protect modification to the reference count

Definition at line 144 of file itkLightObject.h.

template<class TInputImage>

InputIndexType otb::ImageFileWriter< TInputImage >::m_ShiftOutputIndex

private

Definition at line 258 of file otbImageFileWriter.h.

template<class TInputImage>

StreamingManagerPointerType otb::ImageFileWriter< TInputImage >::m_StreamingManager

private

Definition at line 254 of file otbImageFileWriter.h.

bool itk::ProcessObject::m_Updating

protectedinherited

These ivars are made protected so filters like itkStreamingImageFilter can access them directly. This flag indicates when the pipeline is executing. It prevents infinite recursion when pipelines have loops.

Definition at line 418 of file itkProcessObject.h.

template<class TInputImage>

bool otb::ImageFileWriter< TInputImage >::m_UseCompression

private

Definition at line 244 of file otbImageFileWriter.h.

template<class TInputImage>

bool otb::ImageFileWriter< TInputImage >::m_UseInputMetaDataDictionary

private

Definition at line 245 of file otbImageFileWriter.h.

template<class TInputImage>

bool otb::ImageFileWriter< TInputImage >::m_UserSpecifiedImageIO

private

Definition at line 239 of file otbImageFileWriter.h.

template<class TInputImage>

bool otb::ImageFileWriter< TInputImage >::m_UserSpecifiedIORegion

private

Definition at line 242 of file otbImageFileWriter.h.

template<class TInputImage>

bool otb::ImageFileWriter< TInputImage >::m_WriteGeomFile

private

Definition at line 249 of file otbImageFileWriter.h.

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

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Types

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

template<class TInputImage> class otb::ImageFileWriter< TInputImage >

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

template<class TInputImage>
class otb::ImageFileWriter< TInputImage >