Overlap Filter

Class: OverlapBlockV1

Source: inference.core.workflows.core_steps.analytics.overlap.v1.OverlapBlockV1

The OverlapFilter is an analytics block that filters out objects overlapping instances of some other class

For instance, for filtering people on bicycles, "bicycle" could be used as the overlap class.

Examples applications: people in a car, items on a pallet

The filter will remove the overlap class from the results, and only return the objects that overlap it. So in the case above, bicycle will also be removed from the results.

Type identifier

Use the following identifier in step "type" field: roboflow_core/overlap@v1to add the block as as step in your workflow.

Properties

Name	Type	Description	Refs
name	str	Enter a unique identifier for this step..	❌
overlap_type	str	Select center for centerpoint overlap, any for any overlap.	❌
overlap_class_name	str	Overlap Class Name.	❌

The Refs column marks possibility to parametrise the property with dynamic values available in workflow runtime. See Bindings for more info.

Available Connections

Compatible Blocks

Check what blocks you can connect to Overlap Filter in version v1.

• inputs: Path Deviation, Dynamic Zone, Detections Transformation, Template Matching, Detections Classes Replacement, VLM as Detector, Object Detection Model, Instance Segmentation Model, Line Counter, Byte Tracker, Time in Zone, Detections Stitch, Object Detection Model, Segment Anything 2 Model, YOLO-World Model, Detections Merge, Moondream2, OCR Model, Seg Preview, Byte Tracker, Path Deviation, Time in Zone, Instance Segmentation Model, Detections Filter, Overlap Filter, Detection Offset, Bounding Rectangle, Google Vision OCR, EasyOCR, Detections Stabilizer, Time in Zone, Detections Combine, SAM 3, VLM as Detector, Dynamic Crop, Velocity, Detections Consensus, Byte Tracker, PTZ Tracking (ONVIF).md), Perspective Correction
• outputs: Roboflow Dataset Upload, Background Color Visualization, Size Measurement, Path Deviation, Detections Transformation, Corner Visualization, Model Monitoring Inference Aggregator, Detections Classes Replacement, Distance Measurement, Trace Visualization, Line Counter, Bounding Box Visualization, Model Comparison Visualization, Byte Tracker, Pixelate Visualization, Time in Zone, Florence-2 Model, Detections Stitch, Crop Visualization, Triangle Visualization, Segment Anything 2 Model, Ellipse Visualization, Detections Merge, Icon Visualization, Byte Tracker, Color Visualization, Roboflow Dataset Upload, Path Deviation, Label Visualization, Time in Zone, Roboflow Custom Metadata, Florence-2 Model, Blur Visualization, Dot Visualization, Overlap Filter, Detections Filter, Circle Visualization, Detection Offset, Perspective Correction, Line Counter, Detections Combine, Detections Stabilizer, Time in Zone, Velocity, Detections Consensus, Stitch OCR Detections, PTZ Tracking (ONVIF).md), Byte Tracker, Dynamic Crop

Input and Output Bindings

The available connections depend on its binding kinds. Check what binding kinds Overlap Filter in version v1 has.

Bindings

• input

  • predictions (Union[instance_segmentation_prediction, object_detection_prediction]): Object predictions.

• output

  • overlaps (object_detection_prediction): Prediction with detected bounding boxes in form of sv.Detections(...) object.

Example JSON definition of step Overlap Filter in version v1

{
    "name": "<your_step_name_here>",
    "type": "roboflow_core/overlap@v1",
    "predictions": "$steps.object_detection_model.predictions",
    "overlap_type": "Center Overlap",
    "overlap_class_name": "<block_does_not_provide_example>"
}