vtkHDFUtilities.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
// SPDX-License-Identifier: BSD-3-Clause
#ifndef vtkHDFUtilities_h
#define vtkHDFUtilities_h

#include "vtkDataArray.h"
#include "vtkDataObject.h"
#include "vtkDeprecation.h" // For VTK_DEPRECATED_IN_9_7_0 VTK_DEPRECATED_IN_9_6_0
#include "vtkIOHDFModule.h" // For export macro
#include "vtkStringArray.h"
#include "vtkType.h"
#include "vtk_hdf5.h"

#include <array>
#include <string>
#include <vector>

VTK_ABI_NAMESPACE_BEGIN

#if VTK_ID_TYPE_IMPL == VTK_LONG_LONG
#define VTK_ID_H5T H5T_NATIVE_LLONG
#elif VTK_ID_TYPE_IMPL == VTK_LONG
#define VTK_ID_H5T H5T_NATIVE_LONG
#elif VTK_ID_TYPE_IMPL == VTK_INT
#define VTK_ID_H5T H5T_NATIVE_INT
#else
#error "No HDF5 type available for vtkIdType"
#endif

class vtkMemoryResourceStream;

namespace vtkHDFUtilities
{
const std::string VTKHDF_ROOT_PATH = "/VTKHDF";

/*
 * The number of PolyData topologies saved in vtkHDF format
 */
constexpr std::size_t NUM_POLY_DATA_TOPOS = 4;

/*
 * A vector of the topology names that are saved in vtkHDF
 * Can be used for the name of the HDF group only
 */
const std::vector<std::string> POLY_DATA_TOPOS{ "Vertices", "Lines", "Polygons", "Strips" };

/*
 * Attribute tag used in the cache storage to indicate arrays related to the geometry of the data
 * set and not fields of the data set
 */
constexpr int GEOMETRY_ATTRIBUTE_TAG = -42;

/*
 * How many attribute types we have. This returns 3: point, cell and field
 * attribute types.
 */
VTKIOHDF_EXPORT std::vector<int> GetAttributeTypes();

VTKIOHDF_EXPORT bool ReadDataSetType(hid_t groupID, int& dataSetType);

/*
 * Make sure we replace any illegal characters in the objectName (slash, dot) by an underscore, as
 * they would create a HDF5 subgroup.
 */
VTKIOHDF_EXPORT void MakeObjectNameValid(std::string& objectName);

/*
 * Returns the id to a HDF datatype (H5T) from a VTK datatype
 * Returns H5I_INVALID_HID if no corresponding type is found
 */
VTKIOHDF_EXPORT hid_t getH5TypeFromVtkType(int dataType);

/*
 * @struct TemporalGeometryOffsets
 * @brief Use to get the offsets for temporal vtkHDF.
 *
 * To use it, create an object using the templated constructor of this struct.
 * It will fill the object with data that can be then retrieved.
 */
struct VTKIOHDF_EXPORT TemporalGeometryOffsets
{
public:
  TemporalGeometryOffsets();

  VTK_DEPRECATED_IN_9_6_0("Member is deprecated. Please use GetOffsets instead.")
  bool Success = true;

  vtkIdType PartOffset = 0;
  vtkIdType PointOffset = 0;
  std::vector<vtkIdType> CellOffsets;
  std::vector<vtkIdType> ConnectivityOffsets;

  // Polyhedron
  vtkIdType FaceConnectivityOffset = 0;
  vtkIdType PolyhedronToFaceIdOffset = 0;
  vtkIdType FaceOffset = 0;
  bool HasPolyhedron = false;

  template <class T>
  bool GetOffsets(T* impl, vtkIdType step);
};

/*
 * Offsets for temporalHyperTreeGrid
 */
struct VTKIOHDF_EXPORT TemporalHyperTreeGridOffsets
{
public:
  bool Success = true;
  vtkIdType TreeIdsOffset = 0;
  vtkIdType DepthPerTreeOffset = 0;
  vtkIdType NumberOfCellsPerTreeDepthOffset = 0;
  vtkIdType DescriptorsOffset = 0;
  vtkIdType MaskOffset = 0;
  vtkIdType XCoordinatesOffset = 0;
  vtkIdType YCoordinatesOffset = 0;
  vtkIdType ZCoordinatesOffset = 0;
  vtkIdType PartOffset = 0;

  template <class T>
  TemporalHyperTreeGridOffsets(T* impl, vtkIdType step);
};

VTK_DEPRECATED_IN_9_7_0("Deprecated. Please use the version with quiet arg.")
VTKIOHDF_EXPORT bool Open(const char* fileName, hid_t& fileID);

VTKIOHDF_EXPORT bool Open(const char* fileName, hid_t& fileID, bool quiet);

VTK_DEPRECATED_IN_9_7_0("Deprecated. Please use the version with quiet arg.")
VTKIOHDF_EXPORT bool Open(vtkMemoryResourceStream* stream, hid_t& fileImageID);

VTKIOHDF_EXPORT bool Open(vtkMemoryResourceStream* stream, hid_t& fileImageID, bool quiet);

template <typename T>
VTKIOHDF_EXPORT hid_t TemplateTypeToHdfNativeType();

template <typename T>
VTKIOHDF_EXPORT bool GetAttribute(
  hid_t group, const char* attributeName, size_t numberOfElements, T* value);

VTKIOHDF_EXPORT bool GetStringAttribute(
  hid_t groupID, const std::string& name, std::string& attribute);

VTKIOHDF_EXPORT std::size_t GetNumberOfSteps(hid_t groupID);

VTKIOHDF_EXPORT std::vector<hsize_t> GetDimensions(hid_t fileID, const char* datasetName);


VTKIOHDF_EXPORT bool RetrieveHDFInformation(hid_t& rootID, const std::string& rootName,
  const std::string& groupPrefix, hid_t& groupID, std::array<int, 2>& version, int& dataSetType,
  int& numberOfPieces, std::map<int, hid_t>& attributeDataGroup);
VTK_DEPRECATED_IN_9_7_0("Deprecated. Please use the groupPrefix version instead.")
VTKIOHDF_EXPORT bool RetrieveHDFInformation(hid_t& fileID, hid_t& groupID,
  const std::string& rootName, std::array<int, 2>& version, int& dataSetType, int& numberOfPieces,
  std::array<hid_t, 3>& attributeDataGroup);
VTK_DEPRECATED_IN_9_7_0("Deprecated. Please use the std::map version instead.")
VTKIOHDF_EXPORT bool RetrieveHDFInformation(hid_t& rootID, const std::string& rootName,
  const std::string& groupPrefix, hid_t& groupID, std::array<int, 2>& version, int& dataSetType,
  int& numberOfPieces, std::array<hid_t, 3>& attributeDataGroup);

VTKIOHDF_EXPORT herr_t FileInfoCallBack(
  hid_t loc_id, const char* name, const H5L_info_t* info, void* opdata);


VTK_DEPRECATED_IN_9_7_0("Deprecated. Please use the std::map version instead.")
VTKIOHDF_EXPORT std::vector<std::string> GetArrayNames(
  const std::array<hid_t, 3>& attributeDataGroup, int attributeType);
VTKIOHDF_EXPORT std::vector<std::string> GetArrayNames(
  const std::map<int, hid_t>& attributeDataGroup, int attributeType);

VTKIOHDF_EXPORT std::vector<std::string> GetOrderedChildrenOfGroup(
  hid_t groupID, const std::string& path);

VTKIOHDF_EXPORT hid_t OpenDataSet(
  hid_t group, const char* name, hid_t* nativeType, std::vector<hsize_t>& dims);


VTKIOHDF_EXPORT vtkDataArray* NewArrayForGroup(hid_t dataset, hid_t nativeType,
  const std::vector<hsize_t>& dims, const std::vector<hsize_t>& parameterExtent);
VTKIOHDF_EXPORT vtkDataArray* NewArrayForGroup(
  hid_t group, const char* name, const std::vector<hsize_t>& parameterExtent);

VTKIOHDF_EXPORT std::vector<vtkIdType> GetMetadata(
  hid_t group, const char* name, hsize_t size, hsize_t offset);

VTKIOHDF_EXPORT std::array<vtkIdType, 2> GetFieldArraySize(
  hid_t group, vtkIdType step, std::string name);

VTKIOHDF_EXPORT vtkIdType GetArrayOffset(
  hid_t group, vtkIdType step, int attributeType, std::string name);


VTK_DEPRECATED_IN_9_7_0("Deprecated. Please use the std::map version instead.")
VTKIOHDF_EXPORT vtkAbstractArray* NewFieldArray(const std::array<hid_t, 3>& attributeDataGroup,
  const char* name, vtkIdType offset, vtkIdType size, vtkIdType dimMaxSize);
VTKIOHDF_EXPORT vtkAbstractArray* NewFieldArray(const std::map<int, hid_t>& attributeDataGroup,
  const char* name, vtkIdType offset, vtkIdType size, vtkIdType dimMaxSize);

VTKIOHDF_EXPORT vtkStringArray* NewStringArray(
  hid_t dataset, std::vector<hsize_t> dims, std::vector<hsize_t> fileExtent);
}

VTK_ABI_NAMESPACE_END
#include "vtkHDFUtilities.txx" // for template implementations

#endif
// VTK-HeaderTest-Exclude: vtkHDFUtilities.h