VTK  9.0.3
vtkADIOS2CoreImageReader.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkADIOS2CoreImageReader.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 =========================================================================*/
33 #ifndef vtkADIOS2CoreImageReader_h
34 #define vtkADIOS2CoreImageReader_h
35 
36 #include <map> // For independently time stepped array indexing
37 #include <memory> // For std::unique_ptr
38 #include <string> // For variable name index mapping
39 #include <vector> // For independently time stepped array indexing
40 
41 #include "vtkDataObjectAlgorithm.h"
42 #include "vtkMultiProcessController.h" // For the process controller
43 #include "vtkSetGet.h" // For property get/set macros
44 #include "vtkSmartPointer.h" // For the object cache
45 
46 #include "vtkIOADIOS2Module.h" // For export macro
47 
48 class vtkCellArray;
49 class vtkDataArray;
50 class vtkDataObject;
51 class vtkDataSet;
53 class vtkFieldData;
54 class vtkImageData;
56 class vtkStringArray;
57 
58 //----------------------------------------------------------------------------
59 
60 class VTKIOADIOS2_EXPORT vtkADIOS2CoreImageReader : public vtkDataObjectAlgorithm
61 {
62 public:
63  enum class VarType
64  {
65  PointData,
66  CellData
67  };
68  using Params = std::map<std::string, std::string>;
69  using StringToParams = std::map<std::string, Params>;
70  using InquireVariablesType = std::vector<std::pair<std::string, VarType> >;
73  void PrintSelf(ostream& os, vtkIndent indent) override;
74 
80 
81  virtual int CanReadFile(const char* filename);
82 
84 
87  vtkSetMacro(FileName, std::string);
88  vtkGetMacro(FileName, std::string);
90 
91  void SetFileName(const char* filename);
92 
94 
98  vtkSetVector3Macro(Origin, double);
99  vtkGetVector3Macro(Origin, double);
101 
103 
107  vtkSetVector3Macro(Spacing, double);
108  vtkGetVector3Macro(Spacing, double);
110 
112 
118  vtkSetMacro(DimensionArray, std::string);
119  vtkGetMacro(DimensionArray, std::string);
121 
123 
127  vtkSetMacro(DimensionArrayAsCell, bool);
128  vtkGetMacro(DimensionArrayAsCell, bool);
129  vtkBooleanMacro(DimensionArrayAsCell, bool);
131 
134 
138  vtkSetMacro(TimeStepArray, std::string);
139  vtkGetMacro(TimeStepArray, std::string);
141 
143 
153  const char* GetArrayName(int index);
154 
156 
160  void SetArrayStatus(const char* name, int status);
161  int GetArrayStatus(const char* name);
163 
165 
172  vtkSetMacro(IsColumnMajor, bool);
173  vtkGetMacro(IsColumnMajor, bool);
174  vtkBooleanMacro(IsColumnMajor, bool);
176 
178 
181  void SetActiveScalar(const std::pair<std::string, VarType>& inqVars);
182  std::pair<std::string, VarType>& GetActiveScalar();
183  const std::pair<std::string, VarType>& GetActiveScalar() const;
184 
186 
191 
193 
198 
200 
205 
209  virtual int ProcessRequest(
211 
212 protected:
215 
217 
218  virtual int RequestInformation(
219  vtkInformation* request, vtkInformationVector** input, vtkInformationVector* output) override;
220  virtual int RequestData(
221  vtkInformation* request, vtkInformationVector** input, vtkInformationVector* output) override;
222 
224 
226 
227  // Read available variables and attributes in the file
229 
230  // Convert the array selection into inquire variables.
232 
233  // Init the workDistribution based on the first inquired variable
235 
237 
238  // Gather time steps info from the time step array
240 
241  // Helper function for InitWorkDistribution to calculate how many blocks each process shall read
242  template <typename T>
244 
245  // Helper function for ReadImageBlocks to populate vtk data array from adios variable
246  template <typename T, template <typename...> class U>
248  const std::string& varName, size_t blockIndex);
249 
250  // Helper function to gather time steps from adios time array
251  template <typename T>
253 
255 
258 
261 
262  double Origin[3];
263  double Spacing[3];
264  int Dimension[3];
265 
267 
269 
270  struct vtkADIOS2CoreImageReaderImpl;
271  std::unique_ptr<vtkADIOS2CoreImageReaderImpl> Impl;
272 
273 private:
275  void operator=(const vtkADIOS2CoreImageReader&) = delete;
276 };
277 #endif
void CalculateWorkDistribution(const std::string &varName)
virtual int RequestData(vtkInformation *request, vtkInformationVector **input, vtkInformationVector *output) override
std::unique_ptr< vtkADIOS2CoreImageReaderImpl > Impl
void ReadImageBlocks(vtkMultiBlockDataSet *mbds)
void GatherTimeStepsFromADIOSTimeArray()
void SetFileName(const char *filename)
vtkStringArray * GetAllDimensionArrays()
Get/Set the name of the array to deduce the dimension of vtkImageData.
int RequestDataObjectInternal(vtkInformationVector *)
~vtkADIOS2CoreImageReader() override
const char * GetArrayName(int index)
static vtkADIOS2CoreImageReader * New(void)
void UpdateDimensionFromDimensionArray()
void SetController(vtkMultiProcessController *)
Set the MPI controller.
std::vector< std::pair< std::string, VarType > > InquireVariablesType
void SetActiveScalar(const std::pair< std::string, VarType > &inqVars)
Get/Set the active scalar on each image block.
vtkSmartPointer< vtkMultiProcessController > Controller
StringToParams & GetAvilableVariables()
Get the available variables.
virtual int CanReadFile(const char *filename)
virtual int ProcessRequest(vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
The main interface which triggers the reader to start.
std::map< std::string, std::string > Params
void SetArrayStatus(const char *name, int status)
Set the array that should be read in.
const std::pair< std::string, VarType > & GetActiveScalar() const
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
StringToParams & GetAvailableAttributes()
Get the available attributes.
int GetNumberOfArrays()
Get information about arrays.
int GetArrayStatus(const char *name)
int CanReadFile(const std::string &name)
Test whether or not a given file should even be attempted for use with this reader.
const StringToParams & GetAvilableVariables() const
vtkSmartPointer< vtkAbstractArray > PopulateDataArrayFromVar(const std::string &varName, size_t blockIndex)
std::string FetchTypeStringFromVarName(const std::string &name)
std::map< std::string, Params > StringToParams
vtkStringArray * GetAllTimeStepArrays()
std::pair< std::string, VarType > & GetActiveScalar()
const StringToParams & GetAvailableAttributes() const
virtual int RequestInformation(vtkInformation *request, vtkInformationVector **input, vtkInformationVector *output) override
object to represent cell connectivity
Definition: vtkCellArray.h:180
abstract superclass for arrays of numeric data
Definition: vtkDataArray.h:50
Superclass for algorithms that produce only data object as output.
general representation of visualization data
Definition: vtkDataObject.h:60
represent and manipulate attribute data in a dataset
abstract class to specify dataset behavior
Definition: vtkDataSet.h:57
represent and manipulate fields of data
Definition: vtkFieldData.h:54
topologically and geometrically regular array of data
Definition: vtkImageData.h:42
a simple class to control print indentation
Definition: vtkIndent.h:34
Store zero or more vtkInformation instances.
Store vtkAlgorithm input/output information.
Composite dataset that organizes datasets into blocks.
Multiprocessing communication superclass.
a vtkAbstractArray subclass for strings
@ name
Definition: vtkX3D.h:225
@ index
Definition: vtkX3D.h:252
@ string
Definition: vtkX3D.h:496