Skip to content

lm.acquisition.v2#

zen_api.lm.acquisition.v2 #

Classes:

  • RegionPoint –

    Represents a two-dimensional point with X and Y coordinates for use in region-based acquisition scenarios.

  • RegionRect –

    Represents a rectangular region defined by its left (X), top (Y) coordinates, width, and height.

  • RegionContour –

    General data contract for all region contour types.

  • RegionEllipse –

    Represents an elliptical region defined by a bounding rectangle.

  • RegionPolygon –

    Represents a polygonal region defined by an ordered list of vertices.

  • RegionRectangle –

    Represents a rectangular region within the scan area.

RegionPoint dataclass #

RegionPoint(x: float = betterproto.double_field(1), y: float = betterproto.double_field(2))

Bases: Message

Represents a two-dimensional point with X and Y coordinates for use in region-based acquisition scenarios.

Attributes:

  • x (float) –

    The X coordinate of the point.

  • y (float) –

    The Y coordinate of the point.

x class-attribute instance-attribute #

x: float = double_field(1)

The X coordinate of the point.

y class-attribute instance-attribute #

y: float = double_field(2)

The Y coordinate of the point.

RegionRect dataclass #

RegionRect(x: float = betterproto.double_field(1), y: float = betterproto.double_field(2), width: float = betterproto.double_field(3), height: float = betterproto.double_field(4))

Bases: Message

Represents a rectangular region defined by its left (X), top (Y) coordinates, width, and height.

Attributes:

  • x (float) –

    The left coordinate of the rectangle.

  • y (float) –

    The top coordinate of the rectangle.

  • width (float) –

    The width of the rectangle.

  • height (float) –

    The height of the rectangle.

x class-attribute instance-attribute #

x: float = double_field(1)

The left coordinate of the rectangle.

y class-attribute instance-attribute #

y: float = double_field(2)

The top coordinate of the rectangle.

width class-attribute instance-attribute #

width: float = double_field(3)

The width of the rectangle.

height class-attribute instance-attribute #

height: float = double_field(4)

The height of the rectangle.

RegionContour dataclass #

RegionContour(name: str = betterproto.string_field(1), region_ellipse: RegionEllipse = betterproto.message_field(10, group='subtype'), region_rectangle: RegionRectangle = betterproto.message_field(11, group='subtype'), region_polygon: RegionPolygon = betterproto.message_field(12, group='subtype'))

Bases: Message

General data contract for all region contour types.

Attributes:

  • name (str) –

    The region contour name.

name class-attribute instance-attribute #

name: str = string_field(1)

The region contour name.

RegionEllipse dataclass #

RegionEllipse(bounding_box: RegionRect = betterproto.message_field(1))

Bases: Message

Represents an elliptical region defined by a bounding rectangle.

Attributes:

bounding_box class-attribute instance-attribute #

bounding_box: RegionRect = message_field(1)

The rectangle that defines the bounding box of the ellipse. The ellipse is fully contained within this rectangle. The ZenApi.LM.Acquisition.V2.RegionRect specifies the position and size of the bounding rectangle using four values: X (left), Y (top), Width, and Height. For example, a rectangle with X = 10, Y = 20, Width = 100, and Height = 50 defines an ellipse centered at (60, 45) with a horizontal radius of 50 and a vertical radius of 25.

RegionPolygon dataclass #

RegionPolygon(points: List[RegionPoint] = betterproto.message_field(1))

Bases: Message

Represents a polygonal region defined by an ordered list of vertices.

Attributes:

  • points (List[RegionPoint]) –

    The ordered list of ZenApi.LM.Acquisition.V2.RegionPoint instances that define the vertices of the polygon.

points class-attribute instance-attribute #

points: List[RegionPoint] = message_field(1)

The ordered list of ZenApi.LM.Acquisition.V2.RegionPoint instances that define the vertices of the polygon. Each point specifies an (X, Y) coordinate in the region's coordinate space. The polygon is formed by connecting each consecutive point in the list, and finally connecting the last point back to the first to close the shape.

RegionRectangle dataclass #

RegionRectangle(rectangle: RegionRect = betterproto.message_field(1))

Bases: Message

Represents a rectangular region within the scan area.

Attributes:

  • rectangle (RegionRect) –

    The ZenApi.LM.Acquisition.V2.RegionRect that defines the position and size of the rectangular region

rectangle class-attribute instance-attribute #

rectangle: RegionRect = message_field(1)

The ZenApi.LM.Acquisition.V2.RegionRect that defines the position and size of the rectangular region within the scan area.