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

#include <itkGE5ImageIO.h>

+ Inheritance diagram for itk::GE5ImageIO:
+ Collaboration diagram for itk::GE5ImageIO:

Public Types

using Pointer = SmartPointer< Self >
 
using Self = GE5ImageIO
 
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
 
enum  IOPixelType {
  UNKNOWNPIXELTYPE,
  SCALAR,
  RGB,
  RGBA,
  OFFSET,
  VECTOR,
  POINT,
  COVARIANTVECTOR,
  SYMMETRICSECONDRANKTENSOR,
  DIFFUSIONTENSOR3D,
  COMPLEX,
  FIXEDARRAY,
  MATRIX
}
 
enum  IOComponentType {
  UNKNOWNCOMPONENTTYPE,
  UCHAR,
  CHAR,
  USHORT,
  SHORT,
  UINT,
  INT,
  ULONG,
  LONG,
  ULONGLONG,
  LONGLONG,
  FLOAT,
  DOUBLE
}
 
enum  FileType : uint8_t {
  ASCII,
  Binary,
  TypeNotApplicable
}
 
enum  ByteOrder : uint8_t {
  BigEndian,
  LittleEndian,
  OrderNotApplicable
}
 
using IndexValueType = ::itk::IndexValueType
 
using SizeValueType = ::itk::SizeValueType
 
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
 
void ModifyImageInformation () override
 
- Public Member Functions inherited from itk::IPLCommonImageIO
bool CanWriteFile (const char *FileNameToWrite) override
 
unsigned int GetComponentSize () const override
 
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 i) const
 
virtual void SetIORegion (ImageIORegion _arg)
 
virtual const ImageIORegionGetIORegion () const
 
virtual void SetPixelType (const IOPixelType _arg)
 
virtual IOPixelType GetPixelType () const
 
virtual void SetComponentType (const IOComponentType _arg)
 
virtual IOComponentType 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 FileType _arg)
 
virtual FileType GetFileType () const
 
void SetFileTypeToASCII ()
 
void SetFileTypeToBinary ()
 
virtual void SetByteOrder (const ByteOrder _arg)
 
virtual ByteOrder GetByteOrder () const
 
void SetByteOrderToBigEndian ()
 
void SetByteOrderToLittleEndian ()
 
std::string GetFileTypeAsString (FileType) const
 
std::string GetByteOrderAsString (ByteOrder) 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<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
 
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::IPLCommonImageIO
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

 GE5ImageIO ()
 
GEImageHeaderReadHeader (const char *FileNameToRead) override
 
 ~GE5ImageIO () 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, IOComponentType ctype, SizeType numberOfBytesToWrite)
 
virtual void ReadBufferAsASCII (std::istream &os, void *buffer, IOComponentType 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 ()
 

Private Member Functions

int CheckGE5xImages (char const *const imageFileTemplate, std::string &reason)
 

Additional Inherited Members

- Protected Attributes inherited from itk::IPLCommonImageIO
IPLFileNameList * m_FilenameList
 
GEImageHeaderm_ImageHeader
 
ImageIOBase::ByteOrder m_SystemByteOrder
 
- Protected Attributes inherited from itk::ImageIOBase
IOPixelType m_PixelType { SCALAR }
 
IOComponentType m_ComponentType { UNKNOWNCOMPONENTTYPE }
 
ByteOrder m_ByteOrder { OrderNotApplicable }
 
FileType m_FileType { 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 GE5 file format.

Author
Hans J. Johnson

Definition at line 50 of file itkGE5ImageIO.h.

Member Typedef Documentation

◆ Pointer

Definition at line 58 of file itkGE5ImageIO.h.

◆ Self

Standard class type aliases.

Definition at line 56 of file itkGE5ImageIO.h.

◆ Superclass

Definition at line 57 of file itkGE5ImageIO.h.

Constructor & Destructor Documentation

◆ GE5ImageIO()

itk::GE5ImageIO::GE5ImageIO ( )
protected

◆ ~GE5ImageIO()

itk::GE5ImageIO::~GE5ImageIO ( )
overrideprotected

Member Function Documentation

◆ CanReadFile()

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

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

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

Reimplemented from itk::IPLCommonImageIO.

◆ CheckGE5xImages()

int itk::GE5ImageIO::CheckGE5xImages ( char const *const  imageFileTemplate,
std::string &  reason 
)
private

◆ CreateAnother()

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

◆ GetNameOfClass()

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

Run-time type information (and related methods).

Reimplemented from itk::IPLCommonImageIO.

◆ ModifyImageInformation()

void itk::GE5ImageIO::ModifyImageInformation ( )
overridevirtual

Modify Origin and direction

Reimplemented from itk::IPLCommonImageIO.

◆ New()

static Pointer itk::GE5ImageIO::New ( )
static

Method for creation through the object factory.

◆ ReadHeader()

GEImageHeader* itk::GE5ImageIO::ReadHeader ( const char *  FileNameToRead)
overrideprotectedvirtual

Reimplemented from itk::IPLCommonImageIO.


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