read_contour_xld_dxfread_contour_xld_dxfReadContourXldDxfReadContourXldDxfread_contour_xld_dxf (Operator)
Name
read_contour_xld_dxfread_contour_xld_dxfReadContourXldDxfReadContourXldDxfread_contour_xld_dxf — Read XLD contours from a DXF file.
Signature
void ReadContourXldDxf(HObject* Contours, const HTuple& FileName, const HTuple& GenParamName, const HTuple& GenParamValue, HTuple* DxfStatus)
HTuple HXLDCont::ReadContourXldDxf(const HString& FileName, const HTuple& GenParamName, const HTuple& GenParamValue)
HString HXLDCont::ReadContourXldDxf(const HString& FileName, const HString& GenParamName, double GenParamValue)
HString HXLDCont::ReadContourXldDxf(const char* FileName, const char* GenParamName, double GenParamValue)
HString HXLDCont::ReadContourXldDxf(const wchar_t* FileName, const wchar_t* GenParamName, double GenParamValue)
(
Windows only)
def read_contour_xld_dxf(file_name: str, gen_param_name: MaybeSequence[str], gen_param_value: MaybeSequence[Union[int, str, float]]) -> Tuple[HObject, Sequence[str]]
def read_contour_xld_dxf_s(file_name: str, gen_param_name: MaybeSequence[str], gen_param_value: MaybeSequence[Union[int, str, float]]) -> Tuple[HObject, str]
Description
read_contour_xld_dxfread_contour_xld_dxfReadContourXldDxfReadContourXldDxfread_contour_xld_dxf reads the contents of the DXF file
FileNameFileNameFileNamefileNamefile_name (DXF version AC1009, AutoCAD Release 12) and
converts them to the XLD contours ContoursContoursContourscontourscontours.
If no absolute path is given in
FileNameFileNameFileNamefileNamefile_name the DXF file is searched in the current
directory of the HALCON process.
The output parameter DxfStatusDxfStatusDxfStatusdxfStatusdxf_status contains information about
the number of contours that were read and, if necessary,
warnings that parts of the DXF file could not be interpreted.
The operator read_contour_xld_dxfread_contour_xld_dxfReadContourXldDxfReadContourXldDxfread_contour_xld_dxf supports the following
DXF entities:
-
POLYLINE
-
LWPOLYLINE
-
LINE
-
POINT
-
CIRCLE
-
ARC
-
ELLIPSE
-
SPLINE
-
BLOCK
-
INSERT
The x and y coordinates of the DXF entities are stored in the column
and row coordinates, respectively, of the XLD contours
ContoursContoursContourscontourscontours. The z coordinates of the DXF entities are
ignored.
If the file has been created with the operator
write_contour_xld_dxfwrite_contour_xld_dxfWriteContourXldDxfWriteContourXldDxfwrite_contour_xld_dxf, all attributes and global attributes
that were originally defined for the XLD contours are read.
This means that read_contour_xld_dxfread_contour_xld_dxfReadContourXldDxfReadContourXldDxfread_contour_xld_dxf supports all the extended
data written by the operator write_contour_xld_dxfwrite_contour_xld_dxfWriteContourXldDxfWriteContourXldDxfwrite_contour_xld_dxf.
The reading of these attributes can be switched off by setting
the generic parameter 'read_attributes'"read_attributes""read_attributes""read_attributes""read_attributes" to
'false'"false""false""false""false". Generic parameters are set by specifying the
parameter name(s) in GenParamNameGenParamNameGenParamNamegenParamNamegen_param_name and the corresponding
value(s) in GenParamValueGenParamValueGenParamValuegenParamValuegen_param_value.
DXF entities of the type CIRCLE, ARC, ELLIPSE, and SPLINE
are approximated by XLD contours. The accuracy of this
approximation can be controlled with the two generic parameters
'min_num_points'"min_num_points""min_num_points""min_num_points""min_num_points" and 'max_approx_error'"max_approx_error""max_approx_error""max_approx_error""max_approx_error".
The parameter 'min_num_points'"min_num_points""min_num_points""min_num_points""min_num_points" defines the minimum
number of sampling points that are used for the approximation.
Note that the parameter 'min_num_points'"min_num_points""min_num_points""min_num_points""min_num_points" always refers to
the full circle or ellipse, respectively, even for ARCs or elliptical
arcs, i.e., if 'min_num_points'"min_num_points""min_num_points""min_num_points""min_num_points" is set to 50
and a DXF entity of the type ARC is read that represents a semi-circle,
this semi-circle is approximated by at least 25 sampling points.
The parameter 'max_approx_error'"max_approx_error""max_approx_error""max_approx_error""max_approx_error" defines the maximum
deviation of the XLD contour from the ideal
circle or ellipse, respectively (unit: pixel).
For the determination of the accuracy of the approximation
both criteria are evaluated. Then, the criterion that leads
to the more accurate approximation is used.
Internally, the following default values are used for the generic
parameters:
-
'read_attributes'"read_attributes""read_attributes""read_attributes""read_attributes" = 'true'"true""true""true""true"
-
'min_num_points'"min_num_points""min_num_points""min_num_points""min_num_points" = 20
-
'max_approx_error'"max_approx_error""max_approx_error""max_approx_error""max_approx_error" = 0.25
To achieve a more accurate approximation, either the value for
'min_num_points'"min_num_points""min_num_points""min_num_points""min_num_points" must be increased or the value for
'max_approx_error'"max_approx_error""max_approx_error""max_approx_error""max_approx_error" must be decreased.
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
ContoursContoursContourscontourscontours (output_object) xld_cont(-array) → objectHXLDContHObjectHObjectHobject *
Read XLD contours.
FileNameFileNameFileNamefileNamefile_name (input_control) filename.read → HTuplestrHTupleHtuple (string) (string) (HString) (char*)
Name of the DXF file.
File extension:
.dxf
GenParamNameGenParamNameGenParamNamegenParamNamegen_param_name (input_control) attribute.name(-array) → HTupleMaybeSequence[str]HTupleHtuple (string) (string) (HString) (char*)
Names of the generic parameters that can be
adjusted for the DXF input.
Default:
[]
List of values:
'max_approx_error'"max_approx_error""max_approx_error""max_approx_error""max_approx_error", 'min_num_points'"min_num_points""min_num_points""min_num_points""min_num_points", 'read_attributes'"read_attributes""read_attributes""read_attributes""read_attributes"
GenParamValueGenParamValueGenParamValuegenParamValuegen_param_value (input_control) attribute.value(-array) → HTupleMaybeSequence[Union[int, str, float]]HTupleHtuple (real / integer / string) (double / int / long / string) (double / Hlong / HString) (double / Hlong / char*)
Values of the generic parameters that can be
adjusted for the DXF input.
Default:
[]
Suggested values:
'true'"true""true""true""true", 'false'"false""false""false""false", 0.1, 0.25, 0.5, 1, 2, 5, 10, 20
DxfStatusDxfStatusDxfStatusdxfStatusdxf_status (output_control) string(-array) → HTupleSequence[str]HTupleHtuple (string) (string) (HString) (char*)
Status information.
Result
If the parameters are correct and the file could be read the
operator read_contour_xld_dxfread_contour_xld_dxfReadContourXldDxfReadContourXldDxfread_contour_xld_dxf returns the value 2 (
H_MSG_TRUE)
.
Otherwise, an exception is raised.
Possible Predecessors
write_contour_xld_dxfwrite_contour_xld_dxfWriteContourXldDxfWriteContourXldDxfwrite_contour_xld_dxf
See also
write_contour_xld_dxfwrite_contour_xld_dxfWriteContourXldDxfWriteContourXldDxfwrite_contour_xld_dxf,
read_polygon_xld_dxfread_polygon_xld_dxfReadPolygonXldDxfReadPolygonXldDxfread_polygon_xld_dxf,
query_contour_attribs_xldquery_contour_attribs_xldQueryContourAttribsXldQueryContourAttribsXldquery_contour_attribs_xld,
query_contour_global_attribs_xldquery_contour_global_attribs_xldQueryContourGlobalAttribsXldQueryContourGlobalAttribsXldquery_contour_global_attribs_xld,
get_contour_attrib_xldget_contour_attrib_xldGetContourAttribXldGetContourAttribXldget_contour_attrib_xld,
get_contour_global_attrib_xldget_contour_global_attrib_xldGetContourGlobalAttribXldGetContourGlobalAttribXldget_contour_global_attrib_xld
Module
Foundation