ITK  5.0.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes | List of all members
itk::VTKImageIO Class Reference

#include <itkVTKImageIO.h>

+ Inheritance diagram for itk::VTKImageIO:
+ Collaboration diagram for itk::VTKImageIO:

Detailed Description

ImageIO class for reading VTK images.

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

Examples:
Examples/IO/ImageReadExportVTK.cxx.

Definition at line 49 of file itkVTKImageIO.h.

Public Types

using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = VTKImageIO
 
using Superclass = StreamingImageIOBase
 
- Public Types inherited from itk::StreamingImageIOBase
using Pointer = SmartPointer< Self >
 
using Self = StreamingImageIOBase
 
using Superclass = ImageIOBase
 
- Public Types inherited from itk::ImageIOBase
using ArrayOfExtensionsType = std::vector< std::string >
 
using BufferSizeType = ::itk::OffsetValueType
 
enum  ByteOrder {
  BigEndian,
  LittleEndian,
  OrderNotApplicable
}
 
using ConstPointer = SmartPointer< const Self >
 
enum  FileType {
  ASCII,
  Binary,
  TypeNotApplicable
}
 
using IndexValueType = ::itk::IndexValueType
 
enum  IOComponentType {
  UNKNOWNCOMPONENTTYPE,
  UCHAR,
  CHAR,
  USHORT,
  SHORT,
  UINT,
  INT,
  ULONG,
  LONG,
  ULONGLONG,
  LONGLONG,
  FLOAT,
  DOUBLE
}
 
enum  IOPixelType {
  UNKNOWNPIXELTYPE,
  SCALAR,
  RGB,
  RGBA,
  OFFSET,
  VECTOR,
  POINT,
  COVARIANTVECTOR,
  SYMMETRICSECONDRANKTENSOR,
  DIFFUSIONTENSOR3D,
  COMPLEX,
  FIXEDARRAY,
  MATRIX
}
 
using Pointer = SmartPointer< Self >
 
using Self = ImageIOBase
 
using SizeType = ::itk::intmax_t
 
using SizeValueType = ::itk::SizeValueType
 
using Superclass = LightProcessObject
 
- Public Types inherited from itk::LightProcessObject
using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = LightProcessObject
 
using Superclass = Object
 
- Public Types inherited from itk::Object
using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = Object
 
using Superclass = LightObject
 
- Public Types inherited from itk::LightObject
using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = LightObject
 

Public Member Functions

bool CanReadFile (const char *) override
 
bool CanStreamRead () override
 
bool CanStreamWrite () override
 
bool CanWriteFile (const char *) override
 
virtual ::itk::LightObject::Pointer CreateAnother () const
 
SizeType GetHeaderSize () const override
 
virtual const char * GetNameOfClass () const
 
void Read (void *buffer) override
 
void ReadImageInformation () override
 
void Write (const void *buffer) override
 
void WriteImageInformation () override
 
- Public Member Functions inherited from itk::StreamingImageIOBase
ImageIORegion GenerateStreamableReadRegionFromRequestedRegion (const ImageIORegion &requested) const override
 
unsigned int GetActualNumberOfSplitsForWriting (unsigned int numberOfRequestedSplits, const ImageIORegion &pasteRegion, const ImageIORegion &largestPossibleRegion) override
 
- Public Member Functions inherited from itk::ImageIOBase
std::string GetByteOrderAsString (ByteOrder) const
 
virtual unsigned int GetComponentSize () const
 
virtual IOComponentType GetComponentType () const
 
virtual const std::type_info & GetComponentTypeInfo () const
 
virtual std::vector< double > GetDefaultDirection (unsigned int i) const
 
virtual SizeValueType GetDimensions (unsigned int i) const
 
virtual std::vector< double > GetDirection (unsigned int i) const
 
std::string GetFileTypeAsString (FileType) const
 
SizeType GetImageSizeInBytes () const
 
SizeType GetImageSizeInComponents () const
 
SizeType GetImageSizeInPixels () const
 
virtual bool GetIsReadAsScalarPlusPalette () const
 
virtual unsigned int GetNumberOfDimensions () const
 
virtual double GetOrigin (unsigned int i) const
 
virtual SizeType GetPixelStride () 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
 
void SetByteOrderToLittleEndian ()
 
virtual void SetComponentType (const IOComponentType _arg)
 
virtual void SetDirection (unsigned int i, const std::vector< double > &direction)
 
virtual void SetDirection (unsigned int i, const vnl_vector< double > &direction)
 
void SetFileTypeToBinary ()
 
void SetNumberOfDimensions (unsigned int)
 
virtual void SetOrigin (unsigned int i, double origin)
 
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 SetSpacing (unsigned int i, double spacing)
 
template<typename TPixel >
void SetTypeInfo (const TPixel *)
 
virtual bool SupportsDimension (unsigned long dim)
 
virtual void SetFileName (const char *_arg)
 
virtual const char * GetFileName () const
 
virtual void SetDimensions (unsigned int i, SizeValueType dim)
 
virtual void SetIORegion (ImageIORegion _arg)
 
virtual const ImageIORegionGetIORegion () const
 
virtual void SetPixelType (const IOPixelType _arg)
 
virtual IOPixelType GetPixelType () const
 
virtual void SetNumberOfComponents (unsigned int _arg)
 
virtual const unsigned int & GetNumberOfComponents () const
 
virtual void SetUseCompression (bool _arg)
 
virtual bool GetUseCompression () const
 
virtual void UseCompressionOn ()
 
virtual void UseCompressionOff ()
 
virtual void SetUseStreamedReading (bool _arg)
 
virtual bool GetUseStreamedReading () const
 
virtual void UseStreamedReadingOn ()
 
virtual void UseStreamedReadingOff ()
 
virtual void SetUseStreamedWriting (bool _arg)
 
virtual bool GetUseStreamedWriting () const
 
virtual void UseStreamedWritingOn ()
 
virtual void UseStreamedWritingOff ()
 
virtual void SetExpandRGBPalette (bool _arg)
 
virtual bool GetExpandRGBPalette () const
 
virtual void ExpandRGBPaletteOn ()
 
virtual void ExpandRGBPaletteOff ()
 
virtual void SetFileType (const FileType _arg)
 
virtual FileType GetFileType () const
 
void SetFileTypeToASCII ()
 
virtual void SetByteOrder (const ByteOrder _arg)
 
virtual ByteOrder GetByteOrder () const
 
void SetByteOrderToBigEndian ()
 
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 > *)
 
- Public Member Functions inherited from itk::LightProcessObject
virtual void AbortGenerateDataOff ()
 
virtual void AbortGenerateDataOn ()
 
virtual const bool & GetAbortGenerateData () const
 
virtual void SetAbortGenerateData (bool _arg)
 
virtual void UpdateOutputData ()
 
void UpdateProgress (float amount)
 
virtual void SetProgress (float _arg)
 
virtual const float & GetProgress () const
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *)
 
unsigned long AddObserver (const EventObject &event, Command *) const
 
virtual void DebugOff () const
 
virtual void DebugOn () const
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionaryGetMetaDataDictionary ()
 
const MetaDataDictionaryGetMetaDataDictionary () const
 
virtual ModifiedTimeType GetMTime () const
 
virtual const TimeStampGetTimeStamp () const
 
bool HasObserver (const EventObject &event) const
 
void InvokeEvent (const EventObject &)
 
void InvokeEvent (const EventObject &) const
 
virtual void Modified () const
 
void Register () const override
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag)
 
void SetDebug (bool debugFlag) const
 
void SetReferenceCount (int) override
 
void UnRegister () const noexceptoverride
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
void SetMetaDataDictionary (MetaDataDictionary &&rrhs)
 
virtual void SetObjectName (std::string _arg)
 
virtual const std::string & GetObjectName () const
 
- Public Member Functions inherited from itk::LightObject
virtual void Delete ()
 
virtual int GetReferenceCount () const
 
 itkCloneMacro (Self)
 
void Print (std::ostream &os, Indent indent=0) const
 

Static Public Member Functions

static Pointer New ()
 
- Static Public Member Functions inherited from itk::ImageIOBase
static std::string GetComponentTypeAsString (IOComponentType)
 
static IOComponentType GetComponentTypeFromString (const std::string &typeString)
 
static std::string GetPixelTypeAsString (IOPixelType)
 
static IOPixelType GetPixelTypeFromString (const std::string &pixelString)
 
- Static Public Member Functions inherited from itk::LightProcessObject
static Pointer New ()
 
- Static Public Member Functions inherited from itk::Object
static bool GetGlobalWarningDisplay ()
 
static void GlobalWarningDisplayOff ()
 
static void GlobalWarningDisplayOn ()
 
static Pointer New ()
 
static void SetGlobalWarningDisplay (bool flag)
 
- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()
 
static Pointer New ()
 

Protected Member Functions

int GetNextLine (std::ifstream &ifs, std::string &line, bool lowerCase=true, SizeValueType count=0)
 
void InternalReadImageInformation (std::ifstream &file)
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
void ReadBufferAsASCII (std::istream &os, void *buffer, IOComponentType ctype, SizeType numberOfBytesToBeRead) override
 
void ReadHeaderSize (std::ifstream &file)
 
virtual void ReadSymmetricTensorBufferAsBinary (std::istream &os, void *buffer, StreamingImageIOBase::SizeType num)
 
 VTKImageIO ()
 
void WriteBufferAsASCII (std::ostream &os, const void *buffer, IOComponentType ctype, SizeType numberOfBytesToWrite) override
 
void WriteImageInformation (const void *buffer)
 
virtual void WriteSymmetricTensorBufferAsBinary (std::ostream &os, const void *buffer, StreamingImageIOBase::SizeType num)
 
 ~VTKImageIO () override
 
- Protected Member Functions inherited from itk::StreamingImageIOBase
virtual SizeType GetDataPosition () const
 
virtual bool ReadBufferAsBinary (std::istream &is, void *buffer, SizeType num)
 
virtual bool RequestedToStream () const
 
 StreamingImageIOBase ()
 
virtual bool StreamReadBufferAsBinary (std::istream &os, void *buffer)
 
virtual bool StreamWriteBufferAsBinary (std::ostream &os, const void *buffer)
 
virtual bool WriteBufferAsBinary (std::ostream &is, const void *buffer, SizeType num)
 
- Protected Member Functions inherited from itk::ImageIOBase
void AddSupportedReadExtension (const char *extension)
 
void AddSupportedWriteExtension (const char *extension)
 
void ComputeStrides ()
 
virtual unsigned int GetActualNumberOfSplitsForWritingCanStreamWrite (unsigned int numberOfRequestedSplits, const ImageIORegion &pasteRegion) const
 
SizeType GetComponentStride () const
 
virtual const
ImageRegionSplitterBase
GetImageRegionSplitter () 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
 
 ImageIOBase ()
 
virtual void OpenFileForReading (std::ifstream &inputStream, const std::string &filename, bool ascii=false)
 
virtual void OpenFileForWriting (std::ofstream &outputStream, const std::string &filename, bool truncate=true, bool ascii=false)
 
bool ReadBufferAsBinary (std::istream &os, void *buffer, SizeType numberOfBytesToBeRead)
 
virtual void Reset (const bool freeDynamic=true)
 
void Resize (const unsigned int numDimensions, const unsigned int *dimensions)
 
 ~ImageIOBase () override
 
virtual bool HasSupportedReadExtension (const char *fileName, bool ignoreCase=true)
 
virtual bool HasSupportedWriteExtension (const char *fileName, bool ignoreCase=true)
 
- Protected Member Functions inherited from itk::LightProcessObject
virtual void GenerateData ()
 
 LightProcessObject ()
 
 ~LightProcessObject () override
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &time)
 
 ~Object () override
 
- Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer InternalClone () const
 
 LightObject ()
 
virtual void PrintHeader (std::ostream &os, Indent indent) const
 
virtual void PrintTrailer (std::ostream &os, Indent indent) const
 
virtual ~LightObject ()
 

Private Member Functions

std::string GetComponentTypeAsString (IOComponentType)
 
SizeType GetIORegionSizeInBytes () const
 
SizeType GetIORegionSizeInComponents () const
 
SizeType GetIORegionSizeInPixels () const
 
void SetPixelTypeFromString (const std::string &pixelType)
 

Private Attributes

SizeType m_HeaderSize
 

Additional Inherited Members

- Protected Attributes inherited from itk::ImageIOBase
ByteOrder m_ByteOrder {OrderNotApplicable}
 
IOComponentType m_ComponentType {UNKNOWNCOMPONENTTYPE}
 
std::vector< SizeValueTypem_Dimensions
 
std::vector< std::vector
< double > > 
m_Direction
 
bool m_ExpandRGBPalette
 
std::string m_FileName
 
FileType m_FileType {TypeNotApplicable}
 
bool m_Initialized
 
ImageIORegion m_IORegion
 
bool m_IsReadAsScalarPlusPalette
 
unsigned int m_NumberOfComponents
 
unsigned int m_NumberOfDimensions {0}
 
std::vector< double > m_Origin
 
IOPixelType m_PixelType {SCALAR}
 
std::vector< double > m_Spacing
 
std::vector< SizeTypem_Strides
 
bool m_UseCompression
 
bool m_UseStreamedReading
 
bool m_UseStreamedWriting
 
- Protected Attributes inherited from itk::LightObject
std::atomic< int > m_ReferenceCount
 

Member Typedef Documentation

Definition at line 59 of file itkVTKImageIO.h.

Definition at line 58 of file itkVTKImageIO.h.

Standard class type aliases.

Definition at line 56 of file itkVTKImageIO.h.

Definition at line 57 of file itkVTKImageIO.h.

Constructor & Destructor Documentation

itk::VTKImageIO::VTKImageIO ( )
protected
itk::VTKImageIO::~VTKImageIO ( )
overrideprotected

Member Function Documentation

bool itk::VTKImageIO::CanReadFile ( const char *  )
overridevirtual

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

Implements itk::ImageIOBase.

bool itk::VTKImageIO::CanStreamRead ( )
overridevirtual

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::StreamingImageIOBase.

bool itk::VTKImageIO::CanStreamWrite ( )
overridevirtual

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::StreamingImageIOBase.

bool itk::VTKImageIO::CanWriteFile ( const char *  )
overridevirtual

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

Implements itk::ImageIOBase.

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

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

Reimplemented from itk::LightProcessObject.

std::string itk::VTKImageIO::GetComponentTypeAsString ( IOComponentType  )
private
SizeType itk::VTKImageIO::GetHeaderSize ( ) const
inlineoverridevirtual

returns the header size, if it is unknown it will return 0

Implements itk::StreamingImageIOBase.

Definition at line 105 of file itkVTKImageIO.h.

SizeType itk::VTKImageIO::GetIORegionSizeInBytes ( ) const
private

Return the number of bytes in the IOregion.

SizeType itk::VTKImageIO::GetIORegionSizeInComponents ( ) const
private

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

SizeType itk::VTKImageIO::GetIORegionSizeInPixels ( ) const
private

Return the number of pixels in the IOregion.

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

Run-time type information (and related methods).

Reimplemented from itk::StreamingImageIOBase.

int itk::VTKImageIO::GetNextLine ( std::ifstream &  ifs,
std::string &  line,
bool  lowerCase = true,
SizeValueType  count = 0 
)
protected
void itk::VTKImageIO::InternalReadImageInformation ( std::ifstream &  file)
protected
static Pointer itk::VTKImageIO::New ( )
static

Method for creation through the object factory.

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

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.

Reimplemented from itk::StreamingImageIOBase.

void itk::VTKImageIO::Read ( void *  buffer)
overridevirtual

Reads the data from disk into the memory buffer provided.

Implements itk::ImageIOBase.

void itk::VTKImageIO::ReadBufferAsASCII ( std::istream &  os,
void *  buffer,
IOComponentType  ctype,
SizeType  numberOfBytesToBeRead 
)
overrideprotectedvirtual

Convenient method to read a buffer as ASCII text.

Reimplemented from itk::ImageIOBase.

void itk::VTKImageIO::ReadHeaderSize ( std::ifstream &  file)
protected
void itk::VTKImageIO::ReadImageInformation ( )
overridevirtual

Set the spacing and dimesion information for the current filename.

Implements itk::ImageIOBase.

virtual void itk::VTKImageIO::ReadSymmetricTensorBufferAsBinary ( std::istream &  os,
void *  buffer,
StreamingImageIOBase::SizeType  num 
)
protectedvirtual

We have a special method to read symmetric second rank tensors because the VTK file format expands the symmetry and only supports 3D tensors.

void itk::VTKImageIO::SetPixelTypeFromString ( const std::string &  pixelType)
private
void itk::VTKImageIO::Write ( const void *  buffer)
overridevirtual

Writes the data to disk from the memory buffer provided. Make sure that the IORegion has been set properly.

Implements itk::ImageIOBase.

void itk::VTKImageIO::WriteBufferAsASCII ( std::ostream &  os,
const void *  buffer,
IOComponentType  ctype,
SizeType  numberOfBytesToWrite 
)
overrideprotectedvirtual

Convenient method to write a buffer as ASCII text.

Reimplemented from itk::ImageIOBase.

void itk::VTKImageIO::WriteImageInformation ( )
inlineoverridevirtual

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

Implements itk::ImageIOBase.

Definition at line 98 of file itkVTKImageIO.h.

void itk::VTKImageIO::WriteImageInformation ( const void *  buffer)
protected
virtual void itk::VTKImageIO::WriteSymmetricTensorBufferAsBinary ( std::ostream &  os,
const void *  buffer,
StreamingImageIOBase::SizeType  num 
)
protectedvirtual

We have a special method to write symmetric second rank tensors because the VTK file format expands the symmetry and only supports 3D tensors.

Member Data Documentation

SizeType itk::VTKImageIO::m_HeaderSize
private

Definition at line 158 of file itkVTKImageIO.h.


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