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