Deprecate unused/undocumented functions · matplotlib/matplotlib@cef1ca6 · GitHub
Skip to content

Commit cef1ca6

Browse files
oscargusoscargus
committed
Deprecate unused/undocumented functions
1 parent 99d39bd commit cef1ca6

6 files changed

Lines changed: 62 additions & 23 deletions

File tree

‎doc/api/next_api_changes/deprecations/24985-OG.rst‎

Lines changed: 16 additions & 0 deletions

‎lib/mpl_toolkits/mplot3d/art3d.py‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -148,7 +148,7 @@ def set_3d_properties(self, z=0, zdir='z'):
148148
@artist.allow_rasterization
149149
def draw(self, renderer):
150150
position3d = np.array((self._x, self._y, self._z))
151-
proj = proj3d.proj_trans_points(
151+
proj = proj3d._proj_trans_points(
152152
[position3d, position3d + self._dir_vec], self.axes.M)
153153
dx = proj[0][1] - proj[0][0]
154154
dy = proj[1][1] - proj[1][0]
@@ -359,7 +359,7 @@ def do_3d_projection(self):
359359
"""
360360
Project the points according to renderer matrix.
361361
"""
362-
xyslist = [proj3d.proj_trans_points(points, self.axes.M)
362+
xyslist = [proj3d._proj_trans_points(points, self.axes.M)
363363
for points in self._segments3d]
364364
segments_2d = [np.column_stack([xs, ys]) for xs, ys, zs in xyslist]
365365
LineCollection.set_segments(self, segments_2d)

‎lib/mpl_toolkits/mplot3d/axes3d.py‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -249,7 +249,7 @@ def _tunit_cube(self, vals=None, M=None):
249249
if M is None:
250250
M = self.M
251251
xyzs = self._unit_cube(vals)
252-
tcube = proj3d.proj_points(xyzs, M)
252+
tcube = proj3d._proj_points(xyzs, M)
253253
return tcube
254254

255255
@_api.deprecated("3.7")
@@ -918,15 +918,15 @@ def get_proj(self):
918918
if self._focal_length == np.inf:
919919
# Orthographic projection
920920
viewM = proj3d._view_transformation_uvw(u, v, w, eye)
921-
projM = proj3d.ortho_transformation(-self._dist, self._dist)
921+
projM = proj3d._ortho_transformation(-self._dist, self._dist)
922922
else:
923923
# Perspective projection
924924
# Scale the eye dist to compensate for the focal length zoom effect
925925
eye_focal = R + self._dist * ps * self._focal_length
926926
viewM = proj3d._view_transformation_uvw(u, v, w, eye_focal)
927-
projM = proj3d.persp_transformation(-self._dist,
928-
self._dist,
929-
self._focal_length)
927+
projM = proj3d._persp_transformation(-self._dist,
928+
self._dist,
929+
self._focal_length)
930930

931931
# Combine all the transformation matrices to get the final projection
932932
M0 = np.dot(viewM, worldM)

‎lib/mpl_toolkits/mplot3d/axis3d.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -367,7 +367,7 @@ def draw(self, renderer):
367367

368368
# Project the edge points along the current position and
369369
# create the line:
370-
pep = proj3d.proj_trans_points([edgep1, edgep2], self.axes.M)
370+
pep = proj3d._proj_trans_points([edgep1, edgep2], self.axes.M)
371371
pep = np.asarray(pep)
372372
self.line.set_data(pep[0], pep[1])
373373
self.line.draw(renderer)

‎lib/mpl_toolkits/mplot3d/proj3d.py‎

Lines changed: 36 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@
55
import numpy as np
66
import numpy.linalg as linalg
77

8+
from matplotlib import _api
9+
810

911
def _line2d_seg_dist(p, s0, s1):
1012
"""
@@ -51,7 +53,15 @@ def world_transformation(xmin, xmax,
5153
[0, 0, 0, 1]])
5254

5355

56+
@_api.deprecated("3.8")
5457
def rotation_about_vector(v, angle):
58+
"""
59+
Produce a rotation matrix for an angle in radians about a vector.
60+
"""
61+
return _rotation_about_vector(v, angle)
62+
63+
64+
def _rotation_about_vector(v, angle):
5565
"""
5666
Produce a rotation matrix for an angle in radians about a vector.
5767
"""
@@ -101,7 +111,7 @@ def _view_axes(E, R, V, roll):
101111
# Save some computation for the default roll=0
102112
if roll != 0:
103113
# A positive rotation of the camera is a negative rotation of the world
104-
Rroll = rotation_about_vector(w, -roll)
114+
Rroll = _rotation_about_vector(w, -roll)
105115
u = np.dot(Rroll, u)
106116
v = np.dot(Rroll, v)
107117
return u, v, w
@@ -150,7 +160,12 @@ def view_transformation(E, R, V, roll):
150160
return M
151161

152162

163+
@_api.deprecated("3.8")
153164
def persp_transformation(zfront, zback, focal_length):
165+
return _persp_transformation(zfront, zback, focal_length)
166+
167+
168+
def _persp_transformation(zfront, zback, focal_length):
154169
e = focal_length
155170
a = 1 # aspect ratio
156171
b = (zfront+zback)/(zfront-zback)
@@ -162,7 +177,12 @@ def persp_transformation(zfront, zback, focal_length):
162177
return proj_matrix
163178

164179

180+
@_api.deprecated("3.8")
165181
def ortho_transformation(zfront, zback):
182+
return _ortho_transformation(zfront, zback)
183+
184+
185+
def _ortho_transformation(zfront, zback):
166186
# note: w component in the resulting vector will be (zback-zfront), not 1
167187
a = -(zfront + zback)
168188
b = -(zfront - zback)
@@ -218,7 +238,9 @@ def proj_transform(xs, ys, zs, M):
218238
return _proj_transform_vec(vec, M)
219239

220240

221-
transform = proj_transform
241+
transform = _api.deprecated(
242+
"3.8", obj_type="function", name="transform",
243+
alternative="proj_transform")(proj_transform)
222244

223245

224246
def proj_transform_clip(xs, ys, zs, M):
@@ -231,15 +253,26 @@ def proj_transform_clip(xs, ys, zs, M):
231253
return _proj_transform_vec_clip(vec, M)
232254

233255

256+
@_api.deprecated("3.8")
234257
def proj_points(points, M):
235-
return np.column_stack(proj_trans_points(points, M))
258+
return _proj_points(points, M)
259+
236260

261+
def _proj_points(points, M):
262+
return np.column_stack(_proj_trans_points(points, M))
237263

264+
265+
@_api.deprecated("3.8")
238266
def proj_trans_points(points, M):
267+
return _proj_trans_points(points, M)
268+
269+
270+
def _proj_trans_points(points, M):
239271
xs, ys, zs = zip(*points)
240272
return proj_transform(xs, ys, zs, M)
241273

242274

275+
@_api.deprecated("3.8")
243276
def rot_x(V, alpha):
244277
cosa, sina = np.cos(alpha), np.sin(alpha)
245278
M1 = np.array([[1, 0, 0, 0],

‎lib/mpl_toolkits/mplot3d/tests/test_axes3d.py‎

Lines changed: 2 additions & 12 deletions

0 commit comments

Comments
 (0)