142#include <gsl/gsl_math.h>
143#include <gsl/gsl_blas.h>
144#include <gsl/gsl_linalg.h>
145#include <gsl/gsl_randist.h>
146#include <gsl/gsl_rng.h>
147#include <gsl/gsl_statistics.h>
172#define C1 1.19104259e-8
202#define KB 1.3806504e-23
212#define NA 6.02214199e23
286#define N ((2 + NG + NW) * NP + NCL + NSF + 3)
321#define NQ (5 + NG + NW + NCL + NSF)
351#define RFMNPTS 10000000
385#define IDXQ(ig) (2 + (ig))
388#define IDXK(iw) (2 + (ctl->ng) + (iw))
391#define IDXCLZ (2 + (ctl->ng) + (ctl->nw))
394#define IDXCLDZ (3 + (ctl->ng) + (ctl->nw))
397#define IDXCLK(icl) (4 + (ctl->ng) + (ctl->nw) + (icl))
400#define IDXSFT (4 + (ctl->ng) + (ctl->nw) + (ctl->ncl))
403#define IDXSFEPS(isf) (5 + (ctl->ng) + (ctl->nw) + (ctl->ncl) + (isf))
426#define ALLOC(ptr, type, n) \
427 if((ptr=calloc((size_t)(n), sizeof(type)))==NULL) \
428 ERRMSG("Out of memory!");
456#define BRIGHT(rad, nu) \
457 (C2 * (nu) / gsl_log1p(C1 * POW3(nu) / (rad)))
478#define CLAMP(v, lo, hi) \
479 (((v) < (lo)) ? (lo) : (((v) > (hi)) ? (hi) : (v)))
493#define CO2_FIT(TIME) \
494 (373.87884731310215e-6 \
495 + 1.9021498612395775e-6 * (((TIME) - 94694400.) / 31557600.) \
496 + 0.016490044598136553e-6 \
497 * POW2((((TIME) - 94694400.) / 31557600.)))
513#define DEG2RAD(deg) ((deg) * (M_PI / 180.0))
531#define DIST(a, b) sqrt(DIST2(a, b))
549 ((a[0]-b[0])*(a[0]-b[0])+(a[1]-b[1])*(a[1]-b[1])+(a[2]-b[2])*(a[2]-b[2]))
566#define DOTP(a, b) (a[0]*b[0]+a[1]*b[1]+a[2]*b[2])
586#define FREAD(ptr, type, size, out) { \
587 if(fread(ptr, sizeof(type), size, out)!=size) \
588 ERRMSG("Error while reading!"); \
609#define FWRITE(ptr, type, size, out) { \
610 if(fwrite(ptr, sizeof(type), size, out)!=size) \
611 ERRMSG("Error while writing!"); \
632#define LIN(x0, y0, x1, y1, x) \
633 ((y0)+((y1)-(y0))/((x1)-(x0))*((x)-(x0)))
653#define LOGY(x0, y0, x1, y1, x) \
655 ? ((y0)*exp(log((y1)/(y0))/((x1)-(x0))*((x)-(x0)))) \
656 : LIN(x0, y0, x1, y1, x))
674#define MAX(a,b) (((a)>(b))?(a):(b))
692#define MIN(a,b) (((a)<(b))?(a):(b))
706 int nc_result=(cmd); \
707 if(nc_result!=NC_NOERR) \
708 ERRMSG("%s", nc_strerror(nc_result)); \
735#define NC_DEF_VAR(varname, type, ndims, dims, long_name, units, level, quant) { \
736 NC(nc_def_var(ncid, varname, type, ndims, dims, &varid)); \
737 NC(nc_put_att_text(ncid, varid, "long_name", strnlen(long_name, LEN), long_name)); \
738 NC(nc_put_att_text(ncid, varid, "units", strnlen(units, LEN), units)); \
739 NC_DEF_VAR_QUANTIZE(quant); \
741 NC(nc_def_var_deflate(ncid, varid, 1, 1, level)); \
758#ifdef NC_QUANTIZE_GRANULARBR
759#define NC_DEF_VAR_QUANTIZE(quant) do { \
761 NC(nc_def_var_quantize(ncid, varid, NC_QUANTIZE_GRANULARBR, quant)); \
764#define NC_DEF_VAR_QUANTIZE(quant) do { \
766 ERRMSG("NetCDF quantization is not supported by this NetCDF version"); \
787#define NC_GET_DOUBLE(varname, ptr, force) { \
789 NC(nc_inq_varid(ncid, varname, &varid)); \
790 NC(nc_get_var_double(ncid, varid, ptr)); \
792 if(nc_inq_varid(ncid, varname, &varid) == NC_NOERR) { \
793 NC(nc_get_var_double(ncid, varid, ptr)); \
795 WARN("netCDF variable %s is missing!", varname); \
816#define NC_INQ_DIM(dimname, ptr, min, max, check) { \
817 int dimid; size_t naux; \
818 NC(nc_inq_dimid(ncid, dimname, &dimid)); \
819 NC(nc_inq_dimlen(ncid, dimid, &naux)); \
822 if ((*ptr) < (min) || (*ptr) > (max)) \
823 ERRMSG("Dimension %s is out of range!", dimname); \
840#define NC_PUT_DOUBLE(varname, ptr, hyperslab) { \
841 NC(nc_inq_varid(ncid, varname, &varid)); \
843 NC(nc_put_vara_double(ncid, varid, start, count, ptr)); \
845 NC(nc_put_var_double(ncid, varid, ptr)); \
864#define NC_PUT_FLOAT(varname, ptr, hyperslab) { \
865 NC(nc_inq_varid(ncid, varname, &varid)); \
867 NC(nc_put_vara_float(ncid, varid, start, count, ptr)); \
869 NC(nc_put_var_float(ncid, varid, ptr)); \
887#define NC_PUT_INT(varname, ptr, hyperslab) { \
888 NC(nc_inq_varid(ncid, varname, &varid)); \
890 NC(nc_put_vara_int(ncid, varid, start, count, ptr)); \
892 NC(nc_put_var_int(ncid, varid, ptr)); \
909#define NC_PUT_ATT(varname, attname, text) { \
910 NC(nc_inq_varid(ncid, varname, &varid)); \
911 NC(nc_put_att_text(ncid, varid, attname, strnlen(text, LEN), text)); \
926#define NC_PUT_ATT_GLOBAL(attname, text) \
927 NC(nc_put_att_text(ncid, NC_GLOBAL, attname, strnlen(text, LEN), text));
958#define NEDT(t_bg, nesr, nu) \
959 (BRIGHT(PLANCK((t_bg), (nu)) + (nesr), (nu)) - (t_bg))
987#define NESR(t_bg, nedt, nu) \
988 (PLANCK((t_bg) + (nedt), (nu)) - PLANCK((t_bg), (nu)))
1004#define NORM(a) sqrt(DOTP(a, a))
1035#define PLANCK(T, nu) \
1036 (C1 * POW3(nu) / gsl_expm1(C2 * (nu) / (T)))
1049#define POW2(x) ((x)*(x))
1062#define POW3(x) ((x)*(x)*(x))
1078#define RAD2DEG(rad) ((rad) * (180.0 / M_PI))
1108#define REFRAC_SW53(p, T, h2o) \
1109 (1e-6 * (77.6 * (p) / (T) + 3.73e5 * (h2o) * (p) / ((T) * (T))))
1135#define REFRAC_EDLEN(p, T) \
1137 * (8342.54 + 2406147.0 / (130.0 - 1.0 / (10.0 * 10.0)) \
1138 + 15998.0 / (38.9 - 1.0 / (10.0 * 10.0)))) \
1139 * ((p) / 1013.25) * (288.15 / (T)))
1155#define TBL_LOG(tbl, id, ig) \
1157 for (int ip = 0; ip < (tbl)->np[(id)][(ig)]; ip++) \
1159 "p[%2d]= %.5e hPa | T[0:%2d]= %.2f ... %.2f K | " \
1160 "u[0:%3d]= %.5e ... %.5e molec/cm^2 | " \
1161 "eps[0:%3d]= %.5e ... %.5e", \
1163 (tbl)->p[(id)][(ig)][(ip)], \
1164 (tbl)->nt[(id)][(ig)][(ip)] - 1, \
1165 (tbl)->t[(id)][(ig)][(ip)][0], \
1166 (tbl)->t[(id)][(ig)][(ip)] \
1167 [(tbl)->nt[(id)][(ig)][(ip)] - 1], \
1168 (tbl)->nu[(id)][(ig)][(ip)][0] - 1, \
1169 exp((tbl)->logu[(id)][(ig)][(ip)][0][0]), \
1170 exp((tbl)->logu[(id)][(ig)][(ip)][0] \
1171 [(tbl)->nu[(id)][(ig)][(ip)][0] - 1]), \
1172 (tbl)->nu[(id)][(ig)][(ip)][0] - 1, \
1173 exp((tbl)->logeps[(id)][(ig)][(ip)][0][0]), \
1174 exp((tbl)->logeps[(id)][(ig)][(ip)][0] \
1175 [(tbl)->nu[(id)][(ig)][(ip)][0] - 1])); \
1189#define SELECT_TIMER(id, group) \
1190 {timer_group(id, group, 0);}
1199#define PRINT_TIMERS \
1200 {timer_group("END", "END", 1);}
1220#define TOK(line, tok, format, var) { \
1221 if(((tok)=strtok((line), " \t"))) { \
1222 if(sscanf(tok, format, &(var))!=1) continue; \
1223 } else ERRMSG("Error while reading!"); \
1240 for (iusage = 1; iusage < argc; iusage++) \
1241 if (!strcmp(argv[iusage], "-h") \
1242 || !strcmp(argv[iusage], "--help")) { \
1244 return EXIT_SUCCESS; \
1286#define LOG(level, ...) { \
1289 if(level <= LOGLEV) { \
1290 printf(__VA_ARGS__); \
1323#define WARN(...) { \
1324 printf("\nWarning (%s, %s, l%d): ", __FILE__, __func__, __LINE__); \
1325 LOG(0, __VA_ARGS__); \
1356#define ERRMSG(...) { \
1357 printf("\nError (%s, %s, l%d): ", __FILE__, __func__, __LINE__); \
1358 LOG(0, __VA_ARGS__); \
1359 exit(EXIT_FAILURE); \
1391#define PRINT(format, var) \
1392 printf("Print (%s, %s, l%d): %s= "format"\n", \
1393 __FILE__, __func__, __LINE__, #var, var);
1824 char shared_io_atm_apr_file[
LEN];
1827 char shared_io_obs_meas_file[
LEN];
1830 char shared_io_atm_final_file[
LEN];
1833 char shared_io_obs_final_file[
LEN];
1836 char shared_io_matrix_cov_apr_file[
LEN];
1839 char shared_io_matrix_kernel_file[
LEN];
1842 char shared_io_matrix_cov_ret_file[
LEN];
1845 char shared_io_matrix_corr_file[
LEN];
1848 char shared_io_matrix_gain_file[
LEN];
1851 char shared_io_matrix_avk_file[
LEN];
1854 char shared_io_atm_err_total_file[
LEN];
1857 char shared_io_atm_err_noise_file[
LEN];
1860 char shared_io_atm_err_formod_file[
LEN];
1863 char shared_io_atm_cont_file[
LEN];
1866 char shared_io_atm_res_file[
LEN];
1980 const gsl_matrix * avk);
2038 const gsl_matrix * avk,
2102 const int value_iqa,
2217 const gsl_vector * dx,
2218 const gsl_vector * dy,
2219 const gsl_matrix * s_a_inv,
2220 const gsl_vector * sig_eps_inv);
2358 const atm_t * atm_src,
2388 const obs_t * obs_src,
2466 const char *emitter);
2508 los_t * los_scratch,
2509 obs_t * obs_scratch);
2537 los_t * los_scratch,
2538 obs_t * obs_scratch);
2597 obs_t * obs_scratch);
2921 double tau_path[
ND][
NG],
2922 double tau_seg[
ND]);
2967 double tau_path[
ND][
NG],
2968 double tau_seg[
ND]);
3040 const double logeps);
3309 const gsl_matrix * a,
3310 const gsl_vector * b,
3311 const int transpose,
3512 const char *dirname,
3513 const char *filename,
3565 const char *filename,
3619 const char *filename,
3665 const char *filename,
3734 const char *dirname,
3735 const char *filename,
3737 gsl_matrix * matrix,
3772 const char *dirname,
3773 const char *filename,
3774 gsl_matrix * matrix);
3794 const char *dirname,
3795 const char *filename,
3796 gsl_matrix * matrix);
3820 const char *dirname,
3821 const char *filename,
3822 gsl_matrix * matrix,
3862 const char *dirname,
3863 const char *filename,
3906 const char *filename,
3952 const char *filename,
3989 const char *filename,
4034 const char *basename,
4161 const char *filename,
4200 const char *filename,
4427 const char *varname,
4429 const char *defvalue,
4550 gsl_vector * sig_noise,
4551 gsl_vector * sig_formod,
4552 gsl_vector * sig_eps_inv);
4582 const char *shared_file,
4583 const char *legacy_file,
4584 const char **dirname,
4615 const char *shared_file,
4616 const char *legacy_file,
4617 const char **dirname,
4797 size_t *bytes_used);
4856 const uint8_t * buf);
4890 const double remain,
4961 const char *dirname,
4962 const char *filename,
5019 const char *filename,
5077 const char *filename,
5129 const char *filename,
5186 const char *filename,
5214 const char *dirname,
5215 const char *filename,
5217 const gsl_matrix * matrix,
5220 const char *rowspace,
5221 const char *colspace,
5273 const char *dirname,
5274 const char *filename,
5276 const gsl_matrix * matrix,
5279 const char *rowspace,
5280 const char *colspace,
5298 const char *dirname,
5299 const char *filename,
5300 const gsl_matrix * matrix);
5329 const char *dirname,
5330 const char *filename,
5332 const gsl_matrix * matrix,
5335 const char *rowspace,
5336 const char *colspace,
5376 const char *dirname,
5377 const char *filename,
5421 const char *filename,
5463 const char *filename,
5505 const char *filename,
5545 const char *filename,
5596 const char *quantity,
5600 const gsl_matrix * s);
5791 const gsl_vector * x,
5824 const gsl_vector * x,
5861 const gsl_vector * y,
double intpol_tbl_eps(const tbl_t *tbl, const int ig, const int id, const int ip, const int it, const double logu)
Interpolate gas emissivity as a function of column amount.
void analyze_avk(const ret_t *ret, const ctl_t *ctl, const atm_t *atm, const int *iqa, const int *ipa, const gsl_matrix *avk)
Analyze averaging kernel (AVK) matrix for retrieval diagnostics.
void read_tbl_bin(const ctl_t *ctl, tbl_t *tbl, const int id, const int ig)
Read a single compact binary emissivity lookup table.
#define LEN
Maximum length of ASCII data lines.
@ FORMOD_STATUS_TOO_MANY_LOS_POINTS
@ FORMOD_STATUS_FOV_DATA_MISSING
@ FORMOD_STATUS_RFM_UNSUPPORTED
@ FORMOD_STATUS_OBSERVER_BELOW_SURFACE
double cost_function(const gsl_vector *dx, const gsl_vector *dy, const gsl_matrix *s_a_inv, const gsl_vector *sig_eps_inv)
Compute the normalized quadratic cost function for optimal estimation.
double read_obs_rfm(const char *basename, const double z, const double *nu, const double *f, const int n)
Read and spectrally convolve an RFM output spectrum.
void write_atm(const char *dirname, const char *filename, const ctl_t *ctl, const atm_t *atm, int profile)
Write atmospheric data to a file.
void read_rfm_spec(const char *filename, double *nu, double *rad, int *npts)
Read a Reference Forward Model (RFM) ASCII spectrum.
void tbl_pack(const tbl_t *tbl, int id, int ig, uint8_t *buf, size_t *bytes_used)
Pack a lookup table into a contiguous binary buffer.
void read_matrix_nc(const char *dirname, const char *filename, gsl_matrix *matrix, int dataset)
Read a numerical matrix from a netCDF file.
double cos_sza(const double sec, const double lon, const double lat)
Calculates the cosine of the solar zenith angle.
int raytrace(const ctl_t *ctl, const atm_t *atm, obs_t *obs, los_t *los, const int ir)
Perform line-of-sight (LOS) ray tracing through the atmosphere.
void read_atm_bin(const char *filename, const ctl_t *ctl, atm_t *atm)
Read atmospheric data in binary format.
void write_obs_asc(const char *filename, const ctl_t *ctl, const obs_t *obs)
Write observation data to an ASCII text file.
void formod_rfm(const ctl_t *ctl, const tbl_t *tbl, const atm_t *atm, obs_t *obs)
Forward-model radiance and transmittance with the Reference Forward Model (RFM).
int locate_reg(const double *xx, const int n, const double x)
Locate index for interpolation on a regular (uniform) grid.
void intpol_tbl_ega(const ctl_t *ctl, const tbl_t *tbl, const los_t *los, const int ip, double tau_path[ND][NG], double tau_seg[ND])
Interpolate emissivities and transmittances using the Emissivity Growth Approximation (EGA).
double ctmo2(const double nu, const double p, const double t)
Compute O₂ collision-induced absorption coefficient.
void write_obs_nc(const char *filename, const ctl_t *ctl, const obs_t *obs, const int profile)
Write one observation profile to a NetCDF file.
void tbl_free(const ctl_t *ctl, tbl_t *tbl)
Free lookup table and all internally allocated memory.
void write_tbl_asc(const ctl_t *ctl, const tbl_t *tbl, const int id, const int ig)
Write one emissivity lookup table in human-readable ASCII format.
void write_tbl_nc(const ctl_t *ctl, const tbl_t *tbl, const int id, const int ig)
Write one packed lookup table to a NetCDF file.
void idx2name(const ctl_t *ctl, const int idx, char *quantity)
Convert a quantity index to a descriptive name string.
void read_ctl(int argc, char *argv[], ctl_t *ctl)
Read model control parameters from command-line and configuration input.
void formod_continua(const ctl_t *ctl, const los_t *los, const int ip, double *beta)
Compute total extinction including gaseous continua.
void read_obs_bin(const char *filename, const ctl_t *ctl, obs_t *obs)
Read binary-formatted observation data from a file.
int shared_io_lock(const ret_t *ret)
Acquire an exclusive lock for shared retrieval output files.
void read_obs(const char *dirname, const char *filename, const ctl_t *ctl, obs_t *obs, int profile)
Read observation data from an input file.
void matrix_product(const gsl_matrix *a, const gsl_vector *b, const int transpose, gsl_matrix *c)
Compute structured matrix products of the form or .
int formod_pencil(const ctl_t *ctl, const tbl_t *tbl, const atm_t *atm, obs_t *obs, const int ir, los_t *los)
Compute line-of-sight radiances using the pencil-beam forward model.
int locate_irr(const double *xx, const int n, const double x)
Locate index for interpolation on an irregular grid.
const char * shared_io_input_target(const ret_t *ret, const char *shared_file, const char *legacy_file, const char **dirname, int *profile)
Resolve retrieval input target for legacy-directory and shared-file modes.
void write_matrix_asc(const char *dirname, const char *filename, const ctl_t *ctl, const gsl_matrix *matrix, const atm_t *atm, const obs_t *obs, const char *rowspace, const char *colspace, const char *sort)
Write a fully annotated matrix (e.g., Jacobian or gain matrix) to an ASCII file.
void day2doy(int year, int mon, int day, int *doy)
Convert a calendar date to day-of-year.
void write_atm_nc(const char *filename, const ctl_t *ctl, const atm_t *atm, int profile)
Write one atmospheric profile to a netCDF file.
void write_matrix(const char *dirname, const char *filename, const ctl_t *ctl, const gsl_matrix *matrix, const atm_t *atm, const obs_t *obs, const char *rowspace, const char *colspace, const char *sort, int dataset)
Write a fully annotated matrix (e.g., Jacobian or gain matrix) to file.
void time2jsec(const int year, const int mon, const int day, const int hour, const int min, const int sec, const double remain, double *jsec)
Converts time components to seconds since January 1, 2000, 12:00:00 UTC.
void x2atm(const ctl_t *ctl, const gsl_vector *x, atm_t *atm)
Map retrieval state vector back to atmospheric structure.
void atm2x_help(const double value, const int value_iqa, const int value_ip, gsl_vector *x, int *iqa, int *ipa, size_t *n)
Append a single atmospheric value to the state vector.
double ctmh2o(const double nu, const double p, const double t, const double q, const double u)
Compute the MT_CKD 4.1 water vapor continuum (optical depth).
void write_tbl_bin(const ctl_t *ctl, const tbl_t *tbl, const int id, const int ig)
Write one emissivity lookup table in compact binary format.
void intpol_tbl_cga(const ctl_t *ctl, const tbl_t *tbl, const los_t *los, const int ip, double tau_path[ND][NG], double tau_seg[ND])
Interpolate emissivities and transmittances using the Curtis–Godson approximation (CGA).
void shared_io_unlock(int fd)
Release a shared retrieval output lock.
void write_atm_rfm(const char *filename, const ctl_t *ctl, const atm_t *atm)
Write atmospheric profile in RFM-compatible format.
#define ND
Maximum number of radiance channels.
void set_cov_meas(const ret_t *ret, const ctl_t *ctl, const obs_t *obs, gsl_vector *sig_noise, gsl_vector *sig_formod, gsl_vector *sig_eps_inv)
Construct measurement error standard deviations and their inverse.
void write_obs(const char *dirname, const char *filename, const ctl_t *ctl, const obs_t *obs, int profile)
Write observation data to an output file in ASCII or binary format.
#define NSHAPE
Maximum number of shape function grid points.
void write_tbl(const ctl_t *ctl, const tbl_t *tbl)
Write emissivity lookup tables to disk.
size_t tbl_unpack(tbl_t *tbl, int id, int ig, const uint8_t *buf)
Unpack a lookup table from a contiguous binary buffer.
void read_matrix(const char *dirname, const char *filename, const ctl_t *ctl, gsl_matrix *matrix, int dataset)
Read a numerical matrix from a file.
void intpol_atm(const ctl_t *ctl, const atm_t *atm, const double z, double *p, double *t, double *q, double *k)
Interpolate atmospheric state variables at a given altitude.
int find_emitter(const ctl_t *ctl, const char *emitter)
Find gas species index by name.
void optimal_estimation(ret_t *ret, ctl_t *ctl, tbl_t *tbl, obs_t *obs_meas, obs_t *obs_i, atm_t *atm_apr, atm_t *atm_i, double *chisq)
Perform optimal estimation retrieval using Levenberg–Marquardt minimization.
double intpol_tbl_u(const tbl_t *tbl, const int ig, const int id, const int ip, const int it, const double logeps)
Interpolate column amount as a function of emissivity.
void timer_group(const char *name, const char *group, int output)
Aggregate wall-clock timings for named code phases.
void tangent_point(const los_t *los, double *tpz, double *tplon, double *tplat)
Determine the tangent point along a line of sight (LOS).
double ctmco2(const double nu, const double p, const double t, const double u)
Compute carbon dioxide continuum optical depth.
void read_atm(const char *dirname, const char *filename, const ctl_t *ctl, atm_t *atm, int profile)
Read atmospheric input data from a file.
int formod_fov(const ctl_t *ctl, obs_t *obs, obs_t *obs_scratch)
Apply field-of-view (FOV) convolution to modeled radiances.
void write_matrix_nc(const char *dirname, const char *filename, const ctl_t *ctl, const gsl_matrix *matrix, const atm_t *atm, const obs_t *obs, const char *rowspace, const char *colspace, const char *sort, int dataset)
Write a numerical matrix to a netCDF file.
void write_atm_asc(const char *filename, const ctl_t *ctl, const atm_t *atm)
Write atmospheric data to an ASCII file.
void write_matrix_bin(const char *dirname, const char *filename, const gsl_matrix *matrix)
Write a numerical matrix to a binary file.
void copy_obs(const ctl_t *ctl, obs_t *obs_dest, const obs_t *obs_src, const int init)
Copy or initialize observation geometry and radiance data.
void formod_batch(const ctl_t *ctl, const tbl_t *tbl, atm_t *atm, obs_t *obs, const int nbatch, int *status, los_t *los_scratch, obs_t *obs_scratch)
Execute the forward model for a batch of independent cases.
#define TBLNT
Maximum number of temperatures in emissivity tables.
void write_obs_bin(const char *filename, const ctl_t *ctl, const obs_t *obs)
Write observation data in binary format to a file.
void x2atm_help(double *value, const gsl_vector *x, size_t *n)
Helper function to extract a single value from the retrieval state vector.
void cart2geo(const double *x, double *z, double *lon, double *lat)
Converts Cartesian coordinates to geographic coordinates.
#define NP
Maximum number of atmospheric data points.
void doy2day(int year, int doy, int *mon, int *day)
Convert a day-of-year value to a calendar date.
void kernel(const ctl_t *ctl, const tbl_t *tbl, atm_t *atm, obs_t *obs, gsl_matrix *k)
Compute the Jacobian (kernel) matrix by finite differences.
void read_obs_nc(const char *filename, const ctl_t *ctl, obs_t *obs, const int profile)
Read one observation profile from a NetCDF file.
void init_srcfunc(const ctl_t *ctl, tbl_t *tbl)
Initialize source function lookup tables from emissivity data.
void matrix_invert(gsl_matrix *a)
Invert a square matrix, optimized for diagonal or symmetric positive-definite matrices.
void read_ret(int argc, char *argv[], const ctl_t *ctl, ret_t *ret)
Read retrieval configuration and error parameters.
double scan_ctl(int argc, char *argv[], const char *varname, const int arridx, const char *defvalue, char *value)
Scan control file or command-line arguments for a configuration variable.
void write_shape(const char *filename, const double *x, const double *y, const int n)
Write tabulated shape function data to a text file.
void read_atm_asc(const char *filename, const ctl_t *ctl, atm_t *atm)
Read atmospheric data in ASCII format.
#define NG
Maximum number of emitters.
void read_tbl_asc(const ctl_t *ctl, tbl_t *tbl, const int id, const int ig)
Read a single ASCII emissivity lookup table.
void formod_srcfunc(const ctl_t *ctl, const tbl_t *tbl, const double t, double *src)
Interpolate the source function (Planck radiance) at a given temperature.
void analyze_avk_quantity(const gsl_matrix *avk, const int iq, const int *ipa, const size_t *n0, const size_t *n1, double *cont, double *res)
Analyze averaging kernel submatrix for a specific retrieved quantity.
void jsec2time(const double jsec, int *year, int *mon, int *day, int *hour, int *min, int *sec, double *remain)
Converts Julian seconds to calendar date and time components.
#define TBLNS
Maximum number of source function temperature levels.
void read_matrix_asc(const char *dirname, const char *filename, gsl_matrix *matrix)
Read a numerical matrix from an ASCII file.
tbl_t * read_tbl(const ctl_t *ctl)
Read emissivity lookup tables from disk.
void read_matrix_bin(const char *dirname, const char *filename, gsl_matrix *matrix)
Read a numerical matrix from a binary file.
void read_tbl_nc_channel(const ctl_t *ctl, tbl_t *tbl, int id, int ig, int ncid)
Read one packed emissivity lookup table from an open NetCDF file.
const char * shared_io_output_target(const ret_t *ret, const char *shared_file, const char *legacy_file, const char **dirname, int *profile)
Resolve retrieval output target for legacy-directory and shared-file modes.
void read_atm_nc(const char *filename, const ctl_t *ctl, atm_t *atm, int profile)
Read one atmospheric profile from a netCDF file.
void copy_atm(const ctl_t *ctl, atm_t *atm_dest, const atm_t *atm_src, const int init)
Copy or initialize atmospheric profile data.
size_t obs2y(const ctl_t *ctl, const obs_t *obs, gsl_vector *y, int *ida, int *ira)
Convert observation radiances into a measurement vector.
void y2obs(const ctl_t *ctl, const gsl_vector *y, obs_t *obs)
Copy elements from the measurement vector y into the observation structure.
void hydrostatic(const ctl_t *ctl, atm_t *atm)
Adjust pressure profile using the hydrostatic equation.
void read_shape(const char *filename, double *x, double *y, int *n)
Read a two-column shape function from an ASCII file.
double ctmn2(const double nu, const double p, const double t)
Compute N₂ collision-induced absorption coefficient.
size_t atm2x(const ctl_t *ctl, const atm_t *atm, gsl_vector *x, int *iqa, int *ipa)
Convert atmospheric data to state vector elements.
#define TBLNP
Maximum number of pressure levels in emissivity tables.
void climatology(const ctl_t *ctl, atm_t *atm)
Initializes atmospheric climatology profiles.
void geo2cart(const double z, const double lon, const double lat, double *x)
Converts geographic coordinates (longitude, latitude, altitude) to Cartesian coordinates.
#define NSF
Maximum number of surface layer spectral grid points.
#define NCL
Maximum number of cloud layer spectral grid points.
void set_cov_apr(const ret_t *ret, const ctl_t *ctl, const atm_t *atm, const int *iqa, const int *ipa, gsl_matrix *s_a)
Construct the a priori covariance matrix for retrieval parameters.
const char * shared_io_output_file(const ret_t *ret)
Return the primary shared retrieval output file configured for locking.
void write_stddev(const char *quantity, const ret_t *ret, const ctl_t *ctl, const atm_t *atm, const gsl_matrix *s)
Write retrieval standard deviation profiles to disk.
#define NLOS
Maximum number of LOS points.
int formod(const ctl_t *ctl, const tbl_t *tbl, atm_t *atm, obs_t *obs, los_t *los_scratch, obs_t *obs_scratch)
Execute one complete forward-model calculation.
size_t tbl_packed_size(const tbl_t *tbl, int id, int ig)
Compute required buffer size (in bytes) for tbl_pack().
#define NR
Maximum number of ray paths.
int locate_tbl(const float *xx, const int n, const double x)
Locate index for interpolation within emissivity table grids.
void write_atm_bin(const char *filename, const ctl_t *ctl, const atm_t *atm)
Write atmospheric data to a binary file.
void read_obs_asc(const char *filename, const ctl_t *ctl, obs_t *obs)
Read ASCII-formatted observation data from a file.
#define NW
Maximum number of spectral windows.
Atmospheric profile data.
double clz
Cloud layer height [km].
int np
Number of data points.
double cldz
Cloud layer depth [km].
double sft
Surface temperature [K].
int write_matrix
Write matrix file (0=no, 1=yes).
int nw
Number of spectral windows.
int atmfmt
Atmospheric data file format (1=ASCII, 2=binary, 3=netCDF).
double retp_zmin
Minimum altitude for pressure retrieval [km].
int ig_co2
Emitter index of CO2.
double hydz
Reference height for hydrostatic pressure profile (-999 to skip) [km].
int ctm_co2
Compute CO2 continuum (0=no, 1=yes).
double rett_zmax
Maximum altitude for temperature retrieval [km].
int ret_sfeps
Retrieve surface layer emissivity (0=no, 1=yes).
int ret_sft
Retrieve surface layer temperature (0=no, 1=yes).
int ret_clz
Retrieve cloud layer height (0=no, 1=yes).
int ctm_n2
Compute N2 continuum (0=no, 1=yes).
int ctm_h2o
Compute H2O continuum (0=no, 1=yes).
int formod
Forward model (0=CGA, 1=EGA, 2=RFM).
int ng
Number of emitters.
int refrac
Take into account refractivity (0=no, 1=yes).
int ig_o2
Emitter index of O2.
double rett_zmin
Minimum altitude for temperature retrieval [km].
double sfsza
Solar zenith angle at the surface [deg] (-999=auto).
int nd
Number of radiance channels.
int fov_n
Field-of-view number of data points.
int sftype
Surface treatment (0=none, 1=emissions, 2=downward, 3=solar).
int matrixfmt
Matrix data file format (1=ASCII, 2=binary, 3=netCDF).
int ncl
Number of cloud layer spectral grid points.
int ig_n2
Emitter index of N2.
int obsfmt
Observation data file format (1=ASCII, 2=binary, 3=netCDF).
int ctm_o2
Compute O2 continuum (0=no, 1=yes).
int ret_clk
Retrieve cloud layer extinction (0=no, 1=yes).
int nsf
Number of surface layer spectral grid points.
double rayds
Maximum step length for raytracing [km].
int ret_cldz
Retrieve cloud layer depth (0=no, 1=yes).
int ig_h2o
Emitter index of H2O.
int tblfmt
Look-up table file format (1=ASCII, 2=binary, 3=netCDF).
double raydz
Vertical step length for raytracing [km].
int write_bbt
Use brightness temperature instead of radiance (0=no, 1=yes).
double retp_zmax
Maximum altitude for pressure retrieval [km].
double sft
Surface temperature [K].
int np
Number of LOS points.
Observation geometry and radiance data.
int nr
Number of ray paths.
Retrieval control parameters.
double err_press_cz
Vertical correlation length for pressure error [km].
double err_press
Pressure error [%].
int err_ana
Carry out error analysis (0=no, 1=yes).
double err_temp_cz
Vertical correlation length for temperature error [km].
double conv_dmin
Minimum normalized step size in state space.
double err_temp
Temperature error [K].
double err_clz
Cloud height error [km].
double err_sft
Surface temperature error [K].
double err_temp_ch
Horizontal correlation length for temperature error [km].
int kernel_recomp
Re-computation of kernel matrix (number of iterations).
int conv_itmax
Maximum number of iterations.
double err_cldz
Cloud depth error [km].
double err_press_ch
Horizontal correlation length for pressure error [km].
int shared_io_profile
Profile index used for shared netCDF retrieval inputs and outputs.
Emissivity look-up tables.