FDF.README S.Drake/COMET 11/96 S.Drake/COMET 1/97 Updated for 1.0.3 P.Bruehl/NWS 1/97 Updated for 1.0.3 P.Bruehl/NWS 4/97 Updated for 1.0.4 Field Description Files (FDF) comprise a list of key/value pairs. These key value pairs are used to build GEMPAK variables and to pass information to the Graphical User Interface (GUI). The user can create and/or modify existing FDFs to customize the appearance of each field that is plotted. FDFs must reside in a directory pointed to in the file "Garp_defaults". There is a root directory for scalar and vector fields for plan view, cross section, time/height sections and vertical profiles. Sub- directories of these root directories should be created to subdivide the FDFs according to how you want to organize them. For example, you could create a subdirectory for plan view scalar fields called "Convective" for convection related FDFs. Note, each additional group must be listed in the $GARPHOME/config/Garp_defaults file in the xxxChapter keys (ScalarChapter, VectorChapter, etc.). Each FDF contains a short list of required parameters followed by a list of parameters which may be changed to customize the appearance of a given field. Following is a description of these parameters. Along with the parameter name is a code for the projection it is relevant for, valid values and in some cases the GEMPAK variable to which it applies. For GEMPAK related variables you can access GEMPAK help files for more complete documentation. MPV = Model Plan View MXS = Model Cross Section MTH = Model Time/Height Section MVP = Model Vertical Profile *** Required Parameters *** type: MPV, MXS, MTH, MVP scalar, vector This parameter defines whether you are plotting a scalar or vector field. Since the FDF location in either the scalar or vector directory is used to determine it's type, this value is used only for internal documentation purposes. --- layer: MPV y, n This parameter defines whether the field is valid at a single level in the atmosphere or over layer. If it is valid only for a single level, the level2 button will be desensitized. Some products such as relative humidity may valid both at a single level and for a layer. For this kind of product, you can click on the "Layer" radio button to sensitize the level2 button. Then you can choose the layer you are interested in looking at using both the level1 and level2 buttons. You can click on the "Info" button if you need information on valid layers for a given product. --- function: MPV, MXS, MTH, MVP ( none ) The function parameter is the GEMPAK string which defines a GEMPAK field or function. For example, it is comparable to the GFUNC parameter in the GEMPAK routine GDCNTR. --- description: MPV, MXS, MTH, MVP ( none ) This is a simple description of the field you are going to display. --- *** End of Required Parameters *** *** Significant Parameters *** label: MPV, MXS, MTH, MVP ( none ) When the user clicks on an FDF in a dialog the file name for that FDF appears as a label above the function text field. Using this parameter the user can define a label which will appear other than the FDF name. --- vcoord: MPV, MXS, MTH, MVP ( model dependent ) GVCORD This key defines the vertical coordinate. Valid vertical coordinates are given by 4 letter strings defined within GEMPAK. Garp does not interpolate between vertical coordinates so you must use a vertical coordinate which is valid for a given model. --- level1: MPV, MXS, MTH, MVP ( model, vertical coordinate dependent ) GLEVEL For single level fields this parameter defines the level at which the current field will be plotted. For layered fields, this parameter defines the lower level. When you click on the level1 button you will get a list of vertical levels for the current vertical coordinate. The vertical levels at which layered fields are defined may be different from those given in this dialog. To double check which levels are valid to define layered fields click on the "Info" button and look at a grid file for this model. For vertical projections this will be the lowest level of the plot. --- level2: MPV, MXS, MTH, MVP ( model, vertical coordinate dependent ) GLEVEL This parameter defines a second level for layered fields. For vertical projections this will be the top level of the plot. --- contour: MPV, MXS ( y, n ) This is a boolean parameter which signals whether or not you want to plot contour lines or, for vector fields, the vector. fill: MPV, MXS ( scalar fields ) ( y, n ) This is a boolean parameter which signals whether or not you want to color fill the displayed field. --- hilo: MPV ( scalar fields ) ( y, n ) This is a boolean parameter which signals whether or not you want to plot high/low symbols. --- pres: MPV, MXS, MTH, MVP ( none ) This parameter comprises a semicolon separated list of pressure levels. These levels will be used to define the contour interval, minimum and maximum which will be used depending on the value of level1. The length of this list should be one less than that given for contour increments. For example, if pres = 1000;500;250 and cint = 10;20;30;40 then a contour interval of 10 will be used below 1000mb; a contour interval of 20 will be used between 1000mb and 500mb; a contour interval of 30 will be used between 500mb and 250mb; and a contour interval of 40 will be used above 250mb. --- pres_cint: MPV, MXS, MTH, MVP ( none ) CINT This parameter can be either monovalued or a list of contour intervals. If it is a list it should be one value more than the "pres" parameter. --- pres_cmin: MPV, MXS, MTH, MVP ( none ) CINT This parameter describes a contour minimum value. It's usage is the same as for pres_cint. --- pres_cmax: MPV, MXS, MTH, MVP ( none ) CINT This parameter describes a contour maximum value. It's usage is the same as for pres_cint. --- pres_fint: MPV, MXS ( none ) FINT This parameter describes a color contour interval value. It's usage is the same as for pres_cint. --- pres_fmin: MPV, MXS ( none ) FINT This parameter describes a color contour minimum value. It's usage is the same as for pres_cint. --- pres_fmax: MPV, MXS ( none ) FINT This parameter describes a color contour maximum value. It's usage is the same as for pres_cint. --- ! Sigma levels sgma: sgma_cint: sgma_cmin: sgma_cmax: sgma_fint: sgma_fmin: sgma_fmax: ! Isentropes thta: thta_cint: thta_cmin: thta_cmax: thta_fint: thta_fmin: thta_fmax: ! Geopotential Height hght: hght_cint: hght_cmin: hght_cmax: hght_fint: hght_fmin: hght_fmax: ! No coordinates (surface) none: none_cint none_cmin none_cmax none_fint none_fmin none_fmax ! Freezing Level frzl frzl_cint frzl_cmin frzl_cmax frzl_fint frzl_fmin frzl_fmax ! Tropopause Level trop trop_cint trop_cmin trop_cmax trop_fint trop_fmin trop_fmax ! Maxmum Wind Speed Level mwsl mwsl_cint mwsl_cmin mwsl_cmax mwsl_fint mwsl_fmin mwsl_fmax ! Height above ground Level hagl hagl_cint hagl_cmin hagl_cmax hagl_fint hagl_fmin hagl_fmax ! Hybrid Level hybl hybl_cint hybl_cmin hybl_cmax hybl_fint hybl_fmin hybl_fmax ! Pressure above ground level pagl pagl_cint pagl_cmin pagl_cmax pagl_fint pagl_fmin pagl_fmax ! Eta levels eta eta_cint eta_cmin eta_cmax eta_fint eta_fmin eta_fmax ! Entire Atmosphere as a layer eatm eatm_cint eatm_cmin eatm_cmax eatm_fint eatm_fmin eatm_fmax ! Depth below sea level dpth dpth_cint dpth_cmin dpth_cmax dpth_fint dpth_fmin dpth_fmax ! Low Cloud Layer lcly lcly_cint lcly_cmin lcly_cmax lcly_fint lcly_fmin lcly_fmax ! Middle Cloud Layer mcly mcly_cint mcly_cmin mcly_cmax mcly_fint mcly_fmin mcly_fmax ! High Cloud Layer hcly hcly_cint hcly_cmin hcly_cmax hcly_fint hcly_fmin hcly_fmax --- line_color: MPV, MXS, MTH, MVP ( none ) LINE This parameter defines a contour line or vector color using a GEMPAK color number. --- line_type: MPV, MXS, MTH, MVP ( none ) LINE This parameter defines a contour line type. --- line_width: MPV, MXS, MTH, MVP ( none ) LINE This parameter defines a contour line width. --- line_label_frequency: MPV, MXS, MTH, MVP ( none ) LINE This parameter defines a contour label frequency. --- scale: MPV, MXS, MTH, MVP ( none ) SCALE This parameter defines a multiplier of 10**(scale) by which to multiply the grid. An advantage of using it is to insure all the plots in an animation have the same scale factor. The disadvantage is that a given scale factor may not be consistently germane. --- colorh: MPV ( none ) HILO This defines the color of a high symbol. --- colorl: MPV ( none ) HILO This defines the color of a low symbol. --- symbolh: MPV ( none ) HILO This parameter defines the high symbol. --- symboll: MPV ( none ) HILO This parameter defines the low symbol. --- rangeh: MPV ( none ) HILO This parameter defines the value range for the high symbol. --- rangel: MPV ( none ) HILO This parameter defines the value range for the low symbol. --- radius: MPV ( none ) HILO This parameter defines the search radius. --- counth: MPV ( none ) HILO This parameter defines the maximum number of high to be plotted. Note the following information from GEMPAK: It is common for HILO symbols near the edge of the display to be hidden when hardware text font is used. Therefore, when using hardware text font, the number of HILO symbols displayed may be slightly less than what the user specifies. --- countl: MPV ( none ) HILO This parameter defines the maximum number of lows to be plotted. --- interp: MPV ( none ) HILO This parameter defines an interpolation flag which specifies whether the values and locations of the highs and lows will be at grid points, or will be interpolated between grid points. The default is NO. --- sizes: MPV ( none ) HLSYM Symbol text size. --- sizev: MPV ( none ) HLSYM Value text size. --- position: MPV ( none ) HLSYM Plot value at this position. --- fonts: MPV ( none ) HLSYM Symbol text font. --- fontv: MPV ( none ) HLSYM Value text font. --- widths: MPV ( none ) HLSYM Symbol text font width. --- widthv: MPV ( none ) HLSYM Value text font width. --- hwflgs: MPV ( none ) HLSYM Symbol hardware/software flag. --- hwflgv: MPV ( none ) HLSYM Value hardware/software flag. --- colorbar: MPV, MXS ( none ) CLRBAR Label and the bounding box color. --- colorbar_orientation: MPV, MXS ( none ) CLRBAR Colorbar orientation. --- colorbar_anchor: MPV, MXS ( none ) CLRBAR Colorbar anchor. --- colorbar_x: MPV, MXS ( none ) CLRBAR Colorbar x anchor position. --- colorbar_y: MPV, MXS ( none ) CLRBAR Colorbar y anchor position. --- colorbar_length: MPV, MXS ( none ) CLRBAR Colorbar length. --- colorbar_width: MPV, MXS ( none ) CLRBAR Colorbar width. --- colorbar_frequency: MPV, MXS ( none ) CLRBAR Colorbar label frequency. --- subbox: MPV, MXS ( none ) CONTUR Contouring subbox factor. --- smoothing: MPV, MXS ( none ) CONTUR Number of smoothing passes. --- text_size: MPV, MXS, MTH, MVP text_font: MPV, MXS, MTH, MVP text_width: MPV, MXS, MTH, MVP text_hw_flag: MPV, MXS, MTH, MVP --- fline: MPV, MXS ( none ) FLINE Color fill list. --- skip_contour: MPV ( none ) SKIP Thinning value. --- skip_plot_x: MPV ( none ) SKIP X point for data display. --- skip_plot_y: MPV ( none ) SKIP Y point for data display. --- ptype_axis: MXS, MTH, MVP ( none ) PTYPE Type of vertical axis. --- ptype_left: MXS, MTH, MVP ( none ) PTYPE Left margin of plot. --- ptype_bottom: MXS, MTH, MVP ( none ) PTYPE Bottom margin of plot. --- ptype_right: MXS, MTH, MVP ( none ) PTYPE Right margin of plot. --- ptype_top: MXS, MTH, MVP ( none ) PTYPE Top margin of plot. --- xaxis_lower: MVP ( none ) XAXIS Lower bound of horizontal axis. --- xaxis_upper: MVP ( none ) XAXIS Upper bound of horizontal axis. --- xaxis_increment: MVP ( none ) XAXIS Increment of horizontal axis. --- xaxis_lbfq: MVP ( none ) XAXIS Label frequency of horizontal axis. --- xaxis_gdfq: MVP ( none ) XAXIS Grid line frequency of horizontal axis. --- xaxis_tkfq: MVP ( none ) XAXIS Tick frequency of horizontal axis. --- yaxis_lower: Not implemented ( none ) YAXIS Lower bound of vertical axis. --- yaxis_upper: Not implemented ( none ) YAXIS Upper bound of vertical axis. --- yaxis_increment: Not implemented ( none ) YAXIS Increment of vertical axis. --- yaxis_lbfq: Not implemented ( none ) YAXIS Label frequency of vertical axis. --- yaxis_gdfq: Not implemented ( none ) YAXIS Grid line frequency of vertical axis. --- yaxis_tkfq: Not implemented ( none ) YAXIS Tick frequency of vertical axis. --- wind_symbol: MPV, MXS, MTH, MPV ( vector fields ) ( none ) WIND Wind symbol. --- wind_symbol_size: MPV, MXS, MTH, MPV ( vector fields ) ( none ) WIND Wind symbol size. --- wind_symbol_width: MPV, MXS, MTH, MPV ( vector fields ) ( none ) WIND Wind symbol width. --- wind_symbol_type: MPV, MXS, MTH, MPV ( vector fields ) ( none ) WIND Wind symbol plot type. --- wind_symbol_headsize: MPV, MXS, MTH, MPV ( vector fields ) ( none ) WIND Wind symbol headsize. --- refvec_mag: MPV, MTH ( vector fields ) ( none ) REFVEC Unit length of reference vector. --- refvec_x: MPV, MTH ( vector fields ) ( none ) REFVEC Reference vector x position. --- refvec_y: MPV, MTH ( vector fields ) ( none ) REFVEC Reference vector y position. --- refvec_textsize: MPV, MTH ( vector fields ) ( none ) REFVEC Reference vector text size. --- refvec_font: MPV, MTH ( vector fields ) ( none ) REFVEC Reference vector font. --- refvec_width: MPV, MTH ( vector fields ) ( none ) REFVEC Reference vector width. --- refvec_hw_flag: MPV, MTH ( vector fields ) ( none ) REFVEC Reference vector hardware flag. --- refvec_label: MPV, MTH ( vector fields ) ( none ) REFVEC Reference vector label. --- taxis_dir: MTH ( R ) TAXIS Direction of time axis. --- taxis_start: MTH ( none ) TAXIS Start time for time axis. --- taxis_stop: MTH ( none ) TAXIS End time for time axis. --- taxis_inc: MTH ( none ) TAXIS Time increment in hours and minutes. --- taxis_lb: MTH ( none ) TAXIS Time axis label frequency. --- taxis_gl: MTH ( none ) TAXIS Time axis grid line frequency. --- taxis_tm: MTH ( none ) TAXIS Time axis tick mark frequency. ---