#include <itkVTIImageIO.h>

Detailed Description

ImageIO class for reading and writing VTK XML ImageData (.vti) files.

Supported on read (every encoding ParaView 5.x emits by default):

<VTKFile> attributes: type="ImageData", any version, any byte_order (LittleEndian / BigEndian), header_type in {UInt32, UInt64}.
<ImageData> attributes: WholeExtent, Origin, Spacing, and Direction (VTK 9+; defaults to identity when absent).
Single-<Piece> images.
<DataArray> format = "ascii" | "binary" (inline base64) | "appended" (raw or base64 AppendedData).
compressor = vtkZLibDataCompressor, or absent (uncompressed).
Pixel types: Scalar, Vector (3-component), RGB (3), RGBA (4), and symmetric second-rank tensor (6 components, VTK canonical [XX, YY, ZZ, XY, YZ, XZ] layout remapped to ITK's internal [e00, e01, e02, e11, e12, e22] on read).

Single-image semantics: VTIImageIO yields exactly one image per file. When <PointData> declares Scalars/Vectors/Tensors hint attributes, the named DataArray is selected; when no hint is given, the first <DataArray> child of <PointData> is used. Sibling DataArrays in the same <PointData> are silently ignored, since ITK's IO model is one image per file. Arrays inside <CellData>, <FieldData>, or other containers are not consumed (see F-011).

Supported on write:

<VTKFile version="1.0" header_type="UInt64"> matching ParaView 5.7+.
format = "ascii" and "binary" (inline base64) for every supported pixel type except binary symmetric tensor (see deferred list).
format = "appended" encoding="raw" + vtkZLibDataCompressor: enabled by calling SetUseCompression(true); produces the smallest files on disk and matches what ParaView emits by default for large images.
Direction is always emitted as a row-major 3x3 Direction attribute, padded with identity for images of dimension < 3.

Deferred to the follow-up PR. Items marked (guard) raise an itkExceptionMacro tagged with the F-NNN identifier so git grep F-NNN locates the guard + test + commit; items marked (latent) have no public API surface today and so cannot be triggered without a code change, but are listed here so the F-NNN identifier is findable from the header:

F-001 vtkLZ4DataCompressor read (guard)
F-002 vtkLZMADataCompressor read (guard)
F-003 appended-raw writer (no compression) (latent)
F-004 streaming read for appended-raw (latent)
F-005 multi-<Piece> images (guard)
F-007 binary symmetric-tensor write (guard)
F-008 appended-base64 writer (latent)
F-009 MetaDataDictionary round-trip (latent)
F-010 catch-all for unknown compressors (guard)
F-011 <CellData>-only images (only <PointData> consumed) (guard)

Implementation notes:

XML header parsing uses expat (ITKExpat); <!DOCTYPE>/<!ENTITY> declarations are rejected up-front to mitigate billion-laughs and XXE attacks.
Expat is fed the file in chunks and suspended (XML_StopParser) at the <AppendedData> start tag so binary bytes never enter the parser. For large files this avoids a full in-memory copy of the binary payload during ReadImageInformation().

Definition at line 94 of file itkVTIImageIO.h.

Inheritance diagram for itk::VTIImageIO:

Collaboration diagram for itk::VTIImageIO:

Public Types
using	ConstPointer = SmartPointer<const Self>

using	Pointer = SmartPointer<Self>

using	Self = VTIImageIO

using	Superclass = ImageIOBase

Public Types inherited from itk::ImageIOBase
using	ArrayOfExtensionsType = std::vector<std::string>

using	BufferSizeType = itk::OffsetValueType

using	ConstPointer = SmartPointer<const Self>

using	IndexValueType = itk::IndexValueType

using	IOByteOrderEnum = itk::IOByteOrderEnum

using	IOComponentEnum = itk::IOComponentEnum

using	IOFileEnum = itk::IOFileEnum

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	CanWriteFile (const char *) override

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

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::ImageIOBase
virtual bool	CanStreamRead ()

virtual bool	CanStreamWrite ()

virtual ImageIORegion	GenerateStreamableReadRegionFromRequestedRegion (const ImageIORegion &requested) const

virtual unsigned int	GetActualNumberOfSplitsForWriting (unsigned int numberOfRequestedSplits, const ImageIORegion &pasteRegion, const ImageIORegion &largestPossibleRegion)

std::string	GetByteOrderAsString (IOByteOrderEnum) const

virtual unsigned int	GetComponentSize () const

virtual IOComponentEnum	GetComponentType () const

virtual int	GetCompressionLevel () const

virtual const std::string &	GetCompressor () const

virtual std::vector< double >	GetDefaultDirection (unsigned int k) const

virtual std::vector< double >	GetDirection (unsigned int i) const

std::string	GetFileTypeAsString (IOFileEnum) 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 ArrayOfExtensionsType &	GetSupportedReadExtensions () const

const ArrayOfExtensionsType &	GetSupportedWriteExtensions () const

void	SetByteOrderToLittleEndian ()

virtual void	SetComponentType (const IOComponentEnum _arg)

virtual void	SetCompressionLevel (int _arg)

virtual void	SetCompressor (std::string _c)

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)

virtual void	SetSpacing (unsigned int i, double spacing)

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 SizeValueType	GetDimensions (unsigned int i) const

virtual void	SetIORegion (ImageIORegion _arg)

virtual const ImageIORegion &	GetIORegion () const

virtual void	SetPixelType (const itk::CommonEnums::IOPixel _arg)

virtual itk::CommonEnums::IOPixel	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	SetWritePalette (bool _arg)

virtual bool	GetWritePalette () const

virtual void	WritePaletteOn ()

virtual void	WritePaletteOff ()

virtual void	SetFileType (const IOFileEnum _arg)

virtual IOFileEnum	GetFileType () const

void	SetFileTypeToASCII ()

virtual void	SetByteOrder (const IOByteOrderEnum _arg)

virtual IOByteOrderEnum	GetByteOrder () const

void	SetByteOrderToBigEndian ()

template<typename TPixel>
void	SetPixelTypeInfo (const TPixel *)

template<typename TComponent>
void	SetPixelTypeInfo (const RGBPixel< TComponent > *)

template<typename TComponent>
void	SetPixelTypeInfo (const RGBAPixel< TComponent > *)

template<unsigned int VLength>
void	SetPixelTypeInfo (const Offset< VLength > *)

template<typename TComponent, unsigned int VLength>
void	SetPixelTypeInfo (const Vector< TComponent, VLength > *)

template<typename TCoordinate, unsigned int VPointDimension>
void	SetPixelTypeInfo (const Point< TCoordinate, VPointDimension > *)

template<typename TComponent, unsigned int VLength>
void	SetPixelTypeInfo (const CovariantVector< TComponent, VLength > *)

template<typename TComponent, unsigned int VLength>
void	SetPixelTypeInfo (const SymmetricSecondRankTensor< TComponent, VLength > *)

template<typename TComponent>
void	SetPixelTypeInfo (const DiffusionTensor3D< TComponent > *)

template<typename TComponent>
void	SetPixelTypeInfo (const std::complex< TComponent > *)

template<typename TComponent, unsigned int VLength>
void	SetPixelTypeInfo (const FixedArray< TComponent, VLength > *)

template<typename TComponent>
void	SetPixelTypeInfo (const VariableLengthVector< TComponent > *)

template<typename TValue>
void	SetPixelTypeInfo (const Array< TValue > *)

template<typename TComponent, unsigned int VLength>
void	SetPixelTypeInfo (const Matrix< TComponent, VLength, VLength > *)

template<typename TValue>
void	SetPixelTypeInfo (const VariableSizeMatrix< TValue > *)

virtual bool	HasSupportedReadExtension (const char *fileName, bool ignoreCase=true)

virtual bool	HasSupportedWriteExtension (const char *fileName, bool ignoreCase=true)

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 *cmd) const

unsigned long	AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) const

virtual void	DebugOff () const

virtual void	DebugOn () const

Command *	GetCommand (unsigned long tag)

bool	GetDebug () const

MetaDataDictionary &	GetMetaDataDictionary ()

const MetaDataDictionary &	GetMetaDataDictionary () const

virtual ModifiedTimeType	GetMTime () const

virtual const TimeStamp &	GetTimeStamp () 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) const

void	SetDebug (bool debugFlag) const

void	SetReferenceCount (int) override

void	UnRegister () const noexcept override

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
Pointer	Clone () const

virtual void	Delete ()

virtual int	GetReferenceCount () const

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

Static Public Member Functions
static Pointer	New ()

static void	SwapBufferForByteOrder (void *buffer, std::vcl_size_t componentSize, std::vcl_size_t numComponents, IOByteOrderEnum fileByteOrder, IOByteOrderEnum targetByteOrder)

Static Public Member Functions inherited from itk::ImageIOBase
static std::string	GetComponentTypeAsString (IOComponentEnum)

static IOComponentEnum	GetComponentTypeFromString (const std::string &typeString)

static constexpr IOComponentEnum	GetComponentTypeFromTypeTraits (const bool isFloatingPoint, const bool isUnsigned, const vcl_size_t numberOfBits)

static constexpr vcl_size_t	GetNumberOfBitsOfComponentType (const IOComponentEnum componentEnum)

static std::string	GetPixelTypeAsString (IOPixelEnum)

static IOPixelEnum	GetPixelTypeFromString (const std::string &pixelString)

static constexpr bool	IsComponentTypeFloatingPoint (const IOComponentEnum componentEnum)

static constexpr bool	IsComponentTypeUnsigned (const IOComponentEnum componentEnum)

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 val)

Static Public Member Functions inherited from itk::LightObject
static void	BreakOnError ()

static Pointer	New ()

Protected Member Functions
void	PrintSelf (std::ostream &os, Indent indent) const override

	VTIImageIO ()

	~VTIImageIO () override

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	InternalSetCompressor (const std::string &_compressor)

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)

virtual void	ReadBufferAsASCII (std::istream &is, void *buffer, IOComponentEnum ctype, SizeType numComp)

bool	ReadBufferAsBinary (std::istream &is, void *buffer, SizeType num)

virtual void	Reset (const bool freeDynamic=true)

void	Resize (const unsigned int numDimensions, const unsigned int *dimensions)

void	SetSupportedReadExtensions (const ArrayOfExtensionsType &)

void	SetSupportedWriteExtensions (const ArrayOfExtensionsType &)

virtual void	WriteBufferAsASCII (std::ostream &os, const void *buffer, IOComponentEnum ctype, SizeType numComp)

	~ImageIOBase () override

virtual void	SetMaximumCompressionLevel (int)

virtual int	GetMaximumCompressionLevel () const

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 &timeStamp)

	~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 Types
enum class	DataEncoding : std::uint8_t { ASCII , Base64 , RawAppended , Base64Appended , ZLibBase64 , ZLibAppended , ZLibBase64Appended }

Static Private Member Functions
static SizeType	DecodeBase64 (const std::string &encoded, std::vector< unsigned char > &decoded)

static void	DecompressZLib (const unsigned char *compressedData, std::vcl_size_t compressedDataSize, bool headerUInt64, std::vector< unsigned char > &uncompressed)

static std::string	EncodeBase64 (const unsigned char *data, SizeType numBytes)

static std::string	ITKComponentToVTKTypeString (IOComponentEnum t)

static std::string	TrimString (const std::string &s)

static IOComponentEnum	VTKTypeStringToITKComponent (const std::string &vtkType)

Private Attributes
std::string	m_AppendedBase64Content {}

bool	m_AppendedDataIsBase64 { false }

std::streampos	m_AppendedDataOffset { 0 }

std::string	m_AsciiDataContent {}

std::string	m_Base64DataContent {}

SizeType	m_DataArrayOffset { 0 }

DataEncoding	m_DataEncoding { DataEncoding::Base64 }

bool	m_HeaderTypeUInt64 { false }

bool	m_IsZLibCompressed { false }

Additional Inherited Members
Protected Attributes inherited from itk::ImageIOBase
IOByteOrderEnum	m_ByteOrder { IOByteOrderEnum::OrderNotApplicable }

IOComponentEnum	m_ComponentType { IOComponentEnum::UNKNOWNCOMPONENTTYPE }

int	m_CompressionLevel { 30 }

std::string	m_Compressor { "uninitialized" }

std::vector< SizeValueType >	m_Dimensions {}

std::vector< std::vector< double > >	m_Direction {}

bool	m_ExpandRGBPalette {}

std::string	m_FileName {}

IOFileEnum	m_FileType { IOFileEnum::TypeNotApplicable }

bool	m_Initialized {}

ImageIORegion	m_IORegion {}

bool	m_IsReadAsScalarPlusPalette {}

int	m_MaximumCompressionLevel { 100 }

unsigned int	m_NumberOfComponents {}

unsigned int	m_NumberOfDimensions { 0 }

std::vector< double >	m_Origin {}

IOPixelEnum	m_PixelType { IOPixelEnum::SCALAR }

std::vector< double >	m_Spacing {}

std::vector< SizeType >	m_Strides {}

bool	m_UseCompression { false }

bool	m_UseStreamedReading {}

bool	m_UseStreamedWriting {}

bool	m_WritePalette {}

Protected Attributes inherited from itk::LightObject
std::atomic< int >	m_ReferenceCount {}

Member Typedef Documentation

◆ ConstPointer

using itk::VTIImageIO::ConstPointer = SmartPointer<const Self>

Definition at line 103 of file itkVTIImageIO.h.

◆ Pointer

using itk::VTIImageIO::Pointer = SmartPointer<Self>

Definition at line 102 of file itkVTIImageIO.h.

◆ Self

using itk::VTIImageIO::Self = VTIImageIO

Standard class type aliases.

Definition at line 100 of file itkVTIImageIO.h.

◆ Superclass

using itk::VTIImageIO::Superclass = ImageIOBase

Definition at line 101 of file itkVTIImageIO.h.

Member Enumeration Documentation

◆ DataEncoding

enum class itk::VTIImageIO::DataEncoding : std::uint8_t

strongprivate

Enumerator
ASCII
Base64
RawAppended
Base64Appended
ZLibBase64
ZLibAppended
ZLibBase64Appended

Definition at line 191 of file itkVTIImageIO.h.

Constructor & Destructor Documentation

◆ VTIImageIO()

itk::VTIImageIO::VTIImageIO ( )

protected

Referenced by GetNameOfClass().

◆ ~VTIImageIO()

itk::VTIImageIO::~VTIImageIO ( )

overrideprotected

Member Function Documentation

◆ CanReadFile()

bool itk::VTIImageIO::CanReadFile ( const char * )

overridevirtual

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

Implements itk::ImageIOBase.

◆ CanWriteFile()

bool itk::VTIImageIO::CanWriteFile ( const char * )

overridevirtual

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

Implements itk::ImageIOBase.

◆ CreateAnother()

virtual::itk::LightObject::Pointer itk::VTIImageIO::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.

◆ DecodeBase64()

static SizeType itk::VTIImageIO::DecodeBase64	(	const std::string &	encoded,
		std::vector< unsigned char > &	decoded )

staticprivate

Decode a base64-encoded string into raw bytes. Returns the number of decoded bytes.

◆ DecompressZLib()

static void itk::VTIImageIO::DecompressZLib	(	const unsigned char *	compressedData,
		std::vcl_size_t	compressedDataSize,
		bool	headerUInt64,
		std::vector< unsigned char > &	uncompressed )

staticprivate

Decompress a VTK zlib-compressed block sequence into raw bytes. The input buffer begins with the VTK multi-block compression header (nblocks / uncompressed_blocksize / last_partial_size / compressed_sizes[]). Header integers are UInt32 or UInt64 per headerUInt64.

◆ EncodeBase64()

static std::string itk::VTIImageIO::EncodeBase64	(	const unsigned char *	data,
		SizeType	numBytes )

staticprivate

Encode raw bytes as a base64 string.

◆ GetNameOfClass()

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

virtual

See also: LightObject::GetNameOfClass()

Reimplemented from itk::ImageIOBase.

References VTIImageIO().

◆ ITKComponentToVTKTypeString()

static std::string itk::VTIImageIO::ITKComponentToVTKTypeString ( IOComponentEnum t )

staticprivate

Map ITK IOComponentEnum to VTK type string.

◆ New()

static Pointer itk::VTIImageIO::New ( )

static

Method for creation through the object factory.

◆ PrintSelf()

void itk::VTIImageIO::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::ImageIOBase.

◆ Read()

void itk::VTIImageIO::Read ( void * buffer )

overridevirtual

Reads the data from disk into the memory buffer provided.

Implements itk::ImageIOBase.

◆ ReadImageInformation()

void itk::VTIImageIO::ReadImageInformation ( )

overridevirtual

Set the spacing and dimension information for the current filename.

Implements itk::ImageIOBase.

◆ SwapBufferForByteOrder()

static void itk::VTIImageIO::SwapBufferForByteOrder	(	void *	buffer,
		std::vcl_size_t	componentSize,
		std::vcl_size_t	numComponents,
		IOByteOrderEnum	fileByteOrder,
		IOByteOrderEnum	targetByteOrder )

static

Byte-swap numComponents values of componentSize bytes each in place when fileByteOrder differs from targetByteOrder. The implementation reverses bytes within each component unconditionally (via std::reverse) rather than going through ByteSwapper's system-relative helpers, so it is deterministic on hosts of either endianness and therefore unit-testable without a big-endian runner. Public so that endianness behaviour can be exercised directly in tests.

◆ TrimString()

static std::string itk::VTIImageIO::TrimString ( const std::string & s )

staticprivate

Trim leading/trailing whitespace from a string.

◆ VTKTypeStringToITKComponent()

static IOComponentEnum itk::VTIImageIO::VTKTypeStringToITKComponent ( const std::string & vtkType )

staticprivate

Map VTK type string to ITK IOComponentEnum.

◆ Write()

void itk::VTIImageIO::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.

◆ WriteImageInformation()

void itk::VTIImageIO::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 136 of file itkVTIImageIO.h.

Member Data Documentation

◆ m_AppendedBase64Content

std::string itk::VTIImageIO::m_AppendedBase64Content {}

private

Cached base64 content from appended data section when encoding="base64".

Definition at line 230 of file itkVTIImageIO.h.

◆ m_AppendedDataIsBase64

bool itk::VTIImageIO::m_AppendedDataIsBase64 { false }

private

Whether appended data uses base64 encoding (encoding="base64") vs raw (encoding="raw").

Definition at line 227 of file itkVTIImageIO.h.

◆ m_AppendedDataOffset

std::streampos itk::VTIImageIO::m_AppendedDataOffset { 0 }

private

Byte offset into the file where the appended data section begins (only relevant when m_DataEncoding == RawAppended).

Definition at line 214 of file itkVTIImageIO.h.

◆ m_AsciiDataContent

std::string itk::VTIImageIO::m_AsciiDataContent {}

private

Cached ASCII data text content captured by the expat parser when the active DataArray is in ASCII format. Empty otherwise.

Definition at line 206 of file itkVTIImageIO.h.

◆ m_Base64DataContent

std::string itk::VTIImageIO::m_Base64DataContent {}

private

Cached base64 data text content captured by the expat parser when the active DataArray is in base64 ("binary") format. Empty otherwise.

Definition at line 210 of file itkVTIImageIO.h.

◆ m_DataArrayOffset

SizeType itk::VTIImageIO::m_DataArrayOffset { 0 }

private

Offset within the appended data block for this DataArray (in bytes, not counting the leading block-size UInt32/UInt64).

Definition at line 218 of file itkVTIImageIO.h.

◆ m_DataEncoding

DataEncoding itk::VTIImageIO::m_DataEncoding { DataEncoding::Base64 }

private

Definition at line 202 of file itkVTIImageIO.h.

◆ m_HeaderTypeUInt64

bool itk::VTIImageIO::m_HeaderTypeUInt64 { false }

private

Whether the header uses 64-bit block-size integers (header_type="UInt64").

Definition at line 221 of file itkVTIImageIO.h.

◆ m_IsZLibCompressed

bool itk::VTIImageIO::m_IsZLibCompressed { false }

private

Whether the file uses zlib compression (compressor="vtkZLibDataCompressor").

Definition at line 224 of file itkVTIImageIO.h.

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

itkVTIImageIO.h

Detailed Description

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Types

Static Private Member Functions

Private Attributes

Additional Inherited Members

Member Typedef Documentation

◆ ConstPointer

◆ Pointer

◆ Self

◆ Superclass

Member Enumeration Documentation

◆ DataEncoding

Constructor & Destructor Documentation

◆ VTIImageIO()

◆ ~VTIImageIO()

Member Function Documentation

◆ CanReadFile()

◆ CanWriteFile()

◆ CreateAnother()

◆ DecodeBase64()

◆ DecompressZLib()

◆ EncodeBase64()

◆ GetNameOfClass()

◆ ITKComponentToVTKTypeString()

◆ New()

◆ PrintSelf()

◆ Read()

◆ ReadImageInformation()

◆ SwapBufferForByteOrder()

◆ TrimString()

◆ VTKTypeStringToITKComponent()

◆ Write()

◆ WriteImageInformation()

Member Data Documentation

◆ m_AppendedBase64Content

◆ m_AppendedDataIsBase64

◆ m_AppendedDataOffset

◆ m_AsciiDataContent

◆ m_Base64DataContent

◆ m_DataArrayOffset

◆ m_DataEncoding

◆ m_HeaderTypeUInt64

◆ m_IsZLibCompressed