Skip to content

Commit

Permalink
Update acquire.pyi
Browse files Browse the repository at this point in the history
Adding docstrings for OffsetCapabilities
  • Loading branch information
dgmccart authored Aug 23, 2024
1 parent d4a9270 commit 93bc2d0
Showing 1 changed file with 20 additions and 6 deletions.
26 changes: 20 additions & 6 deletions python/acquire/acquire.pyi
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

0 comments on commit 93bc2d0

Please sign in to comment.