Inspection

STEP/BREP inspection, topology neighborhoods, comparisons, sections, evidence, and rendering helpers.

This catalog contains 47 public symbols. Select a symbol for its exact signature, parameters, return contract, errors, members, aliases, and behavior notes.

Modules

Symbol	Import	Summary
brep	from cadflow.inspect import brep	OCP-native STEP/BREP inspection utilities.
inspect	from cadflow import inspect	Inspection-only utilities kept outside CadFlow's modeling graph.
inspection	from cadflow import inspection	BREP inspection domain facade.

Classes

Symbol	Import	Summary
BRepComparison	from cadflow.inspect.brep import BRepComparison	Hard-gate comparison facts for two solid BREPs.
BRepInspection	from cadflow.inspect.brep import BRepInspection	JSON-serializable geometry and topology facts for one BREP.
BRepModel	from cadflow.inspect.brep import BRepModel	One BREP with deterministic zero-based topology ids and incidence data.
EntityInspectionParity	from cadflow.inspect.brep import EntityInspectionParity	Result of checking stable entity output against a BRepInspection report.
InspectionSummaryComparison	from cadflow.inspect.brep import InspectionSummaryComparison	Fast report-level diagnostics; not a geometric acceptance result.
SliceComparison	from cadflow.inspect.brep import SliceComparison	SliceComparison(target: 'str | None', candidate: 'str | None', total_samples: 'int', xor_samples: 'int', sampled_slices_identical: 'bool', panels: 'tuple[SlicePanelResult, ...]', image: 'str | None' = None)
SlicePanelResult	from cadflow.inspect.brep import SlicePanelResult	SlicePanelResult(slice: 'str', samples: 'int', xor_samples: 'int')
SliceSpec	from cadflow.inspect.brep import SliceSpec	One constant-coordinate physical slice.

Exceptions

Symbol	Import	Summary
BRepEntityError	from cadflow.inspect.brep import BRepEntityError	Raised when a STEP model or stable entity query cannot be processed.

Functions

Symbol	Import	Summary
clear_step_model_cache_rnone	from cadflow.inspect.brep import clear_step_model_cache_rnone	Clear the bounded STEP entity-model cache.
compare_boundary_distance_rdescriptor	from cadflow.inspect.brep import compare_boundary_distance_rdescriptor	Compute bidirectional sampled-boundary to exact-boundary distances.
compare_entities_rdescriptor	from cadflow.inspect.brep import compare_entities_rdescriptor	Compare entity geometry, scalar parameters, distance, and adjacency.
compare_global_properties_rdescriptor	from cadflow.inspect.brep import compare_global_properties_rdescriptor	Compare material counts, mass properties, bounds, and raw topology.
compare_inspections_rinspectionsummarycomparison	from cadflow.inspect.brep import compare_inspections_rinspectionsummarycomparison	Compare inexpensive inspection summaries without claiming BREP equality.
compare_material_rdescriptor	from cadflow.inspect.brep import compare_material_rdescriptor	Compute missing/excess volumes using directional cuts by default.
compare_model_to_inspection_rentityinspectionparity	from cadflow.inspect.brep import compare_model_to_inspection_rentityinspectionparity	Check summary, geometry labels, measurements, and incidence parity.
compare_sections_rdescriptor	from cadflow.inspect.brep import compare_sections_rdescriptor	Compare target and current contour geometry on one physical plane.
compare_shape_slices_rslicecomparison	from cadflow.inspect.brep import compare_shape_slices_rslicecomparison	Compare occupancy on physical slices and optionally render an XOR image.
compare_shapes_rbrepcomparison	from cadflow.inspect.brep import compare_shapes_rbrepcomparison	Compare material point sets and geometry-labelled incidence graphs.
compare_step_slices_rslicecomparison	from cadflow.inspect.brep import compare_step_slices_rslicecomparison	Load two STEP solids and compare physical occupancy slices.
compare_step_to_inspection_rentityinspectionparity	from cadflow.inspect.brep import compare_step_to_inspection_rentityinspectionparity	Load a STEP file and compare it with a serialized BRepInspection report.
compare_steps_rbrepcomparison	from cadflow.inspect.brep import compare_steps_rbrepcomparison	Load two STEP files and run the strict BREP comparison.
evaluate_reconstruction_rdescriptor	from cadflow.inspect.brep import evaluate_reconstruction_rdescriptor	Apply replay, validity, material, boundary, and optional strict gates.
index_shape_rbrepmodel	from cadflow.inspect.brep import index_shape_rbrepmodel	Build stable entity maps for one in-memory OCP shape.
inspect_difference_regions_rdescriptor	from cadflow.inspect.brep import inspect_difference_regions_rdescriptor	Aggregate material components and optional precomputed boundary anomalies.
inspect_face_boundaries_rdescriptor	from cadflow.inspect.brep import inspect_face_boundaries_rdescriptor	Return ordered outer and inner wire occurrences for one stable face id.
inspect_nearby_entities_rdescriptor	from cadflow.inspect.brep import inspect_nearby_entities_rdescriptor	Find stable entities whose exact geometry lies near a point or region.
inspect_point_rdescriptor	from cadflow.inspect.brep import inspect_point_rdescriptor	Return exact point-to-entity distances, ordered by distance then stable id.
inspect_section_rdescriptor	from cadflow.inspect.brep import inspect_section_rdescriptor	Intersect a model with an unbounded plane and assemble sampled contours.
inspect_shape_rbrepinspection	from cadflow.inspect.brep import inspect_shape_rbrepinspection	Inspect one imported shape without relying on STEP entity numbering.
inspect_step_entity_rdescriptor	from cadflow.inspect.brep import inspect_step_entity_rdescriptor	Return geometry, measurements, bounds, and adjacency for one entity id.
inspect_step_rbrepinspection	from cadflow.inspect.brep import inspect_step_rbrepinspection	Load and inspect one valid, single-root STEP file.
inspect_step_rsummary	from cadflow.inspect.brep import inspect_step_rsummary	Return global material and topology facts for one STEP file.
inspect_topology_neighborhood_rdescriptor	from cadflow.inspect.brep import inspect_topology_neighborhood_rdescriptor	Return a deterministic, bounded breadth-first topology neighborhood.
load_step_rbrepmodel	from cadflow.inspect.brep import load_step_rbrepmodel	Load and cache a STEP model with deterministic topology ids.
load_step_rshape	from cadflow.inspect.brep import load_step_rshape	Load one transferred STEP shape and optionally require a valid BREP.
make_center_slice_specs_rslicespeclist	from cadflow.inspect.brep import make_center_slice_specs_rslicespeclist	Return one center slice normal to each global axis.
render_entity_kind_maps_rpath	from cadflow.inspect.brep import render_entity_kind_maps_rpath	Render independent face, edge, and vertex highlight maps.
render_entity_map_rpath	from cadflow.inspect.brep import render_entity_map_rpath	Render stable BREP entity IDs without flattening model depth.
render_region_rpath	from cadflow.inspect.brep import render_region_rpath	Highlight stable entities and their optional topology neighborhood.
render_shape_views_rpath	from cadflow.inspect.brep import render_shape_views_rpath	Render smooth shaded BREP views with true topology edges by default.
render_step_views_rpath	from cadflow.inspect.brep import render_step_views_rpath	Load STEP/XCAF colors and render smooth faces with true BREP edges.
select_region_entities_rdescriptor	from cadflow.inspect.brep import select_region_entities_rdescriptor	Expand stable ids through topology and optionally filter them by bounds distance.

Constants

Symbol	Import	Summary
DEFAULT_VIEWS	from cadflow.inspect.brep import DEFAULT_VIEWS	Built-in immutable sequence.