ImageBoundingBox Class

A basic rectangle specifying a sub-region of the image.

Inheritance

azure.ai.vision.imageanalysis._model_base.Model

ImageBoundingBox

Constructor

ImageBoundingBox(*args: Any, **kwargs: Any)

Variables

Name	Description
x	int X-coordinate of the top left point of the area, in pixels. Required.
y	int Y-coordinate of the top left point of the area, in pixels. Required.
width	int Width of the area, in pixels. Required.
height	int Height of the area, in pixels. Required.

Methods

as_dict	Return a dict that can be JSONify using json.dump.
clear
copy
get
items
keys
pop
popitem
setdefault
update
values

as_dict

Return a dict that can be JSONify using json.dump.

as_dict(*, exclude_readonly: bool = False) -> Dict[str, Any]

Keyword-Only Parameters

Name	Description
exclude_readonly	bool Whether to remove the readonly properties.

Returns

Type	Description
dict	A dict JSON compatible object

clear

clear() -> None

copy

copy() -> Model

get

get(key: str, default: Any = None) -> Any

Parameters

Name	Description
key Required
default Required	Default value: None

items

items() -> ItemsView[str, Any]

keys

keys() -> KeysView[str]

pop

pop(key: str, default: ~typing.Any = <object object>) -> Any

Parameters

Name	Description
key Required
default Required

popitem

popitem() -> Tuple[str, Any]

setdefault

setdefault(key: str, default: ~typing.Any = <object object>) -> Any

Parameters

Name	Description
key Required
default Required

update

update(*args: Any, **kwargs: Any) -> None

values

values() -> ValuesView[Any]

Attributes

height

Height of the area, in pixels. Required.

height: int

width

Width of the area, in pixels. Required.

width: int

x

X-coordinate of the top left point of the area, in pixels. Required.

x: int

y

Y-coordinate of the top left point of the area, in pixels. Required.

y: int