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

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