inspect_difference_regions_rdescriptor
Kind: Function
Domain: Inspection
Canonical import: from cadflow.inspect.brep import inspect_difference_regions_rdescriptor
Signature
def inspect_difference_regions_rdescriptor(target: 'ModelInput', current: 'ModelInput', *, distance_threshold: 'float' = 0.1, linear_deflection: 'float' = 0.5, max_samples: 'int' = 600, cluster_radius: 'float | None' = None, merge_radius: 'float | None' = None, boolean_tolerance: 'float | None' = None, include_boundary: 'bool' = False, boundary_result: 'Mapping[str, Any] | None' = None, material_result: 'Mapping[str, Any] | None' = None) -> 'dict[str, Any]'
Description
Aggregate material components and optional precomputed boundary anomalies.
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. |
distance_threshold | 'float' | no | 0.1 | Not explicitly described in the source docstring. |
linear_deflection | 'float' | no | 0.5 | Not explicitly described in the source docstring. |
max_samples | 'int' | no | 600 | Not explicitly described in the source docstring. |
cluster_radius | 'float | None' | no | None | Not explicitly described in the source docstring. |
merge_radius | 'float | None' | no | None | Not explicitly described in the source docstring. |
boolean_tolerance | 'float | None' | no | None | Not explicitly described in the source docstring. |
include_boundary | 'bool' | no | False | Not explicitly described in the source docstring. |
boundary_result | 'Mapping[str, Any] | None' | no | None | Not explicitly described in the source docstring. |
material_result | 'Mapping[str, Any] | None' | no | None | 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 inspect_difference_regions_rdescriptor