SliceComparison
Kind: Class
Domain: Inspection
Canonical import: from cadflow.inspect.brep import SliceComparison
Signature
class SliceComparison(target: 'str | None', candidate: 'str | None', total_samples: 'int', xor_samples: 'int', sampled_slices_identical: 'bool', panels: 'tuple[SlicePanelResult, ...]', image: 'str | None' = None) -> None
Description
SliceComparison(target: 'str | None', candidate: 'str | None', total_samples: 'int', xor_samples: 'int', sampled_slices_identical: 'bool', panels: 'tuple[SlicePanelResult, ...]', image: 'str | None' = None)
Parameters
| Name | Type | Required | Default | Source description |
|---|---|---|---|---|
target | 'str | None' | yes | - | Not explicitly described in the source docstring. |
candidate | 'str | None' | yes | - | Not explicitly described in the source docstring. |
total_samples | 'int' | yes | - | Not explicitly described in the source docstring. |
xor_samples | 'int' | yes | - | Not explicitly described in the source docstring. |
sampled_slices_identical | 'bool' | yes | - | Not explicitly described in the source docstring. |
panels | 'tuple[SlicePanelResult, ...]' | yes | - | Not explicitly described in the source docstring. |
image | 'str | None' | no | None | Not explicitly described in the source docstring. |
Returns
Type: None
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.
Data fields
| Name | Type | Default |
|---|---|---|
target | 'str | None' | required |
candidate | 'str | None' | required |
total_samples | 'int' | required |
xor_samples | 'int' | required |
sampled_slices_identical | 'bool' | required |
panels | 'tuple[SlicePanelResult, ...]' | required |
image | 'str | None' | None |
Public members
| Member | Kind | Signature | Description |
|---|---|---|---|
to_dict | method | (self) -> 'dict[str, Any]' | See the member signature. |
write_json | method | (self, path: 'str | Path', *, indent: 'int' = 2) -> 'Path' | See the member signature. |
Behavior and constraints
- Instances are immutable dataclass values; update workflows return a replacement value.
Import check
from cadflow.inspect.brep import SliceComparison