Skip to content

gen_ellipse_contour_xldgen_ellipse_contour_xldGenEllipseContourXldGenEllipseContourXldgen_ellipse_contour_xldgen_ellipse_contour_xld🔗

Short description🔗

gen_ellipse_contour_xldgen_ellipse_contour_xldGenEllipseContourXldGenEllipseContourXldgen_ellipse_contour_xldgen_ellipse_contour_xld — Create an XLD contour that corresponds to an elliptic arc.

Signature🔗

gen_ellipse_contour_xld( out xld_cont ContEllipse, ellipse.center.y Row, ellipse.center.x Column, ellipse.angle.rad Phi, ellipse.radius1 Radius1, ellipse.radius2 Radius2, angle.rad StartPhi, angle.rad EndPhi, string PointOrder, real Resolution )gen_ellipse_contour_xld( : ContEllipse : Row, Column, Phi, Radius1, Radius2, StartPhi, EndPhi, PointOrder, Resolution : )void GenEllipseContourXld( HObject* ContEllipse, const HTuple& Row, const HTuple& Column, const HTuple& Phi, const HTuple& Radius1, const HTuple& Radius2, const HTuple& StartPhi, const HTuple& EndPhi, const HTuple& PointOrder, const HTuple& Resolution )static void HOperatorSet.GenEllipseContourXld( out HObject contEllipse, HTuple row, HTuple column, HTuple phi, HTuple radius1, HTuple radius2, HTuple startPhi, HTuple endPhi, HTuple pointOrder, HTuple resolution )def gen_ellipse_contour_xld( row: MaybeSequence[float], column: MaybeSequence[float], phi: MaybeSequence[float], radius_1: MaybeSequence[float], radius_2: MaybeSequence[float], start_phi: MaybeSequence[float], end_phi: MaybeSequence[float], point_order: MaybeSequence[str], resolution: float ) -> HObject

Herror gen_ellipse_contour_xld( Hobject* ContEllipse, double Row, double Column, double Phi, double Radius1, double Radius2, double StartPhi, double EndPhi, const char* PointOrder, double Resolution )

Herror T_gen_ellipse_contour_xld( Hobject* ContEllipse, const Htuple Row, const Htuple Column, const Htuple Phi, const Htuple Radius1, const Htuple Radius2, const Htuple StartPhi, const Htuple EndPhi, const Htuple PointOrder, const Htuple Resolution )

void HXLDCont::GenEllipseContourXld( const HTuple& Row, const HTuple& Column, const HTuple& Phi, const HTuple& Radius1, const HTuple& Radius2, const HTuple& StartPhi, const HTuple& EndPhi, const HTuple& PointOrder, double Resolution )

void HXLDCont::GenEllipseContourXld( double Row, double Column, double Phi, double Radius1, double Radius2, double StartPhi, double EndPhi, const HString& PointOrder, double Resolution )

void HXLDCont::GenEllipseContourXld( double Row, double Column, double Phi, double Radius1, double Radius2, double StartPhi, double EndPhi, const char* PointOrder, double Resolution )

void HXLDCont::GenEllipseContourXld( double Row, double Column, double Phi, double Radius1, double Radius2, double StartPhi, double EndPhi, const wchar_t* PointOrder, double Resolution ) (Windows only)

void HXLDCont.GenEllipseContourXld( HTuple row, HTuple column, HTuple phi, HTuple radius1, HTuple radius2, HTuple startPhi, HTuple endPhi, HTuple pointOrder, double resolution )

void HXLDCont.GenEllipseContourXld( double row, double column, double phi, double radius1, double radius2, double startPhi, double endPhi, string pointOrder, double resolution )

Description🔗

gen_ellipse_contour_xldGenEllipseContourXld creates one or more elliptic arcs or closed ellipses. Ellipses are specified by their center (Rowrowrow, Columncolumncolumn), the orientation of the main axis Phiphiphi, the length of the larger half axis Radius1radius1radius_1, and the length of the smaller half axis Radius2radius2radius_2. In addition to that, elliptic arcs are characterized by the angle of the start point StartPhistartPhistart_phi, the angle of the end point EndPhiendPhiend_phi, and the point order PointOrderpointOrderpoint_order along the boundary. Both the angle of the start point and the angle of the end point are measured from the positive main axis specified with Phiphiphi. They correspond to the smallest surrounding circle of the ellipse. The actual start and end point of the ellipse is the intersection of the ellipse with the orthogonal projection of the corresponding circle point onto the main axis. Both angles refer to the coordinate system of the ellipse, i.e. relative to the main axis and in a mathematical positive direction. Thus, the two main poles correspond to the angles 0 and \(\pi\), the two minor poles to the angles \(\pi/2\) and \(3\pi/2\). To create a closed ellipse the values 0 and \(2\pi\) (with positive point order) have to be passed to the operator. All angles Phiphiphi, StartPhistartPhistart_phi, EndPhiendPhiend_phi take arbitrary values and are mapped internally to the interval \([0,2\pi]\). The resolution of the resulting contours ContEllipsecontEllipsecont_ellipse is controlled via Resolutionresolutionresolution containing the maximum Euclidean distance between neighboring contour points. The resolution is set to the smallest valid value, if the input value falls below this value.

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 created items is always N.

Execution information🔗

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🔗

ContEllipsecontEllipsecont_ellipse (output_object) xld_cont(-array) → objectobjectHObjectHXLDContHObjectHobject *

Resulting contour.

Rowrowrow (input_control) ellipse.center.y(-array) → (real)(real)HTuple (double)HTuple (double)MaybeSequence[float]Htuple (double)

Row coordinate of the center of the ellipse.

Default: 200.0200.0

Columncolumncolumn (input_control) ellipse.center.x(-array) → (real)(real)HTuple (double)HTuple (double)MaybeSequence[float]Htuple (double)

Column coordinate of the center of the ellipse.

Default: 200.0200.0

Phiphiphi (input_control) ellipse.angle.rad(-array) → (real)(real)HTuple (double)HTuple (double)MaybeSequence[float]Htuple (double)

Orientation of the main axis [rad].

Default: 0.00.0

Radius1radius1radius_1 (input_control) ellipse.radius1(-array) → (real)(real)HTuple (double)HTuple (double)MaybeSequence[float]Htuple (double)

Length of the larger half axis.

Default: 100.0100.0
Restriction: Radius1 > 0

Radius2radius2radius_2 (input_control) ellipse.radius2(-array) → (real)(real)HTuple (double)HTuple (double)MaybeSequence[float]Htuple (double)

Length of the smaller half axis.

Default: 50.050.0
Restriction: Radius2 >= 0 && Radius2 <= Radius1

StartPhistartPhistart_phi (input_control) angle.rad(-array) → (real)(real)HTuple (double)HTuple (double)MaybeSequence[float]Htuple (double)

Angle of the start point on the smallest surrounding circle [rad].

Default: 0.00.0

EndPhiendPhiend_phi (input_control) angle.rad(-array) → (real)(real)HTuple (double)HTuple (double)MaybeSequence[float]Htuple (double)

Angle of the end point on the smallest surrounding circle [rad].

Default: 6.283186.28318

PointOrderpointOrderpoint_order (input_control) string(-array) → (string)(string)HTuple (HString)HTuple (string)MaybeSequence[str]Htuple (char*)

point order along the boundary.

Default: 'positive'"positive"
List of values: 'negative', 'positive'"negative", "positive"

Resolutionresolutionresolution (input_control) real → (real)(real)HTuple (double)HTuple (double)floatHtuple (double)

Resolution: Maximum distance between neighboring contour points.

Default: 1.51.5
Restriction: Resolution >= 1.192e-7

Example🔗

(HDevelop)


draw_ellipse(WindowHandle,Row,Column,Phi,Radius1,Radius2)
gen_ellipse_contour_xld(Ellipse,Row,Column,Phi,Radius1,Radius2,0,6.28319, \
                        'positive',1.5)
length_xld(Ellipse,Length)
* Transform StartPhi so that the start point of the ellipse actually
* intersects the line through origin at the angle StartPhi measured from
* the positive main axis
affine_trans_point_2d ([1.0,0.0,0.0,0.0,1.0*Radius2/Radius1,0.0], \
                       sin(StartPhi), cos(StartPhi), Qx, Qy)
StartPhiEllipse := atan2(Qx,Qy)
(C)
draw_ellipse(WindowHandle,&Row,&Column,&Phi,&Radius1,&Radius2)\;
gen_ellipse_contour_xld(&Ellipse,Row,Column,Phi,Radius1,Radius2,0,6.28319,
                        "positive")\;
length_xld(Ellipse,&Length)\;

Result🔗

gen_ellipse_contour_xldGenEllipseContourXld returns 2 (H_MSG_TRUE) if all parameter values are correct. If necessary, an exception is raised.

Combinations with other operators🔗

Combinations

Possible predecessors

draw_ellipseDrawEllipse

Possible successors

disp_xldDispXld, get_points_ellipseGetPointsEllipse

Alternatives

gen_circle_contour_xldGenCircleContourXld

Module🔗

Foundation