Orfeo Toolbox  3.16
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Types | Protected Member Functions | Protected Attributes | Private Member Functions
otb::VectorDataIOBase Class Reference

Abstract superclass defines VectorData IO interface. More...

#include <otbVectorDataIOBase.h>

+ Inheritance diagram for otb::VectorDataIOBase:
+ Collaboration diagram for otb::VectorDataIOBase:

List of all members.

Public Types

enum  ByteOrder {
  BigEndian,
  LittleEndian,
  OrderNotApplicable
}
typedef SmartPointer< const SelfConstPointer
typedef itk::SmartPointer< SelfPointer
typedef itk::Point< double,
VDimension
PointType
typedef VectorDataIOBase Self
typedef std::streamoff SizeType
typedef itk::Vector< double,
VDimension
SpacingType
typedef itk::LightProcessObject 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 *) const =0
virtual bool CanStreamRead () const
virtual bool CanStreamWrite () const
virtual bool CanWriteFile (const char *) const =0
virtual ::itk::LightObject::Pointer CreateAnother (void) const
virtual void DebugOff () const
virtual void DebugOn () const
virtual void Delete ()
virtual const bool & GetAbortGenerateData ()
virtual ByteOrder GetByteOrder () const
std::string GetByteOrderAsString (ByteOrder) const
Command * GetCommand (unsigned long tag)
bool GetDebug () const
virtual const char * GetFileName () const
MetaDataDictionary & GetMetaDataDictionary (void)
const MetaDataDictionary & GetMetaDataDictionary (void) const
virtual unsigned long GetMTime () const
virtual const char * GetNameOfClass () const
virtual const float & GetProgress ()
virtual int GetReferenceCount () const
bool HasObserver (const EventObject &event) const
void InvokeEvent (const EventObject &)
void InvokeEvent (const EventObject &) const
virtual void Modified () const
void Print (std::ostream &os, Indent indent=0) const
virtual void Read (itk::DataObject *data)=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 ()
void SetDebug (bool debugFlag) const
virtual void SetFileName (const char *_arg)
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
virtual void SetProgress (float _arg)
virtual void SetReferenceCount (int)
virtual void UnRegister () const
virtual void UpdateOutputData ()
void UpdateProgress (float amount)
virtual void Write (const itk::DataObject *data, char **papszOptions=NULL)=0

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 VDimension = 3

Protected Types

typedef int InternalReferenceCountType

Protected Member Functions

 VectorDataIOBase ()
virtual ~VectorDataIOBase ()
virtual void GenerateData ()
virtual void PrintHeader (std::ostream &os, Indent indent) const
bool PrintObservers (std::ostream &os, Indent indent) const
virtual void PrintSelf (std::ostream &os, itk::Indent indent) const
virtual void PrintTrailer (std::ostream &os, Indent indent) const
virtual void Reset (const bool freeDynamic=true)

Protected Attributes

ByteOrder m_ByteOrder
std::string m_FileName
bool m_Initialized
InternalReferenceCountType m_ReferenceCount
SimpleFastMutexLock m_ReferenceCountLock

Private Member Functions

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

Detailed Description

Abstract superclass defines VectorData IO interface.

VectorDataIOBase is a class that reads and/or writes VectorData data of a particular format (such as shapefile or kml). The VectorDataIOBase encapsulates both the reading and writing of data. The VectorDataIOBase is used by the VectorDataFileReader class (to read data) and the VectorDataFileWriter (to write data) into a single file. Normally the user does not directly manipulate this class other than to instantiate it, set the FileName, and assign it to a VectorDataFileReader/VectorDataFileWriter.

A Pluggable factory pattern is used this allows different kinds of readers to be registered (even at run time) without having to modify the code in this class.

See also:
VectorDataFileWriter
VectorDataFileReader

Definition at line 55 of file otbVectorDataIOBase.h.


Member Typedef Documentation

typedef SmartPointer<const Self> itk::LightProcessObject::ConstPointer
inherited

Reimplemented from itk::Object.

Reimplemented in itk::ImageKmeansModelEstimator< TInputImage, TMembershipFunction >, itk::ImageGaussianModelEstimator< TInputImage, TMembershipFunction, TTrainingImage >, itk::Statistics::SampleClassifier< TSample >, itk::Statistics::SampleClassifier< itk::Statistics::ListSample< TInputImage::PixelType > >, itk::ImageClassifierBase< TInputImage, TClassifiedImage >, itk::ImageModelEstimatorBase< TInputImage, TMembershipFunction >, itk::Statistics::SampleClassifierWithMask< TSample, TMaskSample >, itk::LevelSetVelocityNeighborhoodExtractor< TLevelSet, TAuxValue, VAuxDimension >, itk::LevelSetNeighborhoodExtractor< TLevelSet >, otb::SVMClassifier< TSample, TLabel >, otb::SEMClassifier< TInputImage, TOutputImage >, otb::KMLVectorDataIO, otb::OGRVectorDataIO, itk::VTKImageIO2, itk::Statistics::ErrorBackPropagationLearningWithMomentum< LayerType, TTargetVector >, itk::Statistics::ErrorBackPropagationLearningFunctionBase< LayerType, TTargetVector >, itk::Statistics::QuickPropLearningRule< LayerType, TTargetVector >, itk::Statistics::LayerBase< TMeasurementVector, TTargetVector >, itk::Statistics::WeightSetBase< TMeasurementVector, TTargetVector >, itk::Statistics::RBFLayer< TMeasurementVector, TTargetVector >, otb::SVMMarginSampler< TSample, TModel >, itk::Statistics::LearningFunctionBase< LayerType, TTargetVector >, itk::Statistics::LearningFunctionBase< LayerType::LayerInterfaceType, TTargetVector >, itk::MetaArrayWriter, itk::MetaArrayReader, itk::Statistics::RBFBackPropagationLearningFunction< LayerType, TTargetVector >, itk::Statistics::TrainingFunctionBase< TSample, TTargetVector, ScalarType >, itk::Statistics::IterativeSupervisedTrainingFunction< TSample, TTargetVector, ScalarType >, itk::Statistics::BackPropagationLayer< TMeasurementVector, TTargetVector >, itk::Statistics::BatchSupervisedTrainingFunction< TSample, TTargetVector, ScalarType >, and itk::Statistics::CompletelyConnectedWeightSet< TMeasurementVector, TTargetVector >.

Definition at line 78 of file itkLightProcessObject.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.

Reimplemented from itk::LightProcessObject.

Reimplemented in otb::KMLVectorDataIO, and otb::OGRVectorDataIO.

Definition at line 61 of file otbVectorDataIOBase.h.

Reimplemented in otb::KMLVectorDataIO, and otb::OGRVectorDataIO.

Definition at line 68 of file otbVectorDataIOBase.h.

Standard class typedefs.

Reimplemented from itk::LightProcessObject.

Reimplemented in otb::KMLVectorDataIO, and otb::OGRVectorDataIO.

Definition at line 59 of file otbVectorDataIOBase.h.

typedef std::streamoff otb::VectorDataIOBase::SizeType

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

Definition at line 105 of file otbVectorDataIOBase.h.

Reimplemented in otb::OGRVectorDataIO.

Definition at line 67 of file otbVectorDataIOBase.h.

Reimplemented from itk::LightProcessObject.

Reimplemented in otb::KMLVectorDataIO, and otb::OGRVectorDataIO.

Definition at line 60 of file otbVectorDataIOBase.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 

Reimplemented in otb::KMLVectorDataIO, and otb::OGRVectorDataIO.

Definition at line 76 of file otbVectorDataIOBase.h.


Constructor & Destructor Documentation

otb::VectorDataIOBase::VectorDataIOBase ( )
protected

Definition at line 24 of file otbVectorDataIOBase.cxx.

otb::VectorDataIOBase::~VectorDataIOBase ( )
protectedvirtual

Definition at line 40 of file otbVectorDataIOBase.cxx.

otb::VectorDataIOBase::VectorDataIOBase ( 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 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::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.

virtual bool otb::VectorDataIOBase::CanReadFile ( const char *  ) const
pure virtual

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

Implemented in otb::KMLVectorDataIO, and otb::OGRVectorDataIO.

virtual bool otb::VectorDataIOBase::CanStreamRead ( void  ) const
inlinevirtual

Determine if the VectorDataIO can stream reading from this file. Default is false.

Definition at line 115 of file otbVectorDataIOBase.h.

virtual bool otb::VectorDataIOBase::CanStreamWrite ( void  ) const
inlinevirtual

Determine if the ImageIO can stream writing to this file. Default is false.

Definition at line 135 of file otbVectorDataIOBase.h.

virtual bool otb::VectorDataIOBase::CanWriteFile ( const char *  ) const
pure virtual

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

Implemented in otb::KMLVectorDataIO, and otb::OGRVectorDataIO.

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::PhilipsPAR, itk::ImageKmeansModelEstimator< TInputImage, TMembershipFunction >, itk::Bruker2DSEQImageIO, itk::AnalyzeImageIO, itk::ImageGaussianModelEstimator< TInputImage, TMembershipFunction, TTrainingImage >, itk::PolygonGroupSpatialObjectXMLFileWriter, itk::Statistics::SampleClassifier< TSample >, itk::Statistics::SampleClassifier< itk::Statistics::ListSample< TInputImage::PixelType > >, itk::ImageClassifierBase< TInputImage, TClassifiedImage >, itk::GDCMImageIO, itk::Statistics::SampleClassifierWithMask< TSample, TMaskSample >, itk::LevelSetVelocityNeighborhoodExtractor< TLevelSet, TAuxValue, VAuxDimension >, itk::LevelSetNeighborhoodExtractor< TLevelSet >, itk::Brains2MaskImageIO, itk::IPLCommonImageIO, itk::MINC2ImageIO, itk::StimulateImageIO, otb::SVMClassifier< TSample, TLabel >, itk::MRCImageIO, itk::PhilipsRECImageIO, itk::VoxBoCUBImageIO, otb::TileMapImageIO, itk::GE5ImageIO, otb::SEMClassifier< TInputImage, TOutputImage >, itk::GE4ImageIO, itk::GEAdwImageIO, itk::RawImageIO< TPixel, VImageDimension >, itk::SiemensVisionImageIO, otb::GDALImageIO, itk::NiftiImageIO, itk::PolygonGroupSpatialObjectXMLFileReader, otb::KMLVectorDataIO, itk::Statistics::ErrorBackPropagationLearningFunctionBase< LayerType, TTargetVector >, itk::TransformFileReader, itk::Statistics::ErrorBackPropagationLearningWithMomentum< LayerType, TTargetVector >, otb::BSQImageIO, otb::OGRVectorDataIO, itk::VTKImageIO2, otb::LUMImageIO, otb::MWImageIO, otb::RADImageIO, itk::TransformFileWriter, itk::Statistics::QuickPropLearningRule< LayerType, TTargetVector >, otb::JPEG2000ImageIO, itk::BioRadImageIO, itk::GiplImageIO, itk::VTKImageIO, otb::ONERAImageIO, itk::BMPImageIO, itk::DicomImageIO, itk::NrrdImageIO, itk::LSMImageIO, itk::MetaImageIO, itk::TIFFImageIO, itk::Statistics::RBFLayer< TMeasurementVector, TTargetVector >, otb::SVMMarginSampler< TSample, TModel >, itk::JPEGImageIO, itk::PNGImageIO, itk::Statistics::RBFBackPropagationLearningFunction< LayerType, TTargetVector >, otb::MSTARImageIO, itk::Statistics::TrainingFunctionBase< TSample, TTargetVector, ScalarType >, itk::TransformFileWriter, itk::MetaArrayWriter, itk::Statistics::IterativeSupervisedTrainingFunction< TSample, TTargetVector, ScalarType >, itk::DICOMImageIO2, itk::MetaArrayReader, itk::Statistics::BatchSupervisedTrainingFunction< TSample, TTargetVector, ScalarType >, itk::TransformFileReader, itk::Statistics::BackPropagationLayer< TMeasurementVector, TTargetVector >, itk::Statistics::CompletelyConnectedWeightSet< TMeasurementVector, TTargetVector >, itk::MatlabTransformIO, and itk::TxtTransformIO.

Referenced by itk::StreamingImageIOBase::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 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::LightProcessObject::GenerateData ( void  )
inlineprotectedvirtualinherited
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.

virtual ByteOrder otb::VectorDataIOBase::GetByteOrder ( ) const
virtual
std::string otb::VectorDataIOBase::GetByteOrderAsString ( ByteOrder  t) const

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

Definition at line 45 of file otbVectorDataIOBase.cxx.

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().

virtual const char* otb::VectorDataIOBase::GetFileName ( ) const
virtual
bool itk::Object::GetGlobalWarningDisplay ( )
staticinherited

Get the value of the global debug output control flag.

Definition at line 381 of file itkObject.cxx.

MetaDataDictionary & itk::Object::GetMetaDataDictionary ( void  )
inherited
Returns:
A reference to this objects MetaDataDictionary.
Warning:
This reference may be changed.

Reimplemented in otb::ImageMetadataInterfaceBase.

Definition at line 532 of file itkObject.cxx.

References NULL.

Referenced by otb::RenderingImageFilter< TInputImage, TOutputImage >::BeforeThreadedGenerateData(), itk::Brains2MaskImageIO::CanReadFile(), otb::DataNode< TPrecision, VDimension, TValuePrecision >::CopyFieldList(), otb::VectorImage< TPixel, VImageDimension >::CopyInformation(), otb::Image< TPixel, VImageDimension >::CopyInformation(), itk::GDCMImageIO::GetBodyPart(), itk::GDCMImageIO::GetInstitution(), itk::GDCMImageIO::GetManufacturer(), itk::GDCMImageIO::GetModality(), itk::GDCMImageIO::GetModel(), itk::GDCMImageIO::GetNumberOfSeriesInStudy(), itk::GDCMImageIO::GetNumberOfStudyRelatedSeries(), itk::GDCMImageIO::GetPatientAge(), itk::GDCMImageIO::GetPatientDOB(), itk::GDCMImageIO::GetPatientID(), itk::GDCMImageIO::GetPatientName(), itk::GDCMImageIO::GetPatientSex(), itk::GDCMImageIO::GetScanOptions(), itk::GDCMImageIO::GetStudyDate(), itk::GDCMImageIO::GetStudyDescription(), itk::GDCMImageIO::GetStudyID(), itk::GDCMImageIO::GetValueFromTag(), otb::GDALImageIO::InternalReadImageInformation(), itk::GDCMImageIO::InternalReadImageInformation(), otb::GDALImageIO::InternalWriteImageInformation(), otb::RAMDrivenAdaptativeStreamingManager< TImage >::PrepareStreaming(), itk::DICOMImageIO2::Read(), itk::DICOMImageIO2::ReadImageInformation(), itk::NrrdImageIO::ReadImageInformation(), otb::JPEG2000ImageIO::ReadImageInformation(), itk::MetaImageIO::ReadImageInformation(), itk::VoxBoCUBImageIO::ReadImageInformation(), itk::MRCImageIO::ReadImageInformation(), itk::IPLCommonImageIO::ReadImageInformation(), itk::PhilipsRECImageIO::ReadImageInformation(), itk::AnalyzeImageIO::ReadImageInformation(), itk::Bruker2DSEQImageIO::ReadImageInformation(), otb::ImageMetadataInterfaceBase::SetImage(), itk::NiftiImageIO::SetImageIOMetadataFromNIfTI(), otb::VectorDataToLabelImageFilter< TVectorData, TOutputImage >::SetOutputParametersFromImage(), itk::NrrdImageIO::Write(), itk::GDCMImageIO::Write(), and itk::PolygonGroupSpatialObjectXMLFileWriter::WriteFile().

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

Reimplemented in otb::ImageMetadataInterfaceBase.

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.

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::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 >, itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >, itk::SpatialObject< TDimension >, itk::SpatialObject< 3 >, itk::SpatialObject< ::itk::GetMeshDimension< TMesh >::PointDimension >, itk::MultiResolutionImageRegistrationMethod< TFixedImage, TMovingImage >, itk::ImageRegistrationMethod< TFixedImage, TMovingImage >, itk::VectorResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >, itk::ImageToSpatialObjectRegistrationMethod< TFixedImage, TMovingSpatialObject >, itk::TransformToDeformationFieldSource< TOutputImage, TTransformPrecisionType >, itk::InverseDeformationFieldImageFilter< TInputImage, TOutputImage >, itk::PointSetToImageRegistrationMethod< TFixedPointSet, TMovingImage >, itk::BoundingBox< TPointIdentifier, VPointDimension, TCoordRep, TPointsContainer >, itk::PointSetToPointSetRegistrationMethod< TFixedPointSet, TMovingPointSet >, itk::DeformationFieldSource< TOutputImage >, itk::ImageSpatialObject< TDimension, TPixelType >, itk::ImageSpatialObject< TDimension, unsigned char >, itk::MeshSpatialObject< TMesh >, and itk::SceneSpatialObject< TSpaceDimension >.

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(), 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().

virtual const char* otb::VectorDataIOBase::GetNameOfClass ( ) const
virtual
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 105 of file itkLightObject.h.

static void itk::Object::GlobalWarningDisplayOff ( )
inlinestaticinherited
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
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.

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 >, otb::SurfaceAdjacencyEffect6SCorrectionSchemeFilter< TInputImage, TOutputImage >, 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::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::GenericRSTransform< TScalarType, NInputDimensions, NOutputDimensions >, otb::MeanShiftImageFilter< TInputImage, TOutputImage, TLabeledOutput, TBufferConverter >, otb::MeanShiftImageFilter< TInputImage, TOutputImage, TLabeledOutput, MeanShift::VectorBufferConverter >, otb::GCPsToRPCSensorModelImageFilter< TImage >, otb::Polygon< TValue >, otb::ImageRegionAdaptativeSplitter< VImageDimension >, otb::GenericInterpolateImageFunction< TInputImage, TFunction, TBoundaryCondition, TCoordRep >, itk::GrayscaleDilateImageFilter< TInputImage, TOutputImage, TKernel >, otb::PolyLineParametricPathWithValue< TValue, VDimension >, itk::GrayscaleErodeImageFilter< TInputImage, TOutputImage, TKernel >, otb::PolyLineParametricPathWithValue< TValue, 2 >, itk::MorphologicalGradientImageFilter< TInputImage, TOutputImage, TKernel >, otb::PhysicalToRPCSensorModelImageFilter< TImage >, itk::GrayscaleMorphologicalClosingImageFilter< TInputImage, TOutputImage, TKernel >, itk::GrayscaleMorphologicalOpeningImageFilter< TInputImage, TOutputImage, TKernel >, itk::MiniPipelineSeparableImageFilter< TInputImage, TOutputImage, TFilter >, itk::MiniPipelineSeparableImageFilter< TInputImage, TOutputImage, RankImageFilter< TInputImage, TInputImage, FlatStructuringElement< ::itk::GetImageDimension< TInputImage >::ImageDimension > > >, itk::NormalizeImageFilter< TInputImage, TOutputImage >, and otb::StatisticsXMLFileReader< TMeasurementVector >.

Definition at line 297 of file itkObject.cxx.

Referenced by otb::Wrapper::InputImageListParameter::AddFromFileName(), otb::Wrapper::InputVectorDataListParameter::AddFromFileName(), otb::Wrapper::InputImageListParameter::AddImage(), otb::Wrapper::InputImageListParameter::AddNullElement(), otb::Wrapper::InputVectorDataListParameter::AddNullElement(), otb::Wrapper::StringListParameter::AddNullElement(), otb::VectorDataModel::AddPointToGeometry(), otb::Wrapper::InputVectorDataListParameter::AddVectorData(), otb::Wrapper::InputImageListParameter::ClearValue(), otb::Wrapper::InputVectorDataListParameter::ClearValue(), otb::VectorDataModel::DeleteGeometry(), otb::VectorDataModel::EndGeometry(), otb::Wrapper::InputImageListParameter::Erase(), otb::Wrapper::InputVectorDataListParameter::Erase(), itk::NarrowBandImageFilterBase< TInputImage, Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::InsertNarrowBandNode(), otb::ImageWidget< TInputImage >::LinearInterpolationOff(), otb::ImageWidget< TInputImage >::LinearInterpolationOn(), itk::MatrixOffsetTransformBase< TScalarType, NInputDimensions, NOutputDimensions >::MatrixOffsetTransformBase(), otb::ogr::ImageReference< double >::Modified(), otb::Function::StandardRenderingFunction< TPixel, TRGBPixel, TPixelRepresentationFunction, TTransferFunction >::SetAutoMinMax(), otb::BlendingImageFilter< TInputImage1, TInputImage2, TOutputImage >::SetBlendingFunction(), otb::ImageLayerGenerator< TImageLayer >::SetBlendingFunction(), otb::TileMapImageIO::SetCacheDirectory(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetCenter(), otb::Function::StandardRenderingFunction< TPixel, TRGBPixel, TPixelRepresentationFunction, TTransferFunction >::SetChannelList(), itk::LBFGSBOptimizer::SetCostFunction(), itk::MINC2ImageIO::SetDimensionName(), itk::ImageIOBase::SetDimensions(), itk::ImageIOBase::SetDirection(), otb::Wrapper::InputImageListParameter::SetImageList(), itk::GDCMSeriesFileNames::SetInputDirectory(), otb::HistogramStatisticsFunction< TInputHistogram, TOutput >::SetInputHistogram(), otb::ImageToGenericRSOutputParameters< TImage >::SetInputKeywordList(), otb::Wrapper::InputVectorDataListParameter::SetListFromFileName(), otb::Wrapper::InputImageListParameter::SetListFromFileName(), otb::Function::RenderingFunction< TPixel, TRGBPixel >::SetListSample(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetMatrix(), itk::NarrowBandImageFilterBase< TInputImage, Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::SetNarrowBand(), itk::NarrowBandImageFilterBase< TInputImage, Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::SetNarrowBandInnerRadius(), itk::NarrowBandImageFilterBase< TInputImage, Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::SetNarrowBandTotalRadius(), otb::Wrapper::InputImageListParameter::SetNthFileName(), otb::Wrapper::InputVectorDataListParameter::SetNthFileName(), itk::ImageIOBase::SetNumberOfDimensions(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetOffset(), itk::ImageIOBase::SetOrigin(), otb::ImageToGenericRSOutputParameters< TImage >::SetOutputProjectionRef(), otb::MapProjectionAdapter::SetParameter(), otb::Function::GaussianRenderingFunction< TPixel, TRGBPixel, TPixelRepresentationFunction, TTransferFunction >::SetParameters(), otb::Function::StandardRenderingFunction< TPixel, TRGBPixel, TPixelRepresentationFunction, TTransferFunction >::SetParameters(), itk::ThresholdLabelerImageFilter< TInputImage, TOutputImage >::SetRealThresholds(), otb::ImageLayerGenerator< TImageLayer >::SetRenderingFunction(), otb::RenderingImageFilter< TInputImage, TOutputImage >::SetRenderingFunction(), itk::ImageIOBase::SetSpacing(), itk::ThresholdLabelerImageFilter< TInputImage, TOutputImage >::SetThresholds(), itk::Statistics::GoodnessOfFitFunctionBase< TInputHistogram >::SetTotalObservedScale(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetTranslation(), otb::Wrapper::OutputFilenameParameter::SetValue(), otb::Wrapper::InputFilenameParameter::SetValue(), otb::Wrapper::ListViewParameter::SetValue(), otb::Wrapper::ChoiceParameter::SetValue(), otb::Wrapper::InputVectorDataListParameter::SetVectorDataList(), and otb::MapProjectionAdapter::SetWkt().

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

Method for creation through the object factory.

Reimplemented from itk::Object.

Reimplemented in itk::PhilipsPAR, itk::ImageKmeansModelEstimator< TInputImage, TMembershipFunction >, itk::Bruker2DSEQImageIO, itk::AnalyzeImageIO, itk::ImageGaussianModelEstimator< TInputImage, TMembershipFunction, TTrainingImage >, itk::PolygonGroupSpatialObjectXMLFileWriter, itk::Statistics::SampleClassifier< TSample >, itk::Statistics::SampleClassifier< itk::Statistics::ListSample< TInputImage::PixelType > >, itk::ImageClassifierBase< TInputImage, TClassifiedImage >, itk::GDCMImageIO, itk::Statistics::SampleClassifierWithMask< TSample, TMaskSample >, itk::LevelSetVelocityNeighborhoodExtractor< TLevelSet, TAuxValue, VAuxDimension >, itk::LevelSetNeighborhoodExtractor< TLevelSet >, itk::Brains2MaskImageIO, itk::IPLCommonImageIO, itk::MINC2ImageIO, itk::StimulateImageIO, otb::SVMClassifier< TSample, TLabel >, itk::MRCImageIO, itk::PhilipsRECImageIO, itk::VoxBoCUBImageIO, otb::TileMapImageIO, itk::GE5ImageIO, otb::SEMClassifier< TInputImage, TOutputImage >, itk::GE4ImageIO, itk::GEAdwImageIO, itk::RawImageIO< TPixel, VImageDimension >, itk::SiemensVisionImageIO, otb::GDALImageIO, itk::NiftiImageIO, itk::PolygonGroupSpatialObjectXMLFileReader, otb::KMLVectorDataIO, itk::Statistics::ErrorBackPropagationLearningFunctionBase< LayerType, TTargetVector >, itk::TransformFileReader, itk::Statistics::ErrorBackPropagationLearningWithMomentum< LayerType, TTargetVector >, otb::BSQImageIO, otb::OGRVectorDataIO, itk::VTKImageIO2, otb::LUMImageIO, otb::MWImageIO, otb::RADImageIO, itk::TransformFileWriter, itk::Statistics::QuickPropLearningRule< LayerType, TTargetVector >, otb::JPEG2000ImageIO, itk::BioRadImageIO, itk::GiplImageIO, itk::VTKImageIO, otb::ONERAImageIO, itk::BMPImageIO, itk::DicomImageIO, itk::NrrdImageIO, itk::LSMImageIO, itk::MetaImageIO, itk::TIFFImageIO, itk::Statistics::RBFLayer< TMeasurementVector, TTargetVector >, otb::SVMMarginSampler< TSample, TModel >, itk::JPEGImageIO, itk::PNGImageIO, itk::Statistics::RBFBackPropagationLearningFunction< LayerType, TTargetVector >, otb::MSTARImageIO, itk::Statistics::TrainingFunctionBase< TSample, TTargetVector, ScalarType >, itk::TransformFileWriter, itk::MetaArrayWriter, itk::Statistics::IterativeSupervisedTrainingFunction< TSample, TTargetVector, ScalarType >, itk::DICOMImageIO2, itk::MetaArrayReader, itk::Statistics::BatchSupervisedTrainingFunction< TSample, TTargetVector, ScalarType >, itk::TransformFileReader, itk::Statistics::BackPropagationLayer< TMeasurementVector, TTargetVector >, itk::Statistics::CompletelyConnectedWeightSet< TMeasurementVector, TTargetVector >, itk::MatlabTransformIO, and itk::TxtTransformIO.

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

void otb::VectorDataIOBase::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::LightProcessObject.

Reimplemented in otb::OGRVectorDataIO, and otb::KMLVectorDataIO.

Definition at line 63 of file otbVectorDataIOBase.cxx.

Referenced by otb::KMLVectorDataIO::PrintSelf(), and otb::OGRVectorDataIO::PrintSelf().

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.

virtual void otb::VectorDataIOBase::Read ( itk::DataObject data)
pure virtual

Reads the data from disk into the memory buffer provided.

Implemented in otb::KMLVectorDataIO, and otb::OGRVectorDataIO.

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().

void itk::Object::RemoveAllObservers ( )
inherited

Remove all observers .

Definition at line 435 of file itkObject.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 otb::VectorDataIOBase::Reset ( const bool  freeDynamic = true)
protectedvirtual

Return the object to an initialized state, ready to be used

Definition at line 32 of file otbVectorDataIOBase.cxx.

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 otb::VectorDataIOBase::SetByteOrder ( const ByteOrder  _arg)
virtual

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 otb::VectorDataIOBase::SetByteOrderToBigEndian ( )
inline

Definition at line 91 of file otbVectorDataIOBase.h.

void otb::VectorDataIOBase::SetByteOrderToLittleEndian ( )
inline

Definition at line 95 of file otbVectorDataIOBase.h.

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.

virtual void otb::VectorDataIOBase::SetFileName ( const char *  _arg)
virtual

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

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().

void itk::Object::SetMetaDataDictionary ( const MetaDataDictionary rhs)
inherited
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 347 of file itkObject.cxx.

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().

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 77 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 51 of file itkLightProcessObject.cxx.

virtual void otb::VectorDataIOBase::Write ( const itk::DataObject data,
char **  papszOptions = NULL 
)
pure virtual

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 otb::KMLVectorDataIO, and otb::OGRVectorDataIO.


Member Data Documentation

ByteOrder otb::VectorDataIOBase::m_ByteOrder
protected

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

Definition at line 156 of file otbVectorDataIOBase.h.

std::string otb::VectorDataIOBase::m_FileName
protected

Filename to read

Definition at line 162 of file otbVectorDataIOBase.h.

Referenced by otb::OGRVectorDataIO::Write(), and otb::KMLVectorDataIO::Write().

bool otb::VectorDataIOBase::m_Initialized
protected

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

Definition at line 159 of file otbVectorDataIOBase.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.

const unsigned int otb::VectorDataIOBase::VDimension = 3
static

Definition at line 66 of file otbVectorDataIOBase.h.


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

Generated at Sun Feb 3 2013 04:21:07 for Orfeo Toolbox with doxygen 1.8.1.1