remove_object_model_3d_attribT_remove_object_model_3d_attribRemoveObjectModel3dAttribRemoveObjectModel3dAttribremove_object_model_3d_attrib (Operator)
Name
remove_object_model_3d_attribT_remove_object_model_3d_attribRemoveObjectModel3dAttribRemoveObjectModel3dAttribremove_object_model_3d_attrib — Remove attributes of a 3D object model.
Signature
Description
remove_object_model_3d_attribremove_object_model_3d_attribRemoveObjectModel3dAttribRemoveObjectModel3dAttribRemoveObjectModel3dAttribremove_object_model_3d_attrib copies the 3d object model
ObjectModel3DObjectModel3DObjectModel3DObjectModel3DobjectModel3Dobject_model_3d and removes within this copy the standard and/or
extended attributes given in AttributesAttributesAttributesAttributesattributesattributes.
The new 3d object model is returned in ObjectModel3DOutObjectModel3DOutObjectModel3DOutObjectModel3DOutobjectModel3DOutobject_model_3dout.
Doing so does not modify the 3d object model ObjectModel3DObjectModel3DObjectModel3DObjectModel3DobjectModel3Dobject_model_3d but a
new model is created. This is in contrast to the
operator remove_object_model_3d_attrib_modremove_object_model_3d_attrib_modRemoveObjectModel3dAttribModRemoveObjectModel3dAttribModRemoveObjectModel3dAttribModremove_object_model_3d_attrib_mod, which modifies the input
model but functions identically otherwise.
If the AttributesAttributesAttributesAttributesattributesattributes do not exist in ObjectModel3DObjectModel3DObjectModel3DObjectModel3DobjectModel3Dobject_model_3d, no
exception is raised.
Standard attributes
The following values for the parameter AttributesAttributesAttributesAttributesattributesattributes are possible:
- 'point_normal'"point_normal""point_normal""point_normal""point_normal""point_normal":
-
This value specifies that the
attribute with the 3D point normals and the attribute with the
3D point coordinates are removed.
- 'triangles'"triangles""triangles""triangles""triangles""triangles":
-
This value specifies that the
attribute with the face triangles is removed.
- 'polygons'"polygons""polygons""polygons""polygons""polygons":
-
This value specifies that the
attribute with the face polygon is removed.
- 'lines'"lines""lines""lines""lines""lines":
-
This value specifies that the
attribute with the lines is removed.
- 'xyz_mapping'"xyz_mapping""xyz_mapping""xyz_mapping""xyz_mapping""xyz_mapping":
-
This value specifies that the
attribute with the mapping to image coordinates is removed.
- 'extended_attribute'"extended_attribute""extended_attribute""extended_attribute""extended_attribute""extended_attribute":
-
This value specifies that all
user-defined extended attributes are removed.
- 'primitives_all'"primitives_all""primitives_all""primitives_all""primitives_all""primitives_all":
-
This value specifies that the
attribute with the parameters of the primitive (including an empty
primitive) is removed (e.g., obtained from
the operator fit_primitives_object_model_3dfit_primitives_object_model_3dFitPrimitivesObjectModel3dFitPrimitivesObjectModel3dFitPrimitivesObjectModel3dfit_primitives_object_model_3d).
- 'primitive_plane'"primitive_plane""primitive_plane""primitive_plane""primitive_plane""primitive_plane":
-
This value specifies that the
attribute with the primitive plane is removed (e.g., obtained from
the operator fit_primitives_object_model_3dfit_primitives_object_model_3dFitPrimitivesObjectModel3dFitPrimitivesObjectModel3dFitPrimitivesObjectModel3dfit_primitives_object_model_3d).
- 'primitive_sphere'"primitive_sphere""primitive_sphere""primitive_sphere""primitive_sphere""primitive_sphere":
-
This value specifies that the
attribute with the primitive sphere is removed (e.g., obtained from
the operator fit_primitives_object_model_3dfit_primitives_object_model_3dFitPrimitivesObjectModel3dFitPrimitivesObjectModel3dFitPrimitivesObjectModel3dfit_primitives_object_model_3d).
- 'primitive_cylinder'"primitive_cylinder""primitive_cylinder""primitive_cylinder""primitive_cylinder""primitive_cylinder":
-
This value specifies that the
attribute with the primitive cylinder is removed (e.g., obtained from
the operator fit_primitives_object_model_3dfit_primitives_object_model_3dFitPrimitivesObjectModel3dFitPrimitivesObjectModel3dFitPrimitivesObjectModel3dfit_primitives_object_model_3d).
- 'primitive_box'"primitive_box""primitive_box""primitive_box""primitive_box""primitive_box":
-
This value specifies that the
attribute with the primitive cylinder is removed.
- 'shape_based_matching_3d_data'"shape_based_matching_3d_data""shape_based_matching_3d_data""shape_based_matching_3d_data""shape_based_matching_3d_data""shape_based_matching_3d_data":
-
This value
specifies that the attribute with the prepared shape model for
shape-based 3D matching is removed.
- 'distance_computation_data'"distance_computation_data""distance_computation_data""distance_computation_data""distance_computation_data""distance_computation_data":
-
This value
specifies that the attribute with the distance computation data
structure is removed.
The distance computation data can be created with
prepare_object_model_3dprepare_object_model_3dPrepareObjectModel3dPrepareObjectModel3dPrepareObjectModel3dprepare_object_model_3d, and can be used with
distance_object_model_3ddistance_object_model_3dDistanceObjectModel3dDistanceObjectModel3dDistanceObjectModel3ddistance_object_model_3d.
- 'score'"score""score""score""score""score":
-
This value specifies that the
attribute with the scores is removed. Scores may be obtained from the
operator reconstruct_surface_stereoreconstruct_surface_stereoReconstructSurfaceStereoReconstructSurfaceStereoReconstructSurfaceStereoreconstruct_surface_stereo.
- 'red'"red""red""red""red""red":
-
This value specifies that the attribute containing
the red color is removed.
- 'green'"green""green""green""green""green":
-
This value specifies that the attribute containing
the green color is removed.
- 'blue'"blue""blue""blue""blue""blue":
-
This value specifies that the attribute containing
the blue color is removed.
- 'original_point_indices'"original_point_indices""original_point_indices""original_point_indices""original_point_indices""original_point_indices":
-
This value specifies that the
attribute with the original point indices is removed. Original point
indices may be obtained from the operator
triangulate_object_model_3dtriangulate_object_model_3dTriangulateObjectModel3dTriangulateObjectModel3dTriangulateObjectModel3dtriangulate_object_model_3d.
- 'all'"all""all""all""all""all":
This value specifies that all available
attributes are removed except for the point coordinates. That is, the
attributes are the point normals, the face triangles, the face polygons,
the mapping to image coordinates, the shape model for matching, the
parameter of a primitive, and the extended attributes.
Extended attributes are attributes, that can be derived from
standard attributes by special operators (e.g.,
distance_object_model_3ddistance_object_model_3dDistanceObjectModel3dDistanceObjectModel3dDistanceObjectModel3ddistance_object_model_3d), or user-defined attributes
(set with set_object_model_3d_attribset_object_model_3d_attribSetObjectModel3dAttribSetObjectModel3dAttribSetObjectModel3dAttribset_object_model_3d_attrib or
set_object_model_3d_attrib_modset_object_model_3d_attrib_modSetObjectModel3dAttribModSetObjectModel3dAttribModSetObjectModel3dAttribModset_object_model_3d_attrib_mod).
The extended attributes can be removed by setting their names in
AttributesAttributesAttributesAttributesattributesattributes.
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
ObjectModel3DObjectModel3DObjectModel3DObjectModel3DobjectModel3Dobject_model_3d (input_control) object_model_3d → HObjectModel3D, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)
Handle of the input 3D object model.
AttributesAttributesAttributesAttributesattributesattributes (input_control) string(-array) → HTupleMaybeSequence[str]HTupleHtuple (string) (string) (HString) (char*)
Name of the attributes to be removed.
Default value:
'extended_attribute'
"extended_attribute"
"extended_attribute"
"extended_attribute"
"extended_attribute"
"extended_attribute"
List of values: 'all'"all""all""all""all""all", 'blue'"blue""blue""blue""blue""blue", 'distance_computation_data'"distance_computation_data""distance_computation_data""distance_computation_data""distance_computation_data""distance_computation_data", 'extended_attribute'"extended_attribute""extended_attribute""extended_attribute""extended_attribute""extended_attribute", 'green'"green""green""green""green""green", 'lines'"lines""lines""lines""lines""lines", 'original_point_indices'"original_point_indices""original_point_indices""original_point_indices""original_point_indices""original_point_indices", 'point_normal'"point_normal""point_normal""point_normal""point_normal""point_normal", 'polygons'"polygons""polygons""polygons""polygons""polygons", 'primitive_box'"primitive_box""primitive_box""primitive_box""primitive_box""primitive_box", 'primitive_cylinder'"primitive_cylinder""primitive_cylinder""primitive_cylinder""primitive_cylinder""primitive_cylinder", 'primitive_plane'"primitive_plane""primitive_plane""primitive_plane""primitive_plane""primitive_plane", 'primitive_sphere'"primitive_sphere""primitive_sphere""primitive_sphere""primitive_sphere""primitive_sphere", 'primitives_all'"primitives_all""primitives_all""primitives_all""primitives_all""primitives_all", 'red'"red""red""red""red""red", 'score'"score""score""score""score""score", 'shape_based_matching_3d_data'"shape_based_matching_3d_data""shape_based_matching_3d_data""shape_based_matching_3d_data""shape_based_matching_3d_data""shape_based_matching_3d_data", 'triangles'"triangles""triangles""triangles""triangles""triangles", 'xyz_mapping'"xyz_mapping""xyz_mapping""xyz_mapping""xyz_mapping""xyz_mapping"
ObjectModel3DOutObjectModel3DOutObjectModel3DOutObjectModel3DOutobjectModel3DOutobject_model_3dout (output_control) object_model_3d → HObjectModel3D, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)
Handle of the resulting 3D object model.
Result
If the parameters are valid, the operator
remove_object_model_3d_attribremove_object_model_3d_attribRemoveObjectModel3dAttribRemoveObjectModel3dAttribRemoveObjectModel3dAttribremove_object_model_3d_attrib returns the value TRUE.
If necessary, an exception is raised.
Possible Predecessors
set_object_model_3d_attribset_object_model_3d_attribSetObjectModel3dAttribSetObjectModel3dAttribSetObjectModel3dAttribset_object_model_3d_attrib
Possible Successors
get_object_model_3d_paramsget_object_model_3d_paramsGetObjectModel3dParamsGetObjectModel3dParamsGetObjectModel3dParamsget_object_model_3d_params
Alternatives
remove_object_model_3d_attrib_modremove_object_model_3d_attrib_modRemoveObjectModel3dAttribModRemoveObjectModel3dAttribModRemoveObjectModel3dAttribModremove_object_model_3d_attrib_mod
See also
copy_object_model_3dcopy_object_model_3dCopyObjectModel3dCopyObjectModel3dCopyObjectModel3dcopy_object_model_3d,
set_object_model_3d_attribset_object_model_3d_attribSetObjectModel3dAttribSetObjectModel3dAttribSetObjectModel3dAttribset_object_model_3d_attrib
Module
3D Metrology