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

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