1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117
|
// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
// SPDX-FileCopyrightText: Copyright (c) Sandia Corporation
// SPDX-License-Identifier: BSD-3-Clause
/**
* @class vtkPNrrdReader
* @brief Read nrrd files efficiently from parallel file systems (and reasonably well elsewhere).
*
*
*
* vtkPNrrdReader is a subclass of vtkNrrdReader that will read Nrrd format
* header information of the image before reading the data. This means that the
* reader will automatically set information like file dimensions.
*
*
* @bug
* There are several limitations on what type of nrrd files we can read. This
* reader only supports nrrd files in raw format. Other encodings like ascii
* and hex will result in errors. When reading in detached headers, this only
* supports reading one file that is detached.
*
*/
#ifndef vtkPNrrdReader_h
#define vtkPNrrdReader_h
#include "vtkIOMPIImageModule.h" // For export macro
#include "vtkNrrdReader.h"
VTK_ABI_NAMESPACE_BEGIN
class vtkCharArray;
class vtkMultiProcessController;
class vtkMPIOpaqueFileHandle;
class VTKIOMPIIMAGE_EXPORT vtkPNrrdReader : public vtkNrrdReader
{
public:
vtkTypeMacro(vtkPNrrdReader, vtkNrrdReader);
static vtkPNrrdReader* New();
void PrintSelf(ostream& os, vtkIndent indent) override;
///@{
/**
* Get/set the multi process controller to use for coordinated reads. By
* default, set to the global controller.
*/
vtkGetObjectMacro(Controller, vtkMultiProcessController);
virtual void SetController(vtkMultiProcessController*);
///@}
protected:
vtkPNrrdReader();
~vtkPNrrdReader() override;
int ReadHeader() override;
int ReadHeader(vtkCharArray* headerBuffer) override;
/**
* Returns the size, in bytes of the scalar data type (GetDataScalarType).
*/
int GetDataScalarTypeSize();
/**
* Break up the controller based on the files each process reads. Each group
* comprises the processes that read the same files in the same order.
* this->GroupedController is set to the group for the current process.
*/
virtual void PartitionController(const int extent[6]);
/**
* Get the header size of the given open file. This should be used in liu of
* the GetHeaderSize methods of the superclass.
*/
virtual unsigned long GetHeaderSize(vtkMPIOpaqueFileHandle& file);
/**
* Set up a "view" on the open file that will allow you to read the 2D or 3D
* subarray from the file in one read. Once you call this method, the file
* will look as if it contains only the data the local process needs to read
* in.
*/
virtual void SetupFileView(vtkMPIOpaqueFileHandle& file, const int extent[6]);
/**
* Given a slice of the data, open the appropriate file, read the data into
* given buffer, and close the file. For three dimensional data, always
* use "slice" 0. Make sure the GroupedController is properly created before
* calling this using the PartitionController method.
*/
virtual void ReadSlice(int slice, const int extent[6], void* buffer);
/**
* Transform the data from the order read from a file to the order to place
* in the output data (as defined by the transform).
*/
virtual void TransformData(vtkImageData* data);
///@{
/**
* A group of processes that are reading the same file (as determined by
* PartitionController.
*/
void SetGroupedController(vtkMultiProcessController*);
vtkMultiProcessController* GroupedController;
///@}
void ExecuteDataWithInformation(vtkDataObject* data, vtkInformation* outInfo) override;
vtkMultiProcessController* Controller;
private:
vtkPNrrdReader(const vtkPNrrdReader&) = delete;
void operator=(const vtkPNrrdReader&) = delete;
};
VTK_ABI_NAMESPACE_END
#endif // vtkPNrrdReader_h
|