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

#include <itkGE4ImageIO.h>

+ Inheritance diagram for itk::GE4ImageIO:
+ Collaboration diagram for itk::GE4ImageIO:

Public Types

using Pointer = SmartPointer< Self >
using Self = GE4ImageIO
using Superclass = IPLCommonImageIO
- Public Types inherited from itk::IPLCommonImageIO
using F32 = float
using F64 = double
using Pointer = SmartPointer< Self >
using S16 = signed short
using S32 = signed int
using S64 = int64_t
using S8 = signed char
using Self = IPLCommonImageIO
using Superclass = ImageIOBase
using U16 = unsigned short
using U32 = unsigned int
using U64 = uint64_t
using U8 = unsigned char
- 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 *FileNameToRead) override
virtual ::itk::LightObject::Pointer CreateAnother () const
virtual const char * GetNameOfClass () const
- Public Member Functions inherited from itk::IPLCommonImageIO
bool CanWriteFile (const char *FileNameToWrite) override
unsigned int GetComponentSize () const override
virtual void ModifyImageInformation ()
void Read (void *buffer) override
void ReadImageInformation () override
virtual void SortImageListByNameAscend ()
virtual void SortImageListByNameDescend ()
void Write (const void *buffer) override
void WriteImageInformation () 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 k) 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 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<unsigned VLength>
void SetPixelTypeInfo (const Offset< VLength > *)
template<typename TPixel , unsigned VLength>
void SetPixelTypeInfo (const Vector< TPixel, VLength > *)
template<typename TCoordRep , unsigned NPointDimension>
void SetPixelTypeInfo (const Point< TCoordRep, NPointDimension > *)
template<typename TPixel , unsigned VLength>
void SetPixelTypeInfo (const CovariantVector< TPixel, VLength > *)
template<typename TPixel , unsigned VLength>
void SetPixelTypeInfo (const SymmetricSecondRankTensor< TPixel, VLength > *)
template<typename TPixel >
void SetPixelTypeInfo (const DiffusionTensor3D< TPixel > *)
template<typename TPixel >
void SetPixelTypeInfo (const std::complex< TPixel > *)
template<typename TPixel , unsigned VLength>
void SetPixelTypeInfo (const FixedArray< TPixel, VLength > *)
template<typename TPixel >
void SetPixelTypeInfo (const VariableLengthVector< TPixel > *)
template<typename TValue >
void SetPixelTypeInfo (const Array< TValue > *)
template<typename TPixel , unsigned VLength>
void SetPixelTypeInfo (const Matrix< TPixel, VLength, VLength > *)
template<typename TValue >
void SetPixelTypeInfo (const VariableSizeMatrix< TValue > *)
- 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
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 Public Member Functions inherited from itk::IPLCommonImageIO
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 val)
- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()
static Pointer New ()

Protected Member Functions

 GE4ImageIO ()
GEImageHeaderReadHeader (const char *FileNameToRead) override
 ~GE4ImageIO () override
- Protected Member Functions inherited from itk::IPLCommonImageIO
int AddElementToList (char const *const filename, const float sliceLocation, const int offset, const int XDim, const int YDim, const float XRes, const float YRes, const int Key1, const int Key2)
int GetDoubleAt (std::ifstream &f, std::streamoff Offset, double *ip, bool throw_exception=true)
int GetFloatAt (std::ifstream &f, std::streamoff Offset, float *ip, bool throw_exception=true)
int GetIntAt (std::ifstream &f, std::streamoff Offset, int *ip, bool throw_exception=true)
int GetShortAt (std::ifstream &f, std::streamoff Offset, short *ip, bool throw_exception=true)
int GetStringAt (std::ifstream &f, std::streamoff Offset, char *buf, vcl_size_t amount, bool throw_exception=true)
double hdr2Double (char *hdr)
float hdr2Float (char *hdr)
int hdr2Int (char *hdr)
short hdr2Short (char *hdr)
 IPLCommonImageIO ()
void PrintSelf (std::ostream &os, Indent indent) const override
void sortImageListAscend ()
void sortImageListDescend ()
int statTimeToAscii (void *clock, char *timeString, int len)
 ~IPLCommonImageIO () override
- 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 numComp)
virtual void ReadBufferAsASCII (std::istream &is, void *buffer, IOComponentEnum ctype, SizeType numComp)
bool ReadBufferAsBinary (std::istream &is, void *buffer, SizeType num)
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 &timeStamp)
- 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

float MvtSunf (int numb)

Additional Inherited Members

- Protected Attributes inherited from itk::IPLCommonImageIO
IPLFileNameList * m_FilenameList
IOByteOrderEnum m_SystemByteOrder
- 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

Class that defines how to read GE4 file format.

Hans J. Johnson

Definition at line 59 of file itkGE4ImageIO.h.

Member Typedef Documentation

◆ Pointer

Definition at line 67 of file itkGE4ImageIO.h.

◆ Self

Standard class type aliases.

Definition at line 65 of file itkGE4ImageIO.h.

◆ Superclass

Definition at line 66 of file itkGE4ImageIO.h.

Constructor & Destructor Documentation

◆ GE4ImageIO()

itk::GE4ImageIO::GE4ImageIO ( )

Set the spacing and dimension information for the set filename. Get the type of the pixel.
Reads the data from disk into the memory buffer provided. Compute the size (in bytes) of the components of a pixel. For example, and RGB pixel of unsigned char would have a component size of 1 byte.

◆ ~GE4ImageIO()

itk::GE4ImageIO::~GE4ImageIO ( )

Member Function Documentation

◆ CanReadFile()

bool itk::GE4ImageIO::CanReadFile ( const char *  FileNameToRead)

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

Hans J Johnson
FileNameToReadThe name of the file to test for reading.
Sets classes ImageIOBase::m_FileName variable to be FileNameToWrite
Returns true if this ImageIO can read the file specified.

Reimplemented from itk::IPLCommonImageIO.

◆ CreateAnother()

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

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

◆ GetNameOfClass()

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

Run-time type information (and related methods).

Reimplemented from itk::IPLCommonImageIO.

◆ MvtSunf()

float itk::GE4ImageIO::MvtSunf ( int  numb)

◆ New()

static Pointer itk::GE4ImageIO::New ( )

Method for creation through the object factory.

◆ ReadHeader()

GEImageHeader* itk::GE4ImageIO::ReadHeader ( const char *  FileNameToRead)

Reimplemented from itk::IPLCommonImageIO.

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