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

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