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

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>"
}