Slice¶

class Slice(index, figures=None)[source]¶

Bases: Frame

Single slice in volume plane; holds VolumeFigures at given index. Immutable.

Same parameters as Frame.

Parameters:

index : int¶: Slice index.
figures=None¶: List of VolumeFigures.

Usage Example:

import supervisely as sly

obj_class = sly.ObjClass('car', sly.Rectangle)
volume_obj = sly.VolumeObject(obj_class)
geometry = sly.Rectangle(0, 0, 100, 100)
figure = sly.VolumeFigure(volume_obj, geometry, "axial", 7)
slice_ = sly.Slice(7, figures=[figure])

Methods

`clone`	Makes a copy of Frame with new fields, if fields are given, otherwise it will use fields of the original Frame.
`from_json`	Deserialize a Slice object from a JSON representation.
`key`	Get Frame key (index) value.
`to_json`	Convert the Frame to a json dict.
`validate_figures_bounds`	Checks if image with given size contains a figure.

Attributes

`figures`	Frame figures.
`index`	Frame index.

figure_type¶: alias of VolumeFigure

classmethod from_json(data, objects, plane_name, slices_count=None, key_id_map=None)[source]¶

Deserialize a Slice object from a JSON representation.

Parameters:

data : dict¶: The JSON representation of the Slice.
objects¶: A collection of objects in volume.
plane_name : str¶: The name of the plane.
slices_count : Optional[int]¶: The total number of slices in the volume, if known.
key_id_map=None¶: A mapping of keys to IDs used for referencing objects.

Returns:

The deserialized Slice object.

Return type:

Slice

Raises:

ValueError – If the slice index is negative or greater than the total number of slices.

Usage Example:

import supervisely as sly
slice_index = 7
geometry = sly.Rectangle(0, 0, 100, 100)
class_car = sly.ObjClass('car', sly.Rectangle)
object_car = sly.VolumeObject(class_car)
objects = sly.VolumeObjectCollection([object_car])
figure_car = sly.VolumeFigure(object_car, geometry, sly.Plane.AXIAL, slice_index)

slice = sly.Slice(slice_index, figures=[figure_car])
slice_json = slice.to_json()

new_slice = sly.Slice.from_json(slice_json, objects, sly.Plane.AXIAL)

clone(index=None, figures=None)¶

Makes a copy of Frame with new fields, if fields are given, otherwise it will use fields of the original Frame.

Parameters:

index : int, optional¶: Index of the Frame.
figures=None¶: List of VideoFigures.

Returns:

Frame object.

Return type:

Frame

Usage Example:

import supervisely as sly

frame_index = 7
geometry = sly.Rectangle(0, 0, 100, 100)
class_car = sly.ObjClass('car', sly.Rectangle)
object_car = sly.VideoObject(class_car)
figure_car = sly.VideoFigure(object_car, geometry, frame_index)
frame = sly.Frame(frame_index, figures=[figure_car])

# Remember that Frame object is immutable, and we need to assign new instance of Frame to a new variable
new_frame = frame.clone(index=100, figures=[])
print(new_frame.to_json())
# Output: {
#     "index": 100,
#     "figures": []
# }

key()¶

Get Frame key (index) value.

Returns:

Frame key (index) value

Return type:

int

Usage Example:

import supervisely as sly

frame_index = 7
geometry = sly.Rectangle(0, 0, 100, 100)
class_car = sly.ObjClass('car', sly.Rectangle)
object_car = sly.VideoObject(class_car)
figure_car = sly.VideoFigure(object_car, geometry, frame_index)

frame = sly.Frame(frame_index, figures=[figure_car])
print(frame.key())
# Output: 7

to_json(key_id_map=None)¶

Convert the Frame to a json dict. Read more about Supervisely format.

Parameters:

key_id_map=None¶: KeyIdMap object.

Returns:

Json format as a dict

Return type:

Dict

Usage Example:

import supervisely as sly

frame_index = 7
geometry = sly.Rectangle(0, 0, 100, 100)
class_car = sly.ObjClass('car', sly.Rectangle)
object_car = sly.VideoObject(class_car)
figure_car = sly.VideoFigure(object_car, geometry, frame_index)

frame = sly.Frame(frame_index, figures=[figure_car])
frame_json = frame.to_json()
print(frame_json)
# Output: {
#     "index": 7,
#     "figures": [
#         {
#             "key": "39f3eb15791f4c72b7cdb98c17b3f0f1",
#             "objectKey": "319814af474941a98ca208c3fad5ed81",
#             "geometryType": "rectangle",
#             "geometry": {
#                 "points": {
#                     "exterior": [
#                         [
#                             0,
#                             0
#                         ],
#                         [
#                             100,
#                             100
#                         ]
#                     ],
#                     "interior": []
#                 }
#             }
#         }
#     ]
# }

validate_figures_bounds(img_size=None)¶

Checks if image with given size contains a figure.

Parameters:

img_size : Tuple[int, int], optional¶: Size of the image (height, width).

:raises OutOfImageBoundsException: if figure is out of image bounds :returns: None :rtype: None

Usage Example:

import supervisely as sly

frame_index = 7
geometry = sly.Rectangle(0, 0, 100, 100)
class_car = sly.ObjClass('car', sly.Rectangle)
object_car = sly.VideoObject(class_car)
figure_car = sly.VideoFigure(object_car, geometry, frame_index)
frame = sly.Frame(frame_index, figures=[figure_car])

image_size = (20, 200)
frame.validate_figures_bounds(image_size)
# raise OutOfImageBoundsException("Figure is out of image bounds")