vtkHDFReader.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 vtkHDFReader_h
#define vtkHDFReader_h
 
#include "vtkDataAssembly.h" // For vtkDataAssembly
#include "vtkDataObjectAlgorithm.h"
#include "vtkDeprecation.h"  // For VTK_DEPRECATED_IN_9_7_0 VTK_DEPRECATED_IN_9_6_0
#include "vtkIOHDFModule.h"  // For export macro
#include "vtkSmartPointer.h" // For vtkSmartPointer
 
#include <array>  // For storing the time range
#include <memory> // For std::unique_ptr
#include <vector> // For storing list of values
 
VTK_ABI_NAMESPACE_BEGIN
class vtkAbstractArray;
class vtkCallbackCommand;
class vtkCellData;
class vtkCommand;
class vtkDataArraySelection;
class vtkDataSet;
class vtkDataSetAttributes;
class vtkHyperTreeGrid;
class vtkImageData;
class vtkInformation;
class vtkInformationVector;
class vtkMultiBlockDataSet;
class vtkOverlappingAMR;
class vtkPartitionedDataSet;
class vtkPartitionedDataSetCollection;
class vtkPointData;
class vtkPolyData;
class vtkRectilinearGrid;
class vtkResourceStream;
class vtkStructuredGrid;
class vtkTable;
class vtkUnstructuredGrid;
 
namespace vtkHDFUtilities
{
struct TemporalHyperTreeGridOffsets;
struct TemporalGeometryOffsets;
}
 
class VTKIOHDF_EXPORT vtkHDFReader : public vtkDataObjectAlgorithm
{
public:
  static vtkHDFReader* New();
  vtkTypeMacro(vtkHDFReader, vtkDataObjectAlgorithm);
  void PrintSelf(ostream& os, vtkIndent indent) override;


  vtkSetFilePathMacro(FileName);
  vtkGetFilePathMacro(FileName);


  void SetStream(vtkResourceStream* stream);
  vtkResourceStream* GetStream();
 
  enum
  {
    Block,
    Interleave
  };


  vtkSetClampMacro(PieceDistribution, int, Block, Interleave);
  vtkGetMacro(PieceDistribution, int);

  virtual vtkTypeBool CanReadFile(VTK_FILEPATH const char* name);
  static bool CanReadFile(vtkResourceStream* stream);


  vtkDataSet* GetOutputAsDataSet();
  vtkDataSet* GetOutputAsDataSet(int index);


  virtual vtkDataArraySelection* GetPointDataArraySelection();
  virtual vtkDataArraySelection* GetCellDataArraySelection();
  virtual vtkDataArraySelection* GetFieldDataArraySelection();
  virtual vtkDataArraySelection* GetRowDataArraySelection();


  int GetNumberOfPointArrays();
  int GetNumberOfCellArrays();


  const char* GetPointArrayName(int index);
  const char* GetCellArrayName(int index);


  bool GetHasTemporalData();
  vtkGetMacro(NumberOfSteps, vtkIdType);
  vtkGetMacro(Step, vtkIdType);
  vtkSetMacro(Step, vtkIdType);
  vtkGetMacro(TimeValue, double);
  const std::array<double, 2>& GetTimeRange() const { return this->TimeRange; }


  VTK_DEPRECATED_IN_9_7_0("Do not use, cache is on by default and should not be disabled.")
  virtual bool GetUseCache();
  VTK_DEPRECATED_IN_9_7_0("Do not use, cache is on by default and should not be disabled.")
  virtual void SetUseCache(bool use);
  VTK_DEPRECATED_IN_9_7_0("Do not use, cache is on by default and should not be disabled.")
  virtual void UseCacheOn();
  VTK_DEPRECATED_IN_9_7_0("Do not use, cache is on by default and should not be disabled.")
  virtual void UseCacheOff();


  vtkSetMacro(MaximumLevelsToReadByDefaultForAMR, unsigned int);
  vtkGetMacro(MaximumLevelsToReadByDefaultForAMR, unsigned int);


  VTK_DEPRECATED_IN_9_7_0("Do not use, will be removed.")
  std::string GetAttributeOriginalIdName(vtkIdType attribute);
  VTK_DEPRECATED_IN_9_7_0("Do not use, will be removed.")
  void SetAttributeOriginalIdName(vtkIdType attribute, const std::string& name);

  vtkMTimeType GetMTime() override;
 
protected:
  vtkHDFReader();
  ~vtkHDFReader() override;

  int CanReadFileVersion(int major, int minor);


  int Read(vtkInformation* outInfo, vtkImageData* data);
  int Read(vtkInformation* outInfo, vtkRectilinearGrid* data);
  int Read(vtkInformation* outInfo, vtkStructuredGrid* data);
  int Read(vtkInformation* outInfo, vtkTable* data);
  int Read(vtkInformation* outInfo, vtkUnstructuredGrid* data, vtkPartitionedDataSet* pData);
  int Read(vtkInformation* outInfo, vtkPolyData* data, vtkPartitionedDataSet* pData);
  int Read(vtkInformation* outInfo, vtkHyperTreeGrid* data, vtkPartitionedDataSet* pData);
  int Read(vtkInformation* outInfo, vtkOverlappingAMR* data);
  int Read(vtkInformation* outInfo, vtkPartitionedDataSetCollection* data);
  int Read(vtkInformation* outInfo, vtkMultiBlockDataSet* data);
  int ReadRecursively(vtkInformation* outInfo, vtkMultiBlockDataSet* data, const std::string& path);
 
  VTK_DEPRECATED_IN_9_6_0("This method is deprecated, do not use")
  int Read(const std::vector<vtkIdType>& numberOfPoints,
    const std::vector<vtkIdType>& numberOfCells,
    const std::vector<vtkIdType>& numberOfConnectivityIds, vtkIdType partOffset,
    vtkIdType startingPointOffset, vtkIdType startingCellOffset,
    vtkIdType startingConnectctivityIdOffset, int filePiece, vtkUnstructuredGrid* pieceData);

  VTK_DEPRECATED_IN_9_7_0("This method is deprecated, do not use")
  int AddFieldArrays(vtkDataObject* data);

  static void SelectionModifiedCallback(
    vtkObject* caller, unsigned long eid, void* clientdata, void* calldata);


  int RequestDataObject(vtkInformation* request, vtkInformationVector** inputVector,
    vtkInformationVector* outputVector) override;
  int RequestInformation(vtkInformation* request, vtkInformationVector** inputVector,
    vtkInformationVector* outputVector) override;
  int RequestData(vtkInformation* request, vtkInformationVector** inputVector,
    vtkInformationVector* outputVector) override;

  void PrintPieceInformation(vtkInformation* outInfo);

  int SetupInformation(vtkInformation* outInfo);

  char* FileName;

  vtkSmartPointer<vtkResourceStream> Stream;

  std::map<int, vtkDataArraySelection*> DataArraySelection;

  vtkCallbackCommand* SelectionObserver;

  vtkSmartPointer<vtkDataAssembly> Assembly;


  vtkIdType Step = 0;
  vtkIdType NumberOfSteps = 1;
  double TimeValue = 0.0;
  std::array<double, 2> TimeRange;
 
  unsigned int MaximumLevelsToReadByDefaultForAMR = 0;
 
  bool UseCache = true;
  struct DataCache;
  std::shared_ptr<DataCache> Cache;
 
private:
  vtkHDFReader(const vtkHDFReader&) = delete;
  void operator=(const vtkHDFReader&) = delete;
 
  class Implementation;
  Implementation* Impl;

  bool ReadData(vtkInformation* outInfo, vtkDataObject* data);

  bool ReadStructuredData(
    vtkDataSet* data, const int* WholeExtent, const std::vector<int>& updateExtent);

  bool ReadAMRData(vtkOverlappingAMR* data, unsigned int maxLevel,
    const std::map<int, vtkDataArraySelection*>& dataArraySelection, bool isTemporalData);

  int Read(const std::vector<vtkIdType>& numberOfPoints,
    const std::vector<vtkIdType>& numberOfCells,
    const std::vector<vtkIdType>& numberOfConnectivityIds,
    const std::vector<vtkIdType>& numberOfFaces,
    const std::vector<vtkIdType>& numberOfPolyhedronToFaceIds,
    const std::vector<vtkIdType>& numberOfFaceConnectivityIds,
    vtkHDFUtilities::TemporalGeometryOffsets& geoOffsets, int filePiece,
    vtkUnstructuredGrid* pieceData);

  int Read(const std::vector<vtkIdType>& numberOfTrees, const std::vector<vtkIdType>& numberOfCells,
    const std::vector<vtkIdType>& numberOfDepths, const std::vector<vtkIdType>& descriptorSizes,
    const vtkHDFUtilities::TemporalHyperTreeGridOffsets& htgTemporalOffsets, int filePiece,
    vtkHyperTreeGrid* pieceData);

  void SetHasTemporalData(bool useTemporalData);

  std::vector<int> GetPieceAssignmentForDistribution(
    int pieceIdx, int numDatasets, int numPieces) const;

  void GenerateAssembly();

  bool RetrieveStepsFromAssembly();

  bool RetrieveDataArraysFromAssembly();

  bool ReadFieldArrays(vtkDataObject* data);
 
  vtkSmartPointer<vtkDataObject> OutputCache;
 
  std::map<vtkIdType, std::string> AttributesOriginalIdName{
    { vtkDataObject::POINT, "__pointsOriginalIds__" },
    { vtkDataObject::CELL, "__cellOriginalIds__" }, { vtkDataObject::FIELD, "__fieldOriginalIds__" }
  };
 
  bool HasTemporalData = false;
  std::string CompositeCachePath; // Identifier for the current composite piece
  int PieceDistribution = Interleave;
};
 
VTK_ABI_NAMESPACE_END
#endif