ITK  5.2.0
Insight Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Private Types | Private Member Functions | Private Attributes | Static Private Attributes | List of all members

#include <itkVoxBoCUBImageIO.h>

+ Inheritance diagram for itk::VoxBoCUBImageIO:
+ Collaboration diagram for itk::VoxBoCUBImageIO:

Public Types

using Pointer = SmartPointer< Self >
 
using Self = VoxBoCUBImageIO
 
using Superclass = ImageIOBase
 
- Public Types inherited from itk::ImageIOBase
using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = ImageIOBase
 
using Superclass = LightProcessObject
 
using IndexValueType = ::itk::IndexValueType
 
using SizeValueType = ::itk::SizeValueType
 
using IOComponentEnum = itk::IOComponentEnum
 
using IOFileEnum = itk::IOFileEnum
 
using IOByteOrderEnum = itk::IOByteOrderEnum
 
using SizeType = ::itk::intmax_t
 
using BufferSizeType = ::itk::OffsetValueType
 
using ArrayOfExtensionsType = std::vector< std::string >
 
- 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 PrintSelf (std::ostream &os, Indent indent) const override
 
void Read (void *buffer) override
 
void ReadImageInformation () override
 
 VoxBoCUBImageIO ()
 
void Write (const void *buffer) override
 
void WriteImageInformation () override
 
 ~VoxBoCUBImageIO () override
 
- Public Member Functions inherited from itk::ImageIOBase
virtual void SetFileName (const char *_arg)
 
virtual const char * GetFileName () const
 
void SetNumberOfDimensions (unsigned int)
 
virtual unsigned int GetNumberOfDimensions () const
 
virtual void SetDimensions (unsigned int i, SizeValueType dim)
 
virtual SizeValueType GetDimensions (unsigned int i) const
 
virtual void SetOrigin (unsigned int i, double origin)
 
virtual double GetOrigin (unsigned int i) const
 
virtual void SetSpacing (unsigned int i, double spacing)
 
virtual double GetSpacing (unsigned int i) const
 
virtual void SetDirection (unsigned int i, const std::vector< double > &direction)
 
virtual void SetDirection (unsigned int i, const vnl_vector< double > &direction)
 
virtual std::vector< double > GetDirection (unsigned int i) const
 
virtual std::vector< double > GetDefaultDirection (unsigned int i) const
 
virtual void SetIORegion (ImageIORegion _arg)
 
virtual const ImageIORegionGetIORegion () const
 
virtual void SetPixelType (const ::itk::CommonEnums::IOPixel _arg)
 
virtual ::itk::CommonEnums::IOPixel GetPixelType () const
 
virtual void SetComponentType (const IOComponentEnum _arg)
 
virtual IOComponentEnum GetComponentType () const
 
virtual const std::type_info & GetComponentTypeInfo () 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 SetCompressionLevel (int _arg)
 
virtual int GetCompressionLevel () const
 
virtual void SetCompressor (std::string _c)
 
virtual const std::string & GetCompressor () const
 
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 bool GetIsReadAsScalarPlusPalette () const
 
virtual void SetFileType (const IOFileEnum _arg)
 
virtual IOFileEnum GetFileType () const
 
void SetFileTypeToASCII ()
 
void SetFileTypeToBinary ()
 
virtual void SetByteOrder (const IOByteOrderEnum _arg)
 
virtual IOByteOrderEnum GetByteOrder () const
 
void SetByteOrderToBigEndian ()
 
void SetByteOrderToLittleEndian ()
 
std::string GetFileTypeAsString (IOFileEnum) const
 
std::string GetByteOrderAsString (IOByteOrderEnum) const
 
virtual SizeType GetPixelStride () const
 
SizeType GetImageSizeInPixels () const
 
SizeType GetImageSizeInBytes () const
 
SizeType GetImageSizeInComponents () const
 
virtual unsigned int GetComponentSize () const
 
virtual bool CanStreamRead ()
 
virtual bool CanStreamWrite ()
 
virtual bool SupportsDimension (unsigned long dim)
 
virtual ImageIORegion GenerateStreamableReadRegionFromRequestedRegion (const ImageIORegion &requested) const
 
virtual unsigned int GetActualNumberOfSplitsForWriting (unsigned int numberOfRequestedSplits, const ImageIORegion &pasteRegion, const ImageIORegion &largestPossibleRegion)
 
virtual ImageIORegion GetSplitRegionForWriting (unsigned int ithPiece, unsigned int numberOfActualSplits, const ImageIORegion &pasteRegion, const ImageIORegion &largestPossibleRegion)
 
const ArrayOfExtensionsTypeGetSupportedReadExtensions () const
 
const ArrayOfExtensionsTypeGetSupportedWriteExtensions () const
 
template<typename TPixel >
void SetTypeInfo (const TPixel *)
 
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 > *)
 
- 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 SetProgress (float _arg)
 
virtual const float & GetProgress () const
 
void UpdateProgress (float amount)
 
virtual void UpdateOutputData ()
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *)
 
unsigned long AddObserver (const EventObject &event, Command *) const
 
unsigned long AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) 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 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
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 (IOComponentEnum)
 
static IOComponentEnum GetComponentTypeFromString (const std::string &typeString)
 
static std::string GetPixelTypeAsString (IOPixelEnum)
 
static IOPixelEnum 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 ()
 

Private Types

using InverseOrientationMap = std::map< OrientationFlags, std::string >
 
using OrientationFlags = SpatialOrientation::ValidCoordinateOrientationFlags
 
using OrientationMap = std::map< std::string, OrientationFlags >
 

Private Member Functions

bool CheckExtension (const char *, bool &isCompressed)
 
GenericCUBFileAdaptor * CreateReader (const char *filename)
 
GenericCUBFileAdaptor * CreateWriter (const char *filename)
 
void InitializeOrientationMap ()
 
void SwapBytesIfNecessary (void *buffer, BufferSizeType numberOfBytes)
 

Private Attributes

InverseOrientationMap m_InverseOrientationMap
 
OrientationMap m_OrientationMap
 
GenericCUBFileAdaptor * m_Reader
 
GenericCUBFileAdaptor * m_Writer
 

Static Private Attributes

static const char * m_VB_BYTEORDER
 
static const char * m_VB_BYTEORDER_LSB
 
static const char * m_VB_BYTEORDER_MSB
 
static const char * m_VB_DATATYPE
 
static const char * m_VB_DATATYPE_BYTE
 
static const char * m_VB_DATATYPE_DOUBLE
 
static const char * m_VB_DATATYPE_FLOAT
 
static const char * m_VB_DATATYPE_INT
 
static const char * m_VB_DIMENSIONS
 
static const char * m_VB_IDENTIFIER_FILETYPE
 
static const char * m_VB_IDENTIFIER_SYSTEM
 
static const char * m_VB_ORIENTATION
 
static const char * m_VB_ORIGIN
 
static const char * m_VB_SPACING
 

Additional Inherited Members

- Protected Member Functions inherited from itk::ImageIOBase
 ImageIOBase ()
 
 ~ImageIOBase () override
 
virtual const ImageRegionSplitterBaseGetImageRegionSplitter () const
 
virtual bool HasSupportedReadExtension (const char *fileName, bool ignoreCase=true)
 
virtual bool HasSupportedWriteExtension (const char *fileName, bool ignoreCase=true)
 
virtual void SetMaximumCompressionLevel (int)
 
virtual int GetMaximumCompressionLevel () const
 
virtual void InternalSetCompressor (const std::string &COMPRESSOR)
 
virtual void Reset (const bool freeDynamic=true)
 
void Resize (const unsigned int numDimensions, const unsigned int *dimensions)
 
virtual unsigned int GetPixelSize () const
 
void ComputeStrides ()
 
SizeType GetComponentStride () const
 
SizeType GetRowStride () const
 
SizeType GetSliceStride () const
 
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 WriteBufferAsASCII (std::ostream &os, const void *buffer, IOComponentEnum ctype, SizeType numberOfBytesToWrite)
 
virtual void ReadBufferAsASCII (std::istream &os, void *buffer, IOComponentEnum ctype, SizeType numberOfBytesToBeRead)
 
bool ReadBufferAsBinary (std::istream &os, void *buffer, SizeType numberOfBytesToBeRead)
 
void AddSupportedReadExtension (const char *extension)
 
void AddSupportedWriteExtension (const char *extension)
 
void SetSupportedReadExtensions (const ArrayOfExtensionsType &)
 
void SetSupportedWriteExtensions (const ArrayOfExtensionsType &)
 
virtual unsigned int GetActualNumberOfSplitsForWritingCanStreamWrite (unsigned int numberOfRequestedSplits, const ImageIORegion &pasteRegion) const
 
virtual ImageIORegion GetSplitRegionForWritingCanStreamWrite (unsigned int ithPiece, unsigned int numberOfActualSplits, const ImageIORegion &pasteRegion) const
 
- Protected Member Functions inherited from itk::LightProcessObject
 LightProcessObject ()
 
 ~LightProcessObject () override
 
virtual void GenerateData ()
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
 ~Object () override
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &time)
 
- 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 ()
 
- Protected Attributes inherited from itk::ImageIOBase
IOPixelEnum m_PixelType { IOPixelEnum::SCALAR }
 
IOComponentEnum m_ComponentType { IOComponentEnum::UNKNOWNCOMPONENTTYPE }
 
IOByteOrderEnum m_ByteOrder { IOByteOrderEnum::OrderNotApplicable }
 
IOFileEnum m_FileType { IOFileEnum::TypeNotApplicable }
 
bool m_Initialized
 
std::string m_FileName
 
unsigned int m_NumberOfComponents
 
unsigned int m_NumberOfDimensions { 0 }
 
bool m_UseCompression { false }
 
int m_CompressionLevel { 30 }
 
int m_MaximumCompressionLevel { 100 }
 
std::string m_Compressor { "uninitialized" }
 
bool m_UseStreamedReading
 
bool m_UseStreamedWriting
 
bool m_ExpandRGBPalette
 
bool m_IsReadAsScalarPlusPalette
 
bool m_WritePalette
 
ImageIORegion m_IORegion
 
std::vector< SizeValueTypem_Dimensions
 
std::vector< double > m_Spacing
 
std::vector< double > m_Origin
 
std::vector< std::vector< double > > m_Direction
 
std::vector< SizeTypem_Strides
 
- Protected Attributes inherited from itk::LightObject
std::atomic< int > m_ReferenceCount
 

Detailed Description

Read VoxBoCUBImage file format.

A generic reader and writer object for VoxBo files. Basically it provides uniform access to gzip and normal files

Author
Burstein, Pablo D.; Yushkevich, Paul; Gee, James C.

This implementation was contributed as a paper to the Insight Journal https://hdl.handle.net/1926/303

Definition at line 50 of file itkVoxBoCUBImageIO.h.

Member Typedef Documentation

◆ InverseOrientationMap

using itk::VoxBoCUBImageIO::InverseOrientationMap = std::map<OrientationFlags, std::string>
private

Definition at line 121 of file itkVoxBoCUBImageIO.h.

◆ OrientationFlags

Definition at line 119 of file itkVoxBoCUBImageIO.h.

◆ OrientationMap

using itk::VoxBoCUBImageIO::OrientationMap = std::map<std::string, OrientationFlags>
private

Definition at line 120 of file itkVoxBoCUBImageIO.h.

◆ Pointer

Definition at line 58 of file itkVoxBoCUBImageIO.h.

◆ Self

Standard class type aliases.

Definition at line 56 of file itkVoxBoCUBImageIO.h.

◆ Superclass

Definition at line 57 of file itkVoxBoCUBImageIO.h.

Constructor & Destructor Documentation

◆ VoxBoCUBImageIO()

itk::VoxBoCUBImageIO::VoxBoCUBImageIO ( )

◆ ~VoxBoCUBImageIO()

itk::VoxBoCUBImageIO::~VoxBoCUBImageIO ( )
override

Member Function Documentation

◆ CanReadFile()

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

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

Implements itk::ImageIOBase.

◆ CanWriteFile()

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

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

Implements itk::ImageIOBase.

◆ CheckExtension()

bool itk::VoxBoCUBImageIO::CheckExtension ( const char *  ,
bool &  isCompressed 
)
private

◆ CreateAnother()

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

◆ CreateReader()

GenericCUBFileAdaptor* itk::VoxBoCUBImageIO::CreateReader ( const char *  filename)
private

◆ CreateWriter()

GenericCUBFileAdaptor* itk::VoxBoCUBImageIO::CreateWriter ( const char *  filename)
private

◆ GetNameOfClass()

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

Run-time type information (and related methods).

Reimplemented from itk::ImageIOBase.

◆ InitializeOrientationMap()

void itk::VoxBoCUBImageIO::InitializeOrientationMap ( )
private

◆ New()

static Pointer itk::VoxBoCUBImageIO::New ( )
static

Method for creation through the object factory.

◆ PrintSelf()

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

Types for managing image size and image index components.

Reimplemented from itk::ImageIOBase.

◆ Read()

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

Reads the data from disk into the memory buffer provided.

Implements itk::ImageIOBase.

◆ ReadImageInformation()

void itk::VoxBoCUBImageIO::ReadImageInformation ( )
overridevirtual

Set the spacing and dimension information for the set filename.

Implements itk::ImageIOBase.

◆ SwapBytesIfNecessary()

void itk::VoxBoCUBImageIO::SwapBytesIfNecessary ( void *  buffer,
BufferSizeType  numberOfBytes 
)
private

◆ Write()

void itk::VoxBoCUBImageIO::Write ( const void *  buffer)
overridevirtual

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

Implements itk::ImageIOBase.

◆ WriteImageInformation()

void itk::VoxBoCUBImageIO::WriteImageInformation ( )
overridevirtual

Set the spacing and dimension information for the set filename.

Implements itk::ImageIOBase.

Member Data Documentation

◆ m_InverseOrientationMap

InverseOrientationMap itk::VoxBoCUBImageIO::m_InverseOrientationMap
private

Definition at line 124 of file itkVoxBoCUBImageIO.h.

◆ m_OrientationMap

OrientationMap itk::VoxBoCUBImageIO::m_OrientationMap
private

Definition at line 123 of file itkVoxBoCUBImageIO.h.

◆ m_Reader

GenericCUBFileAdaptor* itk::VoxBoCUBImageIO::m_Reader
private

Definition at line 112 of file itkVoxBoCUBImageIO.h.

◆ m_VB_BYTEORDER

const char* itk::VoxBoCUBImageIO::m_VB_BYTEORDER
staticprivate

Definition at line 137 of file itkVoxBoCUBImageIO.h.

◆ m_VB_BYTEORDER_LSB

const char* itk::VoxBoCUBImageIO::m_VB_BYTEORDER_LSB
staticprivate

Definition at line 140 of file itkVoxBoCUBImageIO.h.

◆ m_VB_BYTEORDER_MSB

const char* itk::VoxBoCUBImageIO::m_VB_BYTEORDER_MSB
staticprivate

Definition at line 139 of file itkVoxBoCUBImageIO.h.

◆ m_VB_DATATYPE

const char* itk::VoxBoCUBImageIO::m_VB_DATATYPE
staticprivate

Definition at line 136 of file itkVoxBoCUBImageIO.h.

◆ m_VB_DATATYPE_BYTE

const char* itk::VoxBoCUBImageIO::m_VB_DATATYPE_BYTE
staticprivate

Definition at line 141 of file itkVoxBoCUBImageIO.h.

◆ m_VB_DATATYPE_DOUBLE

const char* itk::VoxBoCUBImageIO::m_VB_DATATYPE_DOUBLE
staticprivate

Definition at line 144 of file itkVoxBoCUBImageIO.h.

◆ m_VB_DATATYPE_FLOAT

const char* itk::VoxBoCUBImageIO::m_VB_DATATYPE_FLOAT
staticprivate

Definition at line 143 of file itkVoxBoCUBImageIO.h.

◆ m_VB_DATATYPE_INT

const char* itk::VoxBoCUBImageIO::m_VB_DATATYPE_INT
staticprivate

Definition at line 142 of file itkVoxBoCUBImageIO.h.

◆ m_VB_DIMENSIONS

const char* itk::VoxBoCUBImageIO::m_VB_DIMENSIONS
staticprivate

Definition at line 133 of file itkVoxBoCUBImageIO.h.

◆ m_VB_IDENTIFIER_FILETYPE

const char* itk::VoxBoCUBImageIO::m_VB_IDENTIFIER_FILETYPE
staticprivate

Definition at line 132 of file itkVoxBoCUBImageIO.h.

◆ m_VB_IDENTIFIER_SYSTEM

const char* itk::VoxBoCUBImageIO::m_VB_IDENTIFIER_SYSTEM
staticprivate

Definition at line 131 of file itkVoxBoCUBImageIO.h.

◆ m_VB_ORIENTATION

const char* itk::VoxBoCUBImageIO::m_VB_ORIENTATION
staticprivate

Definition at line 138 of file itkVoxBoCUBImageIO.h.

◆ m_VB_ORIGIN

const char* itk::VoxBoCUBImageIO::m_VB_ORIGIN
staticprivate

Definition at line 135 of file itkVoxBoCUBImageIO.h.

◆ m_VB_SPACING

const char* itk::VoxBoCUBImageIO::m_VB_SPACING
staticprivate

Definition at line 134 of file itkVoxBoCUBImageIO.h.

◆ m_Writer

GenericCUBFileAdaptor * itk::VoxBoCUBImageIO::m_Writer
private

Definition at line 112 of file itkVoxBoCUBImageIO.h.


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