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

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