Function get_xy_z_params

src/wrf/interputils.py:178–263

Return the cross section parameters. This function returns the xy horizontal cross section line coordinates, the xy x z vertical values interpolated along the xy cross section line, and the fixed vertical levels to be used by the cross section algorithm (at ~1% increments for the mi

(z, pivot_point=None, angle=None,
                    start_point=None, end_point=None,
                    levels=None, autolevels=100)

def get_xy_z_params(z, pivot_point=None, angle=None,
                    start_point=None, end_point=None,
                    levels=None, autolevels=100):
    """Return the cross section parameters.

    This function returns the xy horizontal cross section line coordinates,
    the xy x z vertical values interpolated along the xy cross section
    line, and the fixed vertical levels to be used by the cross section
    algorithm (at ~1% increments for the minimum to maximum vertical
    span).

    Args:

        z (:class:`numpy.ndarray`): The vertical coordinate, whose rightmost
            dimensions are bottom_top x south_north x west_east.

        pivot_point (:obj:`tuple` or :obj:`list`, optional): A
            :obj:`tuple` or :obj:`list` with two entries,
            in the form of [x, y] (or [west_east, south_north]), which
            indicates the x,y location through which the plane will pass.
            Must also specify `angle`.

        angle (:obj:`float`, optional): Only valid for cross sections where
            a plane will be plotted through
            a given point on the model domain. 0.0 represents a S-N cross
            section.  90.0 is a W-E cross section.

        start_point (:obj:`tuple` or :obj:`list`, optional): A
            :obj:`tuple` or :obj:`list` with two entries, in the form of
            [x, y] (or [west_east, south_north]), which indicates the start
            x,y location through which the plane will pass.

        end_point (:obj:`tuple` or :obj:`list`, optional): A
            :obj:`tuple` or :obj:`list` with two entries, in the form of
            [x, y] (or [west_east, south_north]), which indicates the end x,y
            location through which the plane will pass.

        levels (sequence): A sequence of :obj:`float` for the desired
            vertical levels in the output array.  If None, a fixed set of
            vertical levels is provided.  Default is None.

        autolevels(:obj:`int`, optional): The number of evenly spaced
            automatically chosen vertical levels to use when *levels*
            is None. Default is 100.

    Returns:

        :obj:`tuple`:  A tuple containing the xy horizontal cross section
        coordinates, the vertical values interpolated along the xy cross
        section line, and the fixed vertical levels used by the
        cross section algorithm at ~1% increments of minimum to maximum
        vertical span.

    """

    xy = get_xy(z, pivot_point, angle, start_point, end_point)

    # Interp z