Operator Reference

distance_lcdistance_lcDistanceLcDistanceLcdistance_lc (Operator)

distance_lcdistance_lcDistanceLcDistanceLcdistance_lc — Calculate the distance between a line and one contour.

Signature

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 DistanceLc(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

static void HOperatorSet.DistanceLc(HObject contour, HTuple row1, HTuple column1, HTuple row2, HTuple column2, out HTuple distanceMin, out HTuple distanceMax)

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)

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]

Description

The operator distance_lcdistance_lcDistanceLcDistanceLcdistance_lc calculates the orthogonal distance between a line and the segments of a contour. As input the coordinates of two points on a line (Row1Row1Row1row1row_1,Column1Column1Column1column1column_1, Row2Row2Row2row2row_2,Column2Column2Column2column2column_2) and a contour (ContourContourContourcontourcontour) are expected. The parameters DistanceMinDistanceMinDistanceMindistanceMindistance_min and DistanceMaxDistanceMaxDistanceMaxdistanceMaxdistance_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

ContourContourContourcontourcontour (input_object)  xld_cont(-array) objectHXLDContHObjectHObjectHobject

Input contour.

Row1Row1Row1row1row_1 (input_control)  point.y(-array) HTupleMaybeSequence[Union[float, int]]HTupleHtuple (real / integer) (double / int / long) (double / Hlong) (double / Hlong)

Row coordinate of the first point of the line.

Column1Column1Column1column1column_1 (input_control)  point.x(-array) HTupleMaybeSequence[Union[float, int]]HTupleHtuple (real / integer) (double / int / long) (double / Hlong) (double / Hlong)

Column coordinate of the first point of the line.

Row2Row2Row2row2row_2 (input_control)  point.y(-array) HTupleMaybeSequence[Union[float, int]]HTupleHtuple (real / integer) (double / int / long) (double / Hlong) (double / Hlong)

Row coordinate of the second point of the line.

Column2Column2Column2column2column_2 (input_control)  point.x(-array) HTupleMaybeSequence[Union[float, int]]HTupleHtuple (real / integer) (double / int / long) (double / Hlong) (double / Hlong)

Column coordinate of the second point of the line.

DistanceMinDistanceMinDistanceMindistanceMindistance_min (output_control)  real(-array) HTupleSequence[float]HTupleHtuple (real) (double) (double) (double)

Minimum distance between the line and the contour.

DistanceMaxDistanceMaxDistanceMaxdistanceMaxdistance_max (output_control)  real(-array) HTupleSequence[float]HTupleHtuple (real) (double) (double) (double)

Maximum distance between the line and the contour.

Result

distance_lcdistance_lcDistanceLcDistanceLcdistance_lc returns 2 ( H_MSG_TRUE) .

Alternatives

distance_pcdistance_pcDistancePcDistancePcdistance_pc, distance_scdistance_scDistanceScDistanceScdistance_sc, distance_ccdistance_ccDistanceCcDistanceCcdistance_cc, distance_cc_mindistance_cc_minDistanceCcMinDistanceCcMindistance_cc_min

See also

distance_lrdistance_lrDistanceLrDistanceLrdistance_lr, distance_prdistance_prDistancePrDistancePrdistance_pr, distance_srdistance_srDistanceSrDistanceSrdistance_sr

Module

Foundation