Orfeo Toolbox  4.0
Public Types | Public Member Functions | Static Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | Private Member Functions | List of all members
itk::StreamingImageIOBase Class Referenceabstract

A base class for specific ImageIO file formats which support streaming. More...

#include <itkStreamingImageIOBase.h>

+ Inheritance diagram for itk::StreamingImageIOBase:
+ Collaboration diagram for itk::StreamingImageIOBase:

Public Types

typedef std::vector< std::string > ArrayOfExtensionsType
 
typedef ::itk::OffsetValueType BufferSizeType
 
enum  ByteOrder {
  BigEndian,
  LittleEndian,
  OrderNotApplicable
}
 
typedef SmartPointer< const SelfConstPointer
 
enum  FileType {
  ASCII,
  Binary,
  TypeNotApplicable
}
 
typedef ::itk::IndexValueType IndexValueType
 
enum  IOComponentType {
  UNKNOWNCOMPONENTTYPE,
  UCHAR,
  CHAR,
  USHORT,
  SHORT,
  UINT,
  INT,
  ULONG,
  LONG,
  FLOAT,
  DOUBLE
}
 
enum  IOPixelType {
  UNKNOWNPIXELTYPE,
  SCALAR,
  RGB,
  RGBA,
  OFFSET,
  VECTOR,
  POINT,
  COVARIANTVECTOR,
  SYMMETRICSECONDRANKTENSOR,
  DIFFUSIONTENSOR3D,
  COMPLEX,
  FIXEDARRAY,
  MATRIX
}
 
typedef SmartPointer< SelfPointer
 
typedef StreamingImageIOBase Self
 
typedef ::itk::intmax_t SizeType
 
typedef ::itk::SizeValueType SizeValueType
 
typedef ImageIOBase 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 bool CanReadFile (const char *)=0
 
virtual bool CanStreamRead (void)
 
virtual bool CanStreamWrite (void)
 
virtual bool CanWriteFile (const char *)=0
 
virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
virtual void DebugOff () const
 
virtual void DebugOn () const
 
virtual void Delete ()
 
virtual ImageIORegion GenerateStreamableReadRegionFromRequestedRegion (const ImageIORegion &requested) const
 
virtual const bool & GetAbortGenerateData ()
 
virtual unsigned int GetActualNumberOfSplitsForWriting (unsigned int numberOfRequestedSplits, const ImageIORegion &pasteRegion, const ImageIORegion &largestPossibleRegion)
 
virtual ByteOrder GetByteOrder () const
 
std::string GetByteOrderAsString (ByteOrder) const
 
CommandGetCommand (unsigned long tag)
 
virtual unsigned int GetComponentSize () const
 
virtual IOComponentType GetComponentType () const
 
virtual const std::type_info & GetComponentTypeInfo () const
 
bool GetDebug () const
 
virtual std::vector< double > GetDefaultDirection (unsigned int i) const
 
virtual itk::SizeValueType GetDimensions (unsigned int i) const
 
virtual std::vector< double > GetDirection (unsigned int i) const
 
virtual const char * GetFileName () const
 
virtual FileType GetFileType () const
 
std::string GetFileTypeAsString (FileType) const
 
SizeType GetImageSizeInBytes () const
 
SizeType GetImageSizeInComponents () const
 
SizeType GetImageSizeInPixels () const
 
virtual const ImageIORegionGetIORegion ()
 
MetaDataDictionaryGetMetaDataDictionary (void)
 
const MetaDataDictionaryGetMetaDataDictionary (void) const
 
virtual ModifiedTimeType GetMTime () const
 
virtual const char * GetNameOfClass () const
 
virtual const unsigned int & GetNumberOfComponents ()
 
virtual unsigned int GetNumberOfDimensions () const
 
virtual const std::string & GetObjectName ()
 
virtual double GetOrigin (unsigned int i) const
 
virtual SizeType GetPixelStride () const
 
virtual IOPixelType GetPixelType () const
 
virtual const float & GetProgress ()
 
virtual int GetReferenceCount () const
 
virtual double GetSpacing (unsigned int i) const
 
virtual ImageIORegion GetSplitRegionForWriting (unsigned int ithPiece, unsigned int numberOfActualSplits, const ImageIORegion &pasteRegion, const ImageIORegion &largestPossibleRegion)
 
const ArrayOfExtensionsTypeGetSupportedReadExtensions () const
 
const ArrayOfExtensionsTypeGetSupportedWriteExtensions () const
 
virtual const TimeStampGetTimeStamp () const
 
virtual bool GetUseCompression () const
 
virtual bool GetUseStreamedReading () const
 
virtual bool GetUseStreamedWriting () const
 
bool HasObserver (const EventObject &event) const
 
void InvokeEvent (const EventObject &)
 
void InvokeEvent (const EventObject &) const
 
 itkCloneMacro (Self)
 
virtual void Modified () const
 
void Print (std::ostream &os, Indent indent=0) const
 
virtual void Read (void *buffer)=0
 
virtual void ReadImageInformation ()=0
 
virtual void Register () const
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag)
 
virtual void SetAbortGenerateData (bool _arg)
 
virtual void SetByteOrder (const ByteOrder _arg)
 
void SetByteOrderToBigEndian ()
 
void SetByteOrderToLittleEndian ()
 
virtual void SetComponentType (const IOComponentType _arg)
 
void SetDebug (bool debugFlag) const
 
virtual void SetDimensions (unsigned int i, unsigned int dim)
 
virtual void SetDirection (unsigned int i, const std::vector< double > &direction)
 
virtual void SetDirection (unsigned int i, const vnl_vector< double > &direction)
 
virtual void SetFileName (const char *_arg)
 
virtual void SetFileType (const FileType _arg)
 
void SetFileTypeToASCII ()
 
void SetFileTypeToBinary ()
 
virtual void SetIORegion (ImageIORegion _arg)
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
virtual void SetNumberOfComponents (unsigned int _arg)
 
void SetNumberOfDimensions (unsigned int)
 
virtual void SetObjectName (std::string _arg)
 
virtual void SetOrigin (unsigned int i, double origin)
 
virtual void SetPixelType (const IOPixelType _arg)
 
template<typename TPixel >
void SetPixelTypeInfo (const TPixel *)
 
template<typename TPixel >
void SetPixelTypeInfo (const RGBPixel< TPixel > *)
 
template<typename TPixel >
void SetPixelTypeInfo (const RGBAPixel< TPixel > *)
 
template<typename TPixel , unsigned VLength>
void SetPixelTypeInfo (const Vector< TPixel, VLength > *)
 
template<typename TPixel >
void SetPixelTypeInfo (const VariableLengthVector< TPixel > *)
 
template<typename TPixel , unsigned VLength>
void SetPixelTypeInfo (const CovariantVector< TPixel, VLength > *)
 
template<typename TPixel , unsigned VLength>
void SetPixelTypeInfo (const FixedArray< TPixel, VLength > *)
 
template<typename TPixel , unsigned VLength>
void SetPixelTypeInfo (const SymmetricSecondRankTensor< TPixel, VLength > *)
 
template<typename TPixel >
void SetPixelTypeInfo (const DiffusionTensor3D< TPixel > *)
 
template<typename TPixel , unsigned VLength>
void SetPixelTypeInfo (const Matrix< TPixel, VLength, VLength > *)
 
template<typename TPixel >
void SetPixelTypeInfo (const std::complex< TPixel > *)
 
template<unsigned VLength>
void SetPixelTypeInfo (const Offset< VLength > *)
 
virtual void SetProgress (float _arg)
 
virtual void SetReferenceCount (int)
 
virtual void SetSpacing (unsigned int i, double spacing)
 
template<typename TPixel >
void SetTypeInfo (const TPixel *)
 
virtual void SetUseCompression (bool _arg)
 
virtual void SetUseStreamedReading (bool _arg)
 
virtual void SetUseStreamedWriting (bool _arg)
 
virtual bool SupportsDimension (unsigned long dim)
 
virtual void UnRegister () const
 
virtual void UpdateOutputData ()
 
void UpdateProgress (float amount)
 
virtual void UseCompressionOff ()
 
virtual void UseCompressionOn ()
 
virtual void UseStreamedReadingOff ()
 
virtual void UseStreamedReadingOn ()
 
virtual void UseStreamedWritingOff ()
 
virtual void UseStreamedWritingOn ()
 
virtual void Write (const void *buffer)=0
 
virtual void WriteImageInformation ()=0
 

Static Public Member Functions

static void BreakOnError ()
 
static std::string GetComponentTypeAsString (IOComponentType)
 
static IOComponentType GetComponentTypeFromString (const std::string &typeString)
 
static bool GetGlobalWarningDisplay ()
 
static std::string GetPixelTypeAsString (IOPixelType)
 
static IOPixelType GetPixelTypeFromString (const std::string &pixelString)
 
static void GlobalWarningDisplayOff ()
 
static void GlobalWarningDisplayOn ()
 
static Pointer New ()
 
static void SetGlobalWarningDisplay (bool flag)
 

Protected Types

typedef int InternalReferenceCountType
 

Protected Member Functions

 StreamingImageIOBase ()
 
void AddSupportedReadExtension (const char *extension)
 
void AddSupportedWriteExtension (const char *extension)
 
void ComputeStrides ()
 
virtual void GenerateData ()
 
virtual unsigned int GetActualNumberOfSplitsForWritingCanStreamWrite (unsigned int numberOfRequestedSplits, const ImageIORegion &pasteRegion) const
 
SizeType GetComponentStride () const
 
virtual SizeType GetDataPosition (void) const
 Returns the byte offset into the file where the data is located. More...
 
virtual SizeType GetHeaderSize (void) const =0
 Returns the size of the header in the file. More...
 
virtual const
ImageRegionSplitterBase
GetImageRegionSplitter (void) const
 
virtual unsigned int GetPixelSize () const
 
SizeType GetRowStride () const
 
SizeType GetSliceStride () const
 
virtual ImageIORegion GetSplitRegionForWritingCanStreamWrite (unsigned int ithPiece, unsigned int numberOfActualSplits, const ImageIORegion &pasteRegion) const
 
virtual LightObject::Pointer InternalClone () const
 
virtual void OpenFileForReading (std::ifstream &os, const char *filename)
 Opens a file for reading and random access. More...
 
virtual void OpenFileForWriting (std::ofstream &os, const char *filename, bool truncate)
 Opens a file for writing and random access. More...
 
virtual void PrintHeader (std::ostream &os, Indent indent) const
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void PrintSelf (std::ostream &os, Indent indent) const
 
virtual void PrintTrailer (std::ostream &os, Indent indent) const
 
virtual void ReadBufferAsASCII (std::istream &os, void *buffer, IOComponentType ctype, SizeType numberOfBytesToBeRead)
 
virtual bool ReadBufferAsBinary (std::istream &is, void *buffer, SizeType num)
 Reimplemented from super class to get around 2GB read/write limitation. More...
 
virtual bool RequestedToStream (void) const
 Returns true if GetIORegion is not the same size as the largest region give by GetNumberOfDimensions. More...
 
virtual void Reset (const bool freeDynamic=true)
 
void Resize (const unsigned int numDimensions, const unsigned int *dimensions)
 
virtual void SetTimeStamp (const TimeStamp &time)
 
virtual bool StreamReadBufferAsBinary (std::istream &os, void *buffer)
 Reads the set IORegion from os into buffer. More...
 
virtual bool StreamWriteBufferAsBinary (std::ostream &os, const void *buffer)
 Writes the set IORegion from buffer into os. More...
 
virtual void WriteBufferAsASCII (std::ostream &os, const void *buffer, IOComponentType ctype, SizeType numberOfBytesToWrite)
 
virtual bool WriteBufferAsBinary (std::ostream &is, const void *buffer, SizeType num)
 Reimplemented from super class to get around 2GB read/write limitation. More...
 

Protected Attributes

ByteOrder m_ByteOrder
 
IOComponentType m_ComponentType
 
std::vector< SizeValueTypem_Dimensions
 
std::vector< std::vector
< double > > 
m_Direction
 
std::string m_FileName
 
FileType m_FileType
 
bool m_Initialized
 
ImageIORegion m_IORegion
 
unsigned int m_NumberOfComponents
 
unsigned int m_NumberOfDimensions
 
std::vector< double > m_Origin
 
IOPixelType m_PixelType
 
InternalReferenceCountType m_ReferenceCount
 
SimpleFastMutexLock m_ReferenceCountLock
 
std::vector< double > m_Spacing
 
std::vector< SizeTypem_Strides
 
bool m_UseCompression
 
bool m_UseStreamedReading
 
bool m_UseStreamedWriting
 

Private Member Functions

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

Detailed Description

A base class for specific ImageIO file formats which support streaming.

This class overloads the methods needed to enable streaming. These methods are utilized by the ImageFileReader and ImageFileWriter. The implementation supports streaming of an arbitrary sized region as well as pasting to new or existing file ( of the same name, size, and pixel type ).

See Also
CanStreamWrite CanStreamRead GenerateStreamableReadRegionFromRequestedRegion GetActualNumberOfSplitsForWriting

Additionally low level IO methods are provided to read and write an IORegion from a file.

See Also
StreamReadBufferAsBinary StreamWriteBufferAsBinary

This implementation was taken fron the Insight Joural: http://hdl.handle.net/10380/3171

See Also
itk::ImageFileReader itk::ImageFileWriter

Definition at line 52 of file itkStreamingImageIOBase.h.

Member Typedef Documentation

typedef std::vector< std::string > itk::ImageIOBase::ArrayOfExtensionsType
inherited

Type for the list of strings to be used for extensions.

Definition at line 409 of file itkImageIOBase.h.

Type for representing size of bytes, and or positions along a memory buffer

Definition at line 279 of file itkImageIOBase.h.

Definition at line 79 of file itkLightProcessObject.h.

Types for managing image size and image index components.

Definition at line 82 of file itkImageIOBase.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 152 of file itkLightObject.h.

Definition at line 58 of file itkStreamingImageIOBase.h.

Standard class typedefs.

Definition at line 56 of file itkStreamingImageIOBase.h.

Type for representing size of bytes, and or positions along a file

Definition at line 275 of file itkImageIOBase.h.

Definition at line 86 of file itkImageIOBase.h.

Definition at line 57 of file itkStreamingImageIOBase.h.

Member Enumeration Documentation

Enums used to specify byte order; whether Big Endian or Little Endian. Some subclasses use this, some ignore it.

Enumerator
BigEndian 
LittleEndian 
OrderNotApplicable 

Definition at line 227 of file itkImageIOBase.h.

Enums used to specify write style: whether binary or ASCII. Some subclasses use this, some ignore it.

Enumerator
ASCII 
Binary 
TypeNotApplicable 

Definition at line 223 of file itkImageIOBase.h.

Enums used to manipulate the component type. The component type refers to the actual storage class associated with either a SCALAR pixel type or elements of a compound pixel.

Enumerator
UNKNOWNCOMPONENTTYPE 
UCHAR 
CHAR 
USHORT 
SHORT 
UINT 
INT 
ULONG 
LONG 
FLOAT 
DOUBLE 

Definition at line 106 of file itkImageIOBase.h.

Enums used to manipulate the pixel type. The pixel type provides context for automatic data conversions (for instance, RGB to SCALAR, VECTOR to SCALAR).

Enumerator
UNKNOWNPIXELTYPE 
SCALAR 
RGB 
RGBA 
OFFSET 
VECTOR 
POINT 
COVARIANTVECTOR 
SYMMETRICSECONDRANKTENSOR 
DIFFUSIONTENSOR3D 
COMPLEX 
FIXEDARRAY 
MATRIX 

Definition at line 98 of file itkImageIOBase.h.

Constructor & Destructor Documentation

itk::StreamingImageIOBase::StreamingImageIOBase ( )
protected

Definition at line 24 of file itkStreamingImageIOBase.cxx.

itk::StreamingImageIOBase::StreamingImageIOBase ( const Self )
private

Member Function Documentation

virtual void itk::LightProcessObject::AbortGenerateDataOff ( )
virtualinherited
virtual void itk::LightProcessObject::AbortGenerateDataOn ( )
virtualinherited

Turn on and off the AbortGenerateData flag.

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 398 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 409 of file itkObject.cxx.

References itk::SubjectImplementation::AddObserver().

void itk::ImageIOBase::AddSupportedReadExtension ( const char *  extension)
protectedinherited

Insert an extension to the list of supported extensions for reading.

Definition at line 67 of file itkImageIOBase.cxx.

References itk::ImageIOBase::m_SupportedReadExtensions.

void itk::ImageIOBase::AddSupportedWriteExtension ( const char *  extension)
protectedinherited

Insert an extension to the list of supported extensions for writing.

Definition at line 72 of file itkImageIOBase.cxx.

References itk::ImageIOBase::m_SupportedWriteExtensions.

void itk::LightObject::BreakOnError ( )
staticinherited

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

Definition at line 150 of file itkLightObject.cxx.

virtual bool itk::ImageIOBase::CanReadFile ( const char *  )
pure virtualinherited

Determine the file type. Returns true if this ImageIO can read the file specified.

Implemented in itk::VXLVideoIO, itk::FileListVideoIO, and itk::OpenCVVideoIO.

bool itk::StreamingImageIOBase::CanStreamRead ( void  )
virtual

Determine if the ImageIO can stream reading from the current settings. Default is false. If this is queried after the header of the file has been read then it will indicate if that file can be streamed

Reimplemented from itk::ImageIOBase.

Definition at line 302 of file itkStreamingImageIOBase.cxx.

Referenced by GenerateStreamableReadRegionFromRequestedRegion().

bool itk::StreamingImageIOBase::CanStreamWrite ( void  )
virtual

Determine if the ImageIO can stream write from the current settings.

There are two types of non exclusive streaming: pasteing subregions, and iterative

Reimplemented from itk::ImageIOBase.

Definition at line 307 of file itkStreamingImageIOBase.cxx.

Referenced by GetActualNumberOfSplitsForWriting().

virtual bool itk::ImageIOBase::CanWriteFile ( const char *  )
pure virtualinherited

Determine the file type. Returns true if this ImageIO can read the file specified.

Implemented in itk::VXLVideoIO, itk::FileListVideoIO, and itk::OpenCVVideoIO.

void itk::ImageIOBase::ComputeStrides ( )
protectedinherited

Calculates the different strides (distance from one thing to the next). Upon return, strides[0] = bytes to get to the next component of a pixel, strides[1] = bytes to get to the next pixel in x direction, strides[2] = bytes to get to the next row in y direction, strides[3] = bytes to get to the next slice in z direction, etc.

Definition at line 203 of file itkImageIOBase.cxx.

References itk::ImageIOBase::GetComponentSize(), itk::ImageIOBase::m_Dimensions, itk::ImageIOBase::m_NumberOfComponents, itk::ImageIOBase::m_NumberOfDimensions, and itk::ImageIOBase::m_Strides.

Referenced by itk::ImageIOBase::Resize().

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

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 itk::ImageKmeansModelEstimator< TInputImage, TMembershipFunction >, itk::ImageGaussianModelEstimator< TInputImage, TMembershipFunction, TTrainingImage >, itk::ImageClassifierBase< TInputImage, TClassifiedImage >, itk::LevelSetVelocityNeighborhoodExtractor< TLevelSet, TAuxValue, VAuxDimension >, itk::LevelSetNeighborhoodExtractor< TLevelSet >, itk::Statistics::ErrorBackPropagationLearningFunctionBase< LayerType, TTargetVector >, itk::VXLVideoIO, itk::Statistics::QuickPropLearningRule< LayerType, TTargetVector >, itk::Statistics::ErrorBackPropagationLearningWithMomentum< LayerType, TTargetVector >, itk::Statistics::RBFBackPropagationLearningFunction< LayerType, TTargetVector >, itk::Statistics::RBFLayer< TMeasurementVector, TTargetVector >, itk::Statistics::TrainingFunctionBase< TSample, TTargetVector, ScalarType >, itk::Statistics::BatchSupervisedTrainingFunction< TSample, TTargetVector, ScalarType >, itk::OpenCVVideoIO, itk::Statistics::BackPropagationLayer< TMeasurementVector, TTargetVector >, itk::Statistics::IterativeSupervisedTrainingFunction< TSample, TTargetVector, ScalarType >, itk::FileListVideoIO, and itk::Statistics::CompletelyConnectedWeightSet< TMeasurementVector, TTargetVector >.

Referenced by GetActualNumberOfSplitsForWriting().

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 243 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 91 of file itkLightObject.cxx.

virtual void itk::LightProcessObject::GenerateData ( void  )
inlineprotectedvirtualinherited
ImageIORegion itk::StreamingImageIOBase::GenerateStreamableReadRegionFromRequestedRegion ( const ImageIORegion requested) const
virtual

Method for supporting streaming. Given a requested region, determine what could be the region that we can read from the file. This is called the streamable region, which will be equal or smaller than the LargestPossibleRegion (unless it was dimensionaly clipped) and greater or equal to the RequestedRegion

the resulting IORegion may be a greater dimensions the the requested IORegion, if the the derived class is unable to read the requested region. For example if the file has a size of [ 10, 10, 10] but the requested region is [10, 10] the return may be 3 dimensions.

Given a requested region, determine what could be the region that we can read from the file. This is called the streamable region, which will be smaller than the LargestPossibleRegion and greater or equal to the RequestedRegion

Reimplemented from itk::ImageIOBase.

Definition at line 423 of file itkStreamingImageIOBase.cxx.

References CanStreamRead(), itk::ImageIOBase::GenerateStreamableReadRegionFromRequestedRegion(), itk::ImageIOBase::m_NumberOfDimensions, and itk::ImageIOBase::m_UseStreamedReading.

virtual const bool& itk::LightProcessObject::GetAbortGenerateData ( )
virtualinherited

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

unsigned int itk::StreamingImageIOBase::GetActualNumberOfSplitsForWriting ( unsigned int  numberOfRequestedSplits,
const ImageIORegion pasteRegion,
const ImageIORegion largestPossibleRegion 
)
virtual

Before this method is called all the configuration will be done, that is Streaming/PasteRegion/Compression/Filename etc If pasting is being used the number of requested splits is for that region not the largest. The derived ImageIO class should verify that the file is capable of being written with this configuration. If pasted is enabled and is not support or does not work with the file, then an excepetion should be thrown.

The default implementation depends on CanStreamWrite. If false then 1 is returned (unless pasting is indicated), so that the whole file will be updated in one region. If true then its assumed that any arbitrary region can be written to any file. So the users request will be respected. If a derived class has more restictive conditions then they should be checked

Reimplemented from itk::ImageIOBase.

Definition at line 313 of file itkStreamingImageIOBase.cxx.

References CanStreamWrite(), itk::LightProcessObject::CreateAnother(), itk::ImageIOBase::GetActualNumberOfSplitsForWriting(), itk::ImageIOBase::GetActualNumberOfSplitsForWritingCanStreamWrite(), itk::ImageIOBase::GetComponentType(), itk::ImageIOBase::GetDimensions(), itk::ImageIOBase::GetDirection(), itk::ImageIOBase::GetNumberOfComponents(), itk::ImageIOBase::GetNumberOfDimensions(), itk::ImageIOBase::GetOrigin(), itk::ImageIOBase::GetPixelType(), itk::SmartPointer< TObjectType >::GetPointer(), itk::ImageIOBase::GetSpacing(), and itk::ImageIOBase::m_FileName.

unsigned int itk::ImageIOBase::GetActualNumberOfSplitsForWritingCanStreamWrite ( unsigned int  numberOfRequestedSplits,
const ImageIORegion pasteRegion 
) const
protectedvirtualinherited
virtual ByteOrder itk::ImageIOBase::GetByteOrder ( ) const
virtualinherited
std::string itk::ImageIOBase::GetByteOrderAsString ( ByteOrder  t) const
inherited

Convenience method returns the ByteOrder as a string. This can be used for writing output files.

Definition at line 387 of file itkImageIOBase.cxx.

References itk::ImageIOBase::BigEndian, itk::ImageIOBase::LittleEndian, and itk::ImageIOBase::OrderNotApplicable.

Referenced by itk::ImageIOBase::PrintSelf().

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 assign 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 421 of file itkObject.cxx.

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

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

unsigned int itk::ImageIOBase::GetComponentSize ( ) const
virtualinherited

Compute the size (in bytes) of the components of a pixel. For example, and RGB pixel of unsigned char would have a component size of 1 byte. This method can be invoked only after the component type is set.

Definition at line 340 of file itkImageIOBase.cxx.

References itk::ImageIOBase::CHAR, itk::ImageIOBase::DOUBLE, itk::ImageIOBase::FLOAT, itk::ImageIOBase::INT, itk::ImageIOBase::LONG, itk::ImageIOBase::m_ComponentType, itk::ImageIOBase::SHORT, itk::ImageIOBase::UCHAR, itk::ImageIOBase::UINT, itk::ImageIOBase::ULONG, itk::ImageIOBase::UNKNOWNCOMPONENTTYPE, and itk::ImageIOBase::USHORT.

Referenced by itk::ImageIOBase::ComputeStrides(), itk::ImageIOBase::GetPixelSize(), and itk::VXLVideoIO::SetWriterParameters().

ImageIOBase::SizeType itk::ImageIOBase::GetComponentStride ( ) const
protectedinherited

Convenient method for accessing number of bytes to get to the next pixel component. Returns m_Strides[0].

Definition at line 245 of file itkImageIOBase.cxx.

virtual IOComponentType itk::ImageIOBase::GetComponentType ( ) const
virtualinherited
std::string itk::ImageIOBase::GetComponentTypeAsString ( IOComponentType  t)
staticinherited
ImageIOBase::IOComponentType itk::ImageIOBase::GetComponentTypeFromString ( const std::string &  typeString)
staticinherited
const std::type_info & itk::ImageIOBase::GetComponentTypeInfo ( ) const
virtualinherited

get the type_info for the current pixel component type. This function is DEPRECATED and only provided for backwards compatibility. There is no use for this method that can't be satisfied by calling GetComponentType.

Definition at line 172 of file itkImageIOBase.cxx.

References itk::ImageIOBase::CHAR, itk::ImageIOBase::DOUBLE, itk::ImageIOBase::FLOAT, itk::ImageIOBase::INT, itk::ImageIOBase::LONG, itk::ImageIOBase::m_ComponentType, itk::ImageIOBase::SHORT, itk::ImageIOBase::UCHAR, itk::ImageIOBase::UINT, itk::ImageIOBase::ULONG, itk::ImageIOBase::UNKNOWNCOMPONENTTYPE, and itk::ImageIOBase::USHORT.

virtual SizeType itk::StreamingImageIOBase::GetDataPosition ( void  ) const
inlineprotectedvirtual

Returns the byte offset into the file where the data is located.

The default implementation is to return the header size.

Definition at line 153 of file itkStreamingImageIOBase.h.

Referenced by StreamWriteBufferAsBinary().

bool itk::Object::GetDebug ( ) const
inherited

Get the value of the debug flag.

Definition at line 263 of file itkObject.cxx.

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

std::vector< double > itk::ImageIOBase::GetDefaultDirection ( unsigned int  k) const
virtualinherited

Return the directions to be assigned by default to recipient images whose dimension is smaller than the image dimension in file.

Return the directions that this particular ImageIO would use by default in the case the recipient image dimension is smaller than the dimension of the image in file.

Definition at line 905 of file itkImageIOBase.cxx.

Referenced by itk::OpenCVVideoIO::GetDirection().

virtual itk::SizeValueType itk::ImageIOBase::GetDimensions ( unsigned int  i) const
inlinevirtualinherited
virtual std::vector< double > itk::ImageIOBase::GetDirection ( unsigned int  i) const
inlinevirtualinherited

Reimplemented in itk::OpenCVVideoIO, and itk::FileListVideoIO.

Definition at line 148 of file itkImageIOBase.h.

Referenced by GetActualNumberOfSplitsForWriting().

virtual const char* itk::ImageIOBase::GetFileName ( ) const
virtualinherited
virtual FileType itk::ImageIOBase::GetFileType ( ) const
virtualinherited
std::string itk::ImageIOBase::GetFileTypeAsString ( FileType  t) const
inherited

Convenience method returns the FileType as a string. This can be used for writing output files.

Definition at line 372 of file itkImageIOBase.cxx.

References itk::ImageIOBase::ASCII, itk::ImageIOBase::Binary, and itk::ImageIOBase::TypeNotApplicable.

Referenced by itk::ImageIOBase::PrintSelf().

bool itk::Object::GetGlobalWarningDisplay ( )
staticinherited

Get the value of the global debug output control flag.

Definition at line 391 of file itkObject.cxx.

virtual SizeType itk::StreamingImageIOBase::GetHeaderSize ( void  ) const
protectedpure virtual

Returns the size of the header in the file.

const ImageRegionSplitterBase * itk::ImageIOBase::GetImageRegionSplitter ( void  ) const
protectedvirtualinherited
ImageIOBase::SizeType itk::ImageIOBase::GetImageSizeInBytes ( ) const
inherited

Return the number of bytes in the image.

Definition at line 238 of file itkImageIOBase.cxx.

ImageIOBase::SizeType itk::ImageIOBase::GetImageSizeInComponents ( ) const
inherited

Return the number of pixels times the number of components in the image.

Definition at line 231 of file itkImageIOBase.cxx.

ImageIOBase::SizeType itk::ImageIOBase::GetImageSizeInPixels ( ) const
inherited

Return the number of pixels in the image.

Definition at line 216 of file itkImageIOBase.cxx.

virtual const ImageIORegion& itk::ImageIOBase::GetIORegion ( )
virtualinherited

Referenced by RequestedToStream().

MetaDataDictionary & itk::Object::GetMetaDataDictionary ( void  )
inherited
const MetaDataDictionary & itk::Object::GetMetaDataDictionary ( void  ) const
inherited
Returns
A constant reference to this objects MetaDataDictionary.

Definition at line 548 of file itkObject.cxx.

References NULL.

ModifiedTimeType itk::Object::GetMTime ( void  ) const
virtualinherited

Return this objects modified time.

Return the modification for this object.

Reimplemented in itk::ImageAdaptor< TImage, TAccessor >, itk::ImageAdaptor< TImage, Accessor::AsinPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::SqrtPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, otb::Accessor::VectorImageToASPixelAccessor< TImage::PixelType::ValueType > >, itk::ImageAdaptor< TImage, Accessor::TanPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::CosPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::VectorToRGBPixelAccessor< TImage::PixelType::ValueType > >, itk::ImageAdaptor< TImage, Accessor::RGBToVectorPixelAccessor< TImage::PixelType::ComponentType > >, itk::ImageAdaptor< TImage, Accessor::ComplexToModulusPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::AbsPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::ShiftScalePixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::SinPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::LogPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::ComplexToPhasePixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< VectorImage< TPixelType, Dimension >, Accessor::VectorImageToImagePixelAccessor< TPixelType > >, itk::ImageAdaptor< TImage, Accessor::Log10PixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::AtanPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::ComplexToRealPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::ComplexToImaginaryPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::ExpNegativePixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::ComplexConjugatePixelAccessor< TImage::PixelType > >, itk::ImageAdaptor< TImage, Accessor::ExpPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::AcosPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::RGBToLuminancePixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::AddPixelAccessor< TImage::PixelType > >, itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType, TTransformPrecisionType >, itk::MultiResolutionImageRegistrationMethod< TFixedImage, TMovingImage >, itk::SpatialObject< VDimension >, itk::SpatialObject< 3 >, itk::SpatialObject< TDimension >, itk::SpatialObject< TMesh::PointDimension >, itk::VectorResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >, itk::ImageRegistrationMethod< TFixedImage, TMovingImage >, itk::ImageToSpatialObjectRegistrationMethod< TFixedImage, TMovingSpatialObject >, itk::InverseDeformationFieldImageFilter< TInputImage, TOutputImage >, itk::TransformToDeformationFieldSource< TOutputImage, TTransformPrecisionType >, itk::BoundingBox< TPointIdentifier, VPointDimension, TCoordRep, TPointsContainer >, itk::InverseDisplacementFieldImageFilter< TInputImage, TOutputImage >, itk::PointSetToImageRegistrationMethod< TFixedPointSet, TMovingImage >, itk::TransformToDisplacementFieldSource< TOutputImage, TTransformPrecisionType >, itk::PointSetToPointSetRegistrationMethod< TFixedPointSet, TMovingPointSet >, itk::DeformationFieldSource< TOutputImage >, itk::LandmarkDisplacementFieldSource< TOutputImage >, itk::ImageSpatialObject< TDimension, TPixelType >, itk::ImageSpatialObject< TDimension, unsigned char >, itk::MeshSpatialObject< TMesh >, and itk::SceneSpatialObject< TSpaceDimension >.

Definition at line 283 of file itkObject.cxx.

Referenced by itk::LandmarkDisplacementFieldSource< TOutputImage >::GetMTime(), itk::DeformationFieldSource< TOutputImage >::GetMTime(), itk::TransformToDisplacementFieldSource< TOutputImage, TTransformPrecisionType >::GetMTime(), itk::InverseDisplacementFieldImageFilter< TInputImage, TOutputImage >::GetMTime(), itk::BoundingBox< TPointIdentifier, VPointDimension, TCoordRep, TPointsContainer >::GetMTime(), itk::TransformToDeformationFieldSource< TOutputImage, TTransformPrecisionType >::GetMTime(), itk::InverseDeformationFieldImageFilter< TInputImage, TOutputImage >::GetMTime(), itk::VectorResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::GetMTime(), itk::SpatialObject< VDimension >::GetMTime(), itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType, TTransformPrecisionType >::GetMTime(), itk::SpatialObject< TMesh::PointDimension >::GetObjectMTime(), and itk::ProcessObject::UpdateOutputInformation().

virtual const char* itk::StreamingImageIOBase::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods).

Reimplemented from itk::ImageIOBase.

virtual const unsigned int& itk::ImageIOBase::GetNumberOfComponents ( )
virtualinherited
virtual unsigned int itk::ImageIOBase::GetNumberOfDimensions ( ) const
virtualinherited
virtual const std::string& itk::Object::GetObjectName ( )
virtualinherited
virtual double itk::ImageIOBase::GetOrigin ( unsigned int  i) const
inlinevirtualinherited

Reimplemented in itk::OpenCVVideoIO, and itk::FileListVideoIO.

Definition at line 128 of file itkImageIOBase.h.

Referenced by GetActualNumberOfSplitsForWriting().

unsigned int itk::ImageIOBase::GetPixelSize ( ) const
protectedvirtualinherited

Compute the size (in bytes) of the pixel. For example, and RGB pixel of unsigned char would have size 3 bytes.

Definition at line 327 of file itkImageIOBase.cxx.

References itk::ImageIOBase::GetComponentSize(), itk::ImageIOBase::GetNumberOfComponents(), itk::ImageIOBase::m_ComponentType, itk::ImageIOBase::m_PixelType, itk::ImageIOBase::UNKNOWNCOMPONENTTYPE, and itk::ImageIOBase::UNKNOWNPIXELTYPE.

Referenced by StreamWriteBufferAsBinary().

ImageIOBase::SizeType itk::ImageIOBase::GetPixelStride ( ) const
virtualinherited

Convenient method for accessing the number of bytes to get to the next pixel. Returns m_Strides[1];

Please note that this methods depends the private methods ComputeStrides being called, otherwise this is the incorrect value.

Definition at line 252 of file itkImageIOBase.cxx.

virtual IOPixelType itk::ImageIOBase::GetPixelType ( ) const
virtualinherited
std::string itk::ImageIOBase::GetPixelTypeAsString ( IOPixelType  t)
staticinherited
ImageIOBase::IOPixelType itk::ImageIOBase::GetPixelTypeFromString ( const std::string &  pixelString)
staticinherited
virtual const float& itk::LightProcessObject::GetProgress ( )
virtualinherited

Get the execution progress of a process object. The progress is a floating number between (0,1), 0 meaning no progress; 1 meaning the filter has completed execution.

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

Gets the reference count on this object.

Definition at line 112 of file itkLightObject.h.

ImageIOBase::SizeType itk::ImageIOBase::GetRowStride ( ) const
protectedinherited

Convenient method for accessing the number of bytes to get to the next row. Returns m_Strides[2].

Definition at line 259 of file itkImageIOBase.cxx.

ImageIOBase::SizeType itk::ImageIOBase::GetSliceStride ( ) const
protectedinherited

Convenient method for accessing the number of bytes to get to the next slice. Returns m_Strides[3].

Definition at line 266 of file itkImageIOBase.cxx.

virtual double itk::ImageIOBase::GetSpacing ( unsigned int  i) const
inlinevirtualinherited

Reimplemented in itk::OpenCVVideoIO, and itk::FileListVideoIO.

Definition at line 137 of file itkImageIOBase.h.

Referenced by GetActualNumberOfSplitsForWriting().

ImageIORegion itk::ImageIOBase::GetSplitRegionForWriting ( unsigned int  ithPiece,
unsigned int  numberOfActualSplits,
const ImageIORegion pasteRegion,
const ImageIORegion largestPossibleRegion 
)
virtualinherited

returns the ith IORegion

numberOfActualSplits should be the value returned from GetActualNumberOfSplitsForWriting with the same parameters

Derieved classes should overload this method to return a compatible region

Definition at line 828 of file itkImageIOBase.cxx.

References itk::ImageIOBase::CanStreamWrite(), and itk::ImageIOBase::GetSplitRegionForWritingCanStreamWrite().

ImageIORegion itk::ImageIOBase::GetSplitRegionForWritingCanStreamWrite ( unsigned int  ithPiece,
unsigned int  numberOfActualSplits,
const ImageIORegion pasteRegion 
) const
protectedvirtualinherited
const ImageIOBase::ArrayOfExtensionsType & itk::ImageIOBase::GetSupportedReadExtensions ( ) const
inherited

This method returns an array with the list of filename extensions supported for reading by this ImageIO class. This is intended to facilitate GUI and application level integration.

Definition at line 62 of file itkImageIOBase.cxx.

References itk::ImageIOBase::m_SupportedReadExtensions.

const ImageIOBase::ArrayOfExtensionsType & itk::ImageIOBase::GetSupportedWriteExtensions ( ) const
inherited

This method returns an array with the list of filename extensions supported for writing by this ImageIO class. This is intended to facilitate GUI and application level integration.

Definition at line 56 of file itkImageIOBase.cxx.

References itk::ImageIOBase::m_SupportedWriteExtensions.

const TimeStamp & itk::Object::GetTimeStamp ( ) const
virtualinherited

Return this object's time stamp.

Return the modification for this object.

Reimplemented in itk::RealTimeClock.

Definition at line 293 of file itkObject.cxx.

Referenced by itk::RealTimeClock::GetTimeStamp().

virtual bool itk::ImageIOBase::GetUseCompression ( ) const
virtualinherited
virtual bool itk::ImageIOBase::GetUseStreamedReading ( ) const
virtualinherited
virtual bool itk::ImageIOBase::GetUseStreamedWriting ( ) const
virtualinherited
static void itk::Object::GlobalWarningDisplayOff ( )
inlinestaticinherited

Definition at line 118 of file itkObject.h.

Referenced by itk::OutputWindow::DisplayText().

static void itk::Object::GlobalWarningDisplayOn ( )
inlinestaticinherited

Definition at line 116 of file itkObject.h.

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

Return true if an observer is registered for this event.

Definition at line 472 of file itkObject.cxx.

LightObject::Pointer itk::LightObject::InternalClone ( ) const
protectedvirtualinherited
void itk::Object::InvokeEvent ( const EventObject event)
inherited
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 462 of file itkObject.cxx.

itk::LightObject::itkCloneMacro ( Self  )
inherited
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.

Reimplemented in otb::SVMModel< TValue, TLabel >, itk::ImageAdaptor< TImage, TAccessor >, itk::ImageAdaptor< TImage, Accessor::AsinPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::SqrtPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, otb::Accessor::VectorImageToASPixelAccessor< TImage::PixelType::ValueType > >, itk::ImageAdaptor< TImage, Accessor::TanPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::CosPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::VectorToRGBPixelAccessor< TImage::PixelType::ValueType > >, itk::ImageAdaptor< TImage, Accessor::RGBToVectorPixelAccessor< TImage::PixelType::ComponentType > >, itk::ImageAdaptor< TImage, Accessor::ComplexToModulusPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::AbsPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::ShiftScalePixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::SinPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::LogPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::ComplexToPhasePixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< VectorImage< TPixelType, Dimension >, Accessor::VectorImageToImagePixelAccessor< TPixelType > >, itk::ImageAdaptor< TImage, Accessor::Log10PixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::AtanPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::ComplexToRealPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::ComplexToImaginaryPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::ExpNegativePixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::ComplexConjugatePixelAccessor< TImage::PixelType > >, itk::ImageAdaptor< TImage, Accessor::ExpPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::AcosPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::RGBToLuminancePixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::AddPixelAccessor< TImage::PixelType > >, otb::SurfaceAdjacencyEffect6SCorrectionSchemeFilter< TInputImage, TOutputImage >, otb::GenericRSTransform< TScalarType, NInputDimensions, NOutputDimensions >, itk::GPUImage< TPixel, VImageDimension >, otb::MeanShiftImageFilter< TInputImage, TOutputImage, TLabeledOutput, TBufferConverter >, otb::MeanShiftImageFilter< TInputImage, TOutputImage, TLabeledOutput, MeanShift::VectorBufferConverter >, otb::GCPsToRPCSensorModelImageFilter< TImage >, otb::Polygon< TValue >, otb::ImageRegionAdaptativeSplitter< VImageDimension >, itk::GrayscaleErodeImageFilter< TInputImage, TOutputImage, TKernel >, itk::GrayscaleMorphologicalClosingImageFilter< TInputImage, TOutputImage, TKernel >, itk::GrayscaleDilateImageFilter< TInputImage, TOutputImage, TKernel >, otb::GenericInterpolateImageFunction< TInputImage, TFunction, TBoundaryCondition, TCoordRep >, itk::MorphologicalGradientImageFilter< TInputImage, TOutputImage, TKernel >, itk::GrayscaleMorphologicalOpeningImageFilter< TInputImage, TOutputImage, TKernel >, otb::PolyLineParametricPathWithValue< TValue, VDimension >, otb::PolyLineParametricPathWithValue< TValue, 2 >, otb::PhysicalToRPCSensorModelImageFilter< TImage >, itk::NormalizeImageFilter< TInputImage, TOutputImage >, and otb::StatisticsXMLFileReader< TMeasurementVector >.

Definition at line 312 of file itkObject.cxx.

Referenced by itk::AttributeSelectionLabelMapFilter< TImage, Functor::LabelLabelObjectAccessor< TImage::LabelObjectType > >::AddAttribute(), itk::Function::ConvergenceMonitoringFunction< TScalar, TScalar >::AddEnergyValue(), otb::Wrapper::InputImageListParameter::AddFromFileName(), otb::Wrapper::InputVectorDataListParameter::AddFromFileName(), otb::Wrapper::InputFilenameListParameter::AddFromFileName(), otb::Wrapper::InputImageListParameter::AddImage(), otb::Wrapper::InputImageListParameter::AddNullElement(), otb::Wrapper::InputVectorDataListParameter::AddNullElement(), otb::Wrapper::InputFilenameListParameter::AddNullElement(), otb::Wrapper::StringListParameter::AddNullElement(), itk::ConnectedRegionsMeshFilter< TInputMesh, TOutputMesh >::AddSeed(), itk::ConnectedRegionsMeshFilter< TInputMesh, TOutputMesh >::AddSpecifiedRegion(), otb::Wrapper::InputVectorDataListParameter::AddVectorData(), itk::PolyLineParametricPath< VDimension >::AddVertex(), itk::ChainCodePath< 2 >::ChangeStep(), itk::ChainCodePath2D::ChangeStep(), itk::FourierSeriesPath< VDimension >::Clear(), itk::HilbertPath< TIndexValue, VDimension >::Clear(), itk::ChainCodePath< 2 >::Clear(), itk::ChainCodePath2D::Clear(), itk::AttributeSelectionLabelMapFilter< TImage, Functor::LabelLabelObjectAccessor< TImage::LabelObjectType > >::ClearAttributeSet(), itk::Function::ConvergenceMonitoringFunction< TScalar, TScalar >::ClearEnergyValues(), itk::MultiTransform< TScalar, NDimensions >::ClearTransformQueue(), otb::Wrapper::InputFilenameListParameter::ClearValue(), otb::Wrapper::InputImageListParameter::ClearValue(), otb::Wrapper::InputVectorDataListParameter::ClearValue(), otb::Wrapper::InputFilenameListParameter::Erase(), otb::Wrapper::InputImageListParameter::Erase(), otb::Wrapper::InputVectorDataListParameter::Erase(), itk::ConnectedRegionsMeshFilter< TInputMesh, TOutputMesh >::InitializeSeedList(), itk::ConnectedRegionsMeshFilter< TInputMesh, TOutputMesh >::InitializeSpecifiedRegionList(), itk::NarrowBandImageFilterBase< TInputImage, Image< TOutputPixelType, TInputImage::ImageDimension > >::InsertNarrowBandNode(), itk::ChainCodePath2D::InsertStep(), itk::ChainCodePath< 2 >::InsertStep(), otb::ogr::ImageReference< double >::Modified(), itk::MultiTransform< TScalar, NDimensions >::PopBackTransform(), itk::MultiTransform< TScalar, NDimensions >::PopFrontTransform(), itk::MultiTransform< TScalar, NDimensions >::PushBackTransform(), itk::MultiTransform< TScalar, NDimensions >::PushFrontTransform(), itk::Statistics::SubsamplerBase< TSample >::RequestMaximumNumberOfResults(), itk::AdaptImageFilter< TInputImage, TOutputImage, TAccessor >::SetAccessor(), itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::SetAdvectionScaling(), itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::SetAlivePoints(), itk::CompositeTransform< TScalar, NDimensions >::SetAllTransformsToOptimize(), itk::GaussianInterpolateImageFunction< TInputImage, TCoordRep >::SetAlpha(), itk::WeightedAddImageFilter< TInputImage1, TInputImage2, TOutputImage >::SetAlpha(), itk::SigmoidImageFilter< TInputImage, TOutputImage >::SetAlpha(), itk::AttributeSelectionLabelMapFilter< TImage, Functor::LabelLabelObjectAccessor< TImage::LabelObjectType > >::SetAttributeSet(), itk::LevelSetVelocityNeighborhoodExtractor< TLevelSet, TAuxValue, VAuxDimension >::SetAuxImage(), itk::SigmoidImageFilter< TInputImage, TOutputImage >::SetBeta(), itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::SetBinaryMask(), otb::TileMapImageIO::SetCacheDirectory(), itk::MatrixOffsetTransformBase< TScalar, 3, 3 >::SetCenter(), itk::ConnectedRegionsMeshFilter< TInputMesh, TOutputMesh >::SetClosestPoint(), itk::ConstantPadImageFilter< TInputImage, TOutputImage >::SetConstant(), itk::DivideOrZeroOutImageFilter< TInputImage1, TInputImage2, TOutputImage >::SetConstant(), itk::LBFGSBOptimizer::SetCostFunction(), itk::VectorThresholdSegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::SetCovariance(), itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::SetCurvatureScaling(), itk::CurvesLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::SetDerivativeSigma(), itk::NarrowBandCurvesLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::SetDerivativeSigma(), itk::GeodesicActiveContourLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::SetDerivativeSigma(), itk::GeodesicActiveContourShapePriorLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::SetDerivativeSigma(), otb::ImageIOBase::SetDimensions(), itk::ImageIOBase::SetDimensions(), otb::ImageIOBase::SetDirection(), itk::ImageIOBase::SetDirection(), itk::ExtractImageFilter< TInputImage, TOutputImage >::SetDirectionCollapseToStrategy(), itk::ComposeDisplacementFieldsImageFilter< TInputImage, TOutputImage >::SetDisplacementField(), itk::InvertDisplacementFieldImageFilter< TInputImage, TOutputImage >::SetDisplacementField(), itk::ThresholdSegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::SetEdgeWeight(), itk::NarrowBandThresholdSegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::SetEdgeWeight(), itk::watershed::Boundary< TScalar, TDimension >::SetFace(), itk::ExpNegativeImageFilter< TInputImage, TOutputImage >::SetFactor(), itk::FileListVideoIO::SetFileName(), itk::AnisotropicDiffusionImageFilter< TInputImage, TOutputImage >::SetFixedAverageGradientMagnitude(), itk::watershed::Boundary< TScalar, TDimension >::SetFlatHash(), itk::NaryFunctorImageFilter< TInputImage, TOutputImage, Functor::Maximum1< TInputImage::PixelType, TInputImage::PixelType > >::SetFunctor(), itk::UnaryFunctorImageFilter< TInputImage, TOutputImage, Functor::ReciprocalHAlphaFunctor< TInputImage::PixelType, TOutputImage::PixelType > >::SetFunctor(), itk::HistogramToImageFilter< THistogram, TImage, Function::HistogramIntensityFunction< SizeValueType, TImage::PixelType > >::SetFunctor(), itk::TernaryFunctorImageFilter< TInputMultiSpectralImage, TInputMultiSpectralInterpImage, TInputPanchroImage, TOutputImage, TFunctor >::SetFunctor(), itk::ConnectedComponentFunctorImageFilter< TInputImage, TOutputImage, Functor::SimilarVectorsFunctor< TInputImage::ValueType >, TMaskImage >::SetFunctor(), itk::BinaryFunctorImageFilter< TInputImage1, TInputImage2, TOutputImage, Functor::DivideOrZeroOut< TInputImage1::PixelType, TInputImage2::PixelType, TOutputImage::PixelType > >::SetFunctor(), itk::ImageMomentsCalculator< TImage >::SetImage(), otb::Wrapper::InputImageListParameter::SetImageList(), itk::VectorIndexSelectionCastImageFilter< TInputImage, TOutputImage >::SetIndex(), itk::MatrixIndexSelectionImageFilter< TInputImage, TOutputImage >::SetIndices(), itk::TriangleMeshToBinaryImageFilter< TInputMesh, TOutputImage >::SetInfoImage(), itk::MRIBiasFieldCorrectionFilter< TInputImage, TOutputImage, TMaskImage >::SetInitialBiasFieldCoefficients(), itk::AmoebaOptimizer::SetInitialSimplexDelta(), itk::HistogramAlgorithmBase< THistogram >::SetInputHistogram(), otb::HistogramStatisticsFunction< TInputHistogram, TOutput >::SetInputHistogram(), otb::ImageToGenericRSOutputParameters< TImage >::SetInputKeywordList(), itk::LabelVotingImageFilter< TInputImage, TOutputImage >::SetLabelForUndecidedPixels(), itk::MultiLabelSTAPLEImageFilter< TInputImage, TOutputImage, TWeights >::SetLabelForUndecidedPixels(), itk::watershed::Segmenter< InputImageType >::SetLargestPossibleRegion(), itk::TemporalDataObject::SetLargestPossibleTemporalRegion(), otb::Wrapper::InputImageListParameter::SetListFromFileName(), otb::Wrapper::InputVectorDataListParameter::SetListFromFileName(), otb::Wrapper::InputFilenameListParameter::SetListFromFileName(), itk::ThresholdSegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::SetLowerThreshold(), itk::NarrowBandThresholdSegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::SetLowerThreshold(), itk::MaskNegatedImageFilter< TInputImage, TMaskImage, TOutputImage >::SetMaskingValue(), itk::MaskImageFilter< TInputImage, TMaskImage, TOutputImage >::SetMaskingValue(), itk::MatrixOffsetTransformBase< TScalar, 3, 3 >::SetMatrix(), itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::SetMaximumCurvatureTimeStep(), itk::watershed::SegmentTable< TScalar >::SetMaximumDepth(), itk::DiscreteGaussianImageFilter< TInputImage, TOutputImage >::SetMaximumError(), itk::CannyEdgeDetectionImageFilter< ImageType, ImageType >::SetMaximumError(), itk::MultiLabelSTAPLEImageFilter< TInputImage, TOutputImage, TWeights >::SetMaximumNumberOfIterations(), itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::SetMaximumPropagationTimeStep(), itk::VectorThresholdSegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::SetMean(), itk::Statistics::MembershipFunctionBase< TMeasurementVector >::SetMeasurementVectorSize(), itk::Statistics::DistanceMetric< Array< double > >::SetMeasurementVectorSize(), itk::Statistics::Sample< ImageJointDomainTraits< TImage >::MeasurementVectorType >::SetMeasurementVectorSize(), itk::NarrowBandImageFilterBase< TInputImage, Image< TOutputPixelType, TInputImage::ImageDimension > >::SetNarrowBand(), itk::NarrowBandImageFilterBase< TInputImage, Image< TOutputPixelType, TInputImage::ImageDimension > >::SetNarrowBandInnerRadius(), itk::NarrowBandImageFilterBase< TInputImage, Image< TOutputPixelType, TInputImage::ImageDimension > >::SetNarrowBandTotalRadius(), itk::OpenCVVideoIO::SetNextFrameToRead(), itk::VXLVideoIO::SetNextFrameToRead(), otb::Wrapper::InputImageListParameter::SetNthFileName(), otb::Wrapper::InputVectorDataListParameter::SetNthFileName(), otb::Wrapper::InputFilenameListParameter::SetNthFileName(), itk::CompositeTransform< TScalar, NDimensions >::SetNthTransformToOptimize(), otb::ImageIOBase::SetNumberOfDimensions(), itk::ImageIOBase::SetNumberOfDimensions(), itk::SparseFieldFourthOrderLevelSetImageFilter< TInputImage, TOutputImage >::SetNumberOfLayers(), itk::Statistics::UniformRandomSpatialNeighborSubsampler< TSample, TRegion >::SetNumberOfResultsRequested(), itk::FastMarchingReachedTargetNodesStoppingCriterion< TInput, TOutput >::SetNumberOfTargetsToBeReached(), itk::MatrixOffsetTransformBase< TScalar, 3, 3 >::SetOffset(), itk::NeighborhoodOperatorImageFunction< TInputImage, TOutput >::SetOperator(), itk::VectorNeighborhoodOperatorImageFilter< TInputImage, TOutputImage >::SetOperator(), itk::NeighborhoodOperatorImageFilter< TInputImage, TOutputImage, TOperatorValueType >::SetOperator(), otb::ImageIOBase::SetOrigin(), itk::ImageIOBase::SetOrigin(), itk::SigmoidImageFilter< TInputImage, TOutputImage >::SetOutputMaximum(), itk::SigmoidImageFilter< TInputImage, TOutputImage >::SetOutputMinimum(), otb::ImageToGenericRSOutputParameters< TImage >::SetOutputProjectionRef(), itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::SetOutsidePoints(), itk::MaskNegatedImageFilter< TInputImage, TMaskImage, TOutputImage >::SetOutsideValue(), itk::MaskImageFilter< TInputImage, TMaskImage, TOutputImage >::SetOutsideValue(), otb::MapProjectionAdapter::SetParameter(), itk::Statistics::ProbabilityDistribution::SetParameters(), itk::DisplacementFieldTransform< TScalar, NDimensions >::SetParameters(), itk::FFTWHalfHermitianToRealInverseFFTImageFilter< TInputImage, TOutputImage >::SetPlanRigor(), itk::FFTWInverseFFTImageFilter< TInputImage, TOutputImage >::SetPlanRigor(), itk::FFTWForwardFFTImageFilter< TInputImage, TOutputImage >::SetPlanRigor(), itk::FFTWRealToHalfHermitianForwardFFTImageFilter< TInputImage, TOutputImage >::SetPlanRigor(), itk::MultiLabelSTAPLEImageFilter< TInputImage, TOutputImage, TWeights >::SetPriorProbabilities(), itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::SetPropagationScaling(), itk::ThresholdLabelerImageFilter< TInputImage, TOutputImage >::SetRealThresholds(), itk::ChangeInformationImageFilter< TInputImage >::SetReferenceImage(), itk::ImportImageFilter< TPixel, VImageDimension >::SetRegion(), itk::BinaryMask3DMeshSource< TInputImage, TOutputMesh >::SetRegionOfInterest(), itk::ScaleTransform< TScalar, NDimensions >::SetScale(), itk::CollidingFrontsImageFilter< TInputImage, TOutputImage >::SetSeedPoints1(), itk::CollidingFrontsImageFilter< TInputImage, TOutputImage >::SetSeedPoints2(), itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::SetSegmentationFunction(), itk::ShapePriorSegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::SetShapePriorScaling(), itk::ImageRegistrationMethodv4< TFixedImage, TMovingImage, TOutputTransform >::SetShrinkFactorsPerDimension(), itk::GaussianInterpolateImageFunction< TInputImage, TCoordRep >::SetSigma(), itk::ThresholdSegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::SetSmoothingConductance(), itk::NarrowBandThresholdSegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::SetSmoothingConductance(), itk::ThresholdSegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::SetSmoothingIterations(), itk::NarrowBandThresholdSegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::SetSmoothingIterations(), itk::ThresholdSegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::SetSmoothingTimeStep(), itk::NarrowBandThresholdSegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::SetSmoothingTimeStep(), itk::PowellOptimizer::SetSpaceDimension(), otb::ImageIOBase::SetSpacing(), itk::ImageIOBase::SetSpacing(), itk::SpatialObject< TMesh::PointDimension >::SetSpacing(), itk::ImageMomentsCalculator< TImage >::SetSpatialObjectMask(), itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::SetSpeedConstant(), itk::FastMarchingReachedTargetNodesStoppingCriterion< TInput, TOutput >::SetTargetCondition(), itk::FastMarchingReachedTargetNodesStoppingCriterion< TInput, TOutput >::SetTargetNodes(), itk::FastMarchingUpwindGradientImageFilter< TLevelSet, TSpeedImage >::SetTargetPoints(), itk::MultiLabelSTAPLEImageFilter< TInputImage, TOutputImage, TWeights >::SetTerminationUpdateThreshold(), itk::DivideOrZeroOutImageFilter< TInputImage1, TInputImage2, TOutputImage >::SetThreshold(), itk::VectorThresholdSegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::SetThreshold(), itk::ThresholdLabelerImageFilter< TInputImage, TOutputImage >::SetThresholds(), itk::MatrixOffsetTransformBase< TScalar, 3, 3 >::SetTranslation(), itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::SetTrialPoints(), itk::ThresholdSegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::SetUpperThreshold(), itk::NarrowBandThresholdSegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::SetUpperThreshold(), itk::Statistics::UniformRandomSpatialNeighborSubsampler< TSample, TRegion >::SetUseClockForSeed(), itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::SetUseMinimalCurvature(), itk::watershed::Boundary< TScalar, TDimension >::SetValid(), otb::Wrapper::OutputProcessXMLParameter::SetValue(), otb::Wrapper::InputProcessXMLParameter::SetValue(), otb::Wrapper::InputFilenameParameter::SetValue(), otb::Wrapper::OutputFilenameParameter::SetValue(), otb::Wrapper::ListViewParameter::SetValue(), otb::Wrapper::ChoiceParameter::SetValue(), itk::DiscreteGaussianImageFilter< TInputImage, TOutputImage >::SetVariance(), itk::CannyEdgeDetectionImageFilter< ImageType, ImageType >::SetVariance(), otb::Wrapper::InputVectorDataListParameter::SetVectorDataList(), otb::MapProjectionAdapter::SetWkt(), itk::LabelVotingImageFilter< TInputImage, TOutputImage >::UnsetLabelForUndecidedPixels(), itk::MultiLabelSTAPLEImageFilter< TInputImage, TOutputImage, TWeights >::UnsetLabelForUndecidedPixels(), itk::MultiLabelSTAPLEImageFilter< TInputImage, TOutputImage, TWeights >::UnsetMaximumNumberOfIterations(), and itk::MultiLabelSTAPLEImageFilter< TInputImage, TOutputImage, TWeights >::UnsetPriorProbabilities().

static Pointer itk::LightProcessObject::New ( )
staticinherited

Method for creation through the object factory.

void itk::StreamingImageIOBase::OpenFileForReading ( std::ifstream &  os,
const char *  filename 
)
protectedvirtual

Opens a file for reading and random access.

The stream is closed if it's already opened. If an error is encountered then an exception will be thrown.

Definition at line 245 of file itkStreamingImageIOBase.cxx.

void itk::StreamingImageIOBase::OpenFileForWriting ( std::ofstream &  os,
const char *  filename,
bool  truncate 
)
protectedvirtual

Opens a file for writing and random access.

Parameters
osis an ostream presumed to be opened for writing
filenameis the name of the file
truncateif true then the file is truncated

The stream is closed if it's already opened. If an error is encountered then an exception will be thrown.

Definition at line 269 of file itkStreamingImageIOBase.cxx.

References itk::ImageIOBase::m_FileName.

void itk::StreamingImageIOBase::operator= ( const Self )
private
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 137 of file itkLightObject.cxx.

References itk::Indent::GetNextIndent().

Referenced by itk::operator<<(), and itk::VideoStream< TFrameType >::PrintSelf().

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

Define a default print header for all objects.

Definition at line 315 of file itkLightObject.cxx.

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

Definition at line 483 of file itkObject.cxx.

void itk::StreamingImageIOBase::PrintSelf ( std::ostream &  os,
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::ImageIOBase.

Definition at line 28 of file itkStreamingImageIOBase.cxx.

References itk::ImageIOBase::PrintSelf().

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

Define a default print trailer for all objects.

Definition at line 325 of file itkLightObject.cxx.

virtual void itk::ImageIOBase::Read ( void *  buffer)
pure virtualinherited

Reads the data from disk into the memory buffer provided.

Implemented in itk::VXLVideoIO, itk::FileListVideoIO, and itk::OpenCVVideoIO.

void itk::ImageIOBase::ReadBufferAsASCII ( std::istream &  os,
void *  buffer,
IOComponentType  ctype,
ImageIOBase::SizeType  numComp 
)
protectedvirtualinherited
bool itk::StreamingImageIOBase::ReadBufferAsBinary ( std::istream &  is,
void *  buffer,
StreamingImageIOBase::SizeType  num 
)
protectedvirtual

Reimplemented from super class to get around 2GB read/write limitation.

Todo:
Move this method to itk::ImageIOBase

Definition at line 116 of file itkStreamingImageIOBase.cxx.

References itk::ImageIOBase::m_FileName.

virtual void itk::ImageIOBase::ReadImageInformation ( )
pure virtualinherited

Read the spacing and dimensions of the image. Assumes SetFileName has been called with a valid file name.

Implemented in itk::VXLVideoIO, itk::FileListVideoIO, and itk::OpenCVVideoIO.

void itk::Object::Register ( ) const
virtualinherited

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

Reimplemented from itk::LightObject.

Definition at line 323 of file itkObject.cxx.

Referenced by itk::ObjectFactoryBase::RegisterFactory(), and itk::ObjectFactoryBase::RegisterFactoryInternal().

void itk::Object::RemoveAllObservers ( )
inherited

Remove all observers .

Definition at line 442 of file itkObject.cxx.

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

Remove the observer with this tag value.

Definition at line 432 of file itkObject.cxx.

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

bool itk::StreamingImageIOBase::RequestedToStream ( void  ) const
protectedvirtual

Returns true if GetIORegion is not the same size as the largest region give by GetNumberOfDimensions.

This compares the IORegion to the size of the image in the file. With out regaurd to the dimensions of either, if the images represent the same region then false is returned.

Definition at line 443 of file itkStreamingImageIOBase.cxx.

References itk::ImageIOBase::GetDimensions(), itk::ImageIOBase::GetIORegion(), itk::ImageIOBase::GetNumberOfDimensions(), itk::ImageIORegion::SetIndex(), and itk::ImageIORegion::SetSize().

void itk::ImageIOBase::Reset ( const bool  freeDynamic = true)
protectedvirtualinherited
void itk::ImageIOBase::Resize ( const unsigned int  numDimensions,
const unsigned int *  dimensions 
)
protectedinherited

Resize the ImageIOBase object to new dimensions.

Definition at line 77 of file itkImageIOBase.cxx.

References itk::ImageIOBase::ComputeStrides(), itk::ImageIOBase::m_Dimensions, itk::ImageIOBase::m_NumberOfDimensions, and NULL.

virtual void itk::LightProcessObject::SetAbortGenerateData ( bool  _arg)
virtualinherited

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

virtual void itk::ImageIOBase::SetByteOrder ( const ByteOrder  _arg)
virtualinherited

These methods indicate the byte ordering of the file you are trying to read in. These methods will then either swap or not swap the bytes depending on the byte ordering of the machine it is being run on. For example, reading in a BigEndian file on a BigEndian machine will result in no swapping. Trying to read the same file on a LittleEndian machine will result in swapping. Note: most UNIX machines are BigEndian while PC's and VAX's are LittleEndian. So if the file you are reading in was generated on a VAX or PC, SetByteOrderToLittleEndian() otherwise SetByteOrderToBigEndian(). Some ImageIOBase subclasses ignore these methods.

void itk::ImageIOBase::SetByteOrderToBigEndian ( )
inlineinherited

Definition at line 256 of file itkImageIOBase.h.

void itk::ImageIOBase::SetByteOrderToLittleEndian ( )
inlineinherited

Definition at line 261 of file itkImageIOBase.h.

virtual void itk::ImageIOBase::SetComponentType ( const IOComponentType  _arg)
virtualinherited

Set/Get the component type of the image. This is always a native type.

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 273 of file itkObject.cxx.

void itk::ImageIOBase::SetDimensions ( unsigned int  i,
unsigned int  dim 
)
virtualinherited

Set/Get the image dimensions in the x, y, z, etc. directions. GetDimensions() is typically used after reading the data; the SetDimensions() is used prior to writing the data.

Definition at line 91 of file itkImageIOBase.cxx.

References itk::ImageIOBase::m_Dimensions, and itk::Object::Modified().

void itk::ImageIOBase::SetDirection ( unsigned int  i,
const std::vector< double > &  direction 
)
virtualinherited

Set/Get the image direction on an axis-by-axis basis. The SetDirection() method is required when writing the image.

Definition at line 136 of file itkImageIOBase.cxx.

References itk::ImageIOBase::m_Direction, and itk::Object::Modified().

Referenced by itk::ImageIOBase::SetNumberOfDimensions().

void itk::ImageIOBase::SetDirection ( unsigned int  i,
const vnl_vector< double > &  direction 
)
virtualinherited

Definition at line 151 of file itkImageIOBase.cxx.

References itk::ImageIOBase::m_Direction, and itk::Object::Modified().

virtual void itk::ImageIOBase::SetFileName ( const char *  _arg)
virtualinherited

Set/Get the name of the file to be read.

Reimplemented in itk::FileListVideoIO.

virtual void itk::ImageIOBase::SetFileType ( const FileType  _arg)
virtualinherited

These methods control whether the file is written binary or ASCII. Many file formats (i.e., subclasses) ignore this flag.

void itk::ImageIOBase::SetFileTypeToASCII ( )
inlineinherited

Definition at line 233 of file itkImageIOBase.h.

void itk::ImageIOBase::SetFileTypeToBinary ( )
inlineinherited

Definition at line 238 of file itkImageIOBase.h.

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 381 of file itkObject.cxx.

virtual void itk::ImageIOBase::SetIORegion ( ImageIORegion  _arg)
virtualinherited

Specify the region of the image data to either read or write. The IORegion specifies the part of the image to read or write. Regions are defined with an index and a size vector. These vectors define the start (lower-left corner) and length of the region within the image. Make sure that the IORegion lies within the image.

void itk::Object::SetMetaDataDictionary ( const MetaDataDictionary rhs)
inherited
virtual void itk::ImageIOBase::SetNumberOfComponents ( unsigned int  _arg)
virtualinherited

Set/Get the number of components per pixel in the image. This may be set by the reading process. For SCALAR pixel types, NumberOfComponents will be 1. For other pixel types, NumberOfComponents will be greater than or equal to one.

void itk::ImageIOBase::SetNumberOfDimensions ( unsigned int  dim)
inherited
virtual void itk::Object::SetObjectName ( std::string  _arg)
virtualinherited

A facility to help application programmers set a human identifiable name for a given object. This has no inherent use in ITK, but is a convenience to allow developers to provide a name for this object.

void itk::ImageIOBase::SetOrigin ( unsigned int  i,
double  origin 
)
virtualinherited

Set/Get the image origin on a axis-by-axis basis. The SetOrigin() method is required when writing the image.

Definition at line 106 of file itkImageIOBase.cxx.

References itk::ImageIOBase::m_Origin, and itk::Object::Modified().

Referenced by itk::ImageIOBase::SetNumberOfDimensions().

virtual void itk::ImageIOBase::SetPixelType ( const IOPixelType  _arg)
virtualinherited

Set/Get the type of the pixel. The PixelTypes provides context to the IO mechanisms for data conversions. PixelTypes can be SCALAR, RGB, RGBA, VECTOR, COVARIANTVECTOR, POINT, INDEX. If the PIXELTYPE is SCALAR, then the NumberOfComponents should be 1. Any other of PIXELTYPE will have more than one component.

template<typename TPixel >
void itk::ImageIOBase::SetPixelTypeInfo ( const TPixel *  )
inlineinherited

Definition at line 434 of file itkImageIOBase.h.

template<typename TPixel >
void itk::ImageIOBase::SetPixelTypeInfo ( const RGBPixel< TPixel > *  )
inlineinherited

Definition at line 441 of file itkImageIOBase.h.

template<typename TPixel >
void itk::ImageIOBase::SetPixelTypeInfo ( const RGBAPixel< TPixel > *  )
inlineinherited

Definition at line 448 of file itkImageIOBase.h.

template<typename TPixel , unsigned VLength>
void itk::ImageIOBase::SetPixelTypeInfo ( const Vector< TPixel, VLength > *  )
inlineinherited

Definition at line 455 of file itkImageIOBase.h.

template<typename TPixel >
void itk::ImageIOBase::SetPixelTypeInfo ( const VariableLengthVector< TPixel > *  )
inlineinherited

Definition at line 462 of file itkImageIOBase.h.

template<typename TPixel , unsigned VLength>
void itk::ImageIOBase::SetPixelTypeInfo ( const CovariantVector< TPixel, VLength > *  )
inlineinherited

Definition at line 469 of file itkImageIOBase.h.

template<typename TPixel , unsigned VLength>
void itk::ImageIOBase::SetPixelTypeInfo ( const FixedArray< TPixel, VLength > *  )
inlineinherited

Definition at line 476 of file itkImageIOBase.h.

template<typename TPixel , unsigned VLength>
void itk::ImageIOBase::SetPixelTypeInfo ( const SymmetricSecondRankTensor< TPixel, VLength > *  )
inlineinherited

Definition at line 484 of file itkImageIOBase.h.

template<typename TPixel >
void itk::ImageIOBase::SetPixelTypeInfo ( const DiffusionTensor3D< TPixel > *  )
inlineinherited

Definition at line 492 of file itkImageIOBase.h.

template<typename TPixel , unsigned VLength>
void itk::ImageIOBase::SetPixelTypeInfo ( const Matrix< TPixel, VLength, VLength > *  )
inlineinherited

Definition at line 500 of file itkImageIOBase.h.

template<typename TPixel >
void itk::ImageIOBase::SetPixelTypeInfo ( const std::complex< TPixel > *  )
inlineinherited

Definition at line 508 of file itkImageIOBase.h.

template<unsigned VLength>
void itk::ImageIOBase::SetPixelTypeInfo ( const Offset< VLength > *  )
inlineinherited

Definition at line 516 of file itkImageIOBase.h.

References itk::ImageIOBase::LONG, and itk::ImageIOBase::OFFSET.

virtual void itk::LightProcessObject::SetProgress ( float  _arg)
virtualinherited

Set the execution progress of a process object. The progress is a floating number between (0,1), 0 meaning no progress; 1 meaning the filter has completed execution.

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 359 of file itkObject.cxx.

void itk::ImageIOBase::SetSpacing ( unsigned int  i,
double  spacing 
)
virtualinherited

Set/Get the image spacing on an axis-by-axis basis. The SetSpacing() method is required when writing the image.

Definition at line 121 of file itkImageIOBase.cxx.

References itk::ImageIOBase::m_Spacing, and itk::Object::Modified().

Referenced by itk::ImageIOBase::SetNumberOfDimensions().

void itk::Object::SetTimeStamp ( const TimeStamp timeStamp)
protectedvirtualinherited

Set the time stamp of this object. This method must be used very carefully !!!. Most mortals will never need to call this method.

Set the time stamp of this object. To be used very carefully !!!. Most mortals will never need to call this method.

Definition at line 302 of file itkObject.cxx.

template<typename TPixel >
void itk::ImageIOBase::SetTypeInfo ( const TPixel *  )
inherited
virtual void itk::ImageIOBase::SetUseCompression ( bool  _arg)
virtualinherited

Set/Get a boolean to use the compression or not.

virtual void itk::ImageIOBase::SetUseStreamedReading ( bool  _arg)
virtualinherited

Set/Get a boolean to use streaming while reading or not.

virtual void itk::ImageIOBase::SetUseStreamedWriting ( bool  _arg)
virtualinherited

Set/Get a boolean to use streaming while writing or not.

bool itk::StreamingImageIOBase::StreamReadBufferAsBinary ( std::istream &  os,
void *  buffer 
)
protectedvirtual

Reads the set IORegion from os into buffer.

Parameters
osis an istream presumed to be opened for reading in binary mode
bufferis pointer to an allocated block of memory suitable to hold the IORegion of the pixel type

This methods relies on GetDataPosition to determin where the data is located in the file. It uses m_IORegion to determin the requested region to read.

The files data is assumed to be unpadded and continuous in the file for the size of the image in the dimensions of the m_IORegion. This means that the image file could be broken into slices, but not blocks for this methods to be used.

Definition at line 34 of file itkStreamingImageIOBase.cxx.

bool itk::StreamingImageIOBase::StreamWriteBufferAsBinary ( std::ostream &  os,
const void *  buffer 
)
protectedvirtual

Writes the set IORegion from buffer into os.

Parameters
osis an ostream presumed to be opened for writing and reading
bufferis a pointer to the data in a continuous block for the region

This methods relies on GetDataPosition to determin where the data is located in the file. It usesy m_IORegion determin the requested region to written.

Definition at line 170 of file itkStreamingImageIOBase.cxx.

References GetDataPosition(), itk::ImageIOBase::GetDimensions(), itk::ImageIORegion::GetImageDimension(), itk::ImageIORegion::GetIndex(), itk::ImageIOBase::GetPixelSize(), itk::ImageIORegion::GetSize(), itk::ImageIORegion::IsInside(), itk::ImageIOBase::m_FileName, itk::ImageIOBase::m_IORegion, and WriteBufferAsBinary().

virtual bool itk::ImageIOBase::SupportsDimension ( unsigned long  dim)
inlinevirtualinherited

The different types of ImageIO's can support data of varying dimensionality. For example, some file formats are strictly 2D while others can support 2D, 3D, or even n-D. This method returns true/false as to whether the ImageIO can support the dimension indicated.

Definition at line 360 of file itkImageIOBase.h.

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 337 of file itkObject.cxx.

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

void itk::LightProcessObject::UpdateOutputData ( void  )
virtualinherited

Actually generate new output.

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

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

Definition at line 71 of file itkLightProcessObject.cxx.

void itk::LightProcessObject::UpdateProgress ( float  amount)
inherited

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

Definition at line 47 of file itkLightProcessObject.cxx.

virtual void itk::ImageIOBase::UseCompressionOff ( )
virtualinherited
virtual void itk::ImageIOBase::UseCompressionOn ( )
virtualinherited
virtual void itk::ImageIOBase::UseStreamedReadingOff ( )
virtualinherited
virtual void itk::ImageIOBase::UseStreamedReadingOn ( )
virtualinherited
virtual void itk::ImageIOBase::UseStreamedWritingOff ( )
virtualinherited
virtual void itk::ImageIOBase::UseStreamedWritingOn ( )
virtualinherited
virtual void itk::ImageIOBase::Write ( const void *  buffer)
pure virtualinherited

Writes the data to disk from the memory buffer provided. Make sure that the IORegions has been set properly. The buffer is cast to a pointer to the beginning of the image data.

Implemented in itk::VXLVideoIO, itk::FileListVideoIO, and itk::OpenCVVideoIO.

void itk::ImageIOBase::WriteBufferAsASCII ( std::ostream &  os,
const void *  buffer,
IOComponentType  ctype,
ImageIOBase::SizeType  numComp 
)
protectedvirtualinherited
bool itk::StreamingImageIOBase::WriteBufferAsBinary ( std::ostream &  is,
const void *  buffer,
StreamingImageIOBase::SizeType  num 
)
protectedvirtual

Reimplemented from super class to get around 2GB read/write limitation.

Todo:
Move this methods to itk::ImageIOBase

Definition at line 142 of file itkStreamingImageIOBase.cxx.

References itk::ImageIOBase::m_FileName.

Referenced by StreamWriteBufferAsBinary().

virtual void itk::ImageIOBase::WriteImageInformation ( )
pure virtualinherited

Writes the spacing and dimensions of the image. Assumes SetFileName has been called with a valid file name.

Implemented in itk::VXLVideoIO, itk::FileListVideoIO, and itk::OpenCVVideoIO.

Member Data Documentation

ByteOrder itk::ImageIOBase::m_ByteOrder
protectedinherited

Big or Little Endian, and the type of the file. (May be ignored.)

Definition at line 538 of file itkImageIOBase.h.

Referenced by itk::ImageIOBase::PrintSelf().

IOComponentType itk::ImageIOBase::m_ComponentType
protectedinherited
std::vector< SizeValueType > itk::ImageIOBase::m_Dimensions
protectedinherited
std::vector< std::vector< double > > itk::ImageIOBase::m_Direction
protectedinherited

The arrays which store the direction cosines of the image.

Definition at line 579 of file itkImageIOBase.h.

Referenced by itk::ImageIOBase::SetDirection(), and itk::ImageIOBase::SetNumberOfDimensions().

std::string itk::ImageIOBase::m_FileName
protectedinherited
FileType itk::ImageIOBase::m_FileType
protectedinherited

Definition at line 540 of file itkImageIOBase.h.

Referenced by itk::ImageIOBase::PrintSelf().

bool itk::ImageIOBase::m_Initialized
protectedinherited

Does the ImageIOBase object have enough info to be of use?

Definition at line 543 of file itkImageIOBase.h.

Referenced by itk::ImageIOBase::Reset().

ImageIORegion itk::ImageIOBase::m_IORegion
protectedinherited

The region to read or write. The region contains information about the data within the region to read or write.

Definition at line 566 of file itkImageIOBase.h.

Referenced by itk::ImageIOBase::PrintSelf(), and StreamWriteBufferAsBinary().

unsigned int itk::ImageIOBase::m_NumberOfComponents
protectedinherited
unsigned int itk::ImageIOBase::m_NumberOfDimensions
protectedinherited
std::vector< double > itk::ImageIOBase::m_Origin
protectedinherited
IOPixelType itk::ImageIOBase::m_PixelType
protectedinherited
InternalReferenceCountType itk::LightObject::m_ReferenceCount
mutableprotectedinherited

Number of uses of this object by other objects.

Definition at line 156 of file itkLightObject.h.

SimpleFastMutexLock itk::LightObject::m_ReferenceCountLock
mutableprotectedinherited

Mutex lock to protect modification to the reference count

Definition at line 159 of file itkLightObject.h.

std::vector< double > itk::ImageIOBase::m_Spacing
protectedinherited

The array which stores the spacing of pixels in the x, y, z directions.

Definition at line 573 of file itkImageIOBase.h.

Referenced by itk::FileListVideoIO::ResetMembers(), itk::VXLVideoIO::ResetMembers(), itk::OpenCVVideoIO::ResetMembers(), itk::ImageIOBase::SetNumberOfDimensions(), and itk::ImageIOBase::SetSpacing().

std::vector< SizeType > itk::ImageIOBase::m_Strides
protectedinherited

Stores the number of bytes it takes to get to the next 'thing' e.g. component, pixel, row, slice, etc.

Definition at line 583 of file itkImageIOBase.h.

Referenced by itk::ImageIOBase::ComputeStrides(), itk::ImageIOBase::Reset(), and itk::ImageIOBase::SetNumberOfDimensions().

bool itk::ImageIOBase::m_UseCompression
protectedinherited

Should we compress the data?

Definition at line 556 of file itkImageIOBase.h.

Referenced by itk::ImageIOBase::PrintSelf(), and itk::ImageIOBase::Reset().

bool itk::ImageIOBase::m_UseStreamedReading
protectedinherited

Should we use streaming for reading

Definition at line 559 of file itkImageIOBase.h.

Referenced by GenerateStreamableReadRegionFromRequestedRegion(), itk::ImageIOBase::PrintSelf(), and itk::ImageIOBase::Reset().

bool itk::ImageIOBase::m_UseStreamedWriting
protectedinherited

Should we use streaming for writing

Definition at line 562 of file itkImageIOBase.h.

Referenced by itk::ImageIOBase::PrintSelf(), and itk::ImageIOBase::Reset().


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

Generated at Sat Mar 8 2014 17:50:12 for Orfeo Toolbox with doxygen 1.8.3.1