Module Expr Str Import alias identifier ImportFrom alias ImportFrom alias ImportFrom alias alias ImportFrom alias identifier Assign NameStore Call NameLoad AttributeLoad NameLoad attr Str Str Assign NameStore Call NameLoad AttributeLoad NameLoad attr Str Str FunctionDef arguments args NameParam defaults body Expr Str If CompareIs NameLoad NameLoad body Assign NameStore Call AttributeLoad NameLoad attr Return NameLoad decorator_list FunctionDef arguments args NameParam NameParam defaults body Expr Str If CompareIs NameLoad NameLoad body Assign NameStore Call AttributeLoad NameLoad attr If CompareIs NameLoad NameLoad body Assign NameStore Call AttributeLoad NameLoad attr Return TupleLoad NameLoad NameLoad decorator_list FunctionDef arguments args NameParam NameParam NameParam NameParam NameParam defaults body Expr Str If CompareIs NameLoad NameLoad body Assign TupleStore NameStore NameStore Call NameLoad NameLoad NameLoad NameLoad NameLoad orelse Assign NameStore NameLoad Assign NameStore NameLoad Return TupleLoad NameLoad NameLoad NameLoad decorator_list FunctionDef arguments args NameParam NameParam defaults NameLoad body Expr Str If CompareIs NameLoad NameLoad body Assign NameStore Call NameLoad NameLoad Return NameLoad decorator_list FunctionDef arguments args NameParam NameParam NameParam NameParam defaults body Expr Str Assign NameStore SubscriptLoad AttributeLoad NameLoad attr Index NameLoad Assign TupleStore NameStore NameStore Call NameLoad NameLoad If CompareIs NameLoad NameLoad body If CompareIn Str NameLoad body Assign NameStore SubscriptLoad NameLoad Index Str orelse Assign NameStore NameLoad If CompareIs NameLoad NameLoad body If CompareIn Str NameLoad body Assign NameStore SubscriptLoad NameLoad Index Str orelse Assign NameStore NameLoad Return TupleLoad NameLoad NameLoad decorator_list FunctionDef arguments args NameParam NameParam NameParam defaults body Expr Str If CompareIs NameLoad NameLoad body Assign NameStore SubscriptLoad SubscriptLoad AttributeLoad NameLoad attr Index Str Index Num If CompareIs NameLoad NameLoad body Assign NameStore SubscriptLoad SubscriptLoad AttributeLoad NameLoad attr Index Str Index Num Return TupleLoad NameLoad NameLoad decorator_list FunctionDef arguments args NameParam NameParam defaults body Expr Str Return BinOpAdd BinOpAdd BinOpAdd Call AttributeLoad NameLoad attr Str Str Str NameLoad Str decorator_list FunctionDef arguments args NameParam NameParam defaults body Expr Str If CompareIn Str SubscriptLoad AttributeLoad NameLoad attr Index NameLoad body Assign NameStore SubscriptLoad SubscriptLoad AttributeLoad NameLoad attr Index NameLoad Index Str orelse If CompareIn Str SubscriptLoad AttributeLoad NameLoad attr Index NameLoad body Assign NameStore SubscriptLoad SubscriptLoad AttributeLoad NameLoad attr Index NameLoad Index Str orelse Assign NameStore Call NameLoad NameLoad Assign NameStore Call AttributeLoad NameLoad attr Str Str Assign NameStore BinOpAdd Call AttributeLoad SubscriptLoad NameLoad Index Num attr SubscriptLoad NameLoad Slice Num Return NameLoad decorator_list FunctionDef arguments args NameParam defaults body Expr Str If CompareIn Str AttributeLoad NameLoad attr body Return SubscriptLoad AttributeLoad NameLoad attr Index Str orelse Return Str decorator_list FunctionDef arguments args NameParam defaults body Expr Str If CompareIn Str AttributeLoad NameLoad attr body Return SubscriptLoad AttributeLoad NameLoad attr Index Str orelse Return Str decorator_list FunctionDef arguments args NameParam defaults body Expr Str Assign NameStore SubscriptLoad SubscriptLoad AttributeLoad NameLoad attr Index Str Index Num Assign NameStore SubscriptLoad AttributeLoad NameLoad attr Index Str Assign NameStore SubscriptLoad AttributeLoad NameLoad attr Index Str Return Call NameLoad NameLoad NameLoad NameLoad decorator_list FunctionDef arguments args NameParam defaults body Expr Str Assign NameStore SubscriptLoad SubscriptLoad AttributeLoad NameLoad attr Index Str Index Num Assign NameStore SubscriptLoad AttributeLoad NameLoad attr Index Str If CompareIn Str AttributeLoad NameLoad attr body Assign NameStore SubscriptLoad AttributeLoad NameLoad attr Index Str orelse Assign NameStore Str Return Call NameLoad NameLoad NameLoad NameLoad decorator_list FunctionDef arguments args NameParam NameParam NameParam NameParam defaults Str body Expr Str Assign NameStore Call AttributeLoad Call NameLoad NameLoad attr Str Str Assign NameStore Call AttributeLoad NameLoad attr Str Str Assign NameStore Call AttributeLoad Call NameLoad NameLoad attr Str Assign NameStore Call AttributeLoad Call NameLoad NameLoad attr Num Return BinOpMod Str TupleLoad NameLoad NameLoad NameLoad NameLoad NameLoad decorator_list FunctionDef arguments args NameParam NameParam NameParam NameParam defaults Str body Expr Str Assign NameStore Call AttributeLoad Call NameLoad NameLoad attr Str Str Assign NameStore Call AttributeLoad NameLoad attr Str Str Assign NameStore Call AttributeLoad Call NameLoad NameLoad attr Str Assign NameStore Call AttributeLoad Call NameLoad NameLoad attr Num Return BinOpMod Str TupleLoad NameLoad NameLoad NameLoad NameLoad NameLoad decorator_list FunctionDef arguments args NameParam NameParam NameParam defaults body Expr Str Assign NameStore BinOpAdd Call AttributeLoad Call NameLoad NameLoad attr Str Assign NameStore SubscriptLoad SubscriptLoad AttributeLoad NameLoad attr Index Str Index NameLoad Assign NameStore BinOpMod Str TupleLoad Call NameLoad NameLoad NameLoad NameLoad Assign NameStore Call NameLoad NameLoad NameLoad Return BinOpAdd BinOpAdd NameLoad Str NameLoad decorator_list FunctionDef arguments args NameParam NameParam NameParam defaults body Expr Str Assign NameStore BinOpAdd Call AttributeLoad Call NameLoad NameLoad attr Str Assign NameStore BinOpDiv SubscriptLoad SubscriptLoad AttributeLoad NameLoad attr Index Str Index NameLoad Num Assign NameStore BinOpMod Str TupleLoad Call NameLoad NameLoad NameLoad NameLoad Assign NameStore Call NameLoad NameLoad NameLoad Return BinOpAdd BinOpAdd NameLoad Str NameLoad decorator_list FunctionDef arguments args NameParam NameParam NameParam defaults body Expr Str Assign NameStore BinOpAdd Call AttributeLoad Call NameLoad NameLoad attr Str Assign NameStore BinOpDiv SubscriptLoad SubscriptLoad AttributeLoad NameLoad attr Index Str Index NameLoad Num If CompareGtE NameLoad Num body Assign NameStore Str orelse Assign NameStore Str Assign NameStore UnaryOpUSub NameLoad Assign NameStore BinOpMod Str TupleLoad Call NameLoad NameLoad NameLoad NameLoad NameLoad Assign NameStore Call NameLoad NameLoad NameLoad Return BinOpAdd BinOpAdd NameLoad Str NameLoad decorator_list FunctionDef arguments args NameParam NameParam NameParam defaults body Expr Str Assign NameStore BinOpAdd Call AttributeLoad Call NameLoad NameLoad attr Str Assign NameStore BinOpDiv SubscriptLoad SubscriptLoad AttributeLoad NameLoad attr Index Str Index NameLoad Num If CompareGtE NameLoad Num body Assign NameStore Str orelse Assign NameStore Str Assign NameStore UnaryOpUSub NameLoad Assign NameStore BinOpMod Str TupleLoad Call NameLoad NameLoad NameLoad NameLoad NameLoad Assign NameStore Call NameLoad NameLoad NameLoad Return BinOpAdd BinOpAdd NameLoad Str NameLoad decorator_list FunctionDef arguments args NameParam NameParam defaults body Expr Str Assign NameStore BinOpAdd Call AttributeLoad Call NameLoad NameLoad attr Str Assign NameStore BinOpMod Str TupleLoad Call NameLoad NameLoad NameLoad Assign NameStore Call NameLoad NameLoad NameLoad Return BinOpAdd BinOpAdd NameLoad Str NameLoad decorator_list FunctionDef arguments args NameParam NameParam NameParam defaults body Expr Str Assign NameStore BinOpAdd Call AttributeLoad Call NameLoad NameLoad attr Str Assign NameStore BinOpMod Str TupleLoad Call NameLoad NameLoad NameLoad Assign NameStore SubscriptLoad SubscriptLoad AttributeLoad NameLoad attr Index Str Index NameLoad Assign NameStore SubscriptLoad SubscriptLoad AttributeLoad NameLoad attr Index Str Index NameLoad Assign NameStore BinOpMod Str TupleLoad NameLoad NameLoad NameLoad Assign NameStore Call NameLoad NameLoad NameLoad Return BinOpAdd BinOpAdd BinOpAdd BinOpAdd NameLoad Str NameLoad Str NameLoad decorator_list FunctionDef arguments args NameParam NameParam NameParam defaults body Expr Str Assign NameStore BinOpAdd Call AttributeLoad Call NameLoad NameLoad attr Str Assign NameStore BinOpMod Str TupleLoad Call NameLoad NameLoad NameLoad Assign NameStore BinOpMod Str NameLoad Assign NameStore Call NameLoad NameLoad NameLoad Return BinOpAdd BinOpAdd BinOpAdd BinOpAdd NameLoad Str NameLoad Str NameLoad decorator_list FunctionDef arguments args NameParam NameParam NameParam defaults NameLoad NameLoad NameLoad body Expr Str If CompareIs NameLoad NameLoad body Assign NameStore Call AttributeLoad NameLoad attr If CompareIsNot NameLoad NameLoad body Expr Call AttributeLoad NameLoad attr NameLoad If CompareIsNot NameLoad NameLoad body Expr Call AttributeLoad NameLoad attr NameLoad decorator_list
N/A N/A 
pyart.graph.common
==================

Common graphing routines.

.. autosummary::
    :toctree: generated/

    parse_ax
    parse_ax_fig
    parse_norm_vmin_vmax
    parse_cmap
    parse_vmin_vmax
    parse_lon_lat
    generate_colorbar_label
    generate_field_name
    generate_radar_name
    generate_grid_name
    generate_radar_time_begin
    generate_grid_time_begin
    generate_filename
    generate_grid_filename
    generate_title
    generate_grid_title
    generate_longitudinal_level_title
    generate_latitudinal_level_title
    generate_vpt_title
    generate_ray_title
    set_limits

 N/A matplotlib.pyplot plt netCDF4 num2date exceptions _deprecated_alias config get_field_colormap get_field_limits core transforms _transforms N/A radar_coords_to_cart N/A _deprecated_alias N/A _transforms antenna_to_cartesian pyart.graph.common.radar_coords_to_cart pyart.core.transforms.antenna_to_cartesian N/A sweep_coords_to_cart N/A _deprecated_alias N/A _transforms antenna_vectors_to_cartesian pyart.graph.common.sweep_coords_to_cart pyart.core.transforms.antenna_vectors_to_cartesian parse_ax N/A N/A ax N/A N/A N/A  Parse and return ax parameter.  N/A N/A ax None N/A N/A ax N/A N/A plt gca N/A ax N/A parse_ax_fig N/A N/A ax fig N/A N/A N/A  Parse and return ax and fig parameters.  N/A N/A ax None N/A N/A ax N/A N/A plt gca N/A N/A fig None N/A N/A fig N/A N/A plt gcf N/A N/A ax fig N/A parse_norm_vmin_vmax N/A N/A norm container field vmin vmax N/A N/A N/A  Parse and return norm, vmin and vmax parameters.  N/A N/A norm None N/A N/A N/A vmin vmax N/A parse_vmin_vmax container field vmin vmax N/A N/A vmin None N/A vmax None N/A N/A norm vmin vmax N/A parse_cmap N/A N/A cmap field N/A None N/A N/A  Parse and return the cmap parameter.  N/A N/A cmap None N/A N/A cmap N/A get_field_colormap field N/A cmap N/A parse_vmin_vmax N/A N/A container field vmin vmax N/A N/A N/A  Parse and return vmin and vmax parameters.  N/A field_dict N/A N/A container fields N/A field N/A N/A field_default_vmin field_default_vmax N/A get_field_limits field N/A N/A vmin None N/A N/A N/A valid_min field_dict N/A N/A vmin N/A field_dict N/A valid_min N/A N/A vmin field_default_vmin N/A N/A vmax None N/A N/A N/A valid_max field_dict N/A N/A vmax N/A field_dict N/A valid_max N/A N/A vmax field_default_vmax N/A N/A vmin vmax N/A parse_lon_lat N/A N/A grid lon lat N/A N/A N/A  Parse lat and lon parameters  N/A N/A lat None N/A N/A lat N/A N/A N/A grid origin_latitude N/A data N/A 0 N/A N/A lon None N/A N/A lon N/A N/A N/A grid origin_longitude N/A data N/A 0 N/A N/A lon lat N/A generate_colorbar_label N/A N/A standard_name units N/A N/A N/A  Generate and return a label for a colorbar.  N/A N/A N/A N/A N/A N/A standard_name replace _  ( units ) N/A generate_field_name N/A N/A container field N/A N/A N/A  Return a nice field name for a particular field.  N/A N/A standard_name N/A N/A container fields N/A field N/A N/A field_name N/A N/A N/A container fields N/A field N/A standard_name N/A N/A N/A long_name N/A N/A container fields N/A field N/A N/A field_name N/A N/A N/A container fields N/A field N/A long_name N/A N/A field_name N/A str field N/A field_name N/A N/A field_name replace _ N/A field_name N/A N/A N/A N/A field_name N/A 0 upper N/A field_name N/A 1 N/A field_name N/A generate_radar_name N/A N/A radar N/A N/A N/A  Return radar name.  N/A N/A instrument_name N/A radar metadata N/A N/A N/A N/A radar metadata N/A instrument_name N/A N/A N/A generate_grid_name N/A N/A grid N/A N/A N/A  Return grid name.  N/A N/A instrument_name N/A grid metadata N/A N/A N/A N/A grid metadata N/A instrument_name N/A N/A N/A generate_radar_time_begin N/A N/A radar N/A N/A N/A  Return time begin in datetime instance.  N/A times N/A N/A N/A radar time N/A data N/A 0 N/A units N/A N/A radar time N/A units N/A calendar N/A N/A radar time N/A calendar N/A N/A num2date times units calendar N/A generate_grid_time_begin N/A N/A grid N/A N/A N/A  Return time begin in datetime instance.  N/A times N/A N/A N/A grid time N/A data N/A 0 N/A units N/A N/A grid time N/A units N/A N/A calendar N/A grid time N/A N/A calendar N/A N/A grid time N/A calendar N/A N/A calendar standard N/A N/A num2date times units calendar N/A generate_filename N/A N/A radar field sweep ext N/A png N/A N/A 
    Generate a filename for a plot.

    Generated filename has form:
        radar_name_field_sweep_time.ext

    Parameters
    ----------
    radar : Radar
        Radar structure.
    field : str
        Field plotted.
    sweep : int
        Sweep plotted.
    ext : str
        Filename extension.

    Returns
    -------
    filename : str
        Filename suitable for saving a plot.

     N/A name_s N/A N/A N/A generate_radar_name radar replace _ N/A field_s N/A N/A field replace _ N/A time_s N/A N/A N/A generate_radar_time_begin radar strftime %Y%m%d%H%M%S N/A sweep_s N/A N/A N/A str sweep zfill 2 N/A N/A %s_%s_%s_%s.%s N/A name_s field_s sweep_s time_s ext N/A generate_grid_filename N/A N/A grid field level ext N/A png N/A N/A 
    Generate a filename for a plot.

    Generated filename has form:
        grid_name_field_level_time.ext

    Parameters
    ----------
    grid : Grid
        Grid structure.
    field : str
        Field plotted.
    level : int
        Level plotted.
    ext : str
        Filename extension.

    Returns
    -------
    filename : str
        Filename suitable for saving a plot.

     N/A name_s N/A N/A N/A generate_grid_name grid replace _ N/A field_s N/A N/A field replace _ N/A time_s N/A N/A N/A generate_grid_time_begin grid strftime %Y%m%d%H%M%S N/A level_s N/A N/A N/A str level zfill 2 N/A N/A %s_%s_%s_%s.%s N/A name_s field_s level_s time_s ext N/A generate_title N/A N/A radar field sweep N/A N/A N/A 
    Generate a title for a plot.

    Parameters
    ----------
    radar : Radar
        Radar structure.
    field : str
        Field plotted.
    sweep : int
        Sweep plotted.

    Returns
    -------
    title : str
        Plot title.

     N/A time_str N/A N/A N/A N/A generate_radar_time_begin radar isoformat Z N/A fixed_angle N/A N/A N/A radar fixed_angle N/A data N/A sweep N/A l1 N/A %s %.1f Deg. %s  N/A N/A generate_radar_name radar fixed_angle time_str N/A field_name N/A generate_field_name radar field N/A N/A N/A l1 field_name N/A generate_grid_title N/A N/A grid field level N/A N/A N/A 
    Generate a title for a plot.

    Parameters
    ----------
    grid : Grid
        Radar structure.
    field : str
        Field plotted.
    level : int
        Verical level plotted.


    Returns
    -------
    title : str
        Plot title.

     N/A time_str N/A N/A N/A N/A generate_grid_time_begin grid isoformat Z N/A height N/A N/A N/A N/A grid z N/A data N/A level 1000.0 N/A l1 N/A %s %.1f km %s  N/A N/A generate_grid_name grid height time_str N/A field_name N/A generate_field_name grid field N/A N/A N/A l1 field_name N/A generate_longitudinal_level_title N/A N/A grid field level N/A N/A N/A 
    Generate a title for a plot.

    Parameters
    ----------
    grid : Grid
        Radar structure.
    field : str
        Field plotted.
    level : int
        Longitudinal level plotted.


    Returns
    -------
    title : str
        Plot title.

     N/A time_str N/A N/A N/A N/A generate_grid_time_begin grid isoformat Z N/A disp N/A N/A N/A N/A grid x N/A data N/A level 1000.0 N/A N/A disp 0 N/A N/A direction east N/A N/A direction west N/A disp N/A disp N/A l1 N/A %s %.1f km %s of origin %s  N/A N/A generate_grid_name grid disp direction time_str N/A field_name N/A generate_field_name grid field N/A N/A N/A l1 field_name N/A generate_latitudinal_level_title N/A N/A grid field level N/A N/A N/A 
    Generate a title for a plot.

    Parameters
    ----------
    grid : Grid
        Radar structure.
    field : str
        Field plotted.
    level : int
        Latitudinal level plotted.


    Returns
    -------
    title : str
        Plot title.

     N/A time_str N/A N/A N/A N/A generate_grid_time_begin grid isoformat Z N/A disp N/A N/A N/A N/A grid y N/A data N/A level 1000.0 N/A N/A disp 0 N/A N/A direction north N/A N/A direction south N/A disp N/A disp N/A l1 N/A %s %.1f km %s of origin %s  N/A N/A generate_grid_name grid disp direction time_str N/A field_name N/A generate_field_name grid field N/A N/A N/A l1 field_name N/A generate_vpt_title N/A N/A radar field N/A N/A N/A 
    Generate a title for a VPT plot.

    Parameters
    ----------
    radar : Radar
        Radar structure.
    field : str
        Field plotted.

    Returns
    -------
    title : str
        Plot title.

     N/A time_str N/A N/A N/A N/A generate_radar_time_begin radar isoformat Z N/A l1 N/A %s %s  N/A N/A generate_radar_name radar time_str N/A field_name N/A generate_field_name radar field N/A N/A N/A l1 field_name N/A generate_ray_title N/A N/A radar field ray N/A N/A N/A 
    Generate a title for a ray plot.

    Parameters
    ----------
    radar : Radar
        Radar structure.
    field : str
        Field plotted.
    ray : int
        Ray plotted.

    Returns
    -------
    title : str
        Plot title.

     N/A time_str N/A N/A N/A N/A generate_radar_time_begin radar isoformat Z N/A l1 N/A %s %s N/A N/A generate_radar_name radar time_str N/A azim N/A N/A N/A radar azimuth N/A data N/A ray N/A elev N/A N/A N/A radar elevation N/A data N/A ray N/A l2 N/A Ray: %i  Elevation: %.1f Azimuth: %.1f N/A ray azim elev N/A field_name N/A generate_field_name radar field N/A N/A N/A N/A N/A l1 l2 field_name N/A generate_az_rhi_title N/A N/A radar field azimuth N/A N/A N/A 
    Generate a title for a pseudo-RHI from PPI azimuth plot.

    Parameters
    ----------
    radar : Radar
        Radar structure.
    field : str
        Field plotted.
    azimuth : float
        Azimuth plotted.

    Returns
    -------
    title : str
        Plot title.

     N/A time_str N/A N/A N/A N/A generate_radar_time_begin radar isoformat Z N/A l1 N/A %s %s  N/A N/A generate_radar_name radar time_str N/A l2 N/A Azimuth: %.1f deg azimuth N/A field_name N/A generate_field_name radar field N/A N/A N/A N/A N/A l1 l2 field_name N/A set_limits N/A N/A xlim ylim ax N/A None None None N/A N/A 
    Set the display limits.

    Parameters
    ----------
    xlim : tuple, optional
        2-Tuple containing y-axis limits in km. None uses default limits.
    ylim : tuple, optional
        2-Tuple containing x-axis limits in km. None uses default limits.
    ax : Axis
        Axis to adjust.  None will adjust the current axis.

     N/A N/A ax None N/A N/A ax N/A N/A plt gca N/A N/A ylim None N/A N/A N/A N/A ax set_ylim ylim N/A N/A xlim None N/A N/A N/A N/A ax set_xlim xlim N/A