VcstLutNetCDF4.h

Go to the documentation of this file.

/******************************************************************************
 *  NAME: VcstLutNetCDF4.h
 *
 *  DESCRIPTION: Object class that generates a netCDF4 LUT.
 *
 *  Created on: June 5, 2015
 *      Author: Sam Anderson, VCST
 *
 *  Modified: October 15, 2015, for generation and processing of time-dependent
 *  netCDF4 LUTs
 *
 ******************************************************************************/
 
#ifndef VcstLutNetCDF4_H_
#define VcstLutNetCDF4_H_
 
#include <string>
#include <vector>
#include <map>
#include <sstream>
#include <iostream>
#include <netinet/in.h>
 
#include <VcstViirsStructs.h>
#include <VcstCmnGeoStructs.h>
#include <VcstGeoParameters.h>
#include <VcstCalLutStructures.h>
#include <VcstCmnLutInputItem.h>
#include <VcstCalLutInputItem.h>
#include <VcstGeoLutInputItem.h>
 
#include <netcdf>
 
using namespace std;
using namespace netCDF;
using namespace netCDF::exceptions;
 
class VcstLutNetCDF4 {
public:
 
    // file attributes
    string lut_title_;
    string lut_prod_name_;
 
    // global attributes:
    string sensor_;
    string platform_name_;
    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 time_coverage_start_;
    string time_coverage_end_;
    int format_version_;
    int instrument_number_;
 
    VcstLutNetCDF4();
 
    ~VcstLutNetCDF4();
 
    int initialize( string platform );
 
    int create_cmngeo_lut();
 
    int create_geo_lut();
 
    int create_cal_static_lut();
 
    int create_rsb_dynamic_lut();
 
    int create_dnb_dynamic_lut();
 
    int create_straylight_dynamic_lut();
 
    VIIRS_PLATFORM_ENUM platform_;
    string platform_str_;
 
    SolarDiffRotationMatrixLutType* SdRotMatPtr_;
    SolarDiffVoltLutType* SdsmVoltPtr_;
    JPLEphemLutType* jplEphemPtr_;
    SAALutType* saaCoeff_;
    CmnGeoParamLutType* paramLut_;
 
    // Pointers to Calibration LUT data structures
 
    proSdrViirsCalTeleCoeffLUT* tCoeffs_;
    proSdrViirsCalBBTempCoeffs* bBTempCoeffs_;
    proSdrViirsCalDgAnDnLmtLUT* dgAnDnLimits_;
 
    proSdrViirsCalDetectorResponseLUT* TableA_;
    proSdrViirsCalInstrumentResponseLUT* TableB_;
    proSdrViirsCalGainTableLUT* GainTable_;
    proSdrViirsCalDeltaCTempLUT* DeltaCTable_;
    proSdrViirsCalFPredictedTableLUT* TableFPredicted_;
 
    proSdrViirsCalDnbFrameToZoneLUT* ftz_;
    ProSdrViirsCalDnbLgsGainsLUT* TableDnbLgsGains_;
    ProSdrViirsCalDnbGainRatiosLUT* TableDnbGainRatios_;
    proSdrViirsDnbDn0Type* dnbDn0_;
    proSdrViirsCaldnbRVSLUT* RVS_DNB_;
    proSdrViirsCalDnbStrayLightLUT* strayLight_;
 
    proSdrViirsCalRVSLUT* rvsLUT_;
    proSdrViirsCalReflectiveLUT* refLUT_;
    proSdrViirsCalQALUT* QALUT_;
    proSdrViirsCalEmissiveLUT* EmissiveLUT_;
    proSdrViirsCalRMParametersLUT* rmParameters_;
    proSdrViirsCalObsToPixelsLUT* obs_to_pixels_;
 
    proSdrViirsCalHAMERLUT* HAMERLUT_;
    proSdrViirsCalRTAERLUT* RTAERLUT_;
    proSdrViirsCalOBCERLUT* OBCERLUT_;
    proSdrViirsCalOBCRRLUT* OBCRRLUT_;
    proSdrViirsCalLtoEBBTLUT* EBBTLUT_;
 
    proSdrViirsCalSolarIradLUT* solarIradLUT_;
    ProSdrViirsCalRelativeSpectralResponseLUT* rsrLUT_;
    ProSdrViirsCalSolarSpectralIradLUT* solarSpectralIradLUT_;
 
    // Pointers to Geolocation LUT data structures
 
    GEO_param_struct* geoImgParams_;
    GEO_param_struct* geoModParams_;
    GEO_param_struct* geoDnbParams_;
 
    void setHistory(std::string history) {
        history_ = history;
    }
 
    std::string getHistory() {
        return history_;
    }
 
protected:
 
    VcstCmnLutInputItem* read_cmngeo_lut(std::string groupName, int size);
 
    VcstCalLutInputItem* read_cal_lut(std::string groupName, int size);
 
    VcstGeoLutInputItem* read_geo_lut(std::string groupName, int size);
 
    int write_global_attributes(NcFile* nc_output);
 
    bool isPlatformLittleEndian();
 
    int write_CMNGEO_PLATFORM_LUT(NcFile* nc_output);
    int write_CMNGEO_JPL_EPHEM(NcFile* nc_output, JPLEphemLutType* lut,
            std::string fileName);
    int write_CMNGEO_SAA_COEFF(NcFile* nc_output, SAALutType* lut,
            std::string fileName);
    int write_CMNGEO_PARAM_LUT(NcFile* nc_output, CmnGeoParamLutType* lut,
            std::string fileName);
    int write_SOLAR_DIFF_VOLT_LUT(NcFile* nc_output, SolarDiffVoltLutType* lut,
            std::string fileName);
    int write_SOLAR_DIFF_ROT_MATRIX_LUT(NcFile* nc_output,
            SolarDiffRotationMatrixLutType* lut, std::string fileName);
 
    int write_SDR_DG_ANOMALY_DN_LIMITS_LUT(NcFile* nc_output,
            proSdrViirsCalDgAnDnLmtLUT* lut, std::string fileName);
    int write_SDR_DNB_STRAY_LIGHT_CORRECTION_LUT(NcFile* nc_output,
            proSdrViirsCalDnbStrayLightLUT* lut, std::string fileName);
    int write_SDR_DNB_DN0_LUT(NcFile* nc_output, proSdrViirsDnbDn0Type* lut,
            std::string fileName);
    int write_SDR_DNB_RVS_LUT(NcFile* nc_output, proSdrViirsCaldnbRVSLUT* lut,
            std::string fileName);
    int write_SDR_DNB_FRAME_TO_ZONE_LUT(NcFile* nc_output,
            proSdrViirsCalDnbFrameToZoneLUT* lut, std::string fileName);
    int write_SDR_DNB_LGS_GAINS_LUT(NcFile* nc_output,
            ProSdrViirsCalDnbLgsGainsLUT* lut, std::string fileName);
    int write_SDR_DNB_GAIN_RATIOS_LUT(NcFile* nc_output,
            ProSdrViirsCalDnbGainRatiosLUT* lut, std::string fileName);
    int write_SDR_F_PREDICTED_LUT(NcFile* nc_output,
            proSdrViirsCalFPredictedTableLUT* lut, std::string fileName);
    int write_SDR_GAIN_LUT(NcFile* nc_output, proSdrViirsCalGainTableLUT* lut,
            std::string fileName);
    int write_SDR_HAM_ER_TABLE_LUT(NcFile* nc_output,
            proSdrViirsCalHAMERLUT* lut, std::string fileName);
    int write_SDR_RTA_ER_TABLE_LUT(NcFile* nc_output,
            proSdrViirsCalRTAERLUT* lut, std::string fileName);
    int write_SDR_OBC_ER_TABLE_LUT(NcFile* nc_output,
            proSdrViirsCalOBCERLUT* lut, std::string fileName);
    int write_SDR_OBC_RR_TABLE_LUT(NcFile* nc_output,
            proSdrViirsCalOBCRRLUT* lut, std::string fileName);
    int write_SDR_EBBT_TABLE_LUT(NcFile* nc_output,
            proSdrViirsCalLtoEBBTLUT* lut, std::string fileName);
    int write_SDR_TELE_COEFFS_LUT(NcFile* nc_output,
            proSdrViirsCalTeleCoeffLUT* lut, std::string fileName);
    int write_SDR_SOLAR_IRAD_LUT(NcFile* nc_output,
            proSdrViirsCalSolarIradLUT* lut, std::string fileName);
    int write_SDR_OBS_TO_PIXELS_LUT(NcFile* nc_output,
            proSdrViirsCalObsToPixelsLUT* lut, std::string fileName);
    int write_SDR_RADIOMETRIC_PARAMETERS_LUT(NcFile* nc_output,
            proSdrViirsCalRMParametersLUT* lut, std::string fileName);
    int write_SDR_QA_LUT(NcFile* nc_output, proSdrViirsCalQALUT* lut,
            std::string fileName);
    int write_SDR_EMISSIVE_LUT(NcFile* nc_output,
            proSdrViirsCalEmissiveLUT* lut, std::string fileName);
    int write_SDR_REFLECTIVE_LUT(NcFile* nc_output,
            proSdrViirsCalReflectiveLUT* lut, std::string fileName);
    int write_SDR_RVS_LUT(NcFile* nc_output, proSdrViirsCalRVSLUT* lut,
            std::string fileName);
    int write_SDR_BB_TEMP_COEFFS_LUT(NcFile* nc_output,
            proSdrViirsCalBBTempCoeffs* lut, std::string fileName);
    int write_SDR_DELTA_C_LUT(NcFile* nc_output,
            proSdrViirsCalDeltaCTempLUT* lut, std::string fileName);
    int write_SDR_COEFF_A_LUT(NcFile* nc_output,
            proSdrViirsCalDetectorResponseLUT* lut, std::string fileName);
    int write_SDR_COEFF_B_LUT(NcFile* nc_output,
            proSdrViirsCalInstrumentResponseLUT* lut, std::string fileName);
    int write_SDR_RELATIVE_SPECTRAL_RESPONSE_LUT(NcFile* nc_output,
            ProSdrViirsCalRelativeSpectralResponseLUT* lut,
            std::string fileName);
    int write_SDR_SOLAR_SPECTRAL_IRAD_LUT(NcFile* nc_output,
            ProSdrViirsCalRelativeSpectralResponseLUT* lut,
            std::string fileName);
 
    int write_GEO_PARAM_LUT(NcFile* nc_output, GEO_param_struct* lut,
            std::string str_geo_params_name, std::string fileName);
 
    int compress_StrayLight_LUT(proSdrViirsCalDnbStrayLightLUT* long_lut,
            shortViirsCalDnbStrayLightLUT* short_lut);
 
    int write_all_SDR_DNB_STRAY_LIGHT_CORRECTION_LUT(NcFile* nc_output);
    int write_all_SDR_F_PREDICTED_LUT(NcFile* nc_output);
    int write_all_SDR_RELATIVE_SPECTRAL_RESPONSE_LUT(NcFile* nc_output);
    int write_all_SDR_SOLAR_SPECTRAL_IRAD_LUT(NcFile* nc_output);
    int write_all_SDR_DNB_LGS_GAINS_LUT(NcFile* nc_output);
    int write_all_SDR_DNB_GAIN_RATIOS_LUT(NcFile* nc_output);
    int write_all_SDR_DNB_DN0_LUT(NcFile* nc_output);
 
    int collect_lut_files(std::string lutName, std::string path);
 
    long long compute_iet_from_filename(std::string fileName);
 
    int compute_solar_irradiance(
            const ProSdrViirsCalRelativeSpectralResponseLUT* rsrLUT);
 
    // Dimensions -- time
 
    NcDim td_luts_dim_dnbdn0_;
    NcDim td_luts_dim_dnbgr_;
    NcDim td_luts_dim_dnblgs_;
    NcDim td_luts_dim_slc_;
    NcDim td_luts_dim_rsbf_;
    NcDim td_luts_dim_rsbrsr_;
 
    std::map<std::string, std::string> lut_files_;
 
    double solar_irad_[14];
 
    // Dimensions
 
    NcDim scalar_dim_;
    NcDim num_scan_start_dim_;
    NcDim num_jpl_ipt_rows_dim_;
    NcDim num_jpl_ipt_cols_dim_;
    NcDim num_jpl_ephem_rows_dim_;
    NcDim num_jpl_ephem_cols_dim_;
    NcDim min_max_dim_;
    NcDim num_sdsm_samples_dim_;
    NcDim num_sdsm_det_dim_;
    NcDim num_sdsm_coef_dim_;
    NcDim matrix_rows_dim_;
    NcDim matrix_cols_dim_;
 
    NcDim num_refl_750m_dg_bands_dim_;
    NcDim num_750m_det_dim_;
    NcDim num_750m_sg_bands_dim_;
    NcDim num_750m_dg_bands_dim_;
    NcDim num_sg_ev_frames_dim_;
    NcDim num_dg_ev_frames_dim_;
    NcDim num_375m_bands_dim_;
    NcDim num_375m_det_dim_;
    NcDim num_375m_frms_dim_;
    NcDim num_hemispheres_dim_;
    NcDim num_sza_bins_dim_;
    NcDim num_dnb_ev_frames_dim_;
    NcDim num_dnb_detectors_dim_;
    NcDim num_mirror_sides_dim_;
    NcDim max_num_gains_dim_;
    NcDim num_dnb_gains_dim_;
    NcDim num_dnb_agg_seq_dim_;
    NcDim num_dnb_gain_ratios_dim_;
    NcDim num_dnb_gain_ratio_coeff_dim_;
    NcDim num_viirs_bands_dim_;
    NcDim max_num_detectors_dim_;
    NcDim num_rtaer_files_dim_;
    NcDim two_values_dim_;
    NcDim num_rtaer_values_dim_;
    NcDim num_hamer_files_dim_;
    NcDim num_hamer_values_dim_;
    NcDim num_obcer_files_dim_;
    NcDim num_obcer_values_dim_;
    NcDim num_obcrr_files_dim_;
    NcDim num_obcrr_values_dim_;
    NcDim num_ebbt_files_dim_;
    NcDim num_ebbt_values_dim_;
    NcDim num_thermistors_dim_;
    NcDim num_temp_coeffs_dim_;
    NcDim num_tref_mux_dim_;
    NcDim num_solar_irad_values_dim_;
    NcDim num_telec_therm_dim_;
    NcDim num_therm_weights_dim_;
    NcDim num_tomm_therm_dim_;
    NcDim num_ttel_therm_dim_;
    NcDim num_viirs_detectors_dim_;
    NcDim num_qual_flag_values_dim_;
    NcDim num_moon_offset_dim_;
    NcDim num_tm_therm_dim_;
    NcDim num_bb_therm_dim_;
    NcDim num_bb_coeff_dim_;
    NcDim num_electronics_sides_dim_;
    NcDim num_dg_gain_states_dim_;
    NcDim num_c_coeffs_dim_;
    NcDim num_thermistor_dim_;
    NcDim num_tele_levels_dim_;
    NcDim num_focal_planes_dim_;
    NcDim num_tdet_levels_dim_;
    NcDim four_values_dim_;
    NcDim num_refl_dnb_bands_dim_;
    NcDim max_rsr_dim_;
 
    NcDim revision_char_dim_;
    NcDim max_band_num_plus_one_dim_;
    NcDim num_aggzones_dim_;
    NcDim num_dnb_aggzone_dim_;
    NcDim dnb_aggzone_bounds_dim_;
    NcDim dnb_aggzone_bound_cols_dim_;
    NcDim max_limit_check_dim_;
    NcDim max_thermistor_id_dim_;
    NcDim num_thermistor_coeffs_dim_;
    NcDim max_poly_degree_plus_one_dim_;
 
};
 
#endif /* VcstLutNetCDF4_H_ */