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

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