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.

Sign up for GitHub

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

Update acquire.pyi to add docstrings for OffsetCapabilities #207

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update acquire.pyi to add docstrings for OffsetCapabilities #207

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
26 changes: 20 additions & 6 deletions python/acquire/acquire.pyi
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -563,10 +563,26 @@ class InputTriggers:

@final
class OffsetCapabilities:
"""Represents the size of the offset of the region of interest
on the camera.

The sum of the offset and shape is the size of the full camera chip.

Attributes:
x:
An instance of the `Property` class which represents the horizontal offset of
the region of interest on the camera chip.
y:
An instance of the `Property` class which represents the vertical offset of the
region of interest on the camera chip.
"""

x: Property
y: Property

def dict(self) -> Dict[str, Any]: ...
def dict(self) -> Dict[str, Any]:
"""Returns a dictionary of a `OffsetCapabilities` object's attributes."""
...

@final
class OutputTriggers:
Expand Down Expand Up @@ -892,20 +908,18 @@ class SampleType:

@final
class ShapeCapabilities:
"""Represents the size of the offset or the shape of the region of interest
"""Represents the shape of the region of interest
on the camera.

The sum of the offset and shape is the size of the full camera chip.

Attributes:
x:
An instance of the `Property` class which represents the width of
the region of interest on the camera or the horizontal offset of
the region of interest on the camera chip.
the region of interest on the camera.
y:
An instance of the `Property` class which represents the height of
the region of interest on the camera or the vertical offset of the
region of interest on the camera chip.
the region of interest on the camera.
"""

x: Property
Expand Down
Loading