compare_boundary_distance_rdescriptor
Kind: Function
Domain: Inspection
Canonical import: from cadflow.inspect.brep import compare_boundary_distance_rdescriptor
Signature
def compare_boundary_distance_rdescriptor(target: 'ModelInput', current: 'ModelInput', *, linear_deflection: 'float' = 0.5, max_samples: 'int' = 200, target_face_ids: 'Sequence[str] | None' = None, current_face_ids: 'Sequence[str] | None' = None, include_records: 'bool' = False) -> 'dict[str, Any]'
Description
Compute bidirectional sampled-boundary to exact-boundary distances.
Parameters
| Name | Type | Required | Default | Source description |
|---|---|---|---|---|
target | 'ModelInput' | yes | - | Not explicitly described in the source docstring. |
current | 'ModelInput' | yes | - | Not explicitly described in the source docstring. |
linear_deflection | 'float' | no | 0.5 | Not explicitly described in the source docstring. |
max_samples | 'int' | no | 200 | Not explicitly described in the source docstring. |
target_face_ids | 'Sequence[str] | None' | no | None | Not explicitly described in the source docstring. |
current_face_ids | 'Sequence[str] | None' | no | None | Not explicitly described in the source docstring. |
include_records | 'bool' | no | False | Not explicitly described in the source docstring. |
Returns
Type: 'dict[str, Any]'
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_boundary_distance_rdescriptor