weldx.DynamicTraceSegment#
- class weldx.DynamicTraceSegment(series, max_coord=1, limit_orientation_to_xy=False, **kwargs)#
Trace segment that can be defined by a
SpatialSeries
.Initialize a
DynamicTraceSegment
.- Parameters:
series (
Union
[SpatialSeries
,Quantity
,DataArray
,str
,MathematicalExpression
]) – ASpatialSeries
that describes the trajectory of the trace segment. Alternatively, one can pass every other object that is valid as first argument to of the__init__
method of theSpatialSeries
.max_coord (
float
) – [only expression basedSpatialSeries
] The maximum coordinate value of the passed series dimension that specifies the position on the 3d line. The value defines the segments length by evaluating the expression on the interval [0,max_coord
]limit_orientation_to_xy (
bool
) – IfTrue
, the orientation vectors of the coordinate systems along the trace are confined to the xy-plane.kwargs – A set of keyword arguments that will be forwarded to the
__init__
method of theSpatialSeries
in case theseries
parameter isn’t already aSpatialSeries
.
Methods
Get an array of the points at the specified relative positions.
Get the length from the start of the segment to the passed relative position.
Calculate a local coordinate system at a position of the trace segment.
Attributes
Get the length of the segment.