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