VTK  9.3.20240420
vtkMPIImageReader.h
Go to the documentation of this file.
1// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
2// SPDX-FileCopyrightText: Copyright (c) Sandia Corporation
3// SPDX-License-Identifier: BSD-3-Clause
4
35#ifndef vtkMPIImageReader_h
36#define vtkMPIImageReader_h
37
38#include "vtkIOMPIImageModule.h" // For export macro
39#include "vtkImageReader.h"
40
41VTK_ABI_NAMESPACE_BEGIN
42class vtkMPIOpaqueFileHandle;
44
45class VTKIOMPIIMAGE_EXPORT vtkMPIImageReader : public vtkImageReader
46{
47public:
50 void PrintSelf(ostream& os, vtkIndent indent) override;
51
53
57 vtkGetObjectMacro(Controller, vtkMultiProcessController);
60
61protected:
64
66
71
77 virtual void PartitionController(const int extent[6]);
78
83 virtual unsigned long GetHeaderSize(vtkMPIOpaqueFileHandle& file);
84
91 virtual void SetupFileView(vtkMPIOpaqueFileHandle& file, const int extent[6]);
92
99 virtual void ReadSlice(int slice, const int extent[6], void* buffer);
100
105 virtual void TransformData(vtkImageData* data);
106
108
115
117
118private:
119 vtkMPIImageReader(const vtkMPIImageReader&) = delete;
120 void operator=(const vtkMPIImageReader&) = delete;
121};
122
123VTK_ABI_NAMESPACE_END
124#endif // vtkMPIImageReader_h
general representation of visualization data
topologically and geometrically regular array of data
Superclass of transformable binary file readers.
a simple class to control print indentation
Definition vtkIndent.h:108
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
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,...
static vtkMPIImageReader * New()
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.