VTK  9.2.6
vtkHDFReader.h
Go to the documentation of this file.
1/*=========================================================================
2
3 Program: Visualization Toolkit
4 Module: vtkHDFReader.h
5
6 Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
7 All rights reserved.
8 See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
9
10 This software is distributed WITHOUT ANY WARRANTY; without even
11 the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
12 PURPOSE. See the above copyright notice for more information.
13
14=========================================================================*/
24#ifndef vtkHDFReader_h
25#define vtkHDFReader_h
26
28#include "vtkIOHDFModule.h" // For export macro
29#include <vector> // For storing list of values
30
33class vtkCommand;
35class vtkDataSet;
37class vtkImageData;
39class vtkInformation;
42
52class VTKIOHDF_EXPORT vtkHDFReader : public vtkDataObjectAlgorithm
53{
54public:
55 static vtkHDFReader* New();
57 void PrintSelf(ostream& os, vtkIndent indent) override;
58
60
66
74 virtual int CanReadFile(VTK_FILEPATH const char* name);
75
77
83
85
93
95
101
103
107 const char* GetPointArrayName(int index);
108 const char* GetCellArrayName(int index);
110
111 vtkSetMacro(MaximumLevelsToReadByDefaultForAMR, unsigned int);
112 vtkGetMacro(MaximumLevelsToReadByDefaultForAMR, unsigned int);
113
114protected:
116 ~vtkHDFReader() override;
117
122 constexpr static int GetNumberOfAttributeTypes() { return 3; }
123
127 int CanReadFileVersion(int major, int minor);
128
130
134 int Read(vtkInformation* outInfo, vtkImageData* data);
138
143 int Read(const std::vector<vtkIdType>& numberOfPoints,
144 const std::vector<vtkIdType>& numberOfCells,
145 const std::vector<vtkIdType>& numberOfConnectivityIds, int filePiece,
146 vtkUnstructuredGrid* pieceData);
151
156 vtkObject* caller, unsigned long eid, void* clientdata, void* calldata);
157
159
164 vtkInformationVector* outputVector) override;
166 vtkInformationVector* outputVector) override;
168 vtkInformationVector* outputVector) override;
170
175
176private:
177 vtkHDFReader(const vtkHDFReader&) = delete;
178 void operator=(const vtkHDFReader&) = delete;
179
180protected:
184 char* FileName;
185
190 vtkDataArraySelection* DataArraySelection[3];
191
198
201 int WholeExtent[6];
202 double Origin[3];
203 double Spacing[3];
205
206 unsigned int MaximumLevelsToReadByDefaultForAMR = 0;
207
208 class Implementation;
210};
211
212#endif
Abstract superclass for all arrays.
supports function callbacks
superclass for callback/observer methods
Definition: vtkCommand.h:395
Store on/off settings for data arrays, etc.
Superclass for algorithms that produce only data object as output.
general representation of visualization data
Definition: vtkDataObject.h:66
represent and manipulate attribute data in a dataset
abstract class to specify dataset behavior
Definition: vtkDataSet.h:63
Implementation for the vtkHDFReader.
VTKHDF format reader.
Definition: vtkHDFReader.h:53
int GetNumberOfPointArrays()
Get the number of point or cell arrays available in the input.
int GetNumberOfCellArrays()
const char * GetCellArrayName(int index)
virtual vtkDataArraySelection * GetFieldDataArraySelection()
vtkDataSet * GetOutputAsDataSet(int index)
virtual vtkDataArraySelection * GetCellDataArraySelection()
int CanReadFileVersion(int major, int minor)
Test if the reader can read a file with the given version number.
int Read(vtkInformation *outInfo, vtkImageData *data)
Reads the 'data' requested in 'outInfo' (through extents or pieces).
~vtkHDFReader() override
vtkSetFilePathMacro(FileName)
Get/Set the name of the input file.
int RequestInformation(vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector) override
int RequestDataObject(vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector) override
Standard functions to specify the type, information and read the data from the file.
int RequestData(vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector) override
static vtkHDFReader * New()
static constexpr int GetNumberOfAttributeTypes()
How many attribute types we have.
Definition: vtkHDFReader.h:122
vtkGetFilePathMacro(FileName)
static void SelectionModifiedCallback(vtkObject *caller, unsigned long eid, void *clientdata, void *calldata)
Modify this object when an array selection is changed.
int AddFieldArrays(vtkDataObject *data)
Read the field arrays from the file and add them to the dataset.
const char * GetPointArrayName(int index)
Get the name of the point or cell array with the given index in the input.
char * FileName
The input file's name.
Definition: vtkHDFReader.h:184
int Read(const std::vector< vtkIdType > &numberOfPoints, const std::vector< vtkIdType > &numberOfCells, const std::vector< vtkIdType > &numberOfConnectivityIds, int filePiece, vtkUnstructuredGrid *pieceData)
Read 'pieceData' specified by 'filePiece' where number of points, cells and connectivity ids store th...
virtual vtkDataArraySelection * GetPointDataArraySelection()
Get the data array selection tables used to configure which data arrays are loaded by the reader.
vtkCallbackCommand * SelectionObserver
The observer to modify this object when the array selections are modified.
Definition: vtkHDFReader.h:196
virtual int CanReadFile(VTK_FILEPATH const char *name)
Test whether the file (type) with the given name can be read by this reader.
int Read(vtkInformation *outInfo, vtkOverlappingAMR *data)
void PrintPieceInformation(vtkInformation *outInfo)
Print update number of pieces, piece number and ghost levels.
int Read(vtkInformation *outInfo, vtkUnstructuredGrid *data)
Implementation * Impl
Definition: vtkHDFReader.h:209
vtkDataSet * GetOutputAsDataSet()
Get the output as a vtkDataSet pointer.
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
topologically and geometrically regular array of data
Definition: vtkImageData.h:54
a simple class to control print indentation
Definition: vtkIndent.h:40
Store zero or more vtkInformation instances.
Store vtkAlgorithm input/output information.
abstract base class for most VTK objects
Definition: vtkObject.h:63
hierarchical dataset of vtkUniformGrids
dataset represents arbitrary combinations of all possible cell types
#define VTK_FILEPATH