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