Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Misc 2024 12 10 update documentation strings #312

Merged
merged 2 commits into from
Dec 10, 2024
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Update documentation in calibration
  • Loading branch information
johningve committed Dec 10, 2024
commit bdb698d681065b3ffffc5a89f816ea72d79fe6f0
10 changes: 10 additions & 0 deletions modules/zivid/experimental/calibration.py
Original file line number Diff line number Diff line change
@@ -17,6 +17,11 @@ def intrinsics(camera, settings=None):
with the given settings. If settings are not provided, intrinsics appropriate for the camera's
default 3D capture settings is returned.

For a 2D+3D capture, the 2D color image and 3D point cloud may have different resolutions, depending
on the pixel sampling and resampling settings used in the Settings and in the Settings.color. This function
returns intrinsics applicable for the 3D point cloud resolution. You can call this function with a Settings2D
instance for the 2D intrinsics.

Args:
camera: A Camera instance
settings: Settings or Settings2D to be used to get correct intrinsics (optional)
@@ -57,8 +62,13 @@ def intrinsics(camera, settings=None):
def estimate_intrinsics(frame):
"""Estimate camera intrinsics for a given frame.

The estimated parameters may be used to project 3D point cloud onto the corresponding 2D image.
This function is for advanced use cases. Otherwise, use intrinsics(camera).

For a 2D+3D capture, the 2D color image and 3D point cloud may have different resolutions, depending
on the pixel sampling and resampling settings used in the Settings and in the Settings.color. This function
returns intrinsics applicable for the 3D point cloud resolution.

Args:
frame: A Frame instance

Loading