env_help.c

Go to the documentation of this file.

#ifndef NGS_HELP_H
#define NGS_HELP_H


#include <stdlib.h>
#include <stdio.h>
#include <strings.h>
#include <string.h>


struct NGS_HELP_STRINGS {
        char *type;
        char *variable;
        char *help;
};


struct NGS_HELP_STRINGS ngs_help[] = {
        { "char",       "title[80]",    " Environment Title: User define-able"  },
        { "char",       "filename[256]",        " Current Selected datafile"    },
        { "char",       "gfilename[256]",       " Current Selected gains datafile"      },
        { "char",       "source[64]",   " Currently Selected Source"    },
        { "char",       "backend[16]",  " Spectrometer/Continuum Backend Name: i.e. F1M-HU"     },
        { "char",       "savefile[256]",        " Save filename"        },
        { "char",       "userfile[256]",        " User filename Used by 'print /w' command"     },
        { "int",        "accum",        " If True, We are in the process of accumulating scans" },
        { "int",        "accumcount",   " Total number of scans last accumulated"       },
        { "int",        "accumreset",   " If True, Next call to the accum function resets all registers"        },
        { "int",        "acc_plot_select_x",    " Accumm plot x axis: 'num', 'el', 'ut', 'scannum'"     },
        { "int",        "acc_plot_select_y",    " Accumm plot y axis: 'sig', 'sky', 'smror', 'tsys', 'tastar', 'tr', 'jansky'"  },
        { "int",        "acount",       " Total number of items in stack"       },
        { "int",        "allow_five_pt",        " Allow five point centers to be accumulated"   },
        { "int",        "ashift",       " # of channels to shift spectra - or +"        },
        { "int",        "autobad",      " Automatically remove bad channels when encountered"   },
        { "int",        "autotau",      " If True, Process SPTIP's as you encounter them during accum"  },
        { "int",        "badchanepoch",         " Epoch of the 'fixed' bad channel array"       },
        { "int",        "badchanshow",  " If True, Place markers on defined bad channels"       },
        { "int",        "badchans[MAX_BAD_CHANS]",      " Array of flagged bad channels"        },
        { "int",        "baselines[MAX_BASELINES][2]",  " Defined baseline regions"     },
        { "int",        "bdrop",        " # of channels to drop from beginning of spectral plot"        },
        { "int",        "bkmatch",      " Backend matching mode: 0 = FEED, 1 = RESOLUTION, 2 = NAME"    },
        { "int",        "bleadtrail",   " 0 = straight, 1 = polynomial fitting of leading and trailing channels"        },
        { "int",        "bmark",        " If True, show baseline region boxes on plot"  },
        { "int",        "bshow",        " If True, Show the baseline fit on plot"       },
        { "int",        "bsmoothing",   " Linear vs polynomial intep between baseline regions"  },
        { "int",        "calmode",      " Cal Mode: 0 = NONE, 1 = CALSCALE, 2 = BEAMEFF, 3 = TELE_EFF"  },
        { "int",        "check_bkname", "  "    },
        { "int",        "check_date",   " If True, Use the Date in the search criteria" },
        { "int",        "check_feed",   " If True, Use the IF Feed in the search criteria"      },
        { "int",        "check_freq",   " If True, Use the Frequency in the search criteria"    },
        { "int",        "check_scans",  " If True, Use the Actual Scan Numbers in the search criteria"  },
        { "int",        "check_source",         " If True, Use the Source Name in the search criteria"  },
        { "int",        "currentImage",         " Current image header index"   },
        { "int",        "dobadchan",    " If True, smooth over defined bad channels"    },
        { "int",        "dobaseline",   " if True, remove computed baseline"    },
        { "int",        "doing_fives",  " It True, analyse 5 point centers like a seq"  },
        { "int",        "dospike",      " If True, Locate and remove and spikes in data: Experimental"  },
        { "int",        "edrop",        " Amount of channels to remove from end of plot"        },
        { "int",        "elgain",       " If True, Compute and use the defined Elevation Gain Terms"    },
        { "int",        "feed",         " Which feed we are processing at and given time"       },
        { "int",        "glength",      " The number of data points to include in Gaussian fitting"     },
        { "int",        "gridmode",     " Plot window grid mode: 0 = NONE, 1 = X_ONLY, 2 = Y_ONLY, 3 = FULL"    },
        { "int",        "ignoremapoff",         " If True, Ignore small mapping offsets"        },
        { "int",        "ignorepos",    " If True, ignore RA, Dec & Vel in accum function: Think Planets"       },
        { "int",        "invert",       " If True, invert the phases of continuum data" },
        { "int",        "issmt",        " If True, data file is from SMT"       },
        { "int",        "usesat",       " Display Strings And Things if True"   },
        { "int",        "last_scan_count",      " # of scans accumulated in last 'accum'"       },
        { "int",        "loopdelay1",   " Delay for any background loops"       },
        { "int",        "loopdelay2",   " Delay for any foreground loops"       },
        { "int",        "mapangle",     " Preliminary Grid Map plotting angles" },
        { "int",        "mapbaselines",         " # of cells on ends of row used for baselines neg # for center cells 0 to skip altogether"     },
        { "int",        "markers",      " # of filterbank channels per card: see mshow" },
        { "int",        "map_w",        " Grid map width in cells"      },
        { "int",        "map_h",        " Grid map height in cells"     },
        { "int",        "mode",         " 1 = MODE_CONT, 2 = MODE_SPEC, 3 = MODE_OTF"   },
        { "int",        "mshow",        " If True, draw markers on spectral plot show filter card breaks"       },
        { "int",        "nbeff",        " # of columns to printout during beam eff function"    },
        { "int",        "nbox",         " # of channels to use in the boxcar function"  },
        { "int",        "nbshape",      " # of channels to smooth for bshape command"   },
        { "int",        "nfit",         " # of parameters for curve fitting 1 - 10"     },
        { "int",        "nignored",     " # of scans in the ignore-scan array"  },
        { "int",        "nsave",        " Current selected nsave value: Used for fetching saved scans"  },
        { "int",        "nspline",      " # of terms to use in bspline function"        },
        { "int",        "numofscans",   " # of scans in currently selected data file"   },
        { "int",        "ons",  " If True, display the 'on' phases in continuum plot"   },
        { "int",        "otf_cols", "  "        },
        { "int",        "otf_rows", "  "        },
        { "int",        "otf_map_xcell", "  "   },
        { "int",        "otf_map_ycell", "  "   },
        { "int",        "otf_bint_chan",        " Beginning integration channel/region" },
        { "int",        "otf_eint_chan",        " Ending integration channel/region"    },
        { "int",        "otf_3d_bchan",         " Beginning channel of a 3d data cube"  },
        { "int",        "otf_3d_echan",         " Ending channel of a 3d data cube"     },
        { "int",        "otf_3d_interp",        " # of planes to create b/t channels in a 3d data cube" },
        { "int",        "otf_movie_bchan",      " Beginning channel of 'vel' run"       },
        { "int",        "otf_movie_echan",      " Ending channel of 'vel' run"  },
        { "int",        "otf_movie_nchan",      " # of channels to avg for 'vel' run"   },
        { "int",        "otf_cutoff",   " % of the bottom-end of data to cut off"       },
        { "int",        "otf_baselines",        " Remove baselines from individual spectral"    },
        { "int",        "otf_color",    " gray, pseudo, flame1, flame2, flame3, flame4, flame5, flame6" },
        { "int",        "otf_ephem_obj",        " If non-zero, Ignore source Ra & Dec when gridding"    },
        { "int",        "otf_single_spec",      " Which Spectral Channel to plot in lower left window"  },
        { "int",        "otf_if_choice",        " Which IF to process"  },
        { "int",        "otf_load_choice",      " Preview, fast, step"  },
        { "int",        "otf_single_bin",       " # of channels to bin for 'otf_single_spec'"   },
        { "int",        "otf_ignore_color",     " If true, ignore changes in color slow internet helper"        },
        { "int",        "otf_ignore_repaint",   " If true, ignore repaints of grid between tile loads"  },
        { "int",        "otf_show_beam_size",   " If True, place a beam size circle on plot"    },
        { "int",        "otf_chan_map_cent",    " OTF Channel Map Center Channel"       },
        { "int",        "otf_chan_map_cols",    " OTF Channel Map # of Columns" },
        { "int",        "otf_chan_map_rows",    " OTF Channel Map # of Rows"    },
        { "int",        "otf_chan_map_avg",     " OTF Channel Map # os Chans to Avg"    },
        { "int",        "otf_baseline_order",   " The 'order' of baseline removal"      },
        { "int",        "otf_show_regions",     " Show region outlines, if True & loaded"       },
        { "int",        "otf_noint",    " # of channels in OTF bandpass"        },
        { "int",        "otf_spare_ints[22]", "  "      },
        { "int",        "overwrite",    " If true, then save will overwrite an existing nsave"  },
        { "int",        "peakChan",     " Channel number with the peak intensity"       },
        { "int",        "plotstyle",    " Plot Style: 0 = HISTOGRAM, 1 = LINES, 2 = POINTS"     },
        { "int",        "plottmb",      " If true, plot the expected Tmb too 0 no plot, 1 = LSB, 2 USB" },
        { "int",        "plotwin",      " Currently selected Gunplot Window"    },
        { "int",        "procspec",     " If True, Further processing needed: think TP Scans"   },
        { "int",        "read_dir",     " 0 = read data files from back to front [default], 1 = front to back"  },
        { "int",        "rm_fit_data",  " If True, remove the bplot data from yplot: Experimental"      },
        { "int",        "shift_allow",  " If True, allow automatic freq shifting of spectra as encountered"     },
        { "int",        "split_phases",         " If True, do not average ON and OFF five points: Experimental" },
        { "int",        "stackdone",    " We have reached the end of the stack" },
        { "int",        "stackindx",    " Current stack pointer"        },
        { "int",        "strictsb",     " If True, Avoid averaging USB and LSB continuum"       },
        { "int",        "used",         " True if this environment is used"     },
        { "int",        "usegslgauss",  " If True, use the gsl Gaussian fitting, else use unipops version"      },
        { "int",        "xdelay",       " Amount of time to delay between gnuplot calls uSec"   },
        { "int",        "x1mode",       " Bottom X-Axis of Spectral plot: 0 = FREQ, 1 = VEL, 2 = CHAN"  },
        { "int",        "x2mode",       " Top X-Axis of Spectral plot: 0 = FREQ, 1 = VEL, 2 = CHAN"     },
        { "int",        "yaxis_scale",  " 0 = LINEAR_PLOT, 1 = LOG_PLOT"        },
        { "int",        "yscale",       " 0 = Y_AUTO_SCALE, 1 = Y_FIXED_SCALE"  },
        { "int",        "zline",        " If True, Show the zero line in spectral plots"        },
        { "int",        "btokens",      " # of batch tokens in current command" },
        { "int",        "displaymode",  " Night mode vs Day mode may not be fully synced yet"   },
        { "int",        "sf_fitcenter",         " User setable chan # of spectral line center if not in center" },
        { "int",        "sf_start",     " User selectable starting sample for Spectral Line Focus"      },
        { "int",        "sf_end",       " User selectable Ending sample for Spectral Line Focus"        },
        { "int",        "sf_bchans",    " User supplied number of baseline channels to use on the ends" },
        { "int",        "spare_ints[58]",       " Was 62 June 2021"     },
        { "double",     "accumtr",      " Running accum Tr"     },
        { "double",     "accumtastar",  " Running accum TaStar" },
        { "double",     "apperatureeff",        " Resulting Aperture efficiency"        },
        { "double",     "avgEl",        " Average Elevation of latest accum"    },
        { "double",     "beam_eff",     " Computed Beam Eff"    },
        { "double",     "bkres",        " backend resolution When searching using BKMATCH_RESOLUTION"   },
        { "double",     "bm_eff[MAX_BEAMS]",    " Resulting beam efficiency"    },
        { "double",     "bp_avg",       " Average temp of the bandpass (bdrop - edrop)" },
        { "double",     "bscan",        " Beginning scan range during searching"        },
        { "double",     "cal_scale",    " Continuum calibration scale when in CALMODE_CALSCALE" },
        { "double",     "ccur",         " Last mouse click channel"     },
        { "double",     "cnterr",       " Center Error term for last Gaussian fit"      },
        { "double",     "curScan",      " Last scan loaded"     },
        { "double",     "datamax",      " Largest value in h0->data array"      },
        { "double",     "datamin",      " Smallest value in h0->data array"     },
        { "double",     "date",         " Date used in searching"       },
        { "double",     "dfreq",        " Delta freq tolerance used during searching"   },
        { "double",     "dvel",         " Delta Velocity tolerance"     },
        { "double",     "escan",        " Ending scan range during searching"   },
        { "double",     "expectedflux",         " User supplied Expected Source Janskys"        },
        { "double",     "expectedtmb",  " User supplied Expected Source T-main-beam"    },
        { "double",     "fcur",         " Last mouse click freq"        },
        { "double",     "fft_xb",       " FFT X-axis Start"     },
        { "double",     "fft_xe",       " FFT X-Axis End"       },
        { "double",     "sf_fitmhz",    " User defined Width of Spectral Focus/Five-pt fitting (MHz)"   },
        { "double",     "fittedtau",    " Last fitted tau from SPTIP"   },
        { "double",     "focus_fit_1",  " Store results of spec focus here"     },
        { "double",     "focus_fit_2", "  "     },
        { "double",     "freq",         " Rest Freq used during Searching"      },
        { "double",     "gaussPeak",    " Peak Results of Gaussian Fit" },
        { "double",     "gaussCenter",  " Center Results of Gaussian Fit"       },
        { "double",     "gaussHP",      " Width Results of Gaussian Fit"        },
        { "double",     "gaussSum",     " Area under the Gaussian Results"      },
        { "double",     "hghterr",      " Height Error term for last Gaussian fit"      },
        { "double",     "hwdc",         " Fractional time of backend integration i.e. 0.90 for filters" },
        { "double",     "hwerr",        " Width Error term for last Gaussian fit"       },
        { "double",     "if_feed",      " [1, 2, 3 or 4]: requested feed: 0.01, 0.02, 0.03, 0.04"       },
        { "double",     "ignoredscans[MAX_IGNORED]", "  "       },
        { "double",     "intercept",    " Last Intercept from the baseline operation"   },
        { "double",     "jfact",        " Currently used Jk/K factor"   },
        { "double",     "jupiter_tmb",  " Jupiter Temperature-Main-Beam"        },
        { "double",     "kj_factor",    " If Non Zero, use this value for Kelvin to Jansky Conversion"  },
        { "double",     "elgain_term1",         " User input elevation gain curve term 1"       },
        { "double",     "elgain_term2",         " User input elevation gain curve term 2"       },
        { "double",     "elgain_term3",         " User input elevation gain curve term 3"       },
        { "double",     "elgain_term4",         " User input elevation gain curve term 4"       },
        { "double",     "elgain_term5",         " User input elevation gain curve term 5"       },
        { "double",     "lowerdb",      " Lowest fabs(map_value) allowed when using decibel map plot"   },
        { "double",     "mantau0",      " User supplied tau0 value: overrides autotau"  },
        { "double",     "map_angle[2]",         " Grid Map angle used for plotting"     },
        { "double",     "mars_tmb",     " Mars Temperature-Main-Beam"   },
        { "double",     "mercury_tmb",  " Mercury Temperature-Main-Beam: filled in by 'plan' command"   },
        { "double",     "neptune_tmb",  " Neptune Temperature-Main-Beam"        },
        { "double",     "newres",       " New resolution to convert data to. Used by chngres"   },
        { "double",     "oob_val",      " Out Of Bounds Value Set OOB values to this else the avg is used"      },
        { "double",     "otf_nyquistra",        " Size of individual cells in RA"       },
        { "double",     "otf_nyquistdec",       " Size of individual cells in Dec"      },
        { "double",     "otf_map_ra",   " Center of Map in RA"  },
        { "double",     "otf_map_dec",  " Center of Map in Dec" },
        { "double",     "otf_map_xsize",        " Size of map in RA"    },
        { "double",     "otf_map_ysize",        " Size of map in Dec"   },
        { "double",     "otf_grid_scale",       " Magnification scale of plot"  },
        { "double",     "otf_gamma",    " Map Gamma correction" },
        { "double",     "otf_size_factor",      " Scale factor for Automatic OTF Map creation"  },
        { "double",     "otf_delay",    " Delay used for velocity movie"        },
        { "double",     "otf_3d_vrange",        " Scaling factor for Vel Range: nominally 1.0"  },
        { "double",     "otf_3d_urms",  " Max rms allowed in 3d Cube output"    },
        { "double",     "otf_map_velocity",     " Velocity of OTF Map"  },
        { "double",     "otf_map_restfreq",     " Rest Freq of OTF Map" },
        { "double",     "otf_map_freqres",      " Backend Resolution of OTF Map"        },
        { "double",     "otf_zrange_factor",    " The factor to multiply the z-axis by if non-zero"     },
        { "double",     "otf_beam_ra",  " Where to place the beam-size circle on the map"       },
        { "double",     "otf_beam_dec", "  "    },
        { "double",     "otf_spare_doubles[22]", "  "   },
        { "double",     "paperw",       " Width of plot window 0 == normal 800 pixels"  },
        { "double",     "paperh",       " Height of plot window 0 == normal 600 pixels" },
        { "double",     "ptime",        " Time of day used in the 'planets' program 0.0 - 23.99"        },
        { "double",     "p2p",  " Computed Peak to Peak"        },
        { "double",     "rejections[MAX_BEAMS]",        " Currently receiver rejections"        },
        { "double",     "rms",  " Last rms value over the baseline region"      },
        { "double",     "rst",  " Results of the latest calculation"    },
        { "double",     "saturn_tmb",   " Saturn Temperature-Main-Beam" },
        { "double",     "slope",        " Last slope from the baseline operation"       },
        { "double",     "spares[5]",    " Used to be User input elevation SMT gain curve terms" },
        { "double",     "stackscan",    " Current scan pointed to by stack pointer"     },
        { "double",     "tcallimit",    " Tcal Upper limit for Spectral/Cont accum."    },
        { "double",     "tcur",         " Last mouse click temperature" },
        { "double",     "theta_mb",     " Manual Theta Main Beam in arcsecs >0.0 overrides computed value"      },
        { "double",     "totalweight",  " Weighted average of accumulations"    },
        { "double",     "trms",         " Theoretical RMS"      },
        { "double",     "tsyslimit",    " Tsys Upper limit for Spectral/Cont accum."    },
        { "double",     "uranus_tmb",   " Uranus Temperature-Main-Beam" },
        { "double",     "vcur",         " Last mouse click velocity"    },
        { "double",     "venus_tmb",    " Venus Temperature-Main-Beam"  },
        { "double",     "xplotmin",     " Xgraphics Computed X-Plot Range Min"  },
        { "double",     "xplotmax",     " Xgraphics Computed X-Plot Range Max"  },
        { "double",     "yplotmin",     " Xgraphics Computed Y-Plot Range Min"  },
        { "double",     "yplotmax",     " Xgraphics Computed Y-Plot Range Max"  },
        { "double",     "ylower",       " User set lower y scale for plotting"  },
        { "double",     "yupper",       " User set upper y scale for plotting"  },
        { "double",     "fs",   " Freq-switch Signal Offset"    },
        { "double",     "fr",   " Freq-switch Referance Offset" },
        { "double",     "gmap_zmin",    " Z-Axis plotting min used if either is non-zero"       },
        { "double",     "gmap_zmax",    " Z-Axis plotting max used if either is non-zero"       },
        { "double",     "gmap_gamma",   " Grid map Gamma Applied if non-zero"   },
        { "double",     "dish_size",    " User defined dish_size and sub-reflector taper dB's"  },
        { "double",     "taper",        " Used if value > 0.0"  },
        { "double",     "focus_lower_limit",    " If non-zero, Focus Tmb must be higher than this to qualify as good"   },
        { "double",     "focus_cnterr_limit",   " If non-zero, Gaussian Center Error must be less than this to qualify as good" },
        { "double",     "focus_freq_upper",     " If non-zero, then limit focus fit to these limits use with 'freq *'"  },
        { "double",     "focus_freq_lower",     " If non-zero, then limit focus fit to these limits use with 'freq *'"  },
        { "double",     "focus_center_diff",    " If non-zero, focus fit must be no more that this amount different then input" },
        { "double",     "nyquist",      " Nyquist sample size based on rest freq"       },
        { "double",     "spare_doubles[51]", "  "       },
};
#define MAX_NGS_HELP 241


int fetchNGSHelp(name, buf)
char *name, *buf;
{
  int i;

  for(i=0;i<MAX_NGS_HELP;i++)
  {
    if(!strncmp(ngs_help[i].variable, name, strlen(name)))
    {
      strcpy(buf, ngs_help[i].help);
      return(0);
    }
  }

  strcpy(buf, "   ");

  return(1);
}


#endif