VTK  9.2.5
vtkMPIImageReader.h
Go to the documentation of this file.
1 // -*- c++ -*-
2 /*=========================================================================
3 
4  Program: Visualization Toolkit
5  Module: vtkMPIImageReader.h
6 
7  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
8  All rights reserved.
9  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
10 
11  This software is distributed WITHOUT ANY WARRANTY; without even
12  the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
13  PURPOSE. See the above copyright notice for more information.
14 
15 =========================================================================*/
16 /*----------------------------------------------------------------------------
17  Copyright (c) Sandia Corporation
18  See Copyright.txt or http://www.paraview.org/HTML/Copyright.html for details.
19 ----------------------------------------------------------------------------*/
20 
51 #ifndef vtkMPIImageReader_h
52 #define vtkMPIImageReader_h
53 
54 #include "vtkIOMPIImageModule.h" // For export macro
55 #include "vtkImageReader.h"
56 
57 class vtkMPIOpaqueFileHandle;
59 
60 class VTKIOMPIIMAGE_EXPORT vtkMPIImageReader : public vtkImageReader
61 {
62 public:
65  void PrintSelf(ostream& os, vtkIndent indent) override;
66 
68 
72  vtkGetObjectMacro(Controller, vtkMultiProcessController);
75 
76 protected:
78  ~vtkMPIImageReader() override;
79 
81 
86 
92  virtual void PartitionController(const int extent[6]);
93 
98  virtual unsigned long GetHeaderSize(vtkMPIOpaqueFileHandle& file);
99 
106  virtual void SetupFileView(vtkMPIOpaqueFileHandle& file, const int extent[6]);
107 
114  virtual void ReadSlice(int slice, const int extent[6], void* buffer);
115 
121 
123 
130 
132 
133 private:
134  vtkMPIImageReader(const vtkMPIImageReader&) = delete;
135  void operator=(const vtkMPIImageReader&) = delete;
136 };
137 
138 #endif // vtkMPIImageReader_h
general representation of visualization data
topologically and geometrically regular array of data
Definition: vtkImageData.h:163
Superclass of transformable binary file readers.
a simple class to control print indentation
Definition: vtkIndent.h:119
Store vtkAlgorithm input/output information.
vtkMPIImageReader provides the mechanism to read a brick of bytes (or shorts, or ints,...
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
virtual void TransformData(vtkImageData *data)
Transform the data from the order read from a file to the order to place in the output data (as defin...
vtkMultiProcessController * Controller
static vtkMPIImageReader * New()
void SetGroupedController(vtkMultiProcessController *)
A group of processes that are reading the same file (as determined by PartitionController.
void ExecuteDataWithInformation(vtkDataObject *data, vtkInformation *outInfo) override
This is a convenience method that is implemented in many subclasses instead of RequestData.
~vtkMPIImageReader() override
vtkMultiProcessController * GroupedController
A group of processes that are reading the same file (as determined by PartitionController.
int GetDataScalarTypeSize()
Returns the size, in bytes of the scalar data type (GetDataScalarType).
virtual void SetupFileView(vtkMPIOpaqueFileHandle &file, const int extent[6])
Set up a "view" on the open file that will allow you to read the 2D or 3D subarray from the file in o...
virtual void PartitionController(const int extent[6])
Break up the controller based on the files each process reads.
virtual void ReadSlice(int slice, const int extent[6], void *buffer)
Given a slice of the data, open the appropriate file, read the data into given buffer,...
virtual void SetController(vtkMultiProcessController *)
Get/set the multi process controller to use for coordinated reads.
virtual unsigned long GetHeaderSize(vtkMPIOpaqueFileHandle &file)
Get the header size of the given open file.
Multiprocessing communication superclass.
@ extent
Definition: vtkX3D.h:351
@ data
Definition: vtkX3D.h:321