Collect visual diagnostics for a VinOfflineSample.
1.1 Parameters
Name
Type
Description
Default
sample
VinOfflineSample
Offline sample returned by VinOfflineDataset with return_format="sample".
required
strict
bool
If True, raise OfflineVisualInventoryError when a required field is absent or invalid. Optional visual payloads are always represented as warnings instead of failures.
True
1.2 Returns
Name
Type
Description
OfflineVisualInventory
Inventory summary with required metadata, derived masks/deltas, optional
OfflineVisualInventory
payload booleans, warnings, and shape metadata.
Source Code
# collect_offline_visual_inventory { #aria_nbv.data_handling.collect_offline_visual_inventory }```pythondata_handling.collect_offline_visual_inventory(sample, *, strict=True)```Collect visual diagnostics for a ``VinOfflineSample``.## Parameters {.doc-section .doc-section-parameters}| Name | Type | Description | Default ||--------|------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------|| sample | VinOfflineSample | Offline sample returned by ``VinOfflineDataset`` with ``return_format="sample"``. | _required_ || strict | bool | If ``True``, raise `OfflineVisualInventoryError` when a required field is absent or invalid. Optional visual payloads are always represented as warnings instead of failures. | `True` |## Returns {.doc-section .doc-section-returns}| Name | Type | Description ||--------|------------------------|--------------------------------------------------------------------------||| OfflineVisualInventory | Inventory summary with required metadata, derived masks/deltas, optional ||| OfflineVisualInventory | payload booleans, warnings, and shape metadata. |