GenPolyline

Classes

class keysight.ads.de.db.CurveInfo

property start_pt: PointF

property end_pt: PointF

property center_pt: PointF

property bulge: float

property angle_radians: float

property start_angle_radians: float

property angle_degrees: float

property start_angle_degrees: float

property radius: float

property arc_orientation: ArcOrientation

property is_clockwise: bool

property is_counter_clockwise: bool

property bbox: BoxF

class keysight.ads.de.db.Edge

A temporary object that represents the edge of an Outline.

This edge should only be used as a temporary object. Any modifications to the Outline will invalidate the Edge object.

property start_pt: PointF

property end_pt: PointF

property is_arc: bool

property curve_info: CurveInfo | None

class keysight.ads.de.db.GenPolygon

TPoint: alias of Union[PointF, tuple[float, float], PointDBU, tuple[int, int]]

__init__(points: Sequence[PointF | tuple[float, float] | PointDBU | tuple[int, int]] | None = None, outline: Outline | None = None) → None

property bbox: BoxF

property empty: bool

property has_arcs: bool

property points: list[PointF]

property outline: Outline

box_intersects_or_contains_edge(box: BoxF) → bool

overlaps(box: BoxF) → bool

contains(point: PointF) → bool

add_point(point: PointF) → None

set_segment_as_arc(index: int, point: PointF, arc_orientation: ArcOrientation | str) → None

set_segment_as_arc_bulge(index: int, bulge: float) → None

remove_arcs(arc_resolution_degrees: float) → None

transform(transformation: Transform, arc_resolution_degrees: float) → None

class keysight.ads.de.db.GenPolygonWithHoles

TPoint: alias of Union[PointF, tuple[float, float], PointDBU, tuple[int, int]]

__init__(points: Sequence[PointF | tuple[float, float] | PointDBU | tuple[int, int]] | None = None, outer_boundary: GenPolygon | None = None, inner_boundaries: Sequence[GenPolygon] | None = None) → None

property outer_boundary: GenPolygon

property inner_boundaries: list[GenPolygon]

A copy of the collection of holes in this polygon.

inner_boundaries is deprecated, and will be removed in the 2026 release. Use: GenPolygonWithHoles.holes.

property holes: ReadableListRefAbc[GenPolygon]: The collection of holes in this polygon.

property num_holes: int

property bbox: BoxF

property empty: bool

property has_arcs: bool

contains(point: PointF) → bool

box_intersects_or_contains_edge(box: BoxF) → bool

overlaps_box(box: BoxF) → bool

overlaps_polygon(is_closed: bool, other: GenPolygonWithHoles, other_is_closed: bool) → bool

self_intersects(arc_resolution_degrees: float) → bool

remove_arcs(arc_resolution_degrees: float) → None

transform(transformation: Transform, arc_resolution_degrees: float) → None

convert_vertices_to_arcs(radius: float, arc_resolution_degrees: float = 5.0, minimum_vertex_distance: float = 0.0) → list[GenPolygonWithHoles]

oversize(oversize_amount: float, miter_angle_degrees: float = 0.0, minimum_vertex_distance: float = 0.0) → list[GenPolygonWithHoles]

class keysight.ads.de.db.GenPolyline

TPoint: alias of Union[PointF, tuple[float, float], PointDBU, tuple[int, int]]

__init__(points: ~collections.abc.Sequence[~keysight.ads.de._points.PointF | tuple[float, float] | ~keysight.ads.de._points.PointDBU | tuple[int, int]] | None = None, width: float = 0.0, bend_style: ~keysight.ads.de._pde.BendStyle | str = <BendStyle.SQUARE: 0>, cap_style: ~keysight.ads.de._pde.CapStyle | str = <CapStyle.ROUND: 1>, miter_radius: float = 0.0) → None

copy() → GenPolyline: Return a copy of this object.

property points: list[PointF]

property outline: Outline

property width: float

property bend_style: BendStyle

property cap_style: CapStyle

property miter_radius: float

property teardrop_info: TeardropLineInfo

property bbox: BoxF

property empty: bool

property has_arcs: bool

add_point(point: PointF) → None

set_segment_as_arc(index: int, point: PointF, arc_orientation: ArcOrientation | str) → None

set_segment_as_arc_bulge(index: int, bulge: float) → None

transform(transformation: Transform) → None

class keysight.ads.de.db.MatrixForTransform

__init__() → None

translate(dx: float, dy: float) → None

rotate_degrees(degrees: float) → None

scale(dx: float, dy: float) → None

invert() → None

property dx: float

property dy: float

property m11: float

property m12: float

property m21: float

property m22: float

class keysight.ads.de.db.Outline

Represents a polyline composed of line and/or arc segments.

It may represent either an open or closed shape. GenPolyline uses an Outline to represent an open shape. GenPolygonF and GenPolygonF_with_holes use an Outline to represent a closed shape. The points (vertices) and bulges control the shape of the outline. The edges are temporary objects that get invalidated whenever the Outline is modified.

TPoint: alias of Union[PointF, tuple[float, float], PointDBU, tuple[int, int]]

__init__(points: Sequence[PointF | tuple[float, float] | PointDBU | tuple[int, int]] | None = None, bulges: Sequence[float] | None = None) → None

property points: IndexedMutableCollectionAbc[PointF]: The collection of vertices for this outline.

property edges: IndexedReadableCollectionAbc[Edge]: The collection of edges for this outline. The edges are only for short term use.

property bbox: BoxF

property empty: bool: True if the outline has no points.

property has_arcs: bool: True if none of the edges are arcs.

box_intersects_or_contains_edge(box: BoxF, is_closed: bool) → bool

edges_intersect(is_closed: bool, other: Outline, other_is_closed: bool) → bool

contains(point: PointF) → bool

contains_and_not_on_edge(point: PointF) → bool

add_point(point: PointF) → None

insert_point(index: int, point: PointF) → None

delete_point(index: int) → None

set_point(index: int, point: PointF) → None

set_segment_as_arc(index: int, point: PointF, arc_orientation: ArcOrientation | str) → None

set_segment_as_arc_bulge(index: int, bulge: float) → None

remove_arcs(arc_resolution_degrees: float) → None

transform(transform: Transform, arc_resolution_degrees: float) → None

curve_info(index: int) → CurveInfo | None

class keysight.ads.de.db.TeardropDefinition

__init__(width: TeardropDefinitionWidth | None = None, *, height: TeardropDefinitionHeight | None = None, angle: TeardropDefinitionAngle | None = None) → None

property style: TeardropDefinitionStyle

property width: TeardropDefinitionWidth | None

property height: TeardropDefinitionHeight | None

property angle: TeardropDefinitionAngle | None

class keysight.ads.de.db.TeardropDefinitionAngle: Bases: object

class keysight.ads.de.db.TeardropDefinitionHeight: Bases: object

class keysight.ads.de.db.TeardropDefinitionWidth: Bases: object

class keysight.ads.de.db.TeardropLineInfo: Bases: object

class keysight.ads.de.db.TeardropTouching

Bases: object

property was_set_manually: bool: For testing.

copy() → TeardropTouching: Return a copy of this object.

class keysight.ads.de.db.Transform

__init__() → None

property matrix: MatrixForTransform

property preserves_aspect_ratio: bool

property preserves_mirroring: bool

property is_orthogonal: bool

property mirrored_in_x: bool

property mirrored_in_y: bool

scale(dx: float, dy: float) → None

mirror_x(mirror: bool = True) → None

mirror_y(mirror: bool = True) → None

clear() → None

translate(point: tuple[float, float] | PointF | None = None, *, dx: float | None = None, dy: float | None = None) → None

rotate_radians(radians: float) → None

rotate_degrees(degrees: float) → None

reverse() → None

multiply_transform(other: Transform) → Transform

transform_user_point(point: PointF) → PointF

transform_point(point: tuple[float, float]) → tuple[float, float]

transform_distance(distance: float) → float

transform_angle_radians(radians: float) → float

transform_angle_degrees(degrees: float) → float

get_transform_angle() → int

Enumerated Types

class keysight.ads.de.db.ArcOrientation

Defines the orientation of an arc or sequence of points.

Members:

CLOCKWISE : ‘Clockwise’: The orientation is clockwise.

ZERO : ‘Zero’: The orientation is unspecified or we don’t care.

COUNTER_CLOCKWISE : ‘CounterClockwise’: The orientation is counter-clockwise.

CLOCKWISE = <ArcOrientation.CLOCKWISE: -1>

COUNTER_CLOCKWISE = <ArcOrientation.COUNTER_CLOCKWISE: 1>

ZERO = <ArcOrientation.ZERO: 0>

__init__(self: keysight.ads.de._pde.ArcOrientation, value: int) → None

__new__(**kwargs)

property name

property str: Return the string representation of the orientation.

property value

class keysight.ads.de.db.BendStyle

Defines the style of a bend in a polyline or polygon.

Members:

SQUARE : ‘Square’: The bend has square corners.

CURVED : ‘Curved’: The bend has curved corners with a specified radius.

MITERED : ‘Mitered’: The bend has mitered corners - prefer AdaptiveMitered.

NEW_MITERED : ‘AdaptiveMitered’: Deprecated alias for ADAPTIVE_MITERED.

ADAPTIVE_MITERED : ‘AdaptiveMitered’: The bend has mitered corners with consistent cut length.

ROUNDED : ‘Rounded’: The bend has rounded corners.

EXACT_MITERED : ‘ExactMitered’: The bend has miter specified exactly - for internal use only.

ADAPTIVE_MITERED = <BendStyle.NEW_MITERED: 3>

CURVED = <BendStyle.CURVED: 1>

EXACT_MITERED = <BendStyle.EXACT_MITERED: 5>

MITERED = <BendStyle.MITERED: 2>

NEW_MITERED = <BendStyle.NEW_MITERED: 3>

ROUNDED = <BendStyle.ROUNDED: 4>

SQUARE = <BendStyle.SQUARE: 0>

__init__(self: keysight.ads.de._pde.BendStyle, value: int) → None

__new__(**kwargs)

property name

property str: Return the string representation of the bend style.

property value

class keysight.ads.de.db.CapStyle

Defines the style of polyline end caps.

Members:

SQUARE : ‘Square’: The end cap is square.

ROUND : ‘Round’: The end cap is round.

SQUARE_EXTENDED : ‘SquareExtended’: The end cap is square and extended by half the width.

CHAMFER : ‘Chamfer’: The end cap is chamfered.

CHAMFER = <CapStyle.CHAMFER: 3>

ROUND = <CapStyle.ROUND: 1>

SQUARE = <CapStyle.SQUARE: 0>

SQUARE_EXTENDED = <CapStyle.SQUARE_EXTENDED: 2>

__init__(self: keysight.ads.de._pde.CapStyle, value: int) → None

__new__(**kwargs)

property name

property str: Return the string representation of the end cap style.

property value

keysight.ads.de.db.LineInfoEnd: alias of End

class keysight.ads.de.db.TeardropDefinitionStyle

Bases: pybind11_object

Members:

NONE

WIDTH_AND_HEIGHT

WIDTH_TANGENT

TEARDROP_ANGLE

__init__(self: keysight.ads.de._pde.TeardropDefinitionStyle, value: int) → None

__new__(**kwargs)

property name

class keysight.ads.de.db.TeardropValueUnits

Bases: pybind11_object

Determines how a teardrop value is specified (ratio or absolute value).

Members:

VALUE : ‘Value’: The value is specified as an absolute value.

DB_UNITS : ‘Value’: Deprecated alias for VALUE.

RATIO : ‘Ratio’: The value is specified as a ratio.

__init__(self: keysight.ads.de._pde.TeardropValueUnits, value: int) → None

__new__(**kwargs)

property name

property str: Return the string representation of the TeardropValueUnits.

class keysight.ads.de.db.TouchType

Members:

NONE

CIRCLE

CIRCLE = <TouchType.CIRCLE: 1>

NONE = <TouchType.NONE: 0>

__init__(self: keysight.ads.de._pde.TouchType, value: int) → None

__new__(**kwargs)

property name

property value

On this page