A display object for creating plots from data in a RslFile object.
| Parameters : | rslfile : RslFile
|
|---|
Attributes
| plots | (list) List of plots created. |
| plot_vars | (list) List of fields plotted, order matches plot list. |
| cbs | (list) List of colorbars created. |
| loc | ((float, float)) Latitude and Longitude of radar in degrees. |
| origin | (‘Radar’) ‘Radar’ |
| time_begin | (datetime) Time of first radar scan. |
| radar_name | (str) Radar name. |
| rslfile | (RslFile) RSL radar object use to create plots. |
Methods
| generate_filename(field, tilt[, ext]) | Generate a filename for a plot. |
| generate_ray_title(field, ray) | Generate a title for a ray plot. |
| generate_title(field, tilt) | Generate a title for a plot. |
| label_xaxis_r([ax]) | Label the xaxis with the default label for r units. |
| label_xaxis_x([ax]) | Label the xaxis with the default label for x units. |
| label_yaxis_field(field[, ax]) | Label the yaxis with the default label for a field units. |
| label_yaxis_y([ax]) | Label the yaxis with the default label for y units. |
| label_yaxis_z([ax]) | Label the yaxis with the default label for z units. |
| plot_colorbar([mappable, field, label, cax, fig]) | Plot a colorbar. |
| plot_cross_hair(size[, npts, ax]) | Plot a cross-hair on a ppi plot. |
| plot_label(label, location[, symbol, ...]) | Plot a single symbol and label at a given location. |
| plot_labels(labels, locations[, symbols, ...]) | Plot symbols and labels at given locations. |
| plot_ppi(field, tilt[, mask_tuple, vmin, ...]) | Plot a PPI. |
| plot_range_ring(range_ring_location_km[, ...]) | Plot a single range ring. |
| plot_range_rings(range_rings[, ax]) | Plot a series of range rings. |
| plot_ray(field, ray[, format_str, ...]) | Plot a single ray. |
| plot_rhi(field, tilt[, mask_tuple, vmin, ...]) | Plot a RHI. |
| set_limits([xlim, ylim, ax]) | Set the display limits. |
Private methods
| __init__(rslfile) | Initialize the object. |
| _generate_colorbar_label(standard_name, units) | Generate and return a label for a colorbar. |
| _generate_field_name(field) | Return a nice field name for a particular field. |
| _get_colorbar_label(field) | Return a colobar label for a given field. |
| _get_data(field, tilt, mask_tuple) | Retrieve and return data from a plot function. |
| _get_ray_data(field, ray, mask_tuple) | Retrieve and return ray data from a plot function. |
| _get_x_y(field, tilt) | Retrieve and return x and y coordinate in km. |
| _get_x_y_z(field, tilt) | Retrieve and return x, y, and z coordinate in km. |
| _label_axes_ppi(axis_labels, ax) | Set the x and y axis labels for a PPI plot. |
| _label_axes_ray(axis_labels, field, ax) | Set the x and y axis labels for a ray plot. |
| _label_axes_rhi(axis_labels, ax) | Set the x and y axis labels for a RHI plot. |
| _parse_ax(ax) | Parse and return ax parameter. |
| _parse_ax_fig(ax, fig) | Parse and return ax and fig parameters. |
| _parse_vmin_vmax(field, vmin, vmax) | |
| _set_ray_title(field, ray, title, ax) | Set the figure title for a ray plot using a default title. |
| _set_title(field, tilt, title, ax) | Set the figure title using a default title. |