Class that defines how to read HDF5 file format. HDF5 IMAGE FILE FORMAT - As much information as I can determine from sourceforge.net/projects/HDF5lib.
- Author
- Kent Williams
HDF5 paths for elements in file
- N is dimension of image
- \/ITKVersion ITK Library Version string
- \/HDFVersion HDF Version String
- \/ITKImage Root Image Group
- \/ITKImage\/<name> name is arbitrary, but to parallel Transform I/O keep an image in a subgroup. The idea is to parallel transform file structure.
- \/ITKImage\/<name>\/Origin N-D point double
- \/ITKImage\/<name>\/Directions N N-vectors double
- \/ITKImage\/<name>\/Spacing N-vector double
- \/ITKImage\/<name>\/Dimensions N-vector itk::SizeValueType
- \/ITKImage\/<name>\/VoxelType String representing voxel type. This can be inferred from the VoxelData type info, but it makes the file more user friendly with respect to HDF5 viewers.
- \/ITKImage\/<name>\/VoxelData multi-dim array of voxel data in the case of non-scalar voxel type, keep voxel components together, to make loading possible without
- \/ITKImage\/<name>\/MetaData Group for storing metadata from MetaDataDictionary
- \/ITKImage\/<name>\/MetaData\/<item-name> Dataset containing data for item-name in the MetaDataDictionary re-arrangement.
- Note
- HDF5's C++ API has no internal thread-safety, so this class serializes CanReadFile(), ReadImageInformation(), Read(), WriteImageInformation(), and Write() with an internal mutex. Other HDF5 consumers in ITK (e.g. HDF5TransformIO) are not covered by this lock.
Definition at line 90 of file itkHDF5ImageIO.h.
|
| bool | CanReadFile (const char *FileNameToRead) override |
| |
| bool | CanWriteFile (const char *name) 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 |
| |
| bool | CanStreamRead () override |
| |
| bool | CanStreamWrite () override |
| |
| ImageIORegion | GenerateStreamableReadRegionFromRequestedRegion (const ImageIORegion &requestedRegion) const override |
| |
| unsigned int | GetActualNumberOfSplitsForWriting (unsigned int numberOfRequestedSplits, const ImageIORegion &pasteRegion, const ImageIORegion &largestPossibleRegion) override |
| |
| 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) |
| |
| virtual void | AbortGenerateDataOff () |
| |
| virtual void | AbortGenerateDataOn () |
| |
| virtual::itk::LightObject::Pointer | CreateAnother () const |
| |
| 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 |
| |
| unsigned long | AddObserver (const EventObject &event, Command *cmd) const |
| |
| unsigned long | AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) const |
| |
| LightObject::Pointer | CreateAnother () const override |
| |
| 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 |
| |
| Pointer | Clone () const |
| |
| virtual void | Delete () |
| |
| virtual int | GetReferenceCount () const |
| |
| void | Print (std::ostream &os, Indent indent=0) const |
| |
|
| SizeType | GetHeaderSize () const override |
| |
| | HDF5ImageIO () |
| |
| void | PrintSelf (std::ostream &os, Indent indent) const override |
| |
| | ~HDF5ImageIO () override |
| |
| virtual SizeType | GetDataPosition () const |
| |
| void | PrintSelf (std::ostream &os, Indent indent) const override |
| |
| virtual bool | ReadBufferAsBinary (std::istream &is, void *buffer, SizeType num) |
| |
| virtual bool | RequestedToStream () const |
| |
| | StreamingImageIOBase () |
| |
| virtual bool | StreamReadBufferAsBinary (std::istream &file, void *_buffer) |
| |
| virtual bool | StreamWriteBufferAsBinary (std::ostream &file, const void *_buffer) |
| |
| virtual bool | WriteBufferAsBinary (std::ostream &os, const void *buffer, SizeType num) |
| |
| 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 |
| |
| virtual void | GenerateData () |
| |
| | LightProcessObject () |
| |
| | ~LightProcessObject () override |
| |
| | Object () |
| |
| bool | PrintObservers (std::ostream &os, Indent indent) const |
| |
| virtual void | SetTimeStamp (const TimeStamp &timeStamp) |
| |
| | ~Object () override |
| |
| 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 () |
| |
|
| std::vector< std::vector< double > > | ReadDirections (const std::string &path) |
| |
| template<typename TScalar> |
| TScalar | ReadScalar (const std::string &DataSetName) |
| |
| std::string | ReadString (const std::string &path) |
| |
| template<typename TScalar> |
| std::vector< TScalar > | ReadVector (const std::string &DataSetName) |
| |
| void | ResetToInitialState () |
| |
| void | SetupStreaming (H5::DataSpace *imageSpace, H5::DataSpace *slabSpace) |
| |
| template<typename TType> |
| void | StoreMetaData (MetaDataDictionary *metaDict, const std::string &HDFPath, const std::string &name, unsigned long numElements) |
| |
| void | WriteDirections (const std::string &path, const std::vector< std::vector< double > > &dir) |
| |
| template<typename TType> |
| bool | WriteMeta (const std::string &name, MetaDataObjectBase *metaObjBase) |
| |
| template<typename TType> |
| bool | WriteMetaArray (const std::string &name, MetaDataObjectBase *metaObjBase) |
| |
| void | WriteScalar (const std::string &path, const bool value) |
| |
| void | WriteScalar (const std::string &path, const long long value) |
| |
| void | WriteScalar (const std::string &path, const long value) |
| |
| template<typename TScalar> |
| void | WriteScalar (const std::string &path, const TScalar &value) |
| |
| void | WriteScalar (const std::string &path, const unsigned long long value) |
| |
| void | WriteScalar (const std::string &path, const unsigned long value) |
| |
| void | WriteString (const std::string &path, const char *s) |
| |
| void | WriteString (const std::string &path, const std::string &value) |
| |
| template<typename TScalar> |
| void | WriteVector (const std::string &path, const std::vector< TScalar > &vec) |
| |