Skip to content

Commit

Permalink
Tiny docs fixes; remove 'z_scaling' option; publish 'vectors_to_carte…
Browse files Browse the repository at this point in the history
…sian'.
  • Loading branch information
pp-mo committed Jan 22, 2025
1 parent cd8ad58 commit d531989
Showing 1 changed file with 2 additions and 8 deletions.
10 changes: 2 additions & 8 deletions src/geovista/bridge.py
Original file line number Diff line number Diff line change
Expand Up @@ -619,7 +619,6 @@ def from_points(
vectors: ArrayLike | tuple(ArrayLike) | None = None,
vectors_crs: CRSLike | None = None,
vectors_array_name: str | None = None,
vectors_z_scaling: float | None = None,
) -> pv.PolyData:
"""Build a point-cloud mesh from x-values, y-values and z-levels.
Expand Down Expand Up @@ -665,16 +664,13 @@ def from_points(
converted to an [N, 3] array of 3-D vectors attached to the result as a
points array ``mesh["vectors"]``. This can be used to generate glyphs
(such as arrows) and streamlines.
vectors_crs : CRSlike, optional
vectors_crs : CRSLike, optional
The Coordinate Reference System of the provided `vectors`. May be anything
accepted by :meth:`pyproj.crs.CRS.from_user_input`. Defaults to the same
as 'crs'.
vectors_array_name : str, optional
Specifies an alternate name for the points array to store the vectors.
Also set as the active vectors name. Defaults to "vectors".
vectors_z_scaling : float, optional
Scaling factor to apply to vertical vectors (i.e. relative to the eastward
and northward components). Defaults to 1.0.
Also set as the active vectors name. Defaults to ``"vectors"``.
Returns
-------
Expand Down Expand Up @@ -752,8 +748,6 @@ def from_points(
vectors = [np.asanyarray(vecdata) for vecdata in vectors]
xx, yy = vectors[:2]
zz = vectors[2] if n_vecs > 2 else np.zeros_like(xx)
if vectors_z_scaling is not None:
zz = zz * vectors_z_scaling

if vectors_crs is None:
vectors_crs = crs
Expand Down

0 comments on commit d531989

Please sign in to comment.