Size Measurement¶
Class: SizeMeasurementBlockV1
Source: inference.core.workflows.core_steps.classical_cv.size_measurement.v1.SizeMeasurementBlockV1
The Size Measurement Block calculates the dimensions of objects relative to a reference object. It uses one model to detect the reference object and another to detect the objects to measure. The block outputs the dimensions of the objects in terms of the reference object.
- Reference Object: This is the known object used as a baseline for measurements. Its dimensions are known and used to scale the measurements of other objects.
- Object to Measure: This is the object whose dimensions are being calculated. The block measures these dimensions relative to the reference object.
Block Usage¶
To use the Size Measurement Block, follow these steps:
- Select Models: Choose a model to detect the reference object and another model to detect the objects you want to measure.
- Configure Inputs: Provide the predictions from both models as inputs to the block.
- Set Reference Dimensions: Specify the known dimensions of the reference object in the format 'width,height' or as a tuple (width, height).
- Run the Block: Execute the block to calculate the dimensions of the detected objects relative to the reference object.
Example¶
Imagine you have a scene with a calibration card and several packages. The calibration card has known dimensions of 5.0 inches by 3.0 inches. You want to measure the dimensions of packages in the scene.
- Reference Object: Calibration card with dimensions 5.0 inches (width) by 3.0 inches (height).
- Objects to Measure: Packages detected in the scene.
The block will use the known dimensions of the calibration card to calculate the dimensions of each package. For example, if a package is detected with a width of 100 pixels and a height of 60 pixels, and the calibration card is detected with a width of 50 pixels and a height of 30 pixels, the block will calculate the package's dimensions as:
- Width: (100 pixels / 50 pixels) * 5.0 inches = 10.0 inches
- Height: (60 pixels / 30 pixels) * 3.0 inches = 6.0 inches
This allows you to obtain the real-world dimensions of the packages based on the reference object's known size.
Type identifier¶
Use the following identifier in step "type"
field: roboflow_core/size_measurement@v1
to add the block as
as step in your workflow.
Properties¶
Name | Type | Description | Refs |
---|---|---|---|
name |
str |
Enter a unique identifier for this step.. | ❌ |
reference_predictions |
List[Any] |
Reference object used to calculate the dimensions of the specified objects. If multiple objects are provided, the highest confidence prediction will be used.. | ✅ |
reference_dimensions |
Union[List[float], Tuple[float, float], str] |
Dimensions of the reference object in desired units, (e.g. inches). Will be used to convert the pixel dimensions of the other objects to real-world units.. | ✅ |
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 Size Measurement
in version v1
.
- inputs:
Google Gemini
,Keypoint Detection Model
,Detections Stabilizer
,Path Deviation
,Perspective Correction
,Instance Segmentation Model
,Florence-2 Model
,PTZ Tracking (ONVIF)
.md),Local File Sink
,Clip Comparison
,Detections Merge
,Time in Zone
,Roboflow Custom Metadata
,Dimension Collapse
,Instance Segmentation Model
,Template Matching
,Dynamic Zone
,Dynamic Crop
,Stitch OCR Detections
,Time in Zone
,Detections Consensus
,Segment Anything 2 Model
,VLM as Classifier
,Bounding Rectangle
,Detection Offset
,Size Measurement
,Object Detection Model
,Twilio SMS Notification
,Detections Filter
,Llama 3.2 Vision
,Clip Comparison
,Email Notification
,LMM
,Roboflow Dataset Upload
,Time in Zone
,CSV Formatter
,Path Deviation
,Detections Transformation
,Byte Tracker
,Byte Tracker
,Single-Label Classification Model
,OCR Model
,Webhook Sink
,Byte Tracker
,Object Detection Model
,Velocity
,Slack Notification
,Roboflow Dataset Upload
,Detections Classes Replacement
,YOLO-World Model
,OpenAI
,Model Monitoring Inference Aggregator
,VLM as Detector
,OpenAI
,Buffer
,LMM For Classification
,Line Counter
,Moondream2
,Multi-Label Classification Model
,Overlap Filter
,Google Vision OCR
,CogVLM
,Detections Stitch
,Florence-2 Model
,VLM as Detector
,OpenAI
,Anthropic Claude
- outputs:
Keypoint Visualization
,Google Gemini
,Keypoint Detection Model
,Email Notification
,Roboflow Dataset Upload
,Circle Visualization
,Path Deviation
,Time in Zone
,Path Deviation
,Perspective Correction
,Color Visualization
,Instance Segmentation Model
,Mask Visualization
,Reference Path Visualization
,Florence-2 Model
,Keypoint Detection Model
,Webhook Sink
,Halo Visualization
,Clip Comparison
,Object Detection Model
,Cache Set
,Dot Visualization
,Roboflow Dataset Upload
,YOLO-World Model
,Classification Label Visualization
,Time in Zone
,Polygon Zone Visualization
,Anthropic Claude
,VLM as Detector
,Instance Segmentation Model
,Polygon Visualization
,Grid Visualization
,Crop Visualization
,OpenAI
,Time in Zone
,LMM For Classification
,Buffer
,Line Counter
,Detections Consensus
,VLM as Classifier
,Bounding Box Visualization
,Trace Visualization
,Label Visualization
,Line Counter
,VLM as Classifier
,Corner Visualization
,Size Measurement
,Florence-2 Model
,Triangle Visualization
,Object Detection Model
,VLM as Detector
,Llama 3.2 Vision
,Ellipse Visualization
,OpenAI
,Line Counter Visualization
,Clip Comparison
Input and Output Bindings¶
The available connections depend on its binding kinds. Check what binding kinds
Size Measurement
in version v1
has.
Bindings
-
input
object_predictions
(Union[instance_segmentation_prediction
,object_detection_prediction
]): Model predictions to measure the dimensions of..reference_predictions
(Union[instance_segmentation_prediction
,object_detection_prediction
,list_of_values
]): Reference object used to calculate the dimensions of the specified objects. If multiple objects are provided, the highest confidence prediction will be used..reference_dimensions
(Union[list_of_values
,string
]): Dimensions of the reference object in desired units, (e.g. inches). Will be used to convert the pixel dimensions of the other objects to real-world units..
-
output
dimensions
(list_of_values
): List of values of any type.
Example JSON definition of step Size Measurement
in version v1
{
"name": "<your_step_name_here>",
"type": "roboflow_core/size_measurement@v1",
"object_predictions": "$segmentation.object_predictions",
"reference_predictions": "$segmentation.reference_predictions",
"reference_dimensions": [
4.5,
3.0
]
}