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
l1c.h
Go to the documentation of this file.
1 /*
2  * File: l1c.h
3  * Author: mmontes
4  *
5  * Created on November 4, 2020, 8:45 AM
6  * // last version 8/15/2022
7  */
8 
9 #ifndef L1C_H
10 #define L1C_H
11 
12 #include <stdio.h>
13 #include <string>
14 #include <vector>
15 #include <filetype.h>
16 #include "l1c_filehandle.h"
17 #include "l1c_str.h"
18 #include "l2_str.h"
19 #include "l1c_input.h"
20 #include "hawkeye_methods.h"
21 #include <boost/assign/list_of.hpp> // for 'list_of()'
22 #include <boost/assert.hpp>
23 #include <boost/algorithm/string.hpp>
24 #include <boost/geometry.hpp>
25 #include <boost/geometry/geometries/point_xy.hpp>
26 #include <boost/geometry/geometries/polygon.hpp>
27 #include <boost/geometry/geometries/box.hpp>
28 #include <boost/foreach.hpp>
29 #include <GeographicLib/Geodesic.hpp>
30 #include <GeographicLib/Constants.hpp>
31 #include <netcdf>
32 
33 #define READ 0
34 #define WRITE 1
35 
36 namespace bg = boost::geometry;
37 typedef bg::model::point<double, 2, bg::cs::geographic<bg::degree>> Point_t;
38 typedef bg::model::polygon<Point_t> Polygon_t;
39 typedef bg::model::box<Point_t> Box_t;
40 typedef double orb_array2[3];
41 
42 namespace l1c {
43 
44 class L1C {
45  protected:
46  public:
47  // methods--------------------------------------
48  L1C();
49  virtual ~L1C();
50 
51  virtual int32_t load_l1c_filehandle4(l1c_filehandle *l1cfile, L1C_input *l1cinput);
52 
53  virtual int32_t ect_swt(l1c_filehandle *l1cfile, int ix1, int ix2, double *tswt_tot, double *latswt_tot,
54  double *lonswt_tot, double *ovel_tot, double *gvel_tot, double *tswt,
55  double *latswt, double *lonswt, float *tcross, float *loncross, double *ovel,
56  double *gvel);
57  virtual int32_t create_time_swt(int num_gridlines, double tfile_ini_sec, double *tmgvf,
58  double tswt_ini_sec, double tswt_end_sec, std::string *tswt_ini,
59  std::string *tswt_ini_file, std::string *tswt_mid,std::string *tswt_end);
60  virtual int32_t swtime_swt2(int swt, L1C_input *l1cinput, l1c_filehandle *l1cfile, int32_t norbs,
61  double *tswt, double tcross, double mgv, double *tmgv);
62  virtual int32_t swtime_swt2_segment(int swt, L1C_input *l1cinput, l1c_filehandle *l1cfile, int32_t norbs,
63  double *tswt, double tcross, double mgv, double *tmgv);
64  virtual int32_t write_L1C_granule2(int swtd, l1c_filehandle *l1cfile, L1C_input *l1cinput, double *tmgv,
65  float **lat_gd, float **lon_gd, float **alt_gd,double *orb_time_tot);
66  virtual int32_t open_l1atol1c3(L1C_input *l1cinput, l1c_filehandle *l1cfile);
67  virtual int search_l1cgen(L1C_input *l1cinput, l1c_str *l1cstr, l1c_filehandle *l1cfile, short **gdindex);
68  virtual int32_t create_SOCEA2(int swtd, L1C_input *l1cinput, l1c_filehandle *l1cfile, float **lat_gd,
69  float **lon_gd, float **altitude, double *tswt);
70  virtual int32_t openL1Cgrid3(l1c_str *l1cstr, l1c_filehandle *l1cfile, L1C_input *l1cinput);
71  virtual int32_t l1_cloud_correct(L1C_input *l1cinput, l1c_filehandle *l1cfile);
72  virtual int32_t add_proc_group_l1c(L1C_input *l1cinput,l1c_filehandle *l1cfile,const char* filename);
73 
74  //---------------------------------------------
75  // global attributes----
76  std::string l1b_name; // just the input l1b filenamed
77  size_t sd_id;
78 
79  // more L1C input vars
80  size_t l1c_pflag; // L1C processing
81  std::vector<std::string> cust_l1cprod; // list of L1c products to be included, flexible approach
82 
83  file_type format; // file type, netcdf4 or hdf4/5
84  // size_t mode;//l1c processing mode ---
85  size_t length; // data block
86  size_t sensorID; // original int32 changed to size_t type
87  size_t subsensorID;
88  float res_spat; // spatial resolution in km
89  float res_spec; // spectral resolution in nm
90 
91  // dimensions--
92  size_t ndets;
93  size_t nscan;
94  size_t n_views; // sensor views
95  size_t npols; // polarization states
96  size_t nbands; // number of total bands
97  size_t nband_blue; // this includes uv + visible bands
98  size_t nband_red; // this inc
99  size_t nband_swir;
100  size_t npix; // num
101 
102  // sensor characteritics
103  float *views; // indexes are not defined
104  size_t pols[3]; //[1 0 0] non-pol, [1 1 0]: non+cross, [1 1 1]: non+cross+parall
105  float *bbands; // array with bands wavelengths
106  float *rbands;
107  float *swirbands;
108 
109  // navigation attributes
110  // fred attr here
111  size_t orbit_number;
112  size_t orb_dir; // asc or desc orbit
113  float orbit_node_lon; // long at which is crossing the equator asc or desc
114 
115  // geolocation attributes
116  size_t terrain_corrected;
117  size_t cloud_corrected;
118  float *cloud_height; // should be in geolocation group nc file
119 
120  // calibration attributes
121  float *Fobar;
122 
123  // projection attributes-
124  // std::string proj_type;
125  size_t projection;
126  float grid_resolution; // grid resolution in km
127  // these params go to proj class
128 
129  // multi attributes (view, pol, bands)
130  float *view_agg; // views to be aggregated for later products such as vsfs etc
131  float *pol_agg; // polarization states to be aggregated for post-processing products, linear
132  // depolarization ratio etc
133  float *band_agg; // specific bands for future merged products
134  bool overlap_vflag; // tells if we want merged views
135  bool overlap_pflag; // tells if we want merged polarizations
136  bool overlap_bflag; // tells if we want merged spectral bands
137  // uncertainty params for merged l1c products
138  size_t unc_meth; // 0: no error calculation, 1: propagation, 2: Monte Carlo
139  float unc_thres_v; // uncertainity threshold of angular merged products as %
140  float unc_thres_p; // same but for polarization
141  float unc_thres_b; // same but for spectral bands
142  // ancill info, requested products?
143  // float *cloud_h;//this is cloud_height
144 };
145 
146 // protos---
147 int32_t load_l1c_filehandle4(l1c_filehandle *l1cfile, L1C_input *l1cinput);
148 int32_t ect_swt(l1c_filehandle *l1cfile, int ix1, int ix2, double *tswt_tot, double *latswt_tot,
149  double *lonswt_tot, double *ovel_tot, double *gvel_tot, double *tswt, double *latswt,
150  double *lonswt, float *tcross, float *loncross, double *ovel, double *gvel);
151 int32_t create_time_swt(int num_gridlines, double tfile_ini_sec, double *tmgvf, double tswt_ini_sec,
152  double tswt_end_sec, std::string *tswt_ini, std::string *tswt_ini_file,std::string *tswt_mid,
153  std::string *tswt_end);
154 int32_t swtime_swt2(int swt, L1C_input *l1cinput, l1c_filehandle *l1cfile, int32_t norbs, double *tswt,
155  double tcross, double mgv, double *tmgv);
156 int32_t swtime_swt2_segment(int swt, L1C_input *l1cinput, l1c_filehandle *l1cfile, int32_t norbs,
157  double *tswt, double tcross, double mgv, double *tmgv);
158 int32_t write_L1C_granule2(int swtd, l1c_filehandle *l1cfile, L1C_input *l1cinput, double *tmgv,
159  float **lat_gd, float **lon_gd, float **alt_gd,double *orb_time_tot);
160 int32_t open_l1atol1c3(L1C_input *l1cinput, l1c_filehandle *l1cfile);
161 int search_l1cgen(L1C_input *l1cinput, l1c_str *l1cstr, l1c_filehandle *l1cfile, short **gdindex);
162 int32_t create_SOCEA2(int swtd, L1C_input *l1cinput, l1c_filehandle *l1cfile, float **lat_gd, float **lon_gd,
163  float **altitude, double *tswt);
164 int32_t openL1Cgrid3(l1c_str *l1cstr, l1c_filehandle *l1cfile, L1C_input *l1cinput);
165 int32_t add_proc_group_l1c(L1C_input *l1cinput,l1c_filehandle *l1cfile,const char* filename);
166 
167 } // namespace l1c
168 #endif
l1c::L1C::subsensorID
size_t subsensorID
Definition: l1c.h:87
l1c::L1C::Fobar
float * Fobar
Definition: l1c.h:121
l1c::L1C::l1b_name
std::string l1b_name
Definition: l1c.h:76
l1c::L1C::orbit_node_lon
float orbit_node_lon
Definition: l1c.h:113
l1c::open_l1atol1c3
int32_t open_l1atol1c3(L1C_input *l1cinput, l1c_filehandle *l1cfile)
l1c::L1C::grid_resolution
float grid_resolution
Definition: l1c.h:126
l1c::L1C::overlap_pflag
bool overlap_pflag
Definition: l1c.h:135
l1c::L1C::swirbands
float * swirbands
Definition: l1c.h:107
l1c::L1C::openL1Cgrid3
virtual int32_t openL1Cgrid3(l1c_str *l1cstr, l1c_filehandle *l1cfile, L1C_input *l1cinput)
Definition: l1c.cpp:2813
l1c::L1C::swtime_swt2_segment
virtual int32_t swtime_swt2_segment(int swt, L1C_input *l1cinput, l1c_filehandle *l1cfile, int32_t norbs, double *tswt, double tcross, double mgv, double *tmgv)
Definition: l1c.cpp:661
l1c_input.h
l1c::L1C::orbit_number
size_t orbit_number
Definition: l1c.h:111
l1c::L1C::band_agg
float * band_agg
Definition: l1c.h:133
l1c::L1C::ect_swt
virtual int32_t ect_swt(l1c_filehandle *l1cfile, int ix1, int ix2, double *tswt_tot, double *latswt_tot, double *lonswt_tot, double *ovel_tot, double *gvel_tot, double *tswt, double *latswt, double *lonswt, float *tcross, float *loncross, double *ovel, double *gvel)
Definition: l1c.cpp:784
l1c_str.h
l1c::swtime_swt2_segment
int32_t swtime_swt2_segment(int swt, L1C_input *l1cinput, l1c_filehandle *l1cfile, int32_t norbs, double *tswt, double tcross, double mgv, double *tmgv)
Polygon_t
bg::model::polygon< Point_t > Polygon_t
Definition: l1c.h:38
l1c::L1C::ndets
size_t ndets
Definition: l1c.h:92
l1c::L1C::nband_red
size_t nband_red
Definition: l1c.h:98
l1c::L1C::create_SOCEA2
virtual int32_t create_SOCEA2(int swtd, L1C_input *l1cinput, l1c_filehandle *l1cfile, float **lat_gd, float **lon_gd, float **altitude, double *tswt)
Definition: l1c.cpp:2149
l1c::L1C::unc_meth
size_t unc_meth
Definition: l1c.h:138
l1c::L1C::n_views
size_t n_views
Definition: l1c.h:94
l1c::swtime_swt2
int32_t swtime_swt2(int swt, L1C_input *l1cinput, l1c_filehandle *l1cfile, int32_t norbs, double *tswt, double tcross, double mgv, double *tmgv)
l1c::L1C::projection
size_t projection
Definition: l1c.h:125
l1c::write_L1C_granule2
int32_t write_L1C_granule2(int swtd, l1c_filehandle *l1cfile, L1C_input *l1cinput, double *tmgv, float **lat_gd, float **lon_gd, float **alt_gd, double *orb_time_tot)
l1c::L1C::npix
size_t npix
Definition: l1c.h:100
string
@ string
Definition: GEO_read_param_file.c:64
l1c::L1C::pol_agg
float * pol_agg
Definition: l1c.h:131
l1c::ect_swt
int32_t ect_swt(l1c_filehandle *l1cfile, int ix1, int ix2, double *tswt_tot, double *latswt_tot, double *lonswt_tot, double *ovel_tot, double *gvel_tot, double *tswt, double *latswt, double *lonswt, float *tcross, float *loncross, double *ovel, double *gvel)
orb_array2
double orb_array2[3]
Definition: l1c.h:40
l1c::L1C::terrain_corrected
size_t terrain_corrected
Definition: l1c.h:116
l1c::L1C::unc_thres_p
float unc_thres_p
Definition: l1c.h:140
l1c::L1C::L1C
L1C()
Definition: l1c.cpp:73
l1c::L1C::unc_thres_b
float unc_thres_b
Definition: l1c.h:141
l1c::l1c_filehandle
Definition: l1c_filehandle.h:25
l1c::L1C
Definition: l1c.h:44
l1c::L1C::npols
size_t npols
Definition: l1c.h:95
l1c::L1C::~L1C
virtual ~L1C()
Definition: l1c.cpp:76
l1c::L1C::unc_thres_v
float unc_thres_v
Definition: l1c.h:139
l1c::L1C::nband_swir
size_t nband_swir
Definition: l1c.h:99
l1c::L1C::cloud_corrected
size_t cloud_corrected
Definition: l1c.h:117
l1c::L1C::nband_blue
size_t nband_blue
Definition: l1c.h:97
l1c::L1C::length
size_t length
Definition: l1c.h:85
l1c::L1C::res_spat
float res_spat
Definition: l1c.h:88
l1c::L1C::cloud_height
float * cloud_height
Definition: l1c.h:118
l1c::load_l1c_filehandle4
int32_t load_l1c_filehandle4(l1c_filehandle *l1cfile, L1C_input *l1cinput)
l1c::L1C::search_l1cgen
virtual int search_l1cgen(L1C_input *l1cinput, l1c_str *l1cstr, l1c_filehandle *l1cfile, short **gdindex)
Definition: l1c.cpp:2655
l1c::L1C::open_l1atol1c3
virtual int32_t open_l1atol1c3(L1C_input *l1cinput, l1c_filehandle *l1cfile)
Definition: l1c.cpp:1061
l1c::add_proc_group_l1c
int32_t add_proc_group_l1c(L1C_input *l1cinput, l1c_filehandle *l1cfile, const char *filename)
l1c::L1C::cust_l1cprod
std::vector< std::string > cust_l1cprod
Definition: l1c.h:81
l1c::L1C::swtime_swt2
virtual int32_t swtime_swt2(int swt, L1C_input *l1cinput, l1c_filehandle *l1cfile, int32_t norbs, double *tswt, double tcross, double mgv, double *tmgv)
Definition: l1c.cpp:724
filename
char filename[FILENAME_MAX]
Definition: atrem_corl1.h:122
l1c::L1C::add_proc_group_l1c
virtual int32_t add_proc_group_l1c(L1C_input *l1cinput, l1c_filehandle *l1cfile, const char *filename)
Definition: l1c.cpp:79
l1c::L1C::bbands
float * bbands
Definition: l1c.h:105
l1c::L1C::l1c_pflag
size_t l1c_pflag
Definition: l1c.h:80
hawkeye_methods.h
l1c
Definition: l1c.cpp:71
l1c::create_time_swt
int32_t create_time_swt(int num_gridlines, double tfile_ini_sec, double *tmgvf, double tswt_ini_sec, double tswt_end_sec, std::string *tswt_ini, std::string *tswt_ini_file, std::string *tswt_mid, std::string *tswt_end)
l1c::L1C::nscan
size_t nscan
Definition: l1c.h:93
l1c::L1C::view_agg
float * view_agg
Definition: l1c.h:130
l1c::L1C::sensorID
size_t sensorID
Definition: l1c.h:86
file_type
file_type
Definition: filetype.h:11
l1c::L1C::res_spec
float res_spec
Definition: l1c.h:89
l1c::L1C::l1_cloud_correct
virtual int32_t l1_cloud_correct(L1C_input *l1cinput, l1c_filehandle *l1cfile)
Definition: l1c.cpp:245
l1c::L1C::format
file_type format
Definition: l1c.h:83
color_dtdb.bg
bg
Definition: color_dtdb.py:451
l1c_filehandle.h
geometry
subroutine geometry
Definition: atrem_app_refl_f90_cubeio.f:1329
l2_str.h
l1c::L1C::nbands
size_t nbands
Definition: l1c.h:96
l1c::l1c_str
Definition: l1c_str.h:19
l1c::L1C::write_L1C_granule2
virtual int32_t write_L1C_granule2(int swtd, l1c_filehandle *l1cfile, L1C_input *l1cinput, double *tmgv, float **lat_gd, float **lon_gd, float **alt_gd, double *orb_time_tot)
Definition: l1c.cpp:2921
l1c::L1C::sd_id
size_t sd_id
Definition: l1c.h:77
l1c::L1C::pols
size_t pols[3]
Definition: l1c.h:104
l1c::L1C::load_l1c_filehandle4
virtual int32_t load_l1c_filehandle4(l1c_filehandle *l1cfile, L1C_input *l1cinput)
Definition: l1c.cpp:3479
l1c::L1C_input
Definition: l1c_input.h:24
Box_t
bg::model::box< Point_t > Box_t
Definition: l1c.h:39
l1c::L1C::views
float * views
Definition: l1c.h:103
Point_t
bg::model::point< double, 2, bg::cs::geographic< bg::degree > > Point_t
Definition: l1c.h:37
l1c::L1C::rbands
float * rbands
Definition: l1c.h:106
l1c::openL1Cgrid3
int32_t openL1Cgrid3(l1c_str *l1cstr, l1c_filehandle *l1cfile, L1C_input *l1cinput)
l1c::L1C::create_time_swt
virtual int32_t create_time_swt(int num_gridlines, double tfile_ini_sec, double *tmgvf, double tswt_ini_sec, double tswt_end_sec, std::string *tswt_ini, std::string *tswt_ini_file, std::string *tswt_mid, std::string *tswt_end)
Definition: l1c.cpp:925
l1c::L1C::overlap_vflag
bool overlap_vflag
Definition: l1c.h:134
l1c::create_SOCEA2
int32_t create_SOCEA2(int swtd, L1C_input *l1cinput, l1c_filehandle *l1cfile, float **lat_gd, float **lon_gd, float **altitude, double *tswt)
l1c::search_l1cgen
int search_l1cgen(L1C_input *l1cinput, l1c_str *l1cstr, l1c_filehandle *l1cfile, short **gdindex)
l1c::L1C::overlap_bflag
bool overlap_bflag
Definition: l1c.h:136
l1c::L1C::orb_dir
size_t orb_dir
Definition: l1c.h:112


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