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