distance_lcDistanceLcDistanceLcdistance_lcdistance_lc
Short description
distance_lcDistanceLcDistanceLcdistance_lcdistance_lc — Calculate the distance between a line and one contour.
Signature
distance_lc( xld_cont Contour, point.y Row1, point.x Column1, point.y Row2, point.x Column2, out real DistanceMin, out real DistanceMax )void DistanceLc( const HObject& Contour, const HTuple& Row1, const HTuple& Column1, const HTuple& Row2, const HTuple& Column2, HTuple* DistanceMin, HTuple* DistanceMax )static void HOperatorSet.DistanceLc( HObject contour, HTuple row1, HTuple column1, HTuple row2, HTuple column2, out HTuple distanceMin, out HTuple distanceMax )def distance_lc( contour: HObject, row_1: MaybeSequence[Union[float, int]], column_1: MaybeSequence[Union[float, int]], row_2: MaybeSequence[Union[float, int]], column_2: MaybeSequence[Union[float, int]] ) -> Tuple[Sequence[float], Sequence[float]]
def distance_lc_s( contour: HObject, row_1: MaybeSequence[Union[float, int]], column_1: MaybeSequence[Union[float, int]], row_2: MaybeSequence[Union[float, int]], column_2: MaybeSequence[Union[float, int]] ) -> Tuple[float, float]Herror distance_lc( const Hobject Contour, double Row1, double Column1, double Row2, double Column2, double* DistanceMin, double* DistanceMax )
Herror T_distance_lc( const Hobject Contour, const Htuple Row1, const Htuple Column1, const Htuple Row2, const Htuple Column2, Htuple* DistanceMin, Htuple* DistanceMax )
void HXLDCont::DistanceLc( const HTuple& Row1, const HTuple& Column1, const HTuple& Row2, const HTuple& Column2, HTuple* DistanceMin, HTuple* DistanceMax ) const
void HXLDCont::DistanceLc( double Row1, double Column1, double Row2, double Column2, double* DistanceMin, double* DistanceMax ) const
void HXLDCont.DistanceLc( HTuple row1, HTuple column1, HTuple row2, HTuple column2, out HTuple distanceMin, out HTuple distanceMax )
void HXLDCont.DistanceLc( double row1, double column1, double row2, double column2, out double distanceMin, out double distanceMax )
Description
The operator distance_lcDistanceLc calculates the orthogonal
distance between a line and the segments of a contour.
As input the coordinates of two points on a line
(Row1row1row_1,Column1column1column_1,
Row2row2row_2,Column2column2column_2) and a contour (Contourcontourcontour)
are expected.
The parameters DistanceMindistanceMindistance_min and DistanceMaxdistanceMaxdistance_max
return the result of the calculation.
Parameter Broadcasting
This operator supports parameter broadcasting.
This means that each parameter can be given as a tuple of length
1 or N.
Parameters with tuple length 1 will be repeated internally
such that the number of distances is always N.
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
Contourcontourcontour (input_object) xld_cont(-array) → objectHObjectHXLDContHObjectHobject
Input contour.
Row1row1row_1 (input_control) point.y(-array) → (real / integer)HTuple (double / Hlong)HTuple (double / int / long)MaybeSequence[Union[float, int]]Htuple (double / Hlong)
Row coordinate of the first point of the line.
Column1column1column_1 (input_control) point.x(-array) → (real / integer)HTuple (double / Hlong)HTuple (double / int / long)MaybeSequence[Union[float, int]]Htuple (double / Hlong)
Column coordinate of the first point of the line.
Row2row2row_2 (input_control) point.y(-array) → (real / integer)HTuple (double / Hlong)HTuple (double / int / long)MaybeSequence[Union[float, int]]Htuple (double / Hlong)
Row coordinate of the second point of the line.
Column2column2column_2 (input_control) point.x(-array) → (real / integer)HTuple (double / Hlong)HTuple (double / int / long)MaybeSequence[Union[float, int]]Htuple (double / Hlong)
Column coordinate of the second point of the line.
DistanceMindistanceMindistance_min (output_control) real(-array) → (real)HTuple (double)HTuple (double)Sequence[float]Htuple (double)
Minimum distance between the line and the contour.
DistanceMaxdistanceMaxdistance_max (output_control) real(-array) → (real)HTuple (double)HTuple (double)Sequence[float]Htuple (double)
Maximum distance between the line and the contour.
Result
distance_lcDistanceLc returns 2 (H_MSG_TRUE).
Combinations with other operators
Combinations
Alternatives
distance_pcDistancePc, distance_scDistanceSc, distance_ccDistanceCc, distance_cc_minDistanceCcMin
See also
distance_lrDistanceLr, distance_prDistancePr, distance_srDistanceSr
Module
Foundation