A sphere with three ocean waves in differing shades of blue. Next to the sphere, there is the bolded text "Ocean Color". Under that, there are two acronyms, separated by a vertical pipe: OB.DAAC (Ocean Biology Distributed Active Archive Center) and OBPG (Ocean Biology Processing Group). Lorem ipsum dolor sit amet
NASA Logo
Ocean Color Science Software

ocssw V2022
L3File.h
Go to the documentation of this file.
1 #ifndef L3File_h
2 #define L3File_h
3 
4 #include <hdf_bin.h>
5 #include <vector>
6 #include <deque>
7 #include <list>
8 #include <stdint.h>
9 
10 #include <boost/geometry.hpp>
11 #include <boost/geometry/geometries/point_xy.hpp>
12 #include <boost/geometry/geometries/polygon.hpp>
13 #include <boost/geometry/geometries/box.hpp>
14 #include <boost/foreach.hpp>
15 
16 #include <L3Shape.h>
17 
18 namespace l3 {
19 const float missingPixelValue = -32767.0;
20 
21 typedef boost::geometry::model::d2::point_xy<float> Point_t;
22 typedef boost::geometry::model::polygon<Point_t> Polygon_t;
23 typedef boost::geometry::model::box<Point_t> Box_t;
24 
25 template<typename Geometry>
26 inline float calcIntersectionArea(Box_t &box, Geometry &geo) {
27  std::deque<Geometry> outPolygons;
28  boost::geometry::intersection(box, geo, outPolygons);
29  float theArea = 0.0;
30 
31  BOOST_FOREACH(Geometry const& p, outPolygons) {
32  theArea += boost::geometry::area(p);
33  }
34  return theArea;
35 }
36 
37 template<>
38 inline float calcIntersectionArea<Box_t>(Box_t &box, Box_t &geo) {
39  Box_t outBox;
40  boost::geometry::intersection(box, geo, outBox);
41  return boost::geometry::area(outBox);
42 }
43 
44 class L3Row;
45 class L3File;
46 
50 class L3Bin {
51  friend class L3Row;
52  friend class L3File;
53  friend class L3FileSMI;
54 
55 private:
56  static const uint8_t qualityUnused = 255;
57 
58  void internalAllocate(int32_t numProducts);
59  void internalCopy(const L3Bin &bin);
60  void internalAdd(const L3Bin &bin);
61  void internalInit(int32_t numProducts);
62  void checkProdId(int32_t prodId) const;
63 
64 protected:
65  int32_t numProducts;
66  int64_t binNum;
67  int64_t recordNum;
68  int32_t nobs;
69  int32_t nscenes;
70  uint8_t quality;
71  float timeRec; //< timeRec/nobs = observation time (sec since 1993 TAI)
72  float weights;
73  float *sums;
74  float *sumSquares;
75 
76 public:
77  L3Bin(int32_t numProducts = 1);
78  L3Bin(const L3Bin &bin);
79  ~L3Bin();
80 
81  void clear();
82 
83  L3Bin& operator=(const L3Bin &bin);
84  L3Bin& operator+=(const L3Bin &bin);
85 
86  void addWeighted(const L3Bin &bin, float weighting);
87 
88  template<typename Geometry1, typename Geometry2>
89  inline void addWeighted(const L3Bin &bin, Geometry1 &box, Geometry2 &geo) {
90  float theArea = calcIntersectionArea(box, geo);
91  if (theArea > 0.0)
92  addWeighted(bin, theArea);
93  }
94 
95  void setNumProducts(int32_t numProducts);
96  int32_t getNumProducts() const;
97  int64_t getBinNum() const;
98  int32_t getNobs() const;
99  int32_t getNscenes() const;
100  int64_t getRecordNum() const;
101  float getObsTime() const;
102  float getWeights() const;
103  uint8_t getQuality() const;
104 
105  float getSum(int32_t prodId = 0) const;
106  float getSumSquares(int32_t prodId = 0) const;
107 
108  float getMean(int32_t prodId = 0) const;
109  float getVariance(int32_t prodId = 0) const;
110  float getStdev(int32_t prodId = 0) const;
111 
112 };
113 
117 class L3Row {
118  friend class L3File;
119  friend class L3FileSMI;
120 
121 protected:
122  int32_t row;
123  int32_t numProducts;
124  int64_t numBins;
125  std::vector<L3Bin*> binArray;
126  int64_t lastBin; //< bin index found by getBin last time
127 
128 public:
129  L3Row(int32_t row, int64_t numBins, int32_t numProducts);
130  ~L3Row();
131 
132  int32_t getRow() const;
133  int32_t getNumProducts() const;
134  int64_t getNumBins() const;
135  void setNumBins(int64_t numBins);
136  L3Bin* getBin(int64_t binNum);
137  L3Bin* getBinByIndex(int32_t index);
138  int64_t getFirstBinNum();
139  int64_t getLastBinNum();
140 };
141 
145 class L3File {
146 protected:
147  L3Shape* shape;
148  Hdf::hdf_bin* binObj;
149  std::list<L3Row*> rowList;
150  int numCacheRows;
151  int64_t *baseRecord;
152  int32_t *extentbin;
153  float* sumBuffer;
154  L3Bin outBin;
155  uint8_t* qualityBuffer;
156  size_t *prodMap;
157  size_t numProds; // number of active Products
158  std::vector<std::string> activeProdNameList;
159 
160  virtual L3Row* readRow(int32_t row);
161 
162  virtual int initRecordLookup();
163 
172  template<typename Geometry>
173  inline bool addBinsFromRow(float lat0, float lon0, Geometry geo,
174  bool areaWeighted) {
175  bool foundIntersect = false;
176  int32_t row0, col0;
177  shape->latlon2rowcol(lat0, lon0, row0, col0);
178 
179  int32_t col = col0;
180  float lat, lon;
181 
182  float deltaLat = 90.0 / shape->getNumRows();
183  float deltaLon = 180.0 / shape->getNumCols(row0);
184 
185  // look right
186  bool binIntersects = true;
187  while (binIntersects) {
188  if (col > shape->getNumCols(row0))
189  break;
190  shape->rowcol2latlon(row0, col, lat, lon);
191  Point_t pMin(lon - deltaLon, lat - deltaLat);
192  Point_t pMax(lon + deltaLon, lat + deltaLat);
193  Box_t box(pMin, pMax);
194  binIntersects = boost::geometry::intersects(geo, box);
195  if (binIntersects) {
196  foundIntersect = true;
197  L3Bin* tmpBin = getBin(row0, col);
198  if (tmpBin) {
199  if (areaWeighted) {
200  outBin.addWeighted(*tmpBin, box, geo);
201  } else
202  outBin += *tmpBin;
203  }
204  col++;
205  }
206  }
207 
208  // look left
209  col = col0 - 1;
210  binIntersects = true;
211  while (binIntersects) {
212  if (col < 0)
213  break;
214  shape->rowcol2latlon(row0, col, lat, lon);
215  Point_t pMin(lon - deltaLon, lat - deltaLat);
216  Point_t pMax(lon + deltaLon, lat + deltaLat);
217  Box_t box(pMin, pMax);
218  binIntersects = boost::geometry::intersects(geo, box);
219  if (binIntersects) {
220  foundIntersect = true;
221  L3Bin* tmpBin = getBin(row0, col);
222  if (tmpBin) {
223  if (areaWeighted) {
224  outBin.addWeighted(*tmpBin, box, geo);
225  } else
226  outBin += *tmpBin;
227  }
228  col--;
229  }
230  }
231 
232  return foundIntersect;
233  }
234 
235 public:
236  L3File();
237  virtual ~L3File();
238 
239  virtual int64_t rowbin2record(int32_t row, int64_t bin);
240  virtual int64_t rowcol2record(int32_t row, int32_t col);
241  virtual int64_t latlon2record(float lat, float lon);
242  virtual int64_t bin2record(int64_t bin);
243 
244  virtual void clearCache();
245  virtual void setNumCacheRows(int32_t numRows);
246  virtual bool open(const char* fileName);
247  virtual void close();
248  virtual meta_l3bType* getMetaData();
249  virtual int32_t getNumProducts();
250  virtual std::string getProductName(size_t index = 0);
251  virtual bool setActiveProductList(const char* prodStr);
252  virtual int32_t getNumActiveProducts();
253  virtual std::string getActiveProductName(size_t index = 0);
254  virtual int32_t getNumRows();
255  virtual L3Row* getRow(int32_t row);
256  virtual L3Bin* getBin(int32_t row, int32_t col);
257  virtual L3Bin* getClosestBin(float lat, float lon);
258 
267  template<typename Geometry>
268  inline L3Bin* getBinsInside(Geometry geo, bool areaWeighted = false) {
269  outBin.clear();
270 
271  // get the center of the geometry
272  Point_t geoCenter;
273  boost::geometry::centroid(geo, geoCenter);
274 
275  // find r,c of closest bin
276  float geoLat = constrainLat(geoCenter.y());
277  float geoLon = constrainLon(geoCenter.x());
278  geoCenter.y(geoLat);
279  geoCenter.x(geoLon);
280 
281  int32_t geoRow, geoCol; // note row,col are 0 based
282  float tmpFloat;
283  shape->latlon2rowcol(geoLat, geoLon, geoRow, geoCol);
284  shape->rowcol2latlon(geoRow, geoCol, geoLat, tmpFloat); // adjust lat on the row center
285 
286  float deltaLat = 180.0 / shape->getNumRows();
287  float lat = geoLat;
288  bool binFound = true;
289 
290  // look up
291  while (binFound) {
292  if (lat > 90.0)
293  break;
294  binFound = addBinsFromRow(lat, geoLon, geo, areaWeighted);
295  lat = lat + deltaLat;
296  }
297 
298  // look down
299  binFound = true;
300  lat = geoLat - deltaLat;
301  while (binFound) {
302  if (lat < -90.0)
303  break;
304  binFound = addBinsFromRow(lat, geoLon, geo, areaWeighted);
305  lat = lat - deltaLat;
306  }
307 
308  if (outBin.nobs == 0)
309  return NULL;
310  else
311  return &outBin;
312  }
313 
314  virtual Hdf::hdf_bin* getHdfBinObject() const;
315  virtual bool hasQuality();
316  virtual void setQualityProcessing(bool val);
317  virtual bool getQualityProcessing() const;
318  virtual int64_t getBaseBin(int32_t row) const;
319  virtual int32_t getRowExtent(int32_t row) const;
320 
321  virtual L3Shape* getShape() const {
322  return shape;
323  }
324 
325 };
326 
327 } // namespace l3
328 
329 #endif
l3::L3File::close
virtual void close()
Definition: L3File.cpp:467
l3::constrainLat
double constrainLat(double lat)
Definition: L3Shape.cpp:13
index
an array had not been initialized Several spelling and grammar corrections were which is read from the appropriate MCF the above metadata values were hard coded A problem calculating the average background DN for SWIR bands when the moon is in the space view port was corrected The new algorithm used to calculate the average background DN for all reflective bands when the moon is in the space view port is now the same as the algorithm employed by the thermal bands For non SWIR changes in the averages are typically less than Also for non SWIR the black body DNs remain a backup in case the SV DNs are not available For SWIR the changes in computed averages were larger because the old which used the black body suffered from contamination by the micron leak As a consequence of the if SV DNs are not available for the SWIR the EV pixels will not be the granule time is used to identify the appropriate tables within the set given for one LUT the first two or last two tables respectively will be used for the interpolation If there is only one LUT in the set of it will be treated as a constant LUT The manner in which Earth View data is checked for saturation was changed Previously the raw Earth View DNs and Space View DNs were checked against the lookup table values contained in the table dn_sat The change made is to check the raw Earth and Space View DNs to be sure they are less than the maximum saturation value and to check the Space View subtracted Earth View dns against a set of values contained in the new lookup table dn_sat_ev The metadata configuration and ASSOCIATEDINSTRUMENTSHORTNAME from the MOD02HKM product The same metatdata with extensions and were removed from the MOD021KM and MOD02OBC products ASSOCIATEDSENSORSHORTNAME was set to MODIS in all products These changes are reflected in new File Specification which users may consult for exact the pow functions were eliminated in Emissive_Cal and Emissive bands replaced by more efficient code Other calculations throughout the code were also made more efficient Aside from a few round off there was no difference to the product The CPU time decreased by about for a day case and for a night case A minor bug in calculating the uncertainty index for emissive bands was corrected The frame index(0-based) was previously being used the frame number(1-based) should have been used. There were only a few minor changes to the uncertainty index(maximum of 1 digit). 3. Some inefficient arrays(Sigma_RVS_norm_sq) were eliminated and some code lines in Preprocess_L1A_Data were moved into Process_OBCEng_Emiss. There were no changes to the product. Required RAM was reduced by 20 MB. Now
l3::L3Bin::~L3Bin
~L3Bin()
Definition: L3File.cpp:24
l3::L3File::getRowExtent
virtual int32_t getRowExtent(int32_t row) const
Get the extent of bins in a row.
Definition: L3File.cpp:857
l3::Box_t
boost::geometry::model::box< Point_t > Box_t
Definition: L3File.h:23
l3::L3File::getClosestBin
virtual L3Bin * getClosestBin(float lat, float lon)
Definition: L3File.cpp:763
l3::L3File::activeProdNameList
std::vector< std::string > activeProdNameList
array of active product names
Definition: L3File.h:158
l3::L3Row::numBins
int64_t numBins
Definition: L3File.h:124
l3::L3Bin::operator=
L3Bin & operator=(const L3Bin &bin)
Definition: L3File.cpp:132
meta_l3bType
Definition: meta_l3b.h:15
l3::L3Bin::sumSquares
float * sumSquares
Definition: L3File.h:74
l3::L3File::hasQuality
virtual bool hasQuality()
Definition: L3File.cpp:812
l3::L3Shape::getNumCols
virtual int32_t getNumCols(int32_t row) const =0
l3::calcIntersectionArea< Box_t >
float calcIntersectionArea< Box_t >(Box_t &box, Box_t &geo)
Definition: L3File.h:38
l3::L3File::binObj
Hdf::hdf_bin * binObj
Definition: L3File.h:148
l3::L3File::qualityBuffer
uint8_t * qualityBuffer
buffer for the quality (2*nrows)
Definition: L3File.h:155
l3::L3Bin::getSumSquares
float getSumSquares(int32_t prodId=0) const
Definition: L3File.cpp:253
l3::L3File::extentbin
int32_t * extentbin
save the number of records in each row
Definition: L3File.h:152
NULL
#define NULL
Definition: decode_rs.h:63
l3::L3Row::getBin
L3Bin * getBin(int64_t binNum)
Definition: L3File.cpp:336
l3::L3File::getActiveProductName
virtual std::string getActiveProductName(size_t index=0)
Definition: L3File.cpp:656
l3::L3Bin::nscenes
int32_t nscenes
Definition: L3File.h:69
l3::L3File::rowList
std::list< L3Row * > rowList
Definition: L3File.h:149
l3::L3File::open
virtual bool open(const char *fileName)
Definition: L3File.cpp:454
l3::L3Row::binArray
std::vector< L3Bin * > binArray
Definition: L3File.h:125
l3::L3File::baseRecord
int64_t * baseRecord
first record index of each row (0 based)
Definition: L3File.h:151
l3::Point_t
boost::geometry::model::d2::point_xy< float > Point_t
Definition: L3File.h:21
l3::L3File::latlon2record
virtual int64_t latlon2record(float lat, float lon)
Definition: L3File.cpp:586
l3::L3File::addBinsFromRow
bool addBinsFromRow(float lat0, float lon0, Geometry geo, bool areaWeighted)
Definition: L3File.h:173
l3::L3File::getBin
virtual L3Bin * getBin(int32_t row, int32_t col)
Definition: L3File.cpp:785
l3::L3Row::row
int32_t row
Definition: L3File.h:122
l3::L3Bin::numProducts
int32_t numProducts
Definition: L3File.h:65
l3::L3Bin::nobs
int32_t nobs
Definition: L3File.h:68
l3::constrainLon
double constrainLon(double lon)
Definition: L3Shape.cpp:26
l3::L3File::setNumCacheRows
virtual void setNumCacheRows(int32_t numRows)
Definition: L3File.cpp:444
l3::L3Bin::getWeights
float getWeights() const
Definition: L3File.cpp:226
l3::L3File::getShape
virtual L3Shape * getShape() const
Definition: L3File.h:321
string
@ string
Definition: GEO_read_param_file.c:64
l3::L3Row::getBinByIndex
L3Bin * getBinByIndex(int32_t index)
Definition: L3File.cpp:382
l3::L3File::getNumRows
virtual int32_t getNumRows()
Definition: L3File.cpp:750
l3::L3File::setActiveProductList
virtual bool setActiveProductList(const char *prodStr)
Definition: L3File.cpp:615
run_local.lat
lat
Definition: run_local.py:69
l3::L3Shape::latlon2rowcol
virtual void latlon2rowcol(double lat, double lon, int32_t &row, int32_t &col) const =0
l3::L3File::~L3File
virtual ~L3File()
Definition: L3File.cpp:427
l3::L3Bin::operator+=
L3Bin & operator+=(const L3Bin &bin)
Definition: L3File.cpp:137
l3::L3File::getNumProducts
virtual int32_t getNumProducts()
Definition: L3File.cpp:605
l3::L3Bin::getNumProducts
int32_t getNumProducts() const
Definition: L3File.cpp:178
l3::L3File::getProductName
virtual std::string getProductName(size_t index=0)
Definition: L3File.cpp:611
run_local.lon
lon
Definition: run_local.py:69
l3::L3Bin::quality
uint8_t quality
Definition: L3File.h:70
Hdf::hdf_bin
Definition: hdf_bin.h:14
l3::L3File::setQualityProcessing
virtual void setQualityProcessing(bool val)
Definition: L3File.cpp:819
l3::L3File::getRow
virtual L3Row * getRow(int32_t row)
Definition: L3File.cpp:719
l3::L3File::getNumActiveProducts
virtual int32_t getNumActiveProducts()
Definition: L3File.cpp:652
l3::L3File::rowcol2record
virtual int64_t rowcol2record(int32_t row, int32_t col)
Definition: L3File.cpp:574
l3::L3Shape::rowcol2latlon
virtual void rowcol2latlon(int32_t row, int32_t col, double &lat, double &lon) const =0
l3::L3File::outBin
L3Bin outBin
accumulation bin for lookups
Definition: L3File.h:154
l3::L3Bin::weights
float weights
Definition: L3File.h:72
l3::L3Bin::getQuality
uint8_t getQuality() const
Definition: L3File.cpp:234
l3::L3File::clearCache
virtual void clearCache()
Definition: L3File.cpp:435
l3::L3Row::getRow
int32_t getRow() const
Definition: L3File.cpp:312
l3::L3File::getBinsInside
L3Bin * getBinsInside(Geometry geo, bool areaWeighted=false)
Definition: L3File.h:268
l3::L3File::getMetaData
virtual meta_l3bType * getMetaData()
Definition: L3File.cpp:499
l3::missingPixelValue
const float missingPixelValue
Definition: L3File.h:19
l3::L3File::readRow
virtual L3Row * readRow(int32_t row)
Definition: L3File.cpp:660
l3::L3Bin::L3Bin
L3Bin(int32_t numProducts=1)
Definition: L3File.cpp:16
l3::L3Bin::getObsTime
float getObsTime() const
Definition: L3File.cpp:218
l3::L3Row::getNumBins
int64_t getNumBins() const
Definition: L3File.cpp:320
l3::L3Bin::getBinNum
int64_t getBinNum() const
Definition: L3File.cpp:186
l3::L3Bin::binNum
int64_t binNum
Definition: L3File.h:66
hdf_bin.h
l3::L3Bin::addWeighted
void addWeighted(const L3Bin &bin, Geometry1 &box, Geometry2 &geo)
Definition: L3File.h:89
l3::L3Bin::timeRec
float timeRec
Definition: L3File.h:71
l3::L3File::numCacheRows
int numCacheRows
Definition: L3File.h:150
l3::L3Bin::getNobs
int32_t getNobs() const
Definition: L3File.cpp:194
l3::L3File::numProds
size_t numProds
Definition: L3File.h:157
l3::L3Bin::clear
void clear()
Definition: L3File.cpp:29
l3::L3Row::setNumBins
void setNumBins(int64_t numBins)
Definition: L3File.cpp:324
l3::L3Bin::getRecordNum
int64_t getRecordNum() const
Definition: L3File.cpp:210
l3::L3Bin::getMean
float getMean(int32_t prodId=0) const
Definition: L3File.cpp:263
l3::L3Shape::getNumRows
virtual int32_t getNumRows() const
Definition: L3Shape.cpp:55
l3::L3Row::getNumProducts
int32_t getNumProducts() const
Definition: L3File.cpp:316
l3::L3Bin::getStdev
float getStdev(int32_t prodId=0) const
Definition: L3File.cpp:288
l3::L3Row::getLastBinNum
int64_t getLastBinNum()
Return the bin number for the last valid bin in the row.
Definition: L3File.cpp:404
l3::L3Bin::getVariance
float getVariance(int32_t prodId=0) const
Definition: L3File.cpp:273
l3::calcIntersectionArea
float calcIntersectionArea(Box_t &box, Geometry &geo)
Definition: L3File.h:26
l3::L3Bin::setNumProducts
void setNumProducts(int32_t numProducts)
Definition: L3File.cpp:163
l3::L3Row::getFirstBinNum
int64_t getFirstBinNum()
Return the bin number for the first valid bin in the row.
Definition: L3File.cpp:392
l3::L3File::getHdfBinObject
virtual Hdf::hdf_bin * getHdfBinObject() const
Definition: L3File.cpp:808
l3
Definition: L3File.cpp:10
l3::L3Row::L3Row
L3Row(int32_t row, int64_t numBins, int32_t numProducts)
Definition: L3File.cpp:297
l3::L3File::getBaseBin
virtual int64_t getBaseBin(int32_t row) const
return the base bin number for a row
Definition: L3File.cpp:847
l3::L3Bin::recordNum
int64_t recordNum
Definition: L3File.h:67
l3::L3Bin::sums
float * sums
Definition: L3File.h:73
l3::L3Bin::getNscenes
int32_t getNscenes() const
Definition: L3File.cpp:202
l3::L3File::getQualityProcessing
virtual bool getQualityProcessing() const
Definition: L3File.cpp:835
l3::L3File::prodMap
size_t * prodMap
index map used to map my product index into binObj's index
Definition: L3File.h:156
l3::L3Bin::addWeighted
void addWeighted(const L3Bin &bin, float weighting)
Definition: L3File.cpp:142
l3::L3Row::numProducts
int32_t numProducts
Definition: L3File.h:123
l3::L3File::rowbin2record
virtual int64_t rowbin2record(int32_t row, int64_t bin)
Definition: L3File.cpp:553
p
float p[MODELMAX]
Definition: atrem_corl1.h:131
l3::L3Bin::getSum
float getSum(int32_t prodId=0) const
Definition: L3File.cpp:243
l3::L3File::initRecordLookup
virtual int initRecordLookup()
Definition: L3File.cpp:510
l3::Polygon_t
boost::geometry::model::polygon< Point_t > Polygon_t
Definition: L3File.h:22
l3::L3File::sumBuffer
float * sumBuffer
buffer for the sums (sum, sumSq, 2*nrows, numProd)
Definition: L3File.h:153
l3::L3File::bin2record
virtual int64_t bin2record(int64_t bin)
Definition: L3File.cpp:599
l3::L3File::shape
L3Shape * shape
Definition: L3File.h:147
l3::L3Row::lastBin
int64_t lastBin
Definition: L3File.h:126


ABOUT

Our Team

Contact Us

DATA

Get Started

Find Data

Use Data

TOOLS

SeaBASS

SeaDAS

Giovanni Data Visualizer

Worldview Mapping Interface

Mission Quality Monitor

HELP

How to Use Earthdata Search

Level 3 & 4 Browser Help

File Search Help

Search & Download Help

Earthdata Forum

Join Mailing List

How to Cite Data

CONNECT WITH US
COMPLIANCE

Web Privacy Policy

Data & Information Policy

Communications Policy

Accessibility

Freedom of Information Act

USA.gov

Responsible NASA Official: Sean Bailey
Curator: OceanColor Webmaster