vtkHDFReaderImplementation.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 vtkHDFReaderImplementation_h
#define vtkHDFReaderImplementation_h

#include "vtkAMRBox.h"
#include "vtkDataSetAttributes.h"
#include "vtkHDFReader.h"
#include "vtk_hdf5.h"

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

VTK_ABI_NAMESPACE_BEGIN
class vtkAbstractArray;
class vtkBitArray;
class vtkDataArray;
class vtkDataAssembly;
class vtkMemoryResourceStream;
class vtkResourceStream;
class vtkStringArray;

class vtkHDFReader::Implementation
{
public:
  Implementation(vtkHDFReader* reader);
  virtual ~Implementation();

  bool Open(VTK_FILEPATH const char* fileName, bool quiet = false);

  bool Open(vtkResourceStream* stream, bool quiet = false);

  void Close();

  void CloseMemberGroups();

  int GetDataSetType() { return this->DataSetType; }
  vtkHDFReader* GetReader() { return this->Reader; }
  const std::array<int, 2>& GetVersion() { return this->Version; }
  template <typename T>
  bool GetAttribute(const char* attributeName, size_t numberOfElements, T* value);
  bool HasAttribute(const char* groupName, const char* attributeName);
  bool HasDataset(const char* datasetName);
  int GetNumberOfPieces(vtkIdType step = -1);
  bool GetPartitionExtent(hsize_t partitionIndex, int* extent);
  std::vector<std::string> GetArrayNames(int attributeType);
  std::vector<std::string> GetOrderedChildrenOfGroup(const std::string& path);

  vtkDataArray* NewArray(
    int attributeType, const char* name, const std::vector<hsize_t>& fileExtent);
  vtkDataArray* NewArray(int attributeType, const char* name, hsize_t offset, hsize_t size);
  vtkAbstractArray* NewFieldArray(
    const char* name, vtkIdType offset = -1, vtkIdType size = -1, vtkIdType dimMaxSize = -1);

  void AttachDatasetAttributeToArray(
    int attributeType, vtkDataArray* array, vtkDataSetAttributes* attributes);


  vtkDataArray* NewMetadataArray(const char* name, const std::vector<hsize_t>& fileExtent);
  vtkDataArray* NewMetadataArray(const char* name, hsize_t offset, hsize_t size);
  std::vector<vtkIdType> GetMetadata(const char* name, hsize_t size, hsize_t offset = 0);

  std::vector<hsize_t> GetDimensions(const char* dataset);

  bool IsPathSoftLink(const std::string& path);


  bool FillAssembly(vtkDataAssembly* data);
  bool FillAssembly(vtkDataAssembly* data, hid_t assemblyHandle, int assemblyID, std::string path);

  std::size_t GetNumberOfSteps();


  vtkDataArray* GetStepValues();
  vtkDataArray* GetStepValues(hid_t group);

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

  vtkIdType GetTemporalOffset(vtkIdType step, const std::string& name);

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

  bool OpenGroupAsVTKGroup(const std::string& groupPath);

  bool RetrieveHDFInformation(const std::string& rootName, const std::string& groupPrefix = "");

  bool GetImageAttributes(int WholeExtent[6], double Origin[3], double Spacing[3]);

  bool GetDimensionsAttribute(int Dimensions[3]);


  unsigned int GetAMRNumberOfLevels();

  bool ComputeAMRBlocksPerLevels(unsigned int nLevels);

  bool ComputeAMROffsetsPerLevels(const std::map<int, vtkDataArraySelection*>& dataArraySelection,
    vtkIdType step, unsigned int nLevels);

  bool ReadAMRTopology(
    vtkOverlappingAMR* data, unsigned int maxLevel, double origin[3], bool isTemporalData);

  bool GetAMRTemporalOffsetForAttributeType(
    unsigned int level, int attributeType, const std::string& name, hsize_t& offset);

  vtkSmartPointer<vtkDataObject> GetNewDataSet(int dataSetType, int numPieces);

  bool ReadHyperTreeGridData(vtkHyperTreeGrid* htg, const vtkDataArraySelection* arraySelection,
    vtkIdType cellOffset, vtkIdType treeIdsOffset, vtkIdType depthOffset,
    vtkIdType descriptorOffset, vtkIdType maskOffset, vtkIdType partOffset,
    vtkIdType verticesPerDepthOffset, vtkIdType XCoordsOffset, vtkIdType YCoordsOffset,
    vtkIdType ZCoordsOffset, vtkIdType depthLimit, vtkIdType step);

  bool ReadHyperTreeGridMetaInfo(vtkHyperTreeGrid* htg);

  bool ReadHyperTreeGridDimensions(vtkHyperTreeGrid* htg, vtkIdType XCoordsOffset,
    vtkIdType YCoordsOffset, vtkIdType ZCoordsOffset);

  bool CreateHyperTreeGridCellArrays(vtkHyperTreeGrid* htg,
    std::vector<vtkSmartPointer<vtkAbstractArray>>& cellArrays,
    const vtkDataArraySelection* arraySelection, vtkIdType cellCount);

  bool AppendCellDataForHyperTree(std::vector<vtkSmartPointer<vtkAbstractArray>>& cellArrays,
    vtkIdType cellOffset, vtkIdType inputCellOffset, vtkIdType step, vtkIdType readableTreeSize);

  bool AppendMaskForHyperTree(vtkHyperTreeGrid* htg, vtkIdType inputCellOffset,
    vtkIdType maskOffset, vtkIdType readableTreeSize);

private:
  std::string FileName;
  vtkResourceStream* Stream = nullptr;
  vtkNew<vtkMemoryResourceStream> LocalMemStream;
  hid_t File;
  hid_t VTKGroup;
  // in the same order as vtkDataObject::AttributeTypes: POINT, CELL, FIELD
  std::map<int, hid_t> AttributeDataGroup;
  int DataSetType;
  int NumberOfPieces;
  std::array<int, 2> Version;
  vtkHDFReader* Reader;


  struct AMRBlocksInformation
  {
    std::vector<int> BlocksPerLevel;
    std::vector<vtkIdType> BlockOffsetsPerLevel;
    std::map<std::string, std::vector<vtkIdType>> CellOffsetsPerLevel;
    std::map<std::string, std::vector<vtkIdType>> PointOffsetsPerLevel;

    void Clear()
    {
      this->BlocksPerLevel.clear();
      this->BlockOffsetsPerLevel.clear();
      this->PointOffsetsPerLevel.clear();
      this->CellOffsetsPerLevel.clear();
    }
  };

  AMRBlocksInformation AMRInformation;

  bool ReadLevelSpacing(hid_t levelGroupID, double* spacing);
  bool ReadAMRBoxRawValues(
    hid_t levelGroupID, std::vector<int>& amrBoxRawData, int level, bool isTemporalData);
  bool ReadLevelTopology(unsigned int level, const std::string& levelGroupName,
    vtkOverlappingAMR* data, double origin[3], bool isTemporalData);
};

VTK_ABI_NAMESPACE_END
#endif
// VTK-HeaderTest-Exclude: vtkHDFReaderImplementation.h