NASA Ocean Color

ocssw V2022

  
 #ifndef SCALED_NCVAR_H
 #define SCALED_NCVAR_H
  
 #define DEFAULT_SENSOR 30  // OCI
  
 #include <netcdf>
 #include <productInfo.h>
 #include <genutils.h>
  
 class ScaledNcVar : public netCDF::NcVar {
    public:
  
     // Copy constructor
     ScaledNcVar(const NcVar &copied);
  
     // destructor
     ~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() { return prodInfo; }
  
     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) { this->prodInfo = prodInfo; }
  
     // netCDF data type for the variable in the file
     netCDF::NcType::ncType thisVarType = getType().getTypeClass();
  
    private:
     // Indicates whether the scale factors of this NcVar have already been obtained
     bool scaleFactorsSet = false;
     // A scalar value that will be added each value stored in this NcVar. 1 by default
     double scaleFactor = 1.0;
     // A scalar value that will be added each value stored in this NcVar. 0 by default
     double addOffset = 0.0;
     // fill value the netCDF file uses
     double fillValue = BAD_FLT;
     // sentinal value for bad data in teh internal memory (usually the fillValue)
     double badValue = BAD_FLT;
     // pointer to the product structure from the product.xml file
     productInfo_t *prodInfo = nullptr;
  
     bool floatingPoint();
  
     void compress(const double *toCompress, std::vector<int32_t> &compressed, size_t count);
  
     void compress(const float *toCompress, std::vector<int32_t> &compressed, size_t count);
  
     void uncompress(double *toUncompress, size_t count);
  
     void uncompress(float *toUncompress, size_t count);
  
     template <typename T>
     void fillToBad(T *data, size_t count);
  
     template <typename T, typename E>
     void badToFill(const T *data, const size_t &count, std::vector<E> &compressed);
  
     void getScaleFactorsFromFile();
  
     double initFillValue();
  
     std::pair<double, double> range();
 };
  
 ScaledNcVar newScaledNcVar(const netCDF::NcGroup &group, const std::string &name,
                             const std::vector<netCDF::NcDim> &dims, int sensorID = DEFAULT_SENSOR);
  
 #endif

ScaledNcVar::thisVarType

netCDF::NcType::ncType thisVarType

Definition: scaledNcVar.hpp:117

genutils.h

ScaledNcVar::getProductInfo

productInfo_t * getProductInfo()

Definition: scaledNcVar.hpp:89

MDN.setup.name

name

Definition: setup.py:14

ScaledNcVar::getFillValue

void getFillValue(double *fillValue)

Get the fill value of this NcVar.

Definition: scaledNcVar.cpp:307

productInfo.h

ScaledNcVar::ScaledNcVar

ScaledNcVar(const NcVar &copied)

Definition: scaledNcVar.cpp:19

string

@ string

Definition: GEO_read_param_file.c:64

ScaledNcVar::getVar

void getVar(float *dataValues)

Takes in a pointer whose memory will be modified. Assumes values found there are integers and perform...

Definition: scaledNcVar.cpp:165

ScaledNcVar::assignFillValue

void assignFillValue(double newValue)

Reassign the fill value.

Definition: scaledNcVar.cpp:51

ScaledNcVar::~ScaledNcVar

~ScaledNcVar()

Definition: scaledNcVar.cpp:22

newScaledNcVar

ScaledNcVar newScaledNcVar(const netCDF::NcGroup &group, const std::string &name, const std::vector< netCDF::NcDim > &dims, int sensorID=DEFAULT_SENSOR)

Create a ScaledNcVar using the product.xml for definition.

Definition: scaledNcVar.cpp:504

DEFAULT_SENSOR

#define DEFAULT_SENSOR

An extension of NetCDF::NcVar to perform scale and offset when getting a variable.

Definition: scaledNcVar.hpp:12

color_dtdb.scale

int scale

Definition: color_dtdb.py:459

ScaledNcVar::setScaleFactors

void setScaleFactors(double scale, double offset, double fillValue=BAD_FLT)

Populate scale factor and add offset manually. Throws an invalid_argument