VTK  9.3.20240327
vtkGDALRasterReader.h
Go to the documentation of this file.
1 // SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
2 // SPDX-License-Identifier: BSD-3-Clause
25 #ifndef vtkGDALRasterReader_h
26 #define vtkGDALRasterReader_h
27 
28 #include <vtkIOGDALModule.h> // For export macro
29 #include <vtkImageReader2.h>
30 
31 // C++ includes
32 #include <string> // string is required
33 #include <vector> // vector is required
34 
35 VTK_ABI_NAMESPACE_BEGIN
36 class VTKIOGDAL_EXPORT vtkGDALRasterReader : public vtkImageReader2
37 {
38 public:
41  void PrintSelf(ostream& os, vtkIndent indent) override;
42 
45 
49  int CanReadFile(VTK_FILEPATH const char* fname) override;
50 
54  const char* GetProjectionString() const;
55 
59  const char* GetProjectionWKT() const { return this->ProjectionWKT.c_str(); }
60 
65  const double* GetGeoCornerPoints();
66 
72  vtkSetMacro(CollateBands, bool);
73  vtkGetMacro(CollateBands, bool);
74  vtkBooleanMacro(CollateBands, bool);
75 
77 
80  vtkSetVector2Macro(TargetDimensions, int);
81  vtkGetVector2Macro(TargetDimensions, int);
83 
85 
90 
94  const std::vector<std::string>& GetMetaData();
95 
102  double GetInvalidValue(size_t bandIndex = 0, int* hasNoData = nullptr);
103 
107  std::vector<std::string> GetDomainMetaData(const std::string& domain);
108 
110 
116 
121 
123 
128  const char* GetCellArrayName(int index);
129  int GetCellArrayStatus(const char* name);
130  void SetCellArrayStatus(const char* name, int status);
134 
135 protected:
136  int RequestData(vtkInformation* request, vtkInformationVector** inputVector,
137  vtkInformationVector* outputVector) override;
138 
140  vtkInformationVector* outputVector) override;
141 
143 
144  int TargetDimensions[2];
150  std::vector<std::string> Domains;
151  std::vector<std::string> MetaData;
153 
154  class vtkGDALRasterReaderInternal;
155  vtkGDALRasterReaderInternal* Impl;
156 
157 private:
158  vtkGDALRasterReader(const vtkGDALRasterReader&) = delete;
159  void operator=(const vtkGDALRasterReader&) = delete;
160 };
161 
162 VTK_ABI_NAMESPACE_END
163 #endif // vtkGDALRasterReader_h
Read raster file formats using GDAL.
void DisableAllCellArrays()
The following methods allow selective reading of bands.
void EnableAllCellArrays()
The following methods allow selective reading of bands.
~vtkGDALRasterReader() override
int FillOutputPortInformation(int port, vtkInformation *info) override
These method should be reimplemented by subclasses that have more than a single input or single outpu...
const std::string & GetDriverShortName()
Return driver name which was used to read the current data.
vtkGDALRasterReaderInternal * Impl
const std::string & GetDriverLongName()
Return driver name which was used to read the current data.
const char * GetProjectionString() const
Return proj4 spatial reference.
void SetCellArrayStatus(const char *name, int status)
The following methods allow selective reading of bands.
int GetNumberOfCellArrays()
The following methods allow selective reading of bands.
const std::vector< std::string > & GetMetaData()
Return metadata as reported by GDAL.
const double * GetGeoCornerPoints()
Return geo-referenced corner points (Upper left, lower left, lower right, upper right)
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
int CanReadFile(VTK_FILEPATH const char *fname) override
Is this file supported.
std::vector< std::string > GetDomainMetaData(const std::string &domain)
Return domain metadata.
std::vector< std::string > Domains
std::vector< std::string > MetaData
static vtkGDALRasterReader * New()
const char * GetCellArrayName(int index)
The following methods allow selective reading of bands.
int RequestData(vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector) override
This is called in response to a REQUEST_DATA request from the executive.
vtkIdType GetNumberOfCells()
Return the number of cells that are not set to GDAL NODATA.
double GetInvalidValue(size_t bandIndex=0, int *hasNoData=nullptr)
Return the invalid value for a pixel (for blanking purposes) in a specified raster band.
int GetCellArrayStatus(const char *name)
The following methods allow selective reading of bands.
int RequestInformation(vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector) override
Subclasses can reimplement this method to collect information from their inputs and set information f...
int * GetRasterDimensions()
Get raster width and height in number of pixels (cells)
const char * GetProjectionWKT() const
Returns WKT spatial reference.
Superclass of binary file readers.
a simple class to control print indentation
Definition: vtkIndent.h:108
Store zero or more vtkInformation instances.
Store vtkAlgorithm input/output information.
@ info
Definition: vtkX3D.h:376
@ port
Definition: vtkX3D.h:447
@ name
Definition: vtkX3D.h:219
@ index
Definition: vtkX3D.h:246
@ string
Definition: vtkX3D.h:490
int vtkIdType
Definition: vtkType.h:315
#define VTK_FILEPATH