Browse Source

Clarify 'as_int' parameter docstring in ll_to_xy and ll_to_xy_proj

'as_int' is True by default, so indicate that it can be set to False to
return floating point values (rather than vice versa).
lon0
Hans Chen 7 years ago
parent
commit
2aa1080dff
  1. 8
      src/wrf/g_latlon.py

8
src/wrf/g_latlon.py

@ -365,8 +365,8 @@ def ll_to_xy(wrfin, latitude, longitude, timeidx=0,
- 'v': Use the same staggered grid as the v wind component, - 'v': Use the same staggered grid as the v wind component,
which has a staggered south_north (y) dimension. which has a staggered south_north (y) dimension.
as_int (:obj:`bool`): Set to True to return the x,y values as as_int (:obj:`bool`): Set to False to return the x,y values as
:obj:`int`, otherwise they will be returned as :obj:`float`. :obj:`float`, otherwise they will be returned as :obj:`int`.
Returns: Returns:
:class:`xarray.DataArray` or :class:`numpy.ndarray`: The :class:`xarray.DataArray` or :class:`numpy.ndarray`: The
@ -421,8 +421,8 @@ def ll_to_xy_proj(latitude, longitude, meta=True, squeeze=True, as_int=True,
return :class:`numpy.ndarray` instead of return :class:`numpy.ndarray` instead of
:class:`xarray.DataArray`. Default is True. :class:`xarray.DataArray`. Default is True.
as_int (:obj:`bool`): Set to True to return the x,y values as as_int (:obj:`bool`): Set to False to return the x,y values as
:obj:`int`, otherwise they will be returned as :obj:`float`. :obj:`float`, otherwise they will be returned as :obj:`int`.
map_proj (:obj:`int`): Model projection [1=Lambert Conformal, map_proj (:obj:`int`): Model projection [1=Lambert Conformal,
2=Polar Stereographic, 3=Mercator, 6=Lat-Lon]. Required. 2=Polar Stereographic, 3=Mercator, 6=Lat-Lon]. Required.

Loading…
Cancel
Save