Alphabetical list of PyNGL resources

nglAppResFileName

If set, this specifies the resource file name that PyNGL will look for (actually that name with a ".res" appended). If not set, then the resource file name defaults to the name specified as the second argument to an Ngl.open_wks call (again with a ".res" appended). Setting this resource allows you to use the same resource file name for different workstations in the same script, or for different workstations in different scripts, while being able to produce output files using the name supplied as the second argument to the Ngl.open_wks call. For complete details on naming resource files and the path search algorithm, see the section Where to put resource files in the Selected topics chapter. For complete details on resource files, see the Resource files section of the Selected topics chapter.

Default: "" (empty string)

nglDraw

If set to False, then the plot in question will not be drawn when the plotting function is called. See also nglFrame.

Default: True

nglFrame

If set to False, then the frame will not be advanced when the plotting function is called. See also nglDraw.

Default: True

nglMaximize

If set to True (the default), then the plot drawn will be maximized in the workstation on which it is being drawn. For an X11 window or an NCGM file, this means the plot will be expanded to fill the biggest possible space within a square, with a small margin around all edges. The aspect ratio will be preserved. For a PostScript or PDF file, the plot will be expanded to fill the biggest possible space on an 8 1/2" x 11" sheet of paper. You can change the default orientation with the resource nglPaperOrientation.

Note: if you are setting the vpWidthF or vpHeightF resources, then you should set nglMaximize to False, as this resource will cause these two resource values to be recalculated.

Default: True

nglPanelBottom

By default, the Ngl.panel routine places all of the plots in the largest area possible in the viewport. This resource, which must be a value greater than or equal to 0.0 and less than 1.0, allows you to set a limit for where the bottommost plot(s) can be drawn. This allows you to reserve white space at the bottom for something like a labelbar. See also the other nglPanel* resources.

Default: 0.0

nglPanelCenter

By default, the Ngl.panel routine centers all of the plots that it is paneling. If there are not enough plots to fill up the requested number of rows and columns, then it will center the remaining plots in the last row. If you set this resource to False, then the remaining plots will be left-justified.

Default: True

nglPanelFigureStrings

If you set this special resource to a list of strings, these strings will be used as figure strings in the lower right hand corner of each paneled plot. You can set the special resource nglPanelFigureStringsJust to change the location of the figure strings. ("TopRight", "TopLeft", "BottomLeft" or "BottomRight" are the choices.)

Default: None

nglPanelFigureStringsBackgroundFillColor

The color index to use for the backgound color for label boxes in panel plots.

Default: 0

nglPanelFigureStringsFontHeightF

If you set nglPanelFigureStrings in a call to Ngl.panel, then this resource allows you to control the font height of the figure strings. If you don't set this resource, then the font height is calculated internally based on a number of factors.

Default: dynamic

nglPanelFigureStringsJust

Used to justify the individual plot labels when nglPanelFigureStrings is True. The legal values are: "TopRight", "TopLeft", "BottomLeft" or "BottomRight".

Default: "BottomRight"

nglPanelFigureStringsOrthogonalPosF

Used to make minor adjustments to the labels in panel plots in a direction orthogonal to the text string. The units are in NDC space.

Default: 0.0

nglPanelFigureStringsParallelPosF

Used to make minor adjustments to the labels in panel plots in a direction parallel to the text string. The units are in NDC space.

Default: 0.0

nglPanelFigureStringsPerimOn

Determines if a perimeter is drawn around the labels for plots in a panel plot.

Default: True

nglPanelLabelBar

If you set this resource to True, then a single labelbar will be generated for all the plots on the page when Ngl.panel is called. The default is to draw the labelbar on the bottom, unless "lbOrientation" is set to the string "Vertical" or the integer 1. Note: using this resource assumes that all of your plots have the same labelbar.

Default: False

nglPanelLabelBarHeightF

This specifies the height of the label bar when nglPanelLabelBar is set to True. A nominal default height is chosen if a value for nglPanelLabelBarHeightF is not specified. Values for this resource are specified in NDC space.

Default: -999.

nglPanelLabelBarLabelAutoStride

When this resource is set True (the default), LabelBar labels are checked for overlap before being drawn. If overlap would otherwise occur, a stride is set through the labels such that overlap will be avoided. The stride proceeds in both directions from a pivot label, chosen based on how "round" it is relative to the other labels. If the labels seem to be equally "round" or if the labels are non-numeric, then the shortest label is chosen as the pivot.

If lbLabelAlignment is set to ExternalEdges, the behavior is a bit different. In this case, the stride is set as described above, but the labels at each end are guaranteed to appear. This may cause labels that would otherwise be part of the stride sequence to be eliminated. This behavior is useful when the end labels are used to show the extreme values of a dataset.

Default: True

nglPanelLabelBarLabelFontHeightF

If set, specifies the height of the labelbar font used when nglPanelLabelBar is set to True. This value is calculated internally if not specified by the user.

Default: -999.

nglPanelLabelBarOrthogonalPosF

This resource can be used to modify the position of a label bar. The values are specified in NDC space. The direction of the positional modification is orthogonal to the long axis of the label bar, i.e. up or down for a horizontal label bar, or left or right for a vertical label bar.

Default: -999.

nglPanelLabelBarParallelPosF

This resource can be used to modify the position of a label bar. The values are specified in NDC space. The direction of the positional modification is parallel to the long axis of the label bar, i.e up or down for a vertical label bar, or left or right for a horizontal label bar.

Default: -999.

nglPanelLabelBarWidthF

This specifies the width of the label bar when nglPanelLabelBar is set to True. A nominal default width is chosen if a value for nglPanelLabelBarWidthF is not specified. Values for this resource are specified in NDC space.

Default: -999.

nglPanelLabelBarXF

Specifies the location of the left edge of the label bar in NDC space. This is calculated internally unless specified by the user.

Default: -999.

nglPanelLabelBarYF

Specifies the location of the top edge of the label bar in NDC space. This is calculated internally unless specified by the user.

Default: -999.

nglPanelLeft

By default, the Ngl.panel routine tries to place all of the plots in the largest area possible in the viewport. This resource, which must be a value greater than or equal to 0.0 and less than 1.0, allows you to set a limit for where the leftmost plot(s) can be drawn. This allows you to reserve white space at the left for something like a labelbar. See also the other nglPanel* resources.

Default: 0.0

nglPanelRight

By default, the Ngl.panel routine tries to place all of the plots in the largest area possible in the viewport. This resource, which must be a value greater than 0.0 and less than or equal to 1.0, allows you to set a limit for where the rightmost plot(s) can be drawn. This allows you to reserve white space at the right for something like a labelbar. See also the other nglPanel* resources.

Default: 1.0

nglPanelRowSpec

Ngl.panel routine panels its plots according to the dims variable which indicates rows x columns. If you set nglPanelRowSpec to True, however, then you can use the dims variable to indicate the number of plots you want per row. For example, setting nglPanelRowSpec to True and dims to [2,3,1] will put 2 plots in the first row, 3 plots in the second row, and 1 plot in the third row.

Default: False

nglPanelTop

By default, the Ngl.panel routine tries to place all of the plots in the largest area possible in the viewport. This resource, which must be a value greater than 0.0 and less than or equal to 1.0, allows you to set a limit for where the topmost plot(s) can be drawn. This allows you to reserve white space at the top for something like a title. See also the other nglPanel* resources.

Default: 1.0

nglPanelXWhiteSpacePercent

Takes a percentage value from 0 to 100 to indicate what percentage of the total plot width should be used for white space at the left and right of each plot in a call to Ngl.panel. See also the other nglPanel* resources.

Default: 1.0

nglPanelYWhiteSpacePercent

Takes a percentage value from 0 to 100 to indicate what percentage of the total plot height should be used for white space at the top and bottom of each plot in a call to Ngl.panel. See also the other nglPanel* resources.

Default: 1.0

nglPaperHeight

This resource specifies the height (in inches) of the paper that you plan to print the PostScript or PDF file on. It is supposed to be used in conjunction with nglMaximize. See also nglPaperMargin, nglPaperWidth, and nglPaperOrientation.

Default: 11.0

nglPaperMargin

This resource specifies the margin (in inches) that you want to leave around the plotting area. It is supposed to be used in conjunction with nglMaximize. See also nglPaperHeight, nglPaperWidth, and nglPaperOrientation.

Default: 0.5

nglPaperOrientation

This resource specifies the orientation of the plot on paper that you plan to print the PostScript or PDF file on. It is only to be used in conjunction with nglMaximize. Valid values are "portrait", "landscape", and "auto". If set to "auto", then PyNGL will figure out the best possible orientation to use for the type of plot being drawn. You cannot change the orientation after you already begin drawing to a frame. This resource will override any setting of wkOrientation.

Default: "auto"

nglPaperWidth

This resource specifies the width (in inches) of the paper that you plan to print the PostScript or PDF file on. It is supposed to be used in conjunction with nglMaximize. See also nglPaperMargin, nglPaperHeight, and nglPaperOrientation.

Default: 8.5

nglPointTickmarksOutward

If set to True, then the major and minor tickmarks on both the X and Y axes will be pointed outwards. Available in version 1.0.0 or later.

Default: False

nglScale

If set to True, then the X and Y axis labels will be scaled to be the same size and the tick marks will be scaled to be the same length. This is useful when the X and Y axis are of different lengths, but you still want the labels and tick marks to be the same for each axis.

Default: True

nglSpreadColorEnd

This resource only takes effect if nglSpreadColors is set to True. It indicates the index of the last color in the color table that should be used for a color contour or vector plot. If this value is negative, then the value indicates the position from the last color in the color table. For example, -1 indicates the last color, -2 indicates the second to the last color, and so on. (The colors go from 0 to ncol-1, where ncol is the number of colors.) See also nglSpreadColorStart.

If nglSpreadColorStart and nglSpreadColorEnd are selected such that the start color is after the end color in the color table, then the colors will be reversed.

Default: -1

nglSpreadColorStart

This resource only takes effect if nglSpreadColors is set to True. It indicates the index of the first color in the color table that should be used for a color contour or vector plot. If this value is negative, then the value indicates the position from the last color in the color table. For example, -1 indicates the last color, -2 indicates the second to the last color, and so on. (The colors go from 0 to ncol-1, where ncol is the number of colors.) See also nglSpreadColorEnd.

If nglSpreadColorStart and nglSpreadColorEnd are selected such that the start color is after the end color in the color table, then the colors will be reversed.

Default: 2

nglSpreadColors

If set to True, and you are drawing a colored contour or vector plot, then the colors used will be spread across the whole color map. If false, then there is a one-to-one matching between the color indices in the current color table and the colors between contour levels. See also nglSpreadColorStart and nglSpreadColorEnd.

Default: True

nglXAxisType

If set, this resource allows you to convert an irregular X axis to a linear or log axis. It works in conjunction with the setting of one of the scalar or vector field resources (sfXArray and vfXArray), since setting these resources automatically causes the X axis to tagged as an irregular axis (even if the values themselves are linear). Valid values are "IrregularAxis", "LinearAxis" and "LogAxis." Using a value of "IrregularAxis" will effectively cause no action to take place on the X axis.

Default: "IrregularAxis"

nglXRefLine

If set, this resource will cause a vertical reference line to be drawn at the given X value (only for calls to Ngl.xy or Ngl.y). Available in version 1.2.0 or later.

Default: -999.

nglXRefLineColor

If nglXRefLine is set, this resource allows you to change its line color. Available in version 1.2.0 or later.

Default: 1 (foreground color)

nglXRefLineThicknessF

If nglXRefLine is set, this resource allows you to change its line thickness. Available in version 1.2.0 or later.

Default: 1.

nglYAxisType

If set, this resource allows you to convert an irregular Y axis to a linear or log axis. It works in conjunction with the setting of one of the scalar or vector field resources (sfYArray and vfYArray), since setting these resources automatically causes the Y axis to tagged as an irregular axis (even if the values themselves are linear). Valid values are "IrregularAxis", "LinearAxis" and "LogAxis." Using a value of "IrregularAxis" will effectively cause no action to take place on the Y axis.

Default: "IrregularAxis"

nglYRefLine

If set, this resource will cause a horizontal reference line to be drawn at the given Y value (only for calls to Ngl.xy or Ngl.y). Available in version 1.2.0 or later.

Default: -999.

nglYRefLineColor

If nglYRefLine is set, this resource allows you to change its line color. Available in version 1.2.0 or later.

Default: 1 (foreground color)

nglYRefLineThicknessF

If nglYRefLine is set, this resource allows you to change its line thickness. Available in version 1.2.0 or later.

Default: 1.

sktCape

This is an old resource name. Use sktParcelPathLineOn instead.

sktColoredBandsOn

Controls whether filled green bands are drawn between alternating isothermal line pairs. This resource is unique to Ngl.skewt_bkg.

Default: False

sktDewPointLineColor

Specifies the color of the dewpoint sounding. This resource is unique to Ngl.skewt_plt.

Default: "RoyalBlue"

sktDewPointMissingV

Sets the missing value for dew point temperature values in the TDC argument. This resource is unique to Ngl.skewt_plt.

Default: -999.

sktDrawColAreaFill

This is an old resource name. Use sktColoredBandsOn instead.

sktDrawColLine

This is an old resource name. Use sktUseMultipleLineColors instead.

sktDrawDryAdiabat

This is an old resource name. Use sktDryAdiabaticLinesOn instead.

sktDrawFahrenheit

This is an old resource name. Use sktTemperatureUnits instead.

sktDrawHeightScale

This is an old resource name. Use sktHeightScaleOn instead.

sktDrawHeightScaleFt

This is an old resource name. Use sktHeightScaleUnits instead.

sktDrawIsobar

This is an old resource name. Use sktIsobarLinesOn instead.

sktDrawIsotherm

This is an old resource name. Use sktIsothermalLinesOn instead.

sktDrawMixRatio

This is an old resource name. Use sktMixingRatioLinesOn instead.

sktDrawMoistAdiabat

This is an old resource name. Use sktMoistAdiabaticLinesOn instead.

sktDrawStandardAtm

This is an old resource name. Use sktStdAtmosphereLineOn instead.

sktDrawStandardAtmThk

This is an old resource name. Use sktStdAtmosphereLineThicknessF instead.

sktDrawWind

This is an old resource name. Use sktWindBarbLineOn instead.

sktDryAdiabaticLinesOn

Controls whether dry adiabatic lapse rate lines are drawn. This resource is unique to Ngl.skewt_bkg.

Default: True

sktGeopotentialLabelColor

The text color for the geopotential (Z) string when the resource sktGeopotentialLabelsOn is True.

Default: "Foreground"

sktGeopotentialLabelsOn

Prints geopotential (Z) on the plot if True. This resource is unique to Ngl.skewt_plt.

Default: True

sktGeopotentialMissingV

Sets the missing value for geopotential values in the Z argument. This resource is unique to Ngl.skewt_plt.

Default: -999.

sktGeopotentialWindBarbColor

Specifies the color of wind barbs where wind speeds and directions are given at coordinates where pressures are missing, but geopotential values do exist. The geopotential values are interpolated to pressure values and those values are used for plotting the wind barbs. This resource is unique to Ngl.skewt_plt.

Default: "Blue"

sktHdir

This is an old resource name. Use sktHeightWindBarbDirections instead.

sktHeight

This is an old resource name. Use sktHeightWindBarbPositions instead.

sktHeightScaleOn

Controls whether a reference height scale is drawn on the right of the chart that corresponding to the standard atmosphere heights associated with the pressure values on the left of the chart. This resource is unique to Ngl.skewt_bkg.

The old resource name was sktDrawHeightScale.

Default: False

sktHeightScaleUnits

Controls whether the labels on the height scale are in feet (the default) or kilometers ("km"). This resource is unique to Ngl.skewt_bkg.

Default: "feet"

sktHeightWindBarbColor

Specifies the color of the wind barbs at height levels when sktHeightWindBarbsOn is set to True. This resource is unique to Ngl.skewt_plt.

Default: "OrangeRed3"

sktHeightWindBarbComponents

Controls how wind speed and direction are calculated for wind barbs specified using sktHeightWindBarbSpeeds and sktHeightWindBarbDirections. If set to "SpeedDirection" (the default), then sktHeightWindBarbSpeeds and sktHeightWindBarbDirections are assumed to specify the speed and direction of the wind barb; in this case the direction should be in degrees clockwise from north. If sktHeightWindBarbComponents is set to "UV", then sktHeightWindBarbSpeeds and sktHeightWindBarbDirections specify the u and v components, respectively, for the wind barbs. This resource is unique to Ngl.skewt_plt

Default: "SpeedDirection"

sktHeightWindBarbDirections

Specifies the wind directions for wind barbs when sktHeightWindBarbComponents is set to "SpeedDirection", or specifies the v components of wind barbs when sktHeightWindBarbComponents is set to "UV". This resource is unique to Ngl.skewt_plt

Default: N/A

sktHeightWindBarbPositionMissingV

Sets the missing value for values specified with the sktHeightWindBarbPositionsk resource. Either set all sktHeightWindBarbPositions values to missing, or none - otherwise you will get wind barbs positioned at odd places where the height values are missing, since skewt_plt interpolates pressures to geopotential values at the heights without regard to potential missing height values. This resource is unique to Ngl.skewt_plt.

Default: -999.

sktHeightWindBarbPositions

Specifies the heights of wind reports to be plotted when sktHeightWindBarbsOn is set to True. Wind barbs will be plotted at the indicated heights. For an example, see skewt2.py. This resource is unique to Ngl.skewt_plt

Default: N/A

sktHeightWindBarbSpeeds

Specifies the wind speeds for wind barbs when sktHeightWindBarbComponents is set to "SpeedDirection", or specifies the u components of wind barbs when sktHeightWindBarbComponents is set to "UV". This resource is unique to Ngl.skewt_plt

Default: N/A

sktHeightWindBarbsOn

Controls plotting of wind barbs at specified heights. For example, specifying values for resources sktHeightWindBarbPositions, sktHeightWindBarbSpeeds, sktHeightWindBarbDirections, and setting sktHeightWindBarbsOn to True would plot the wind barbs in accordance with the resource values. For an example, see skewt2.py. This resource is unique to Ngl.skewt_plt.

Default: False

sktHmissingV

This is an old resource name. Use sktHeightWindBarbPositionMissingV instead.

sktHspd

This is an old resource name. Use sktHeightWindBarbSpeeds instead.

sktHspdHdir

This is an old resource name. Use sktHeightWindBarbComponents instead.

sktIsobarLinesOn

Controls whether horizontal isobar (pressure) lines are drawn. This resource is unique to Ngl.skewt_bkg.

Default: True

sktIsothermalLinesOn

Controls whether diagonal isothermal (temperature) lines are drawn. This resource is unique to Ngl.skewt_bkg.

Default: True

sktMixingRatioLinesOn

Controls whether mixing ration lines and labels are drawn. This resource is unique to Ngl.skewt_bkg.

Default: True

sktMoistAdiabaticLinesOn

Controls whether the moist (or saturated) adiabatic lines and labels are drawn. This resource is unique to Ngl.skewt_bkg.

Default: True

sktParcel

This is an old resource name. Use sktParcelPathStartCoordinate instead.

sktParcelPathLineColor

Specifies the color of the parcel path line, plotted only when cape > 0 and sktParcelPathLineOn is set to True. This resource is unique to Ngl.skewt_plt.

Default: "Red"

sktParcelPathLineOn

Controls whether the CAPE (Convective Available Potential Energy) is plotted when cape > 0. This resource is unique to Ngl.skewt_plt.

Default: True

sktParcelPathStartCoordinate

Specifies the start coordinate of the parcel sounding path. See This resource is unique to Ngl.skewt_plt.

Default: 0 (surface)

sktPlotWindH

This is an old resource name. Use sktHeightWindBarbsOn instead.

sktPlotWindP

This is an old resource name. Use sktPressureWindBarbsOn instead.

sktPmissingV

This is an old resource name. Use sktPressureMissingV instead.

sktPressureMissingV

Sets the missing value for pressure values in the P argument. This resource is unique to Ngl.skewt_plt.

Default: -999.

sktPressureWindBarbColor

Specifies the color of the wind barbs at the pressure labels when sktPressureWindBarbsOn is set to True. This resource is unique to Ngl.skewt_plt.

Default: "Black"

sktPressureWindBarbComponents

Controls how wind speed and direction are calculated for wind barbs specified using the WSPD and WDIR arguments in Ngl.skewt_plt. If set to "SpeedDirection" (the default), then WSPD and WDIR are assumed to specify the speed and direction of the wind barb; in this case the direction should be in degrees clockwise from north. If set to "UV", then WSPD and WDIR specify the u and v components, respectively, for the wind barbs. This resource is unique to Ngl.skewt_plt.

Default: "SpeedDirection"

sktPressureWindBarbStride

Used to thin the number of wind barbs plotted at pressure values (see sktPressureWindBarbsOn; sktPressureWindBarbStride specifies a stride). For example, setting sktPressureWindBarbStride to 3 would cause the plotting of every third wind barb. This resource is unique to Ngl.skewt_plt.

Default: 1

sktPressureWindBarbsOn

Controls whether wind barbs are plotted at pressure levels. This resource is unique to Ngl.skewt_plt.

Default: True

sktPrintZ

This is an old resource name. Use sktGeopotentialLabelsOn instead.

sktStdAtmosphereLineOn

Controls whether a standard atmosphere line is drawn. This resource is unique to Ngl.skewt_bkg.

Default: True

sktStdAtmosphereLineThicknessF

Specifies a scale factor for the thickness of the standard atmosphere line. This resource is unique to Ngl.skewt_bkg.

Default: 2.0

sktTCmissingV

This is an old resource name. Use sktTemperatureMissingV instead.

sktTDCmissingV

This is an old resource name. Use sktDewPointMissingV instead.

sktTemperatureMissingV

Sets the missing value for temperature values in the TC argument. This resource is unique to Ngl.skewt_plt.

Default: -999.

sktTemperatureSoundingLineColor

Specifies the color of the temperature sounding. This resource is unique to Ngl.skewt_plt.

Default: "Foreground"

sktTemperatureUnits

Controls whether the temperature labels along the X-axis are in Fahrenheit (the default) or celsius (centigrade). This resource is unique to Ngl.skewt_bkg.

Default: "fahrenheit"

sktThermoInfo

This is an old resource name. Use sktThermoInfoLabelOn instead.

sktThermoInfoLabelColor

Specifies the color of the information label drawn when sktThermoInfoLabelOn is set to True. This resource is unique to Ngl.skewt_plt.

Default: "Goldenrod4"

sktThermoInfoLabelOn

If True, plots values for Plcl, Tlcl, Shox, Pwat, and Cape at the top of the plot, below the main title. Definitions:

Plcl

Lifting Condensation Level [mb, hPa].

Tlcl

Temperature at the LCL.

Shox

Showalter Index

Pwat

Total Precipitable Water [cm].

Cape

Convective Available Potential Energy [Joules].

Default: True