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

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