Listing of PyNGL Functions by Category

Alphabetical listing | Browsable listing

Visualization:
Graphics routines
Color
Object manipulation
Workstation
General PyNGL routines:
Array creation
Array manipulators
Array query
General applied math
Interpolation
Miscellaneous
System
Earth Science:
CCSM
Lat/lon manipulators
Input/output:
File input/output

Array creators

Ngl.fspan Creates an array of evenly-spaced floating point numbers.
Ngl.generate_2d_array Generates smooth 2D arrays primarily for use in examples.

Array manipulators

Ngl.add_new_coord_limits Adds new minimum/maximum values to X and/or Y coordinate arrays.

Array query

Ngl.dim_gbits Unpacks bit chunks from the rightmost dimension of the input array.
Ngl.get_float Retrieves the value of a resource that uses a float scalar.
Ngl.get_float_array Retrieves the value of a resource that uses a one-dimensional float array.
Ngl.get_integer Retrieves the value of a resource that uses an integer scalar.
Ngl.get_integer_array Retrieves the value of a resource that uses a one-dimensional integer array.
Ngl.get_MDfloat_array Retrieves the value of a resource that uses a multi-dimensional float array.
Ngl.get_MDinteger_array Retrieves the value of a resource that uses a multi-dimensional integer array.
Ngl.get_string Retrieves the value of a resource that uses a string.
Ngl.get_string_array Retrieves the value of a resource that uses a one-dimensional string array.
Ngl.ind Gets the indices of a Python list where the list values are true.

CCSM

Ngl.vinth2p Interpolates CCSM hybrid coordinates to pressure coordinates.

Color routines

Ngl.define_colormap Defines a new color map for the given workstation.
Ngl.draw_colormap Draws the current color map and advances the frame.
Ngl.free_color Removes a color entry from a workstation.
Ngl.get_named_color_index Returns the color index whose associated color on the given workstation is closest to the color name supplied.
Ngl.hlsrgb Converts from the HLS color space to RGB.
Ngl.hsvrgb Converts from the HSV color space to RGB.
Ngl.merge_colormaps Merges two color maps to create a new color map for the given workstation.
Ngl.new_color Adds the given color to the end of the color map of the given workstation.
Ngl.retrieve_colormap Retrieves the current color map associated with the given workstation.
Ngl.rgbhls Converts from the RGB color space to HLS.
Ngl.rgbhsv Converts from the RGB color space to HSV.
Ngl.rgbyiq Converts from the RGB color space to YIQ.
Ngl.set_color Sets a color in the color map of the given workstation.
Ngl.yiqrgb Converts from the YIQ color space to RGB.

File IO

Ngl.asciiread Reads data from an ASCII file.

General applied math

Ngl.betainc Evaluates the incomplete beta function.
Ngl.chiinv Evaluates the inverse chi-squared distribution function.
Ngl.regline Calculates the linear regression coefficient between two series.

Graphics routines

Ngl.add_polygon Adds a polygon to an existing plot.
Ngl.add_polyline Adds a polyline to an existing plot.
Ngl.add_polymarker Adds polymarkers to an existing plot.
Ngl.add_text Adds a text string to an existing plot.
Ngl.blank_plot Creates a blank plot.
Ngl.contour Creates and draws a contour plot.
Ngl.contour_map Creates and draws a contour plot over a map.
Ngl.draw_ndc_grid Draws and labels grid lines at 0.1 NDC intervals.
Ngl.get_bounding_box Retrieves the NDC bounding box values for the given object.
Ngl.labelbar_ndc Draws a labelbar anywhere in the viewport.
Ngl.legend_ndc Draws a legend anywhere in the viewport.
Ngl.map Creates and draws a map.
Ngl.new_dash_pattern Adds new dash patterns to the existing table of dash patterns.
Ngl.new_marker Adds new markers to the existing table of markers.
Ngl.panel Draws multiple plots of identical size on a single frame.
Ngl.polygon Draws a polygon on an existing plot.
Ngl.polygon_ndc Draws a filled polygon on the viewport.
Ngl.polyline Draws a polyline on an existing plot.
Ngl.polyline_ndc Draws a polyline on the viewport.
Ngl.polymarker Draws polymarkers on an existing plot.
Ngl.polymarker_ndc Draws polymarkers on the viewport.
Ngl.skewt_bkg Creates a background chart for Skew T, Log P plotting.
Ngl.skewt_plt Plots soundings and (optionally) winds on Skew T, Log P charts created by Ngl.skewt_bkg.
Ngl.streamline Creates and draws a streamline plot.
Ngl.streamline_map Creates and draws a streamline plot over a map.
Ngl.streamline_scalar Creates and draws a streamline plot with the streamlines colored by a scalar field.
Ngl.streamline_scalar_map Creates and draws streamlines, colored by a scalar field, over a map.
Ngl.text Draws a text string on an existing plot.
Ngl.text_ndc Draws a text string on the viewport.
Ngl.vector Creates and draws a vector plot.
Ngl.vector_map Creates and draws a vector plot over a map.
Ngl.vector_scalar Creates and draws a vector plot with the vectors colored by a scalar field.
Ngl.vector_scalar_map Creates and draws vectors, colored by a scalar field, over a map.
Ngl.wmbarb Draws wind barbs at specified locations.
Ngl.wmbarbmap Draws wind barbs over maps at specified locations.
Ngl.wmgetp Retrieves control parameter values for Ngl.wmxxxx procedures.
Ngl.wmsetp Sets control parameter values for Ngl.wmxxxx procedures.
Ngl.wmstnm Draws station model data.
Ngl.xy Creates and draws an XY plot.
Ngl.y Creates and draws an XY plot using index values for the X axis.

Interpolation

Ngl.ftcurv Calculates an interpolatory spline through a sequence of functional values.
Ngl.ftcurvp Calculates an interpolatory spline under tension through a sequence of functional values for a periodic function.
Ngl.ftcurvpi Calculates an integral of an interpolatory spline between two specified points.
Ngl.linmsg Linearly interpolates to fill in missing values.
Ngl.natgrid Uses a natural neighbor algorithm to interpolate 2-dimensional randomly spaced data.
Ngl.nngetp Retrieves control parameter values for Ngl.natgrid.
Ngl.nnsetp Sets control parameter values for Ngl.natgrid.

Lat/lon manipulators

Ngl.add_cyclic Adds cyclic points to an array.
Ngl.gaus Computes gaussian latitudes and weights.
Ngl.gc_convert Converts degrees along a great circle to radians, meters, feet, or kilometers.
Ngl.gc_dist Calculates the distance in degrees along a great circle between two points.
Ngl.gc_inout Determines if a specified point is inside or outside of a spherical polygon.
Ngl.gc_interp Interpolates points along a great circle between two specified points on the globe.
Ngl.gc_qarea Finds the area of a convex quadrilateral patch on a sphere whose vertices are given in degrees as lat/lon pairs.
Ngl.gc_tarea Finds the area of a triangular patch on a sphere whose vertices are given in degrees as lat/lon pairs.
Ngl.normalize_angle Normalizes any angle in degrees to be in the interval [0.,360.) or [-180.,180.).

Miscellaneous

Ngl.datatondc Converts coordinates in data space to coordinates in NDC space.
Ngl.end Terminates a PyNGL script.
Ngl.ndctodata Converts coordinates in NDC space to coordinates in data space.
Ngl.nice_cntr_levels Given min/max values and the maximum number of steps desired, calculates an array of "nice" equally-spaced values through the data domain.

PyNGL object routines

Ngl.add_annotation Adds an annotation to a given plot.
Ngl.destroy Destroys an Ngl object.
Ngl.draw Draws an Ngl plot object.
Ngl.get_workspace_id Returns a reference to the current Workspace object.
Ngl.maximize_plot Maximizes the size of the given plot on the workstation.
Ngl.overlay Overlays one plot onto another.
Ngl.remove_annotation Removes an annotation from the given plot.
Ngl.remove_overlay Removes an overlaid plot from the given plot.
Ngl.set_values Sets resource values for a specified plot object.

System tools

Ngl.pynglpath Returns full path names for selected abbreviated names.

Workstation routines

Ngl.change_workstation Changes the workstation that plots will be drawn to.
Ngl.clear_workstation Clears a specified workstation.
Ngl.delete_wks Deletes a workstation object.
Ngl.frame Terminates a picture on a specified workstation.
Ngl.open_wks Opens a workstation on which to draw graphics.
Ngl.update_workstation Flushes all output to a specified workstation.