VTK  9.2.6
vtkNetCDFCFReader.h
Go to the documentation of this file.
1// -*- c++ -*-
2/*=========================================================================
3
4 Program: Visualization Toolkit
5 Module: vtkNetCDFCFReader.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/*-------------------------------------------------------------------------
18 Copyright 2008 Sandia Corporation.
19 Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
20 the U.S. Government retains certain rights in this software.
21-------------------------------------------------------------------------*/
22
36#ifndef vtkNetCDFCFReader_h
37#define vtkNetCDFCFReader_h
38
39#include "vtkIONetCDFModule.h" // For export macro
40#include "vtkNetCDFReader.h"
41
42#include "vtkStdString.h" // Used for ivars.
43
44class vtkImageData;
45class vtkPoints;
49
50class VTKIONETCDF_EXPORT vtkNetCDFCFReader : public vtkNetCDFReader
51{
52public:
55 void PrintSelf(ostream& os, vtkIndent indent) override;
56
58
63 vtkGetMacro(SphericalCoordinates, vtkTypeBool);
64 vtkSetMacro(SphericalCoordinates, vtkTypeBool);
65 vtkBooleanMacro(SphericalCoordinates, vtkTypeBool);
67
69
80 vtkGetMacro(VerticalScale, double);
81 vtkSetMacro(VerticalScale, double);
82 vtkGetMacro(VerticalBias, double);
83 vtkSetMacro(VerticalBias, double);
85
87
94 vtkGetMacro(OutputType, int);
95 virtual void SetOutputType(int type);
96 void SetOutputTypeToAutomatic() { this->SetOutputType(-1); }
97 void SetOutputTypeToImage() { this->SetOutputType(VTK_IMAGE_DATA); }
98 void SetOutputTypeToRectilinear() { this->SetOutputType(VTK_RECTILINEAR_GRID); }
99 void SetOutputTypeToStructured() { this->SetOutputType(VTK_STRUCTURED_GRID); }
100 void SetOutputTypeToUnstructured() { this->SetOutputType(VTK_UNSTRUCTURED_GRID); }
102
106 static int CanReadFile(VTK_FILEPATH const char* filename);
107
108protected:
111
113
116
118
120 vtkInformationVector* outputVector) override;
121
123 vtkInformationVector* outputVector) override;
124
126 vtkInformationVector* outputVector) override;
127
129
132 int ReadMetaData(int ncFD) override;
133 int IsTimeDimension(int ncFD, int dimId) override;
134 vtkSmartPointer<vtkDoubleArray> GetTimeValues(int ncFD, int dimId) override;
136
138 {
139 public:
140 vtkDimensionInfo() = default;
141 vtkDimensionInfo(int ncFD, int id);
142 const char* GetName() const { return this->Name.c_str(); }
144 {
149 VERTICAL_UNITS
150 };
151 UnitsEnum GetUnits() const { return this->Units; }
152 vtkSmartPointer<vtkDoubleArray> GetCoordinates() { return this->Coordinates; }
154 bool GetHasRegularSpacing() const { return this->HasRegularSpacing; }
155 double GetOrigin() const { return this->Origin; }
156 double GetSpacing() const { return this->Spacing; }
157 vtkSmartPointer<vtkStringArray> GetSpecialVariables() const { return this->SpecialVariables; }
158
159 protected:
161 int DimId;
166 double Origin, Spacing;
168 int LoadMetaData(int ncFD);
169 };
170 class vtkDimensionInfoVector;
171 friend class vtkDimensionInfoVector;
172 vtkDimensionInfoVector* DimensionInfo;
174
176 {
177 public:
179 : Valid(false)
180 {
181 }
182 vtkDependentDimensionInfo(int ncFD, int varId, vtkNetCDFCFReader* parent);
183 bool GetValid() const { return this->Valid; }
184 bool GetHasBounds() const { return this->HasBounds; }
185 bool GetCellsUnstructured() const { return this->CellsUnstructured; }
186 vtkSmartPointer<vtkIntArray> GetGridDimensions() const { return this->GridDimensions; }
188 {
189 return this->LongitudeCoordinates;
190 }
192 {
193 return this->LatitudeCoordinates;
194 }
195 vtkSmartPointer<vtkStringArray> GetSpecialVariables() const { return this->SpecialVariables; }
196
197 protected:
198 bool Valid;
205 int LoadMetaData(int ncFD, int varId, vtkNetCDFCFReader* parent);
206 int LoadCoordinateVariable(int ncFD, int varId, vtkDoubleArray* coords);
207 int LoadBoundsVariable(int ncFD, int varId, vtkDoubleArray* coords);
208 int LoadUnstructuredBoundsVariable(int ncFD, int varId, vtkDoubleArray* coords);
209 };
211 class vtkDependentDimensionInfoVector;
212 friend class vtkDependentDimensionInfoVector;
213 vtkDependentDimensionInfoVector* DependentDimensionInfo;
214
215 // Finds the dependent dimension information for the given set of dimensions.
216 // Returns nullptr if no information has been recorded.
218
225 vtkIntArray* dimensions, int& longitudeDim, int& latitudeDim, int& verticalDim);
226
228 {
237 COORDS_SPHERICAL_PSIDED_CELLS
238 };
239
246
250 bool DimensionsAreForPointData(vtkIntArray* dimensions) override;
251
258 int pieceNumber, int numberOfPieces, int ghostLevels, int extent[6]);
259
263 void GetUpdateExtentForOutput(vtkDataSet* output, int extent[6]) override;
264
266
272 void Add1DRectilinearCoordinates(vtkPoints* points, const int extent[6]);
273 void Add2DRectilinearCoordinates(vtkPoints* points, const int extent[6]);
277 void Add1DRectilinearCoordinates(vtkUnstructuredGrid* unstructuredOutput, const int extent[6]);
278 void Add2DRectilinearCoordinates(vtkUnstructuredGrid* unstructuredOutput, const int extent[6]);
280
282
285 void Add1DSphericalCoordinates(vtkPoints* points, const int extent[6]);
286 void Add2DSphericalCoordinates(vtkPoints* points, const int extent[6]);
289 void Add1DSphericalCoordinates(vtkUnstructuredGrid* unstructuredOutput, const int extent[6]);
290 void Add2DSphericalCoordinates(vtkUnstructuredGrid* unstructuredOutput, const int extent[6]);
292
296 void AddStructuredCells(vtkUnstructuredGrid* unstructuredOutput, const int extent[6]);
297
299
303 vtkUnstructuredGrid* unstructuredOutput, const int extent[6]);
305 vtkUnstructuredGrid* unstructuredOutput, const int extent[6]);
307
308private:
309 vtkNetCDFCFReader(const vtkNetCDFCFReader&) = delete;
310 void operator=(const vtkNetCDFCFReader&) = delete;
311};
312
313#endif // vtkNetCDFCFReader_h
abstract class to specify dataset behavior
Definition: vtkDataSet.h:63
dynamic, self-adjusting array of double
topologically and geometrically regular array of data
Definition: vtkImageData.h:54
a simple class to control print indentation
Definition: vtkIndent.h:40
Store zero or more vtkInformation instances.
Store vtkAlgorithm input/output information.
dynamic, self-adjusting array of int
Definition: vtkIntArray.h:46
vtkSmartPointer< vtkDoubleArray > GetLatitudeCoordinates() const
vtkSmartPointer< vtkIntArray > GridDimensions
int LoadUnstructuredBoundsVariable(int ncFD, int varId, vtkDoubleArray *coords)
vtkSmartPointer< vtkStringArray > GetSpecialVariables() const
vtkSmartPointer< vtkDoubleArray > LongitudeCoordinates
vtkDependentDimensionInfo(int ncFD, int varId, vtkNetCDFCFReader *parent)
vtkSmartPointer< vtkStringArray > SpecialVariables
int LoadMetaData(int ncFD, int varId, vtkNetCDFCFReader *parent)
vtkSmartPointer< vtkDoubleArray > LatitudeCoordinates
int LoadCoordinateVariable(int ncFD, int varId, vtkDoubleArray *coords)
vtkSmartPointer< vtkDoubleArray > GetLongitudeCoordinates() const
vtkSmartPointer< vtkIntArray > GetGridDimensions() const
int LoadBoundsVariable(int ncFD, int varId, vtkDoubleArray *coords)
vtkSmartPointer< vtkDoubleArray > GetCoordinates()
vtkSmartPointer< vtkDoubleArray > Bounds
vtkSmartPointer< vtkDoubleArray > GetBounds()
vtkSmartPointer< vtkStringArray > SpecialVariables
vtkSmartPointer< vtkDoubleArray > Coordinates
vtkSmartPointer< vtkStringArray > GetSpecialVariables() const
Reads netCDF files that follow the CF convention.
void Add1DSphericalCoordinates(vtkPoints *points, const int extent[6])
Internal methods for setting spherical coordinates.
void SetOutputTypeToUnstructured()
Set/get the data type of the output.
vtkDependentDimensionInfo * FindDependentDimensionInfo(vtkIntArray *dims)
virtual void SetOutputType(int type)
Set/get the data type of the output.
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
int RequestDataObject(vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector) override
This is called by the superclass.
vtkDimensionInfoVector * DimensionInfo
void SetOutputTypeToImage()
Set/get the data type of the output.
void AddUnstructuredSphericalCoordinates(vtkUnstructuredGrid *unstructuredOutput, const int extent[6])
Internal methods for creating unstructured cells.
void FakeStructuredCoordinates(vtkStructuredGrid *structuredOutput)
Internal methods for setting rectilinear coordinates.
void Add2DSphericalCoordinates(vtkUnstructuredGrid *unstructuredOutput, const int extent[6])
Internal methods for setting spherical coordinates.
void Add1DSphericalCoordinates(vtkUnstructuredGrid *unstructuredOutput, const int extent[6])
Internal methods for setting spherical coordinates.
~vtkNetCDFCFReader() override
void Add2DSphericalCoordinates(vtkStructuredGrid *structuredOutput)
Internal methods for setting spherical coordinates.
void Add1DRectilinearCoordinates(vtkUnstructuredGrid *unstructuredOutput, const int extent[6])
Internal methods for setting rectilinear coordinates.
void SetOutputTypeToRectilinear()
Set/get the data type of the output.
int RequestInformation(vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector) override
CoordinateTypesEnum CoordinateType(vtkIntArray *dimensions)
Based on the given dimensions and the current state of the reader, returns how the coordinates should...
void AddRectilinearCoordinates(vtkImageData *imageOutput)
Internal methods for setting rectilinear coordinates.
void GetUpdateExtentForOutput(vtkDataSet *output, int extent[6]) override
Overridden to retrieve stored extent for unstructured data.
vtkDimensionInfo * GetDimensionInfo(int dimension)
vtkTypeBool SphericalCoordinates
static int CanReadFile(VTK_FILEPATH const char *filename)
Returns true if the given file can be read.
int IsTimeDimension(int ncFD, int dimId) override
Interprets the special conventions of COARDS.
void Add1DRectilinearCoordinates(vtkStructuredGrid *structuredOutput)
Internal methods for setting rectilinear coordinates.
void SetOutputTypeToStructured()
Set/get the data type of the output.
static vtkNetCDFCFReader * New()
bool DimensionsAreForPointData(vtkIntArray *dimensions) override
Returns false for spherical dimensions, which should use cell data.
void Add1DSphericalCoordinates(vtkStructuredGrid *structuredOutput)
Internal methods for setting spherical coordinates.
void SetOutputTypeToAutomatic()
Set/get the data type of the output.
void Add2DRectilinearCoordinates(vtkStructuredGrid *structuredOutput)
Internal methods for setting rectilinear coordinates.
void Add2DSphericalCoordinates(vtkPoints *points, const int extent[6])
Internal methods for setting spherical coordinates.
void AddRectilinearCoordinates(vtkRectilinearGrid *rectilinearOutput)
Internal methods for setting rectilinear coordinates.
void Add2DRectilinearCoordinates(vtkUnstructuredGrid *unstructuredOutput, const int extent[6])
Internal methods for setting rectilinear coordinates.
void FakeRectilinearCoordinates(vtkRectilinearGrid *rectilinearOutput)
Internal methods for setting rectilinear coordinates.
void Add2DRectilinearCoordinates(vtkPoints *points, const int extent[6])
Internal methods for setting rectilinear coordinates.
vtkSmartPointer< vtkDoubleArray > GetTimeValues(int ncFD, int dimId) override
Interprets the special conventions of COARDS.
void ExtentForDimensionsAndPiece(int pieceNumber, int numberOfPieces, int ghostLevels, int extent[6])
Convenience function that takes piece information and then returns a set of extents to load based on ...
void Add1DRectilinearCoordinates(vtkPoints *points, const int extent[6])
Internal methods for setting rectilinear coordinates.
void AddStructuredCells(vtkUnstructuredGrid *unstructuredOutput, const int extent[6])
Internal method for building unstructred cells that match structured cells.
int ReadMetaData(int ncFD) override
Interprets the special conventions of COARDS.
void AddUnstructuredRectilinearCoordinates(vtkUnstructuredGrid *unstructuredOutput, const int extent[6])
Internal methods for creating unstructured cells.
int RequestData(vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector) override
vtkDependentDimensionInfoVector * DependentDimensionInfo
virtual void IdentifySphericalCoordinates(vtkIntArray *dimensions, int &longitudeDim, int &latitudeDim, int &verticalDim)
Given the list of dimensions, identify the longitude, latitude, and vertical dimensions.
A superclass for reading netCDF files.
represent and manipulate 3D points
Definition: vtkPoints.h:40
a dataset that is topologically regular with variable spacing in the three coordinate directions
Hold a reference to a vtkObjectBase instance.
Wrapper around std::string to keep symbols short.
Definition: vtkStdString.h:39
topologically regular array of data
dataset represents arbitrary combinations of all possible cell types
int vtkTypeBool
Definition: vtkABI.h:69
#define VTK_IMAGE_DATA
Definition: vtkType.h:83
#define VTK_RECTILINEAR_GRID
Definition: vtkType.h:80
#define VTK_UNSTRUCTURED_GRID
Definition: vtkType.h:81
#define VTK_STRUCTURED_GRID
Definition: vtkType.h:79
#define VTK_FILEPATH