compare_shape_slices_rslicecomparison
Kind: Function
Domain: Inspection
Canonical import: from cadflow.inspect.brep import compare_shape_slices_rslicecomparison
Signature
def compare_shape_slices_rslicecomparison(target: 'TopoDS_Shape', candidate: 'TopoDS_Shape', *, slices: 'Sequence[SliceSpec] | None' = None, samples: 'tuple[int, int]' = (91, 121), classification_tolerance: 'float' = 1e-08, margin_ratio: 'float' = 0.03, output_path: 'str | Path | None' = None, target_name: 'str | None' = None, candidate_name: 'str | None' = None, dpi: 'int' = 180) -> 'SliceComparison'
Description
Compare occupancy on physical slices and optionally render an XOR image.
Compare occupancy on physical slices and optionally render an XOR image.
This is a visual diagnostic, not a replacement for bidirectional Boolean comparison. Keep sample counts moderate because exact BREP classification is intentionally used for every point.
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. |
slices | 'Sequence[SliceSpec] | None' | no | None | Not explicitly described in the source docstring. |
samples | 'tuple[int, int]' | no | (91, 121) | Not explicitly described in the source docstring. |
classification_tolerance | 'float' | no | 1e-08 | Not explicitly described in the source docstring. |
margin_ratio | 'float' | no | 0.03 | Not explicitly described in the source docstring. |
output_path | 'str | Path | None' | no | None | 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. |
dpi | 'int' | no | 180 | Not explicitly described in the source docstring. |
Returns
Type: 'SliceComparison'
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_shape_slices_rslicecomparison