distance_point_linedistance_point_lineDistancePointLineDistancePointLinedistance_point_linedistance_point_line
Short description
distance_point_linedistance_point_lineDistancePointLineDistancePointLinedistance_point_linedistance_point_line — Calculate the distance between a 3D point and a 3D line given by two
points on the line.
Signature
distance_point_line( point3d.x PointX, point3d.y PointY, point3d.z PointZ, point3d.x Point1X, point3d.y Point1Y, point3d.z Point1Z, point3d.x Point2X, point3d.y Point2Y, point3d.z Point2Z, out real Distance )distance_point_line( : : PointX, PointY, PointZ, Point1X, Point1Y, Point1Z, Point2X, Point2Y, Point2Z : Distance )void DistancePointLine( const HTuple& PointX, const HTuple& PointY, const HTuple& PointZ, const HTuple& Point1X, const HTuple& Point1Y, const HTuple& Point1Z, const HTuple& Point2X, const HTuple& Point2Y, const HTuple& Point2Z, HTuple* Distance )static void HOperatorSet.DistancePointLine( HTuple pointX, HTuple pointY, HTuple pointZ, HTuple point1X, HTuple point1Y, HTuple point1Z, HTuple point2X, HTuple point2Y, HTuple point2Z, out HTuple distance )def distance_point_line( point_x: MaybeSequence[float], point_y: MaybeSequence[float], point_z: MaybeSequence[float], point_1x: MaybeSequence[Union[float, int]], point_1y: MaybeSequence[Union[float, int]], point_1z: MaybeSequence[Union[float, int]], point_2x: MaybeSequence[Union[float, int]], point_2y: MaybeSequence[Union[float, int]], point_2z: MaybeSequence[Union[float, int]] ) -> Sequence[float]
def distance_point_line_s( point_x: MaybeSequence[float], point_y: MaybeSequence[float], point_z: MaybeSequence[float], point_1x: MaybeSequence[Union[float, int]], point_1y: MaybeSequence[Union[float, int]], point_1z: MaybeSequence[Union[float, int]], point_2x: MaybeSequence[Union[float, int]], point_2y: MaybeSequence[Union[float, int]], point_2z: MaybeSequence[Union[float, int]] ) -> floatHerror distance_point_line( double PointX, double PointY, double PointZ, double Point1X, double Point1Y, double Point1Z, double Point2X, double Point2Y, double Point2Z, double* Distance )
Herror T_distance_point_line( const Htuple PointX, const Htuple PointY, const Htuple PointZ, const Htuple Point1X, const Htuple Point1Y, const Htuple Point1Z, const Htuple Point2X, const Htuple Point2Y, const Htuple Point2Z, Htuple* Distance )
static HTuple HMisc::DistancePointLine( const HTuple& PointX, const HTuple& PointY, const HTuple& PointZ, const HTuple& Point1X, const HTuple& Point1Y, const HTuple& Point1Z, const HTuple& Point2X, const HTuple& Point2Y, const HTuple& Point2Z )
static double HMisc::DistancePointLine( double PointX, double PointY, double PointZ, double Point1X, double Point1Y, double Point1Z, double Point2X, double Point2Y, double Point2Z )
static HTuple HMisc.DistancePointLine( HTuple pointX, HTuple pointY, HTuple pointZ, HTuple point1X, HTuple point1Y, HTuple point1Z, HTuple point2X, HTuple point2Y, HTuple point2Z )
static double HMisc.DistancePointLine( double pointX, double pointY, double pointZ, double point1X, double point1Y, double point1Z, double point2X, double point2Y, double point2Z )
Description
distance_point_lineDistancePointLine calculates the orthogonal distance
between 3D points and 3D lines. The lines are specified by two
points on the line (\(\mathbf{Q}\) and \(\mathbf{R}\)).
The result is returned in Distancedistancedistance.
The input tuples can define 1 or n points.
The points are specified by
(PointXpointXpoint_x, PointYpointYpoint_y, PointZpointZpoint_z).
The line is specified by two points on the line
(Point1Xpoint1Xpoint_1x, Point1Ypoint1Ypoint_1y, Point1Zpoint1Zpoint_1z) and
(Point2Xpoint2Xpoint_2x, Point2Ypoint2Ypoint_2y, Point2Zpoint2Zpoint_2z).
Let \(\mathbf{P}\) denote the point
(PointXpointXpoint_x, PointYpointYpoint_y, PointZpointZpoint_z),
\(\mathbf{Q}\) the first point
(Point1Xpoint1Xpoint_1x, Point1Ypoint1Ypoint_1y, Point1Zpoint1Zpoint_1z) on the line, and
\(\mathbf{R}\) the second point
(Point2Xpoint2Xpoint_2x, Point2Ypoint2Ypoint_2y, Point2Zpoint2Zpoint_2z) on the line.
First, the line direction
\(\mathbf{V} = \mathbf{R} - \mathbf{Q}\) and
its length \(\|\mathbf{V}\|\) are computed.
If \(\|\mathbf{V}\| = 0\), the points \(\mathbf{Q}\) and
\(\mathbf{R}\) do not define a line and an error is returned.
Furthermore, let \(D\) denote the distance Distancedistancedistance. Then,
\(D = \| (\mathbf{P} - \mathbf{Q}) \times \mathbf{V} \| / \|\mathbf{V}\|\),
where \(\times\) denotes the cross product of two vectors.
Execution information
-
Multithreading type: reentrant (runs in parallel with non-exclusive operators).
-
Multithreading scope: global (may be called from any thread).
-
Processed without parallelization.
Parameters
PointXpointXpoint_x (input_control) point3d.x(-array) → (real)(real)HTuple (double)HTuple (double)MaybeSequence[float]Htuple (double)
X coordinate of the original points.
PointYpointYpoint_y (input_control) point3d.y(-array) → (real)(real)HTuple (double)HTuple (double)MaybeSequence[float]Htuple (double)
Y coordinate of the original points.
PointZpointZpoint_z (input_control) point3d.z(-array) → (real)(real)HTuple (double)HTuple (double)MaybeSequence[float]Htuple (double)
Z coordinate of the original points.
Point1Xpoint1Xpoint_1x (input_control) point3d.x(-array) → (real / integer)(real / integer)HTuple (double / Hlong)HTuple (double / int / long)MaybeSequence[Union[float, int]]Htuple (double / Hlong)
X coordinate of the first point on the line.
Point1Ypoint1Ypoint_1y (input_control) point3d.y(-array) → (real / integer)(real / integer)HTuple (double / Hlong)HTuple (double / int / long)MaybeSequence[Union[float, int]]Htuple (double / Hlong)
Y coordinate of the first point on the line.
Point1Zpoint1Zpoint_1z (input_control) point3d.z(-array) → (real / integer)(real / integer)HTuple (double / Hlong)HTuple (double / int / long)MaybeSequence[Union[float, int]]Htuple (double / Hlong)
Z coordinate of the first point on the line.
Point2Xpoint2Xpoint_2x (input_control) point3d.x(-array) → (real / integer)(real / integer)HTuple (double / Hlong)HTuple (double / int / long)MaybeSequence[Union[float, int]]Htuple (double / Hlong)
X coordinate of the second point on the line.
Point2Ypoint2Ypoint_2y (input_control) point3d.y(-array) → (real / integer)(real / integer)HTuple (double / Hlong)HTuple (double / int / long)MaybeSequence[Union[float, int]]Htuple (double / Hlong)
Y coordinate of the second point on the line.
Point2Zpoint2Zpoint_2z (input_control) point3d.z(-array) → (real / integer)(real / integer)HTuple (double / Hlong)HTuple (double / int / long)MaybeSequence[Union[float, int]]Htuple (double / Hlong)
Z coordinate of the second point on the line.
Distancedistancedistance (output_control) real(-array) → (real)(real)HTuple (double)HTuple (double)Sequence[float]Htuple (double)
Distance between the points and the lines.
Combinations with other operators
Combinations
Possible predecessors
get_line_of_sightGetLineOfSight
Alternatives
distance_point_pluecker_lineDistancePointPlueckerLine
See also
point_pluecker_line_to_hom_mat3dPointPlueckerLineToHomMat3d
Module
Foundation