Skip to content

Commit 8a96770

Browse files
davidsonicfacebook-github-bot
authored andcommitted
Update the docstring for try_get_projection_transform
Summary: Update the docstring for try_get_projection_transform on the API design. Reviewed By: kjchalup Differential Revision: D39227333 fbshipit-source-id: c9d0e625735d4972116d1f71865fb9b763e684de
1 parent 84fa966 commit 8a96770

File tree

1 file changed

+8
-5
lines changed

1 file changed

+8
-5
lines changed

pytorch3d/renderer/cameras.py

+8-5
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
import math
88
import warnings
9-
from typing import List, Optional, Sequence, Tuple, Union
9+
from typing import Any, Dict, List, Optional, Sequence, Tuple, Union
1010

1111
import numpy as np
1212
import torch
@@ -1851,12 +1851,15 @@ def get_screen_to_ndc_transform(
18511851
return transform
18521852

18531853

1854-
def try_get_projection_transform(cameras: CamerasBase, kwargs) -> Optional[Transform3d]:
1854+
def try_get_projection_transform(
1855+
cameras: CamerasBase, cameras_kwargs: Dict[str, Any]
1856+
) -> Optional[Transform3d]:
18551857
"""
1856-
Try block to get projection transform.
1858+
Try block to get projection transform from cameras and cameras_kwargs.
18571859
18581860
Args:
1859-
cameras instance, can be linear cameras or nonliear cameras
1861+
cameras: cameras instance, can be linear cameras or nonliear cameras
1862+
cameras_kwargs: camera parameters to be passed to cameras
18601863
18611864
Returns:
18621865
If the camera implemented projection_transform, return the
@@ -1865,7 +1868,7 @@ def try_get_projection_transform(cameras: CamerasBase, kwargs) -> Optional[Trans
18651868

18661869
transform = None
18671870
try:
1868-
transform = cameras.get_projection_transform(**kwargs)
1871+
transform = cameras.get_projection_transform(**cameras_kwargs)
18691872
except NotImplementedError:
18701873
pass
18711874
return transform

0 commit comments

Comments
 (0)