Skip to content

Commit 0ebabfc

Browse files
committed
Update docstrings to reflect removed internal transforms
1 parent 730fa40 commit 0ebabfc

File tree

1 file changed

+3
-23
lines changed

1 file changed

+3
-23
lines changed

src/pytorch_kinematics/transforms/transform3d.py

Lines changed: 3 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -249,20 +249,7 @@ def compose(self, *others):
249249

250250
def get_matrix(self):
251251
"""
252-
Return a matrix which is the result of composing this transform
253-
with others stored in self.transforms. Where necessary transforms
254-
are broadcast against each other.
255-
For example, if self.transforms contains transforms t1, t2, and t3, and
256-
given a set of points x, the following should be true:
257-
258-
.. code-block:: python
259-
260-
y1 = t1.compose(t2, t3).transform(x)
261-
y2 = t3.transform(t2.transform(t1.transform(x)))
262-
y1.get_matrix() == y2.get_matrix()
263-
264-
Returns:
265-
A transformation matrix representing the composed inputs.
252+
Return the Nx4x4 homogeneous transformation matrix represented by this object.
266253
"""
267254
return self._matrix
268255

@@ -276,7 +263,7 @@ def _get_matrix_inverse(self):
276263
@staticmethod
277264
def _invert_transformation_matrix(T):
278265
"""
279-
Inverts homogeneous transformation matrix
266+
Invert homogeneous transformation matrix.
280267
"""
281268
Tinv = T.clone()
282269
R = T[:, :3, :3]
@@ -291,14 +278,7 @@ def inverse(self, invert_composed: bool = False):
291278
current transformation.
292279
293280
Args:
294-
invert_composed:
295-
- True: First compose the list of stored transformations
296-
and then apply inverse to the result. This is
297-
potentially slower for classes of transformations
298-
with inverses that can be computed efficiently
299-
(e.g. rotations and translations).
300-
- False: Invert the individual stored transformations
301-
independently without composing them.
281+
invert_composed: ignored, included for backwards compatibility
302282
303283
Returns:
304284
A new Transform3D object containing the inverse of the original

0 commit comments

Comments
 (0)