OB.DAAC Logo
NASA Logo
Ocean Color Science Software

ocssw V2022

#include <DtLutNetcdf.h>

Public Member Functions

 DtLutNetcdf ()
 
 ~DtLutNetcdf ()
 
int initialize ()
 
int create_dt_nc4_lut ()
 
int read_grib_lut (dtGribLUT &grib_lut)
 
int read_gas_correction_lut (dtGasCorrectionLUT &gc_lut)
 
int read_land_aerosol_lut (dtLandAerosolLUT &la_lut)
 
int read_ocean_aerosol_lut (dtOceanAerosolLUT &lo_lut)
 
int read_water_vapor_lut (dtWaterVaporLUT &wv_lut)
 
void setHistory (std::string history)
 
std::string getHistory ()
 

Public Attributes

string lut_title_
 
string lut_prod_name_
 
string sensor_
 
string processing_version_
 
string Conventions_
 
string institution_
 
string license_
 
string naming_authority_
 
string date_created_
 
string keywords_vocabulary_
 
string stdname_vocabulary_
 
string creator_name_
 
string creator_email_
 
string creator_url_
 
string project_
 
string publisher_name_
 
string publisher_url_
 
string publisher_email_
 
string processing_level_
 
string cdm_data_type_
 
int orbit_number_
 
string history_
 
string source_files_
 
string time_coverage_start_
 
string time_coverage_end_
 
int format_version_
 
int instrument_number_
 

Protected Member Functions

int read_grib_bin (const string filepath, dtGribLUT *grib_lut)
 
int read_grib_hdf (const string filepath, dtGribLUT *grib_lut)
 
int read_ozone (const string filepath, dtGribLUT *grib_lut)
 
int read_gas_correction_file (dtGasCorrectionLUT *gc_lut)
 
int read_land_aerosol_file (const string groupname, int wnum, dtLandAerosolLUT *la_lut)
 
int read_land_aerosol_map (const string groupname, dtLandAerosolLUT *la_lut)
 
int read_ocean_big_aerosol_file (const string groupname, int wnum, dtOceanAerosolLUT *boa_lut)
 
int read_ocean_small_aerosol_file (const string groupname, int wnum, dtOceanAerosolLUT *soa_lut)
 
int read_transm_h2o_file (const string groupname, int num, dtWaterVaporLUT *wv_lut)
 
int read_ch2_reflectance_file (const string groupname, dtWaterVaporLUT *la_lut)
 
int read_ch19_to_ch2_ratio_file (const string groupname, dtWaterVaporLUT *la_lut)
 
int read_weight_table_file (const string groupname, dtWaterVaporLUT *la_lut)
 
int write_global_attributes (NcFile *nc_output)
 
bool isPlatformLittleEndian ()
 
int write_grib_lut (NcFile *nc_output, dtGribLUT *grib_lut)
 
int write_gas_correction_lut (NcFile *nc_output, dtGasCorrectionLUT *gc_lut)
 
int write_land_aerosol_lut (NcFile *nc_output, dtLandAerosolLUT *la_lut)
 
int write_ocean_aerosol_lut (NcFile *nc_output, dtOceanAerosolLUT *oa_lut)
 
int write_water_vapor_lut (NcFile *nc_output, dtWaterVaporLUT *oa_lut)
 

Static Protected Member Functions

template<typename T >
static void byteSwap (T &aValue)
 

Protected Attributes

NcDim scalar_dim_
 
NcDim num_grib_data_bins_dim_
 
NcDim num_grib_lat_bins_dim_
 
NcDim num_grib_lon_bins_dim_
 
NcDim num_gc_dt_bands_dim_
 
NcDim num_gc_O3_coef_dim_
 
NcDim num_gc_H2O_coef_dim_
 
NcDim num_land_lats_dim_
 
NcDim num_land_lons_dim_
 
NcDim num_land_phi_dim_
 
NcDim num_land_the_dim_
 
NcDim num_land_thet0_dim_
 
NcDim num_land_tau_dim_
 
NcDim num_land_wav_dim_
 
NcDim num_land_table_dim_
 
NcDim num_land_size_dim_
 
NcDim num_land_season_dim_
 
NcDim num_ocean_phi_dim_
 
NcDim num_ocean_the_dim_
 
NcDim num_ocean_thet0_dim_
 
NcDim num_ocean_tau_dim_
 
NcDim num_ocean_wave_dim_
 
NcDim num_ocean_cases_dim_
 
NcDim num_ocean_caseb_dim_
 
NcDim num_ocean_wslut_dim_
 
NcDim num_ocean_moments_dim_
 
NcDim num_h2o_tables_dim_
 
NcDim num_h2o_rows_dim_
 
NcDim num_h2o_vals_dim_
 
NcDim num_weight_vals_dim_
 
NcDim num_ch2_rows_dim_
 
NcDim num_ch2_vals_dim_
 

Detailed Description

Definition at line 177 of file DtLutNetcdf.h.

Constructor & Destructor Documentation

◆ DtLutNetcdf()

Class constructor

Definition at line 32 of file DtLutNetcdf.cpp.

◆ ~DtLutNetcdf()

Class destructor

Definition at line 42 of file DtLutNetcdf.cpp.

Member Function Documentation

◆ byteSwap()

void byteSwap ( T &  aValue)
staticprotected

Converts the endianness of the parameter by performing the appropriate byte swapping.

Definition at line 427 of file DtLutNetcdf.h.

◆ create_dt_nc4_lut()

int create_dt_nc4_lut ( )

Create dark target aerosol netCDF4 LUT

Definition at line 64 of file DtLutNetcdf.cpp.

◆ getHistory()

std::string getHistory ( )
inline

Definition at line 249 of file DtLutNetcdf.h.

◆ initialize()

int initialize ( )

Initialize L1A data

Definition at line 52 of file DtLutNetcdf.cpp.

◆ isPlatformLittleEndian()

bool isPlatformLittleEndian ( )
protected

Determine if platform is little endian

Definition at line 2074 of file DtLutNetcdf.cpp.

◆ read_ch19_to_ch2_ratio_file()

int read_ch19_to_ch2_ratio_file ( const string  groupname,
dtWaterVaporLUT la_lut 
)
protected

Read Reads ch19-to-ch2 ratio data from text file.

Definition at line 1137 of file DtLutNetcdf.cpp.

◆ read_ch2_reflectance_file()

int read_ch2_reflectance_file ( const string  groupname,
dtWaterVaporLUT la_lut 
)
protected

Read ch2 reflectance data from text file.

Definition at line 1173 of file DtLutNetcdf.cpp.

◆ read_gas_correction_file()

int read_gas_correction_file ( dtGasCorrectionLUT gc_lut)
protected

Read gas correction file data from text file.

Definition at line 491 of file DtLutNetcdf.cpp.

◆ read_gas_correction_lut()

int read_gas_correction_lut ( dtGasCorrectionLUT gc_lut)

Definition at line 1699 of file DtLutNetcdf.cpp.

◆ read_grib_bin()

int read_grib_bin ( const string  filepath,
dtGribLUT grib_lut 
)
protected

Read binary GRIB file.

Definition at line 328 of file DtLutNetcdf.cpp.

◆ read_grib_hdf()

int read_grib_hdf ( const string  filepath,
dtGribLUT grib_lut 
)
protected

Read HDF GRIB file.

Definition at line 373 of file DtLutNetcdf.cpp.

◆ read_grib_lut()

int read_grib_lut ( dtGribLUT grib_lut)

Read aerosol netCDF4 LUT

Definition at line 275 of file DtLutNetcdf.cpp.

◆ read_land_aerosol_file()

int read_land_aerosol_file ( const string  groupname,
int  wnum,
dtLandAerosolLUT la_lut 
)
protected

Read land aerosol LUT file data from text file.

Definition at line 527 of file DtLutNetcdf.cpp.

◆ read_land_aerosol_lut()

int read_land_aerosol_lut ( dtLandAerosolLUT la_lut)

Definition at line 1757 of file DtLutNetcdf.cpp.

◆ read_land_aerosol_map()

int read_land_aerosol_map ( const string  groupname,
dtLandAerosolLUT la_lut 
)
protected

Read land aerosol map LUT file data from text file.

Definition at line 642 of file DtLutNetcdf.cpp.

◆ read_ocean_aerosol_lut()

int read_ocean_aerosol_lut ( dtOceanAerosolLUT lo_lut)

Definition at line 1852 of file DtLutNetcdf.cpp.

◆ read_ocean_big_aerosol_file()

int read_ocean_big_aerosol_file ( const string  groupname,
int  wnum,
dtOceanAerosolLUT boa_lut 
)
protected

Read big ocean aerosol LUT data from text file.

Definition at line 941 of file DtLutNetcdf.cpp.

◆ read_ocean_small_aerosol_file()

int read_ocean_small_aerosol_file ( const string  groupname,
int  wnum,
dtOceanAerosolLUT soa_lut 
)
protected

Read small ocean aerosol LUT data from text file.

Definition at line 684 of file DtLutNetcdf.cpp.

◆ read_ozone()

int read_ozone ( const string  filepath,
dtGribLUT grib_lut 
)
protected

Read HDF ozone file.

Definition at line 440 of file DtLutNetcdf.cpp.

◆ read_transm_h2o_file()

int read_transm_h2o_file ( const string  groupname,
int  num,
dtWaterVaporLUT wv_lut 
)
protected

Read transmission H20 LUT data from text file.

Definition at line 1103 of file DtLutNetcdf.cpp.

◆ read_water_vapor_lut()

int read_water_vapor_lut ( dtWaterVaporLUT wv_lut)

Definition at line 1982 of file DtLutNetcdf.cpp.

◆ read_weight_table_file()

int read_weight_table_file ( const string  groupname,
dtWaterVaporLUT la_lut 
)
protected

Read weight table data from text file.

Definition at line 1209 of file DtLutNetcdf.cpp.

◆ setHistory()

void setHistory ( std::string  history)
inline

Definition at line 248 of file DtLutNetcdf.h.

◆ write_gas_correction_lut()

int write_gas_correction_lut ( NcFile *  nc_output,
dtGasCorrectionLUT gc_lut 
)
protected

Write gas correction file data to netcdf LUT.

Definition at line 1246 of file DtLutNetcdf.cpp.

◆ write_global_attributes()

int write_global_attributes ( NcFile *  nc_output)
protected

Write global attributes to file

Definition at line 2026 of file DtLutNetcdf.cpp.

◆ write_grib_lut()

int write_grib_lut ( NcFile *  nc_output,
dtGribLUT grib_lut 
)
protected

Write binary GRIB file.

◆ write_land_aerosol_lut()

int write_land_aerosol_lut ( NcFile *  nc_output,
dtLandAerosolLUT la_lut 
)
protected

Write land aerosol LUT file data to netcdf LUT.

Definition at line 1301 of file DtLutNetcdf.cpp.

◆ write_ocean_aerosol_lut()

int write_ocean_aerosol_lut ( NcFile *  nc_output,
dtOceanAerosolLUT oa_lut 
)
protected

Write ocean aerosol LUT data to netcdf LUT.

Definition at line 1447 of file DtLutNetcdf.cpp.

◆ write_water_vapor_lut()

int write_water_vapor_lut ( NcFile *  nc_output,
dtWaterVaporLUT oa_lut 
)
protected

Write water vapor LUT data to netcdf LUT.

Definition at line 1652 of file DtLutNetcdf.cpp.

Member Data Documentation

◆ cdm_data_type_

string cdm_data_type_

Definition at line 204 of file DtLutNetcdf.h.

◆ Conventions_

string Conventions_

Definition at line 189 of file DtLutNetcdf.h.

◆ creator_email_

string creator_email_

Definition at line 197 of file DtLutNetcdf.h.

◆ creator_name_

string creator_name_

Definition at line 196 of file DtLutNetcdf.h.

◆ creator_url_

string creator_url_

Definition at line 198 of file DtLutNetcdf.h.

◆ date_created_

string date_created_

Definition at line 193 of file DtLutNetcdf.h.

◆ format_version_

int format_version_

Definition at line 210 of file DtLutNetcdf.h.

◆ history_

string history_

Definition at line 206 of file DtLutNetcdf.h.

◆ institution_

string institution_

Definition at line 190 of file DtLutNetcdf.h.

◆ instrument_number_

int instrument_number_

Definition at line 211 of file DtLutNetcdf.h.

◆ keywords_vocabulary_

string keywords_vocabulary_

Definition at line 194 of file DtLutNetcdf.h.

◆ license_

string license_

Definition at line 191 of file DtLutNetcdf.h.

◆ lut_prod_name_

string lut_prod_name_

Definition at line 184 of file DtLutNetcdf.h.

◆ lut_title_

string lut_title_

Definition at line 183 of file DtLutNetcdf.h.

◆ naming_authority_

string naming_authority_

Definition at line 192 of file DtLutNetcdf.h.

◆ num_ch2_rows_dim_

NcDim num_ch2_rows_dim_
protected

Definition at line 408 of file DtLutNetcdf.h.

◆ num_ch2_vals_dim_

NcDim num_ch2_vals_dim_
protected

Definition at line 409 of file DtLutNetcdf.h.

◆ num_gc_dt_bands_dim_

NcDim num_gc_dt_bands_dim_
protected

Definition at line 382 of file DtLutNetcdf.h.

◆ num_gc_H2O_coef_dim_

NcDim num_gc_H2O_coef_dim_
protected

Definition at line 384 of file DtLutNetcdf.h.

◆ num_gc_O3_coef_dim_

NcDim num_gc_O3_coef_dim_
protected

Definition at line 383 of file DtLutNetcdf.h.

◆ num_grib_data_bins_dim_

NcDim num_grib_data_bins_dim_
protected

Definition at line 379 of file DtLutNetcdf.h.

◆ num_grib_lat_bins_dim_

NcDim num_grib_lat_bins_dim_
protected

Definition at line 380 of file DtLutNetcdf.h.

◆ num_grib_lon_bins_dim_

NcDim num_grib_lon_bins_dim_
protected

Definition at line 381 of file DtLutNetcdf.h.

◆ num_h2o_rows_dim_

NcDim num_h2o_rows_dim_
protected

Definition at line 405 of file DtLutNetcdf.h.

◆ num_h2o_tables_dim_

NcDim num_h2o_tables_dim_
protected

Definition at line 404 of file DtLutNetcdf.h.

◆ num_h2o_vals_dim_

NcDim num_h2o_vals_dim_
protected

Definition at line 406 of file DtLutNetcdf.h.

◆ num_land_lats_dim_

NcDim num_land_lats_dim_
protected

Definition at line 385 of file DtLutNetcdf.h.

◆ num_land_lons_dim_

NcDim num_land_lons_dim_
protected

Definition at line 386 of file DtLutNetcdf.h.

◆ num_land_phi_dim_

NcDim num_land_phi_dim_
protected

Definition at line 387 of file DtLutNetcdf.h.

◆ num_land_season_dim_

NcDim num_land_season_dim_
protected

Definition at line 394 of file DtLutNetcdf.h.

◆ num_land_size_dim_

NcDim num_land_size_dim_
protected

Definition at line 393 of file DtLutNetcdf.h.

◆ num_land_table_dim_

NcDim num_land_table_dim_
protected

Definition at line 392 of file DtLutNetcdf.h.

◆ num_land_tau_dim_

NcDim num_land_tau_dim_
protected

Definition at line 390 of file DtLutNetcdf.h.

◆ num_land_the_dim_

NcDim num_land_the_dim_
protected

Definition at line 388 of file DtLutNetcdf.h.

◆ num_land_thet0_dim_

NcDim num_land_thet0_dim_
protected

Definition at line 389 of file DtLutNetcdf.h.

◆ num_land_wav_dim_

NcDim num_land_wav_dim_
protected

Definition at line 391 of file DtLutNetcdf.h.

◆ num_ocean_caseb_dim_

NcDim num_ocean_caseb_dim_
protected

Definition at line 401 of file DtLutNetcdf.h.

◆ num_ocean_cases_dim_

NcDim num_ocean_cases_dim_
protected

Definition at line 400 of file DtLutNetcdf.h.

◆ num_ocean_moments_dim_

NcDim num_ocean_moments_dim_
protected

Definition at line 403 of file DtLutNetcdf.h.

◆ num_ocean_phi_dim_

NcDim num_ocean_phi_dim_
protected

Definition at line 395 of file DtLutNetcdf.h.

◆ num_ocean_tau_dim_

NcDim num_ocean_tau_dim_
protected

Definition at line 398 of file DtLutNetcdf.h.

◆ num_ocean_the_dim_

NcDim num_ocean_the_dim_
protected

Definition at line 396 of file DtLutNetcdf.h.

◆ num_ocean_thet0_dim_

NcDim num_ocean_thet0_dim_
protected

Definition at line 397 of file DtLutNetcdf.h.

◆ num_ocean_wave_dim_

NcDim num_ocean_wave_dim_
protected

Definition at line 399 of file DtLutNetcdf.h.

◆ num_ocean_wslut_dim_

NcDim num_ocean_wslut_dim_
protected

Definition at line 402 of file DtLutNetcdf.h.

◆ num_weight_vals_dim_

NcDim num_weight_vals_dim_
protected

Definition at line 407 of file DtLutNetcdf.h.

◆ orbit_number_

int orbit_number_

Definition at line 205 of file DtLutNetcdf.h.

◆ processing_level_

string processing_level_

Definition at line 203 of file DtLutNetcdf.h.

◆ processing_version_

string processing_version_

Definition at line 188 of file DtLutNetcdf.h.

◆ project_

string project_

Definition at line 199 of file DtLutNetcdf.h.

◆ publisher_email_

string publisher_email_

Definition at line 202 of file DtLutNetcdf.h.

◆ publisher_name_

string publisher_name_

Definition at line 200 of file DtLutNetcdf.h.

◆ publisher_url_

string publisher_url_

Definition at line 201 of file DtLutNetcdf.h.

◆ scalar_dim_

NcDim scalar_dim_
protected

Definition at line 378 of file DtLutNetcdf.h.

◆ sensor_

string sensor_

Definition at line 187 of file DtLutNetcdf.h.

◆ source_files_

string source_files_

Definition at line 207 of file DtLutNetcdf.h.

◆ stdname_vocabulary_

string stdname_vocabulary_

Definition at line 195 of file DtLutNetcdf.h.

◆ time_coverage_end_

string time_coverage_end_

Definition at line 209 of file DtLutNetcdf.h.

◆ time_coverage_start_

string time_coverage_start_

Definition at line 208 of file DtLutNetcdf.h.


The documentation for this class was generated from the following files: