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

#include <itkGiftiMeshIO.h>

+ Inheritance diagram for itk::GiftiMeshIO:
+ Collaboration diagram for itk::GiftiMeshIO:

Public Types

using ConstPointer = SmartPointer< const Self >
 
using DirectionType = Matrix< double, 4, 4 >
 
using LabelColorContainer = MapContainer< int, RGBAPixelType >
 
using LabelColorContainerPointer = LabelColorContainer::Pointer
 
using LabelNameContainer = MapContainer< int, std::string >
 
using LabelNameContainerPointer = LabelNameContainer::Pointer
 
using Pointer = SmartPointer< Self >
 
using RGBAPixelType = RGBAPixel< float >
 
using Self = GiftiMeshIO
 
using SizeValueType = Superclass::SizeValueType
 
using Superclass = MeshIOBase
 
- Public Types inherited from itk::MeshIOBase
using ArrayOfExtensionsType = std::vector< std::string >
 
using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = MeshIOBase
 
using SizeValueType = IdentifierType
 
using StreamOffsetType = std::streamoff
 
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 *FileNameToRead) override
 
bool CanWriteFile (const char *FileNameToWrite) override
 
virtual ::itk::LightObject::Pointer CreateAnother () const
 
virtual const DirectionTypeGetDirection () const
 
LabelColorContainerPointer GetLabelColorTable ()
 
LabelNameContainerPointer GetLabelNameTable ()
 
virtual const char * GetNameOfClass () const
 
virtual bool GetReadPointData () const
 
void ReadCellData (void *buffer) override
 
void ReadCells (void *buffer) override
 
void ReadMeshInformation () override
 
void ReadPointData (void *buffer) override
 
virtual void ReadPointDataOff ()
 
virtual void ReadPointDataOn ()
 
void ReadPoints (void *buffer) override
 
void SetDirection (const DirectionType &direction)
 
void SetLabelColorTable (const LabelColorContainer *colorMap)
 
void SetLabelNameTable (const LabelNameContainer *labelMap)
 
virtual void SetReadPointData (bool _arg)
 
void Write () override
 
void WriteCellData (void *buffer) override
 
void WriteCells (void *buffer) override
 
void WriteMeshInformation () override
 
void WritePointData (void *buffer) override
 
void WritePoints (void *buffer) override
 
- Public Member Functions inherited from itk::MeshIOBase
virtual void SetFileName (const char *_arg)
 
virtual const char * GetFileName () const
 
virtual void SetPointPixelType (const ::itk::CommonEnums::IOPixel _arg)
 
virtual ::itk::CommonEnums::IOPixel GetPointPixelType () const
 
virtual void SetCellPixelType (const ::itk::CommonEnums::IOPixel _arg)
 
virtual ::itk::CommonEnums::IOPixel GetCellPixelType () const
 
virtual void SetPointComponentType (const ::itk::CommonEnums::IOComponent _arg)
 
virtual ::itk::CommonEnums::IOComponent GetPointComponentType () const
 
virtual void SetCellComponentType (const ::itk::CommonEnums::IOComponent _arg)
 
virtual ::itk::CommonEnums::IOComponent GetCellComponentType () const
 
virtual void SetPointPixelComponentType (const ::itk::CommonEnums::IOComponent _arg)
 
virtual ::itk::CommonEnums::IOComponent GetPointPixelComponentType () const
 
virtual void SetCellPixelComponentType (const ::itk::CommonEnums::IOComponent _arg)
 
virtual ::itk::CommonEnums::IOComponent GetCellPixelComponentType () const
 
template<typename T >
void SetPixelType (const T &, bool UsePointPixel=true)
 
template<typename T >
void SetPixelType (const RGBPixel< T > &, bool UsePointPixel=true)
 
template<typename T >
void SetPixelType (const RGBAPixel< T > &, bool UsePointPixel=true)
 
template<typename T , unsigned int VLength>
void SetPixelType (const Vector< T, VLength > &, bool UsePointPixel=true)
 
template<typename T , unsigned int VLength>
void SetPixelType (const CovariantVector< T, VLength > &, bool UsePointPixel=true)
 
template<typename T , unsigned int VLength>
void SetPixelType (const FixedArray< T, VLength > &, bool UsePointPixel=true)
 
template<typename T , unsigned int VLength>
void SetPixelType (const SymmetricSecondRankTensor< T, VLength >, bool UsePointPixel=true)
 
template<typename T >
void SetPixelType (const DiffusionTensor3D< T > &, bool UsePointPixel=true)
 
template<typename T , unsigned int NR, unsigned int NC>
void SetPixelType (const Matrix< T, NR, NC > &, bool UsePointPixel=true)
 
template<typename T >
void SetPixelType (const std::complex< T > &, bool UsePointPixel=true)
 
template<typename T >
void SetPixelType (const Array< T > &array, bool UsePointPixel=true)
 
template<typename T >
void SetPixelType (const VariableLengthVector< T > &vector, bool UsePointPixel=true)
 
template<typename T >
void SetPixelType (const VariableSizeMatrix< T > &matrix, bool UsePointPixel=true)
 
virtual void SetNumberOfPointPixelComponents (unsigned int _arg)
 
virtual unsigned int GetNumberOfPointPixelComponents () const
 
virtual void SetNumberOfCellPixelComponents (unsigned int _arg)
 
virtual unsigned int GetNumberOfCellPixelComponents () const
 
virtual void SetPointDimension (unsigned int _arg)
 
virtual unsigned int GetPointDimension () const
 
virtual void SetNumberOfPoints (SizeValueType _arg)
 
virtual SizeValueType GetNumberOfPoints () const
 
virtual void SetNumberOfCells (SizeValueType _arg)
 
virtual SizeValueType GetNumberOfCells () const
 
virtual void SetNumberOfPointPixels (SizeValueType _arg)
 
virtual SizeValueType GetNumberOfPointPixels () const
 
virtual void SetNumberOfCellPixels (SizeValueType _arg)
 
virtual SizeValueType GetNumberOfCellPixels () const
 
virtual void SetCellBufferSize (SizeValueType _arg)
 
virtual SizeValueType GetCellBufferSize () const
 
virtual void SetUpdatePoints (bool _arg)
 
virtual bool GetUpdatePoints () const
 
virtual void SetUpdateCells (bool _arg)
 
virtual bool GetUpdateCells () const
 
virtual void SetUpdatePointData (bool _arg)
 
virtual bool GetUpdatePointData () const
 
virtual void SetUpdateCellData (bool _arg)
 
virtual bool GetUpdateCellData () const
 
unsigned int GetComponentSize (IOComponentEnum componentType) const
 
std::string GetComponentTypeAsString (IOComponentEnum) const
 
std::string GetPixelTypeAsString (IOPixelEnum) 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 ()
 
virtual void SetUseCompression (bool _arg)
 
virtual bool GetUseCompression () const
 
virtual void UseCompressionOn ()
 
virtual void UseCompressionOff ()
 
std::string GetFileTypeAsString (IOFileEnum) const
 
std::string GetByteOrderAsString (IOByteOrderEnum) const
 
const ArrayOfExtensionsTypeGetSupportedReadExtensions () const
 
const ArrayOfExtensionsTypeGetSupportedWriteExtensions () const
 
- 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
 
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::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

template<typename TInput , typename TOutput >
void ConvertBuffer (TInput *input, TOutput *output, SizeValueType numberOfElements)
 
 GiftiMeshIO ()
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
 ~GiftiMeshIO () override
 
- Protected Member Functions inherited from itk::MeshIOBase
 MeshIOBase ()
 
 ~MeshIOBase () override=default
 
void AddSupportedReadExtension (const char *extension)
 
void AddSupportedWriteExtension (const char *extension)
 
template<typename T >
void ReadBufferAsAscii (T *buffer, std::ifstream &inputFile, SizeValueType numberOfComponents)
 
template<typename T >
void ReadBufferAsBinary (T *buffer, std::ifstream &inputFile, SizeValueType numberOfComponents)
 
template<typename T >
void WriteBufferAsAscii (T *buffer, std::ofstream &outputFile, SizeValueType numberOfLines, SizeValueType numberOfComponents)
 
template<typename TOutput , typename TInput >
void WriteBufferAsBinary (TInput *buffer, std::ofstream &outputFile, SizeValueType numberOfComponents)
 
template<typename TInput , typename TOutput >
void ReadCellsBuffer (TInput *input, TOutput *output)
 
template<typename TInput , typename TOutput >
void ReadCellsBuffer (TInput *input, TOutput *output, CellGeometryEnum type)
 
template<typename TInput , typename TOutput >
void WriteCellsBuffer (TInput *input, TOutput *output, CellGeometryEnum cellType, unsigned int numberOfPoints, SizeValueType numberOfCells)
 
template<typename TInput , typename TOutput >
void WriteCellsBuffer (TInput *input, TOutput *output, CellGeometryEnum cellType, SizeValueType numberOfCells)
 
- 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 ()
 

Private Attributes

DirectionType m_Direction
 
GiftiImageProxy & m_GiftiImage
 
const std::unique_ptr< GiftiImageProxy > m_GiftiImageHolder
 
bool m_ReadPointData
 

Additional Inherited Members

- Protected Attributes inherited from itk::MeshIOBase
IOByteOrderEnum m_ByteOrder { IOByteOrderEnum::OrderNotApplicable }
 
IOFileEnum m_FileType { IOFileEnum::ASCII }
 
std::string m_FileName
 
bool m_UseCompression { false }
 
IOComponentEnum m_PointComponentType { IOComponentEnum::UNKNOWNCOMPONENTTYPE }
 
IOComponentEnum m_CellComponentType { IOComponentEnum::UNKNOWNCOMPONENTTYPE }
 
IOComponentEnum m_PointPixelComponentType { IOComponentEnum::UNKNOWNCOMPONENTTYPE }
 
IOComponentEnum m_CellPixelComponentType { IOComponentEnum::UNKNOWNCOMPONENTTYPE }
 
IOPixelEnum m_PointPixelType { IOPixelEnum::SCALAR }
 
IOPixelEnum m_CellPixelType { IOPixelEnum::SCALAR }
 
unsigned int m_NumberOfPointPixelComponents { 0 }
 
unsigned int m_NumberOfCellPixelComponents { 0 }
 
unsigned int m_PointDimension { 3 }
 
SizeValueType m_NumberOfPoints
 
SizeValueType m_NumberOfCells
 
SizeValueType m_NumberOfPointPixels
 
SizeValueType m_NumberOfCellPixels
 
SizeValueType m_CellBufferSize
 
bool m_UpdatePoints { false }
 
bool m_UpdateCells { false }
 
bool m_UpdatePointData { false }
 
bool m_UpdateCellData { false }
 
- Protected Attributes inherited from itk::LightObject
std::atomic< int > m_ReferenceCount
 

Detailed Description

This class defines how to read and write Gifti file format.

Definition at line 39 of file itkGiftiMeshIO.h.

Member Typedef Documentation

◆ ConstPointer

Definition at line 47 of file itkGiftiMeshIO.h.

◆ DirectionType

using itk::GiftiMeshIO::DirectionType = Matrix<double, 4, 4>

Definition at line 51 of file itkGiftiMeshIO.h.

◆ LabelColorContainer

Definition at line 53 of file itkGiftiMeshIO.h.

◆ LabelColorContainerPointer

Definition at line 55 of file itkGiftiMeshIO.h.

◆ LabelNameContainer

Definition at line 54 of file itkGiftiMeshIO.h.

◆ LabelNameContainerPointer

Definition at line 56 of file itkGiftiMeshIO.h.

◆ Pointer

Definition at line 48 of file itkGiftiMeshIO.h.

◆ RGBAPixelType

Definition at line 52 of file itkGiftiMeshIO.h.

◆ Self

Standard class type aliases.

Definition at line 45 of file itkGiftiMeshIO.h.

◆ SizeValueType

using itk::GiftiMeshIO::SizeValueType = Superclass::SizeValueType

Definition at line 50 of file itkGiftiMeshIO.h.

◆ Superclass

Definition at line 46 of file itkGiftiMeshIO.h.

Constructor & Destructor Documentation

◆ GiftiMeshIO()

itk::GiftiMeshIO::GiftiMeshIO ( )
protected

◆ ~GiftiMeshIO()

itk::GiftiMeshIO::~GiftiMeshIO ( )
overrideprotected

Member Function Documentation

◆ CanReadFile()

bool itk::GiftiMeshIO::CanReadFile ( const char *  FileNameToRead)
overridevirtual

Determine if the file can be read with this MeshIO implementation.

Parameters
FileNameToReadThe name of the file to test for reading.
Postcondition
Sets classes MeshIOBase::m_FileName variable to be FileNameToWrite
Returns
Returns true if this MeshIO can read the file specified.

Implements itk::MeshIOBase.

◆ CanWriteFile()

bool itk::GiftiMeshIO::CanWriteFile ( const char *  FileNameToWrite)
overridevirtual

Determine if the file can be written with this MeshIO implementation.

Parameters
FileNameToWriteThe name of the file to test for writing.
Postcondition
Sets classes MeshIOBase::m_FileName variable to be FileNameToWrite
Returns
Returns true if this MeshIO can write the file specified.

Implements itk::MeshIOBase.

◆ ConvertBuffer()

template<typename TInput , typename TOutput >
void itk::GiftiMeshIO::ConvertBuffer ( TInput *  input,
TOutput *  output,
SizeValueType  numberOfElements 
)
inlineprotected

Definition at line 149 of file itkGiftiMeshIO.h.

◆ CreateAnother()

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

◆ GetDirection()

virtual const DirectionType& itk::GiftiMeshIO::GetDirection ( ) const
virtual

◆ GetLabelColorTable()

LabelColorContainerPointer itk::GiftiMeshIO::GetLabelColorTable ( )

◆ GetLabelNameTable()

LabelNameContainerPointer itk::GiftiMeshIO::GetLabelNameTable ( )

◆ GetNameOfClass()

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

Run-time type information (and related methods).

Reimplemented from itk::MeshIOBase.

◆ GetReadPointData()

virtual bool itk::GiftiMeshIO::GetReadPointData ( ) const
virtual

◆ New()

static Pointer itk::GiftiMeshIO::New ( )
static

Method for creation through the object factory.

◆ PrintSelf()

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

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

Reimplemented from itk::MeshIOBase.

◆ ReadCellData()

void itk::GiftiMeshIO::ReadCellData ( void *  buffer)
overridevirtual

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

Implements itk::MeshIOBase.

◆ ReadCells()

void itk::GiftiMeshIO::ReadCells ( void *  buffer)
overridevirtual

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

Implements itk::MeshIOBase.

◆ ReadMeshInformation()

void itk::GiftiMeshIO::ReadMeshInformation ( )
overridevirtual

Set the spacing and dimension information for the set filename.

Implements itk::MeshIOBase.

◆ ReadPointData()

void itk::GiftiMeshIO::ReadPointData ( void *  buffer)
overridevirtual

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

Implements itk::MeshIOBase.

◆ ReadPointDataOff()

virtual void itk::GiftiMeshIO::ReadPointDataOff ( )
virtual

◆ ReadPointDataOn()

virtual void itk::GiftiMeshIO::ReadPointDataOn ( )
virtual

◆ ReadPoints()

void itk::GiftiMeshIO::ReadPoints ( void *  buffer)
overridevirtual

Reads the data from disk into the memory buffer provided.

Implements itk::MeshIOBase.

◆ SetDirection()

void itk::GiftiMeshIO::SetDirection ( const DirectionType direction)

◆ SetLabelColorTable()

void itk::GiftiMeshIO::SetLabelColorTable ( const LabelColorContainer colorMap)

◆ SetLabelNameTable()

void itk::GiftiMeshIO::SetLabelNameTable ( const LabelNameContainer labelMap)

◆ SetReadPointData()

virtual void itk::GiftiMeshIO::SetReadPointData ( bool  _arg)
virtual

◆ Write()

void itk::GiftiMeshIO::Write ( )
overridevirtual

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

Implements itk::MeshIOBase.

◆ WriteCellData()

void itk::GiftiMeshIO::WriteCellData ( void *  buffer)
overridevirtual

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

Implements itk::MeshIOBase.

◆ WriteCells()

void itk::GiftiMeshIO::WriteCells ( void *  buffer)
overridevirtual

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

Implements itk::MeshIOBase.

◆ WriteMeshInformation()

void itk::GiftiMeshIO::WriteMeshInformation ( )
overridevirtual

Set the spacing and dimension information for the set filename.

Implements itk::MeshIOBase.

◆ WritePointData()

void itk::GiftiMeshIO::WritePointData ( void *  buffer)
overridevirtual

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

Implements itk::MeshIOBase.

◆ WritePoints()

void itk::GiftiMeshIO::WritePoints ( void *  buffer)
overridevirtual

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

Implements itk::MeshIOBase.

Member Data Documentation

◆ m_Direction

DirectionType itk::GiftiMeshIO::m_Direction
private

Definition at line 172 of file itkGiftiMeshIO.h.

◆ m_GiftiImage

GiftiImageProxy& itk::GiftiMeshIO::m_GiftiImage
private

Definition at line 169 of file itkGiftiMeshIO.h.

◆ m_GiftiImageHolder

const std::unique_ptr<GiftiImageProxy> itk::GiftiMeshIO::m_GiftiImageHolder
private

Definition at line 163 of file itkGiftiMeshIO.h.

◆ m_ReadPointData

bool itk::GiftiMeshIO::m_ReadPointData
private

Definition at line 171 of file itkGiftiMeshIO.h.


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