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

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