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
readL2scan.h
Go to the documentation of this file.
1 #ifndef READL2SCAN_H
2 #define READL2SCAN_H
3 
4 #include <dfutils.h>
5 #include <stdint.h>
6 
7 #define byte uint8_t
8 
9 #define MAXNFILES 10000 /* Increase to 544 09/25/06 JMG - 800 WDR */
10 #define MAXNUMBERPRODUCTS 2000
11 #ifdef __cplusplus
12 extern "C" {
13 #endif
14 
15 // set of functions defined in expand 3D module
16 void l3_l2_conversion(char **inp3, char **out2);
17 void l3_l2_index(char **inp3, int *start, int *count);
18 int get_set_flag();
19 int get_l2_flag_use();
20 typedef struct l2prod_struct {
21  int32_t fileindex;
22 
23  char filename[256];
24  char oformat[32];
25 
26  int32_t nrec;
27  int32_t nsamp;
28 
29  int16_t syear;
30  int16_t sday;
31  int32_t smsec;
32  int16_t eyear;
33  int16_t eday;
34  int32_t emsec;
35  int32_t orbit;
36  char dtype[8];
37 
38  int32_t ntilts;
39  int16_t tilt_flags[20];
40  int16_t tilt_ranges[2][20];
41 
42  char *flagnames;
43  int32_t flagmask;
44 
45  int32_t year;
46  int32_t day;
47  int32_t msec;
48 
49  int32_t *year_cache;
50  int32_t *day_cache;
51  int32_t *msec_cache;
52  double *scantime_cache;
53 
54  float *longitude;
55  float *latitude;
56 
57  float *geonav[6];
58 
59  float *lon_cntl;
60  float *lat_cntl;
61  float *cntl_pnts;
62  float *cntl_pnts_cache;
63  float *spline_arr;
64 
65  int32_t nprod;
66  char *prodname[MAXNUMBERPRODUCTS];
67  float bv_unscaled[MAXNUMBERPRODUCTS];
68  int16_t bv_scaled[MAXNUMBERPRODUCTS];
69  int32_t thirdDim[MAXNUMBERPRODUCTS];
70 
71  float **l2_data;
72  int32_t *l2_flags;
73  int32_t *l2_bits;
74 
75  byte eng_qual[4];
76  byte s_flags[4];
77  int32_t nflag[8];
78 
79  int32_t geointerp;
80 
81  byte *mside;
82  byte *detnum;
83  int32_t *pixnum;
84 
85  // area weighting variables
86  float *lat1; // lat1 for corner of pixel
87  float *lon1; // lon1 for corner of pixel
88  float *lat2; // lat2 for corner of pixel
89  float *lon2; // lon2 for corner of pixel
90  byte lat2Valid; // does lat2 and lon2 contain valid coordinates
91 
92  int wavelength[250];
93  int wavelengths_3d[250];
94 
95  int32_t bandsPerPixel;
96  int32_t wavelength_3d;
97 } l2_prod;
98 
99 typedef struct meta_l2Struct {
100  char *product_name; /* ATTR Product name(file name) */
101  char *title;
102  char *data_center; /* ATTR data_center, processing center */
103  char *mission; /* ATTR mission */
104  char *mission_char; /* ATTR Mission Characteristics */
105  char *sensor_name; /* ATTR sensor name */
106  char *sensor; /* ATTR sensor */
107  char *sensor_char; /* ATTR instrumentInformation */
108  char *sw_id; /* ATTR Software ID */
109  char *infiles; /* ATTR Input files */
110  char *stime; /* ATTR Start time */
111  char *etime; /* ATTR End time */
112  char *ctime; /* ATTR scene center time */
113  char *ntime; /* ATTR Node crossing time */
114  char *snode; /* ATTR Start Node */
115  char *enode; /* ATTR End Node */
116  int orbnum; /* ATTR orbit number */
117  char *norad1; /* ATTR NORAD elements, first line */
118  char *norad2; /* ATTR NORAD elements, second line */
119  int pix_start; /* ATTR LAC Pixel Start Number */
120  int pix_sub; /* ATTR LAC Pixel Subsampling */
121  int ncrec; /* ATTR scene center scan line */
122  int nfrec; /* ATTR number of filled scan line */
123  byte ff_mis; /* ATTR FF missing frames */
124  byte sd_mis; /* ATTR SDPS missing frames */
125  float flags_pc[32]; /* MFSD % data for each quality flag */
126  char *lat_units; /* ATTR Latitude units */
127  char *lon_units; /* ATTR Longitude units */
128  float northlat; /* ATTR Northernmost latitude */
129  float southlat; /* ATTR Southernmost latitude */
130  float westlon; /* ATTR Westernmost longitude */
131  float eastlon; /* ATTR Easternmost longitude */
132  float startclat; /* ATTR Start Center Latitude */
133  float startclon; /* ATTR Start Center Longitude */
134  float endclat; /* ATTR End Center Latitude */
135  float endclon; /* ATTR End Center Longitude */
136  float nodel; /* ATTR Orbit node longitude */
137  int ntilts; /* MFSD Sensor Tilt */
138  /* Calibration Vgroup */
139  short entry_year;
140  short entry_day;
141  short ref_year;
142  short ref_day;
143  short ref_minute;
144 } meta_l2Type;
145 
146 /* Prototypes */
147 void free_rowgroup_cache();
148 void init_rowgroup_cache();
149 int32_t get_dtype(int32_t dtype, ds_format_t fileformat);
150 int32_t openL2(const char *fname, const char *plist, l2_prod *l2_str);
151 int32_t reopenL2(int32_t fileindex, l2_prod *l2_str);
152 int32_t readL2(l2_prod *l2_str, int32_t ifile, int32_t recnum, int32_t iprod,
153  unsigned char *scan_in_rowgroup);
154 int32_t readlonlat(l2_prod *l2_str, int32_t ifile, int32_t *start, int32_t *edges,
155  unsigned char *scan_in_rowgroup);
156 int32_t closeL2(l2_prod *l2_str, int32_t ifile);
157 int32_t freeL2(l2_prod *l2_str);
158 int32_t findprod(l2_prod *l2_str, char *prodname);
159 int32_t readL2meta(meta_l2Type *meta_l2, int32_t ifile);
160 int32_t freeL2meta(meta_l2Type *meta_l2);
161 int32_t getL3units(l2_prod *l2_str, int32_t ifile, char *l3b_prodname, char *units);
162 
163 enum L2PixelMode_t { L2PixelOff, L2PixelCorner, L2PixelDelta };
164 
170 void enableL2PixelArea(enum L2PixelMode_t val);
171 
172 #ifdef __cplusplus
173 }
174 #endif
175 #endif
l2prod_struct::lat2
float * lat2
Definition: readL2scan.h:88
meta_l2Struct::product_name
char * product_name
Definition: readL2scan.h:100
meta_l2Struct::orbnum
int orbnum
Definition: readL2scan.h:116
L2PixelOff
@ L2PixelOff
Definition: readL2scan.h:163
l2prod_struct::spline_arr
float * spline_arr
Definition: readL2scan.h:63
l2prod_struct::lon_cntl
float * lon_cntl
Definition: readL2scan.h:59
meta_l2Struct::ncrec
int ncrec
Definition: readL2scan.h:121
l2prod_struct::latitude
float * latitude
Definition: readL2scan.h:55
l2prod_struct::year_cache
int32_t * year_cache
Definition: readL2scan.h:49
get_set_flag
int get_set_flag()
Definition: expand3D.cpp:434
l3_l2_conversion
void l3_l2_conversion(char **inp3, char **out2)
Definition: expand3D.cpp:413
meta_l2Struct::data_center
char * data_center
Definition: readL2scan.h:102
l2prod_struct::ntilts
int32_t ntilts
Definition: readL2scan.h:38
l3_l2_index
void l3_l2_index(char **inp3, int *start, int *count)
Definition: expand3D.cpp:428
meta_l2Struct::startclat
float startclat
Definition: readL2scan.h:132
meta_l2Struct::ntilts
int ntilts
Definition: readL2scan.h:137
reopenL2
int32_t reopenL2(int32_t fileindex, l2_prod *l2_str)
Definition: readL2scan.c:1050
getL3units
int32_t getL3units(l2_prod *l2_str, int32_t ifile, char *l3b_prodname, char *units)
Definition: readL2scan.c:2346
l2prod_struct::lon2
float * lon2
Definition: readL2scan.h:89
meta_l2Struct::nfrec
int nfrec
Definition: readL2scan.h:122
l2prod_struct::mside
byte * mside
Definition: readL2scan.h:81
meta_l2Struct::ref_day
short ref_day
Definition: readL2scan.h:142
meta_l2Struct::flags_pc
float flags_pc[32]
Definition: readL2scan.h:125
readL2meta
int32_t readL2meta(meta_l2Type *meta_l2, int32_t ifile)
Definition: readL2scan.c:2151
l2prod_struct::wavelength_3d
int32_t wavelength_3d
Definition: readL2scan.h:96
L2PixelCorner
@ L2PixelCorner
Definition: readL2scan.h:163
l2prod_struct::tilt_ranges
int16_t tilt_ranges[2][20]
Definition: readL2scan.h:40
l2prod_struct::msec
int32_t msec
Definition: readL2scan.h:47
l2prod_struct::cntl_pnts_cache
float * cntl_pnts_cache
Definition: readL2scan.h:62
l2prod_struct
Definition: readL2scan.h:20
l2prod_struct::bandsPerPixel
int32_t bandsPerPixel
Definition: readL2scan.h:95
l2prod_struct::thirdDim
int32_t thirdDim[MAXNUMBERPRODUCTS]
Definition: readL2scan.h:69
l2prod_struct::longitude
float * longitude
Definition: readL2scan.h:54
meta_l2Struct::lon_units
char * lon_units
Definition: readL2scan.h:127
l2prod_struct::oformat
char oformat[32]
Definition: readL2scan.h:24
meta_l2Struct::enode
char * enode
Definition: readL2scan.h:115
meta_l2Struct::lat_units
char * lat_units
Definition: readL2scan.h:126
l2prod_struct::nsamp
int32_t nsamp
Definition: readL2scan.h:27
l2prod_struct::wavelengths_3d
int wavelengths_3d[250]
Definition: readL2scan.h:93
meta_l2Struct::ctime
char * ctime
Definition: readL2scan.h:112
meta_l2Struct::ref_minute
short ref_minute
Definition: readL2scan.h:143
meta_l2Struct::pix_sub
int pix_sub
Definition: readL2scan.h:120
l2prod_struct::tilt_flags
int16_t tilt_flags[20]
Definition: readL2scan.h:39
l2prod_struct::cntl_pnts
float * cntl_pnts
Definition: readL2scan.h:61
l2prod_struct::wavelength
int wavelength[250]
Definition: readL2scan.h:92
l2prod_struct::geonav
float * geonav[6]
Definition: readL2scan.h:57
init_rowgroup_cache
void init_rowgroup_cache()
Definition: readL2scan.c:287
meta_l2Struct::stime
char * stime
Definition: readL2scan.h:110
l2prod_struct::emsec
int32_t emsec
Definition: readL2scan.h:34
L2PixelDelta
@ L2PixelDelta
Definition: readL2scan.h:163
meta_l2Struct::norad2
char * norad2
Definition: readL2scan.h:118
l2prod_struct::geointerp
int32_t geointerp
Definition: readL2scan.h:79
meta_l2Struct
Definition: readL2scan.h:99
l2prod_struct::year
int32_t year
Definition: readL2scan.h:45
l2prod_struct::detnum
byte * detnum
Definition: readL2scan.h:82
l2prod_struct::bv_scaled
int16_t bv_scaled[MAXNUMBERPRODUCTS]
Definition: readL2scan.h:68
meta_l2Struct::entry_day
short entry_day
Definition: readL2scan.h:140
recnum
read recnum
Definition: HOWTO_Add_a_sensor.txt:72
meta_l2Struct::sw_id
char * sw_id
Definition: readL2scan.h:108
meta_l2Struct::westlon
float westlon
Definition: readL2scan.h:130
l2prod_struct::fileindex
int32_t fileindex
Definition: readL2scan.h:21
meta_l2Struct::eastlon
float eastlon
Definition: readL2scan.h:131
l2prod_struct::l2_data
float ** l2_data
Definition: readL2scan.h:71
free_rowgroup_cache
void free_rowgroup_cache()
Definition: readL2scan.c:259
meta_l2Struct::northlat
float northlat
Definition: readL2scan.h:128
meta_l2Struct::snode
char * snode
Definition: readL2scan.h:114
meta_l2Struct::entry_year
short entry_year
Definition: readL2scan.h:139
l2prod_struct::msec_cache
int32_t * msec_cache
Definition: readL2scan.h:51
readL2
int32_t readL2(l2_prod *l2_str, int32_t ifile, int32_t recnum, int32_t iprod, unsigned char *scan_in_rowgroup)
Definition: readL2scan.c:1336
meta_l2Struct::mission
char * mission
Definition: readL2scan.h:103
MAXNUMBERPRODUCTS
#define MAXNUMBERPRODUCTS
Definition: readL2scan.h:10
findprod
int32_t findprod(l2_prod *l2_str, char *prodname)
Definition: readL2scan.c:2140
meta_l2Struct::endclon
float endclon
Definition: readL2scan.h:135
meta_l2Struct::ff_mis
byte ff_mis
Definition: readL2scan.h:123
l2prod_struct::l2_flags
int32_t * l2_flags
Definition: readL2scan.h:72
meta_l2Struct::ntime
char * ntime
Definition: readL2scan.h:113
meta_l2Struct::infiles
char * infiles
Definition: readL2scan.h:109
meta_l2Struct::norad1
char * norad1
Definition: readL2scan.h:117
l2prod_struct::smsec
int32_t smsec
Definition: readL2scan.h:31
eng_qual
Definition: eng_qual.h:87
meta_l2Struct::title
char * title
Definition: readL2scan.h:101
openL2
int32_t openL2(const char *fname, const char *plist, l2_prod *l2_str)
Definition: readL2scan.c:316
meta_l2Struct::pix_start
int pix_start
Definition: readL2scan.h:119
seadasutils.aquarius_utils.start
start
Definition: aquarius_utils.py:27
meta_l2Struct::sd_mis
byte sd_mis
Definition: readL2scan.h:124
meta_l2Struct::mission_char
char * mission_char
Definition: readL2scan.h:104
l2prod_struct::l2_bits
int32_t * l2_bits
Definition: readL2scan.h:73
color_dtdb.edges
edges
Definition: color_dtdb.py:331
hico.proc_hico.units
units
Definition: proc_hico.py:245
l2prod_struct::prodname
char * prodname[MAXNUMBERPRODUCTS]
Definition: readL2scan.h:66
l2prod_struct::eday
int16_t eday
Definition: readL2scan.h:33
l2prod_struct::nflag
int32_t nflag[8]
Definition: readL2scan.h:77
l2prod_struct::lon1
float * lon1
Definition: readL2scan.h:87
meta_l2Struct::nodel
float nodel
Definition: readL2scan.h:136
get_dtype
int32_t get_dtype(int32_t dtype, ds_format_t fileformat)
Definition: readL2scan.c:231
L2PixelMode_t
L2PixelMode_t
Definition: readL2scan.h:163
meta_l2Struct::sensor_char
char * sensor_char
Definition: readL2scan.h:107
meta_l2Struct::sensor
char * sensor
Definition: readL2scan.h:106
l2prod_struct::day
int32_t day
Definition: readL2scan.h:46
l2prod_struct::flagnames
char * flagnames
Definition: readL2scan.h:42
dtype
dtype
Definition: DDataset.hpp:31
l2prod_struct::scantime_cache
double * scantime_cache
Definition: readL2scan.h:52
meta_l2Struct::ref_year
short ref_year
Definition: readL2scan.h:141
readlonlat
int32_t readlonlat(l2_prod *l2_str, int32_t ifile, int32_t *start, int32_t *edges, unsigned char *scan_in_rowgroup)
Definition: readL2scan.c:1828
meta_l2Struct::southlat
float southlat
Definition: readL2scan.h:129
l2prod_struct::syear
int16_t syear
Definition: readL2scan.h:29
meta_l2Struct::etime
char * etime
Definition: readL2scan.h:111
get_l2_flag_use
int get_l2_flag_use()
Definition: expand3D.cpp:437
l2prod_struct::nrec
int32_t nrec
Definition: readL2scan.h:26
meta_l2Struct::endclat
float endclat
Definition: readL2scan.h:134
enableL2PixelArea
void enableL2PixelArea(enum L2PixelMode_t val)
Definition: readL2scan.c:213
ds_format_t
ds_format_t
Definition: dfutils.h:18
meta_l2Struct::startclon
float startclon
Definition: readL2scan.h:133
l2prod_struct::eyear
int16_t eyear
Definition: readL2scan.h:32
freeL2meta
int32_t freeL2meta(meta_l2Type *meta_l2)
Definition: readL2scan.c:2325
freeL2
int32_t freeL2(l2_prod *l2_str)
Definition: readL2scan.c:2083
l2prod_struct::lat1
float * lat1
Definition: readL2scan.h:86
closeL2
int32_t closeL2(l2_prod *l2_str, int32_t ifile)
Definition: readL2scan.c:1995
l2prod_struct::bv_unscaled
float bv_unscaled[MAXNUMBERPRODUCTS]
Definition: readL2scan.h:67
meta_l2Struct::sensor_name
char * sensor_name
Definition: readL2scan.h:105
l2prod_struct::flagmask
int32_t flagmask
Definition: readL2scan.h:43
l2prod_struct::lat_cntl
float * lat_cntl
Definition: readL2scan.h:60
l2prod_struct::nprod
int32_t nprod
Definition: readL2scan.h:65
l2prod_struct::s_flags
byte s_flags[4]
Definition: readL2scan.h:76
l2prod_struct::filename
char filename[256]
Definition: readL2scan.h:23
l2prod_struct::lat2Valid
byte lat2Valid
Definition: readL2scan.h:90
l2prod_struct::orbit
int32_t orbit
Definition: readL2scan.h:35
l2prod_struct::day_cache
int32_t * day_cache
Definition: readL2scan.h:50
l2prod_struct::pixnum
int32_t * pixnum
Definition: readL2scan.h:83
l2prod_struct::sday
int16_t sday
Definition: readL2scan.h:30
count
int count
Definition: decode_rs.h:79


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