compare_shapes_rbrepcomparison
Kind: Function
Domain: Inspection
Canonical import: from cadflow.inspect.brep import compare_shapes_rbrepcomparison
Signature
def compare_shapes_rbrepcomparison(target: 'TopoDS_Shape', candidate: 'TopoDS_Shape', *, target_name: 'str | None' = None, candidate_name: 'str | None' = None, geometric_tolerance: 'float' = 1e-07, boolean_volume_tolerance: 'float' = 1e-09, boolean_fuzzy_tolerance: 'float | None' = None, material_difference_volumes: 'Sequence[float] | None' = None) -> 'BRepComparison'
Description
Compare material point sets and geometry-labelled incidence graphs.
Compare material point sets and geometry-labelled incidence graphs.
Optional precomputed volumes are validated for compatibility but never used as equality evidence; strict directional cuts are always recomputed.
Parameters
| Name | Type | Required | Default | Source description |
|---|---|---|---|---|
target | 'TopoDS_Shape' | yes | - | Not explicitly described in the source docstring. |
candidate | 'TopoDS_Shape' | yes | - | Not explicitly described in the source docstring. |
target_name | 'str | None' | no | None | Not explicitly described in the source docstring. |
candidate_name | 'str | None' | no | None | Not explicitly described in the source docstring. |
geometric_tolerance | 'float' | no | 1e-07 | Not explicitly described in the source docstring. |
boolean_volume_tolerance | 'float' | no | 1e-09 | Not explicitly described in the source docstring. |
boolean_fuzzy_tolerance | 'float | None' | no | None | Not explicitly described in the source docstring. |
material_difference_volumes | 'Sequence[float] | None' | no | None | Not explicitly described in the source docstring. |
Returns
Type: 'BRepComparison'
The source docstring does not declare additional return semantics.
Errors
The source docstring does not declare a narrower exception contract. Invalid types, values, ownership, paths, or backend state may still raise the corresponding public error.
Behavior and constraints
- The contract below is generated from the current public runtime signature. Check domain notes for ownership and workflow constraints.
Import check
from cadflow.inspect.brep import compare_shapes_rbrepcomparison