OB.DAAC Logo
NASA Logo
Ocean Color Science Software

ocssw V2022
L1B_SetupP.h File Reference
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes

struct  geolocation_sds_t
 

Macros

#define BAND_26_REFL_INDEX   NUM_REFLECTIVE_BANDS - 1
 
#define GEO_STRIDE   5
 
#define GEO_OFFSET   2
 
#define SOLAR_AZIMUTH_ZENITH_SCALE_FACTOR   0.01
 
#define SECONDS_IN_DAY   86400
 

Enumerations

enum  geo_sds_index_t {
  INDEX_LATITUDE, INDEX_LONGITUDE, INDEX_HEIGHT, INDEX_SENSORZENITH,
  INDEX_SENSORAZIMUTH, INDEX_RANGE, INDEX_SOLARZENITH, INDEX_SOLARAZIMUTH,
  INDEX_GFLAGS, NUM_GEO_SDS, INDEX_LATITUDE, INDEX_LONGITUDE,
  INDEX_HEIGHT, INDEX_SENSORZENITH, INDEX_SENSORAZIMUTH, INDEX_RANGE,
  INDEX_SOLARZENITH, INDEX_SOLARAZIMUTH, INDEX_GFLAGS, NUM_GEO_SDS
}
 

Functions

PGSt_SMF_status Open_L1A_EV_SDS (L1A_granule_t *L1A_Gran, L1A_Scan_t *L1A_Scan)
 
PGSt_SMF_status Calculate_Earth_Sun_Distance (L1A_granule_t *L1A_Gran, float32 *Earth_Sun_Dist)
 
PGSt_SMF_status Calculate_RSB_Cal_Coeff (lookup_tables_t *tables, float32 E_S_Dist, RSB_Cal_Coeff_t *RSB_Cal_Coeff)
 
PGSt_SMF_status Init_L1B_ScaleOffset (L1B_ScaleOffset_t *SO, RSB_Cal_Coeff_t *RSB_Cal_Coeff, float32 E_S_Dist, lookup_tables_t *tables)
 
PGSt_SMF_status Copy_Geo_SDS (L1B_granule_t *L1B_Gran, boolean skip_night_hi_res)
 
PGSt_SMF_status Scan_Meta_Cal (lookup_tables_t *tables, L1A_granule_t *L1A_Gran, L1B_granule_t *L1B_Gran, L1B_Scan_Metadata_t *L1B_Scan_Meta, QA_Data_t *QA)
 
PGSt_SMF_status Open_W_L1B_Granule (lookup_tables_t *tables, L1B_granule_t *L1B_Gran, L1B_Scan_t *L1B_Scan, boolean skip_night_hi_res)
 
PGSt_SMF_status Init_QA_Parameters (L1A_granule_t *L1A_Gran, L1B_granule_t *L1B_Gran, QA_Data_t *QA)
 
PGSt_SMF_status Create_L1B_Swath (L1B_granule_t *L1B_Gran, boolean skip_night_hi_res)
 
PGSt_SMF_status Open_L1B_EV_SDS (L1B_granule_t *L1B_Gran, L1B_Scan_t *L1B_Scan, boolean skip_night_hi_res)
 
PGSt_SMF_status Get_SDS_id (int32 f, L1B_Scan_t *L1B_Scan, int16 *num_sds, int32 *sds_id)
 
PGSt_SMF_status Set_SDS_Attributes (int32 *sds_id, char **BandNames, float32 **scale, float32 **offset, char *rad_units, char *refl_units, char *counts_units, int32 num_sds)
 
PGSt_SMF_status Write_Swath_Band_Number (int32 file_index, L1B_granule_t *L1B_Gran)
 
PGSt_SMF_status Set_Unit_Range_Fillvalue (L1B_Scan_t *L1B_Scan, boolean skip_night_hi_res)
 
PGSt_SMF_status Set_L1B_EV_SDS_Attrs (lookup_tables_t *tables, L1B_granule_t *L1B_Gran, L1B_Scan_t *L1B_Scan, boolean skip_night_hi_res)
 
PGSt_SMF_status Create_Band_Subsetting_SDS (L1B_granule_t *L1B_Gran, boolean skip_night_hi_res)
 
PGSt_SMF_status Calculate_DCR_Change (L1A_granule_t *L1A_Gran, QA_Data_t *QA, L1B_Scan_Metadata_t *L1B_Scan_Meta)
 
PGSt_SMF_status Determine_Split_Scans (L1A_granule_t *L1A_Gran, boolean *split_scan)
 
PGSt_SMF_status Get_Split_Scan_Indexes (int32 S1, int32 num_scans, int16 mirror_side[], int32 scan_quality[][SCAN_QUALITY_ARRAY_NUM_ELEMENTS], int32 *S_split_1, int32 *S_split_2)
 
PGSt_SMF_status Set_UI_ConvertToPercent_Attrs (lookup_tables_t *tables, L1B_Scan_t *L1B_Scan, boolean skip_night_hi_res)
 
PGSt_SMF_status Calculate_B26_B5_Correction (float32 *original_correction, float32 *scaled_correction, L1B_ScaleOffset_t *ScaleOffset)
 

Macro Definition Documentation

◆ BAND_26_REFL_INDEX

#define BAND_26_REFL_INDEX   NUM_REFLECTIVE_BANDS - 1

Definition at line 91 of file L1B_SetupP.h.

◆ GEO_OFFSET

#define GEO_OFFSET   2

Definition at line 95 of file L1B_SetupP.h.

◆ GEO_STRIDE

#define GEO_STRIDE   5

Definition at line 94 of file L1B_SetupP.h.

◆ SECONDS_IN_DAY

#define SECONDS_IN_DAY   86400

Definition at line 141 of file L1B_SetupP.h.

◆ SOLAR_AZIMUTH_ZENITH_SCALE_FACTOR

#define SOLAR_AZIMUTH_ZENITH_SCALE_FACTOR   0.01

Definition at line 136 of file L1B_SetupP.h.

Enumeration Type Documentation

◆ geo_sds_index_t

Enumerator
INDEX_LATITUDE 
INDEX_LONGITUDE 
INDEX_HEIGHT 
INDEX_SENSORZENITH 
INDEX_SENSORAZIMUTH 
INDEX_RANGE 
INDEX_SOLARZENITH 
INDEX_SOLARAZIMUTH 
INDEX_GFLAGS 
NUM_GEO_SDS 
INDEX_LATITUDE 
INDEX_LONGITUDE 
INDEX_HEIGHT 
INDEX_SENSORZENITH 
INDEX_SENSORAZIMUTH 
INDEX_RANGE 
INDEX_SOLARZENITH 
INDEX_SOLARAZIMUTH 
INDEX_GFLAGS 
NUM_GEO_SDS 

Definition at line 99 of file L1B_SetupP.h.

Function Documentation

◆ Calculate_B26_B5_Correction()

PGSt_SMF_status Calculate_B26_B5_Correction ( float32 *  original_correction,
float32 *  scaled_correction,
L1B_ScaleOffset_t ScaleOffset 
)

Definition at line 5829 of file L1B_Setup.c.

◆ Calculate_DCR_Change()

PGSt_SMF_status Calculate_DCR_Change ( L1A_granule_t L1A_Gran,
QA_Data_t QA,
L1B_Scan_Metadata_t L1B_Scan_Meta 
)

Definition at line 4339 of file L1B_Setup.c.

◆ Calculate_Earth_Sun_Distance()

PGSt_SMF_status Calculate_Earth_Sun_Distance ( L1A_granule_t L1A_Gran,
float32 *  Earth_Sun_Dist 
)

Definition at line 504 of file L1B_Setup.c.

◆ Calculate_RSB_Cal_Coeff()

PGSt_SMF_status Calculate_RSB_Cal_Coeff ( lookup_tables_t tables,
float32  E_S_Dist,
RSB_Cal_Coeff_t RSB_Cal_Coeff 
)

Definition at line 615 of file L1B_Setup.c.

◆ Copy_Geo_SDS()

PGSt_SMF_status Copy_Geo_SDS ( L1B_granule_t L1B_Gran,
boolean  skip_night_hi_res 
)

Definition at line 3243 of file L1B_Setup.c.

◆ Create_Band_Subsetting_SDS()

PGSt_SMF_status Create_Band_Subsetting_SDS ( L1B_granule_t L1B_Gran,
boolean  skip_night_hi_res 
)

Definition at line 3055 of file L1B_Setup.c.

◆ Create_L1B_Swath()

PGSt_SMF_status Create_L1B_Swath ( L1B_granule_t L1B_Gran,
boolean  skip_night_hi_res 
)

Definition at line 1059 of file L1B_Setup.c.

◆ Determine_Split_Scans()

PGSt_SMF_status Determine_Split_Scans ( L1A_granule_t L1A_Gran,
boolean split_scan 
)

Definition at line 5361 of file L1B_Setup.c.

◆ Get_SDS_id()

PGSt_SMF_status Get_SDS_id ( int32  f,
L1B_Scan_t L1B_Scan,
int16 *  num_sds,
int32 *  sds_id 
)

Definition at line 2787 of file L1B_Setup.c.

◆ Get_Split_Scan_Indexes()

PGSt_SMF_status Get_Split_Scan_Indexes ( int32  S1,
int32  num_scans,
int16  mirror_side[],
int32  scan_quality[][SCAN_QUALITY_ARRAY_NUM_ELEMENTS],
int32 *  S_split_1,
int32 *  S_split_2 
)

Definition at line 5515 of file L1B_Setup.c.

◆ Init_L1B_ScaleOffset()

PGSt_SMF_status Init_L1B_ScaleOffset ( L1B_ScaleOffset_t SO,
RSB_Cal_Coeff_t RSB_Cal_Coeff,
float32  E_S_Dist,
lookup_tables_t tables 
)

◆ Init_QA_Parameters()

PGSt_SMF_status Init_QA_Parameters ( L1A_granule_t L1A_Gran,
L1B_granule_t L1B_Gran,
QA_Data_t QA 
)

Definition at line 4617 of file L1B_Setup.c.

◆ Open_L1A_EV_SDS()

PGSt_SMF_status Open_L1A_EV_SDS ( L1A_granule_t L1A_Gran,
L1A_Scan_t L1A_Scan 
)

Definition at line 419 of file L1B_Setup.c.

◆ Open_L1B_EV_SDS()

PGSt_SMF_status Open_L1B_EV_SDS ( L1B_granule_t L1B_Gran,
L1B_Scan_t L1B_Scan,
boolean  skip_night_hi_res 
)

Definition at line 1726 of file L1B_Setup.c.

◆ Open_W_L1B_Granule()

PGSt_SMF_status Open_W_L1B_Granule ( lookup_tables_t tables,
L1B_granule_t L1B_Gran,
L1B_Scan_t L1B_Scan,
boolean  skip_night_hi_res 
)

Definition at line 894 of file L1B_Setup.c.

◆ Scan_Meta_Cal()

PGSt_SMF_status Scan_Meta_Cal ( lookup_tables_t tables,
L1A_granule_t L1A_Gran,
L1B_granule_t L1B_Gran,
L1B_Scan_Metadata_t L1B_Scan_Meta,
QA_Data_t QA 
)

Definition at line 3766 of file L1B_Setup.c.

◆ Set_L1B_EV_SDS_Attrs()

PGSt_SMF_status Set_L1B_EV_SDS_Attrs ( lookup_tables_t tables,
L1B_granule_t L1B_Gran,
L1B_Scan_t L1B_Scan,
boolean  skip_night_hi_res 
)

Definition at line 2055 of file L1B_Setup.c.

◆ Set_SDS_Attributes()

PGSt_SMF_status Set_SDS_Attributes ( int32 *  sds_id,
char **  BandNames,
float32 **  scale,
float32 **  offset,
char *  rad_units,
char *  refl_units,
char *  counts_units,
int32  num_sds 
)

Definition at line 2871 of file L1B_Setup.c.

◆ Set_UI_ConvertToPercent_Attrs()

PGSt_SMF_status Set_UI_ConvertToPercent_Attrs ( lookup_tables_t tables,
L1B_Scan_t L1B_Scan,
boolean  skip_night_hi_res 
)

Definition at line 5666 of file L1B_Setup.c.

◆ Set_Unit_Range_Fillvalue()

PGSt_SMF_status Set_Unit_Range_Fillvalue ( L1B_Scan_t L1B_Scan,
boolean  skip_night_hi_res 
)

Definition at line 2439 of file L1B_Setup.c.

◆ Write_Swath_Band_Number()

PGSt_SMF_status Write_Swath_Band_Number ( int32  file_index,
L1B_granule_t L1B_Gran 
)

Definition at line 1581 of file L1B_Setup.c.