|
ocssw
V2022
|
#include <scaledNcVar.hpp>
Public Member Functions | |
| ScaledNcVar (const NcVar &copied) | |
| ~ScaledNcVar () | |
| void | getVar (float *dataValues) |
| void | getVar (double *dataValues) |
| void | getVar (std::vector< size_t > start, std::vector< size_t > count, float *dataValues) |
| void | getVar (std::vector< size_t > start, std::vector< size_t > count, double *dataValues) |
| void | putVar (const float *dataValues) |
| void | putVar (const double *dataValues) |
| void | putVar (std::vector< size_t > start, std::vector< size_t > count, const float *dataValues) |
| void | putVar (std::vector< size_t > start, std::vector< size_t > count, const double *dataValues) |
| void | getFillValue (double *fillValue) |
| void | getFillValue (float *fillValue) |
| productInfo_t * | getProductInfo () |
| bool | populateScaleFactors (int sensorID=DEFAULT_SENSOR) |
| void | setScaleFactors (double scale, double offset, double fillValue=BAD_FLT) |
| void | assignBadValue (double newValue) |
| void | assignFillValue (double newValue) |
| void | setProdInfo (productInfo_t *prodInfo) |
| template<typename T , typename E > | |
| void | badToFill (const T *data, const size_t &count, vector< E > &out) |
Public Attributes | |
| netCDF::NcType::ncType | thisVarType = getType().getTypeClass() |
Detailed Description
Definition at line 18 of file scaledNcVar.hpp.
Constructor & Destructor Documentation
◆ ScaledNcVar()
| ScaledNcVar | ( | const NcVar & | copied | ) |
Definition at line 19 of file scaledNcVar.cpp.
◆ ~ScaledNcVar()
| ~ScaledNcVar | ( | ) |
Definition at line 22 of file scaledNcVar.cpp.
Member Function Documentation
◆ assignBadValue()
| void assignBadValue | ( | double | newValue | ) |
Reassign the value of badValue.
- Parameters
-
newValue The desired value of badValue
Definition at line 47 of file scaledNcVar.cpp.
◆ assignFillValue()
| void assignFillValue | ( | double | newValue | ) |
Reassign the fill value.
- Parameters
-
newValue The desired fill value
Definition at line 51 of file scaledNcVar.cpp.
◆ badToFill()
Definition at line 381 of file scaledNcVar.cpp.
◆ getFillValue() [1/2]
| void getFillValue | ( | double * | fillValue | ) |
Get the fill value of this NcVar.
- Parameters
-
fillValue A pointer to a double that will be mutated to contain this NcVar's _FillValue
Definition at line 307 of file scaledNcVar.cpp.
◆ getFillValue() [2/2]
| void getFillValue | ( | float * | fillValue | ) |
Get the fill value of this NcVar.
- Parameters
-
fillValue A pointer to a float that will be mutated to contain this NcVar's _FillValue
Definition at line 310 of file scaledNcVar.cpp.
◆ getProductInfo()
|
inline |
Definition at line 89 of file scaledNcVar.hpp.
◆ getVar() [1/4]
| void getVar | ( | double * | dataValues | ) |
Takes in a pointer whose memory will be modified. Assumes values found there are integers and performs a scale and offset on them, based on this variable's scale_factor and add_offset
- Parameters
-
dataValues An array of values that will be mutated
Definition at line 177 of file scaledNcVar.cpp.
◆ getVar() [2/4]
| void getVar | ( | float * | dataValues | ) |
Takes in a pointer whose memory will be modified. Assumes values found there are integers and performs a scale and offset on them, based on this variable's scale_factor and add_offset
- Parameters
-
dataValues An array of values that will be mutated
Definition at line 165 of file scaledNcVar.cpp.
◆ getVar() [3/4]
| void getVar | ( | std::vector< size_t > | start, |
| std::vector< size_t > | count, | ||
| double * | dataValues | ||
| ) |
Get a variable's values between specified indices.
- Parameters
-
dataValues The values to be stored
◆ getVar() [4/4]
| void getVar | ( | std::vector< size_t > | start, |
| std::vector< size_t > | count, | ||
| float * | dataValues | ||
| ) |
Get a variable's values between specified indices.
- Parameters
-
dataValues The values to be stored
◆ populateScaleFactors()
| bool populateScaleFactors | ( | int | sensorID = DEFAULT_SENSOR | ) |
Populate scale factor and add offset from product.xml. Assumes default sensor (30 == OCI)
- Returns
- Whether the product was found in product.xml
Definition at line 391 of file scaledNcVar.cpp.
◆ putVar() [1/4]
| void putVar | ( | const double * | dataValues | ) |
put an entire variable
- Parameters
-
dataValues The values to be stored
Definition at line 241 of file scaledNcVar.cpp.
◆ putVar() [2/4]
| void putVar | ( | const float * | dataValues | ) |
put an entire variable
- Parameters
-
dataValues The values to be stored
Definition at line 221 of file scaledNcVar.cpp.
◆ putVar() [3/4]
| void putVar | ( | std::vector< size_t > | start, |
| std::vector< size_t > | count, | ||
| const double * | dataValues | ||
| ) |
Put a variable's values between specified indices.
- Parameters
-
dataValues The values to be stored
◆ putVar() [4/4]
| void putVar | ( | std::vector< size_t > | start, |
| std::vector< size_t > | count, | ||
| const float * | dataValues | ||
| ) |
Put a variable's values between specified indices.
- Parameters
-
dataValues The values to be stored
◆ setProdInfo()
|
inline |
Definition at line 114 of file scaledNcVar.hpp.
◆ setScaleFactors()
| void setScaleFactors | ( | double | scale, |
| double | offset, | ||
| double | fillValue = BAD_FLT |
||
| ) |
Populate scale factor and add offset manually. Throws an invalid_argument
Definition at line 440 of file scaledNcVar.cpp.
Member Data Documentation
◆ thisVarType
| netCDF::NcType::ncType thisVarType = getType().getTypeClass() |
Definition at line 117 of file scaledNcVar.hpp.
The documentation for this class was generated from the following files:
- /gfs-oceanweb/web/ocssw/ocssw_src/oel_util/libnetcdfutils/scaledNcVar.hpp
- /gfs-oceanweb/web/ocssw/ocssw_src/oel_util/libnetcdfutils/scaledNcVar.cpp
