PyNGL Home > Functions > Array query

Ngl.get_float_array

Retrieves the value of a resource that uses a one-dimensional float array.

Prototype

farr = Ngl.get_float_array(plotid, resource_name)

Arguments

plotid

The identifier returned from Ngl.open_wks, or any PyNGL function that returns a PlotId.

resource_name

The name of the resource whose value you want to retrieve.

Return value

farr

A one-dimensional NumPy array having elements of type 'float'.

Description

This function retrieves a one-dimensional array that is the value of a specified resource associated with a plot.

The first argument is a PlotId and the second argument is the resource whose value you want to retrieve. The function returns a NumPy array of elements of type float containing the current value of the specified resource.

Note that you need to be careful about which PlotId you use for the first argument. For example, if you create a contour plot over a map, what's returned is the map's PlotId, and hence you can't use this to retrieve contour resource information. To retrieve contour resource values, use the "contour" attribute of the map's PlotId, which is the PlotId for the contour plot created:

map = Ngl.contour_map(wks,data,res)
label_string = Ngl.get_float_array(map.contour,"cnLevels")
See the PlotId documentation for a full list of possible attributes.

See Also

Ngl.get_MDfloat_array, Ngl.get_MDinteger_array, Ngl.get_float, Ngl.get_integer, Ngl.get_integer_array, Ngl.get_string, Ngl.get_string_array

Examples

See ngl11p.py.