ObjectChannel

`ObjectChannel`

Bases: Channel, Iterable[Objects]

Channel that contains batched object data

Experimental

ObjectChannel is experimental since 1.9.0 and may change without notice.

Notes

The data items are assumed to be normalized to the spatial extent [0, 1] in x and y direction
The data property returns a reference to the data
The metadata property returns a reference to the metadata
The dunder methods __getitem__ and __iter__ return or yield a reference to a data item

PARAMETER	DESCRIPTION
`data`	Data TYPE: `Objects \| list[Objects]`
`name`	Name TYPE: `ChannelName \| str`
`buffer_size`	Buffer size as a fraction of the spatial extent of the data TYPE: `FractionalBufferSize` DEFAULT: `0.0`
`metadata`	Metadata TYPE: `dict[str, object] \| None` DEFAULT: `None`
`copy`	If True, the data and metadata are copied during initialization TYPE: `bool` DEFAULT: `False`

`id` `property`

RETURNS	DESCRIPTION
`uuid.UUID`	ID

`name` `property` `writable`

RETURNS	DESCRIPTION
`ChannelName \| str`	Name

`buffer_size` `property`

RETURNS	DESCRIPTION
`FractionalBufferSize`	Buffer size as a fraction of the spatial extent of the data

`metadata` `property` `writable`

RETURNS	DESCRIPTION
`dict[str, object]`	Metadata

`is_copied` `property`

RETURNS	DESCRIPTION
`bool`	If True, the data and metadata are copied during initialization

`batch_size` `property`

RETURNS	DESCRIPTION
`int`	Batch size

`is_in_tiles` `property`

RETURNS	DESCRIPTION
`bool`	True if the channel is inside tiles, False otherwise

`data` `property`

RETURNS	DESCRIPTION
`list[Objects]`	Data

`len`

Computes the batch size.

RETURNS	DESCRIPTION
`int`	Batch size

`from_channels` `classmethod`

Creates an object channel from object channels.

PARAMETER	DESCRIPTION
`channels`	Object channels TYPE: `list[ObjectChannel]`
`copy`	If True, the data and metadata are copied during initialization TYPE: `bool` DEFAULT: `False`

RETURNS	DESCRIPTION
`ObjectChannel`	Object channel

`from_unnormalized_data` `classmethod`

Creates an object channel from unnormalized data.

PARAMETER	DESCRIPTION
`data`	Data TYPE: `Objects \| list[Objects]`
`name`	Name TYPE: `ChannelName \| str`
`coordinates`	Coordinates (x_min, y_min) of the tile or of each tile in meters TYPE: `Coordinates \| CoordinatesSet`
`tile_size`	Tile size in meters TYPE: `TileSize`
`buffer_size`	Buffer size in meters TYPE: `BufferSize` DEFAULT: `0`
`metadata`	Metadata TYPE: `dict[str, object] \| None` DEFAULT: `None`
`copy`	If True, the data and metadata are copied during initialization TYPE: `bool` DEFAULT: `False`

`eq`

Compares the object channels.

PARAMETER	DESCRIPTION
`other`	Other object channel TYPE: `object`

RETURNS	DESCRIPTION
`bool`	True if the object channels are equal, False otherwise

`getitem`

Returns the data item.

PARAMETER	DESCRIPTION
`index`	Index or slice of the data item TYPE: `int \| slice`

RETURNS	DESCRIPTION
`Objects \| list[Objects]`	Data item or sliced data

`iter`

Iterates over the data.

YIELDS	DESCRIPTION
`Objects`	Data item

`add`

Adds the object channels.

PARAMETER	DESCRIPTION
`other`	Other object channel TYPE: `ObjectChannel`

RETURNS	DESCRIPTION
`ObjectChannel`	Object channel

`append`

Appends the data.

PARAMETER	DESCRIPTION
`data`	Data TYPE: `Objects \| list[Objects]`
`inplace`	If True, the data is appended inplace TYPE: `bool` DEFAULT: `False`

RETURNS	DESCRIPTION
`ObjectChannel`	Object channel

`copy`

Copies the channel.

RETURNS	DESCRIPTION
`ObjectChannel`	Object channel

`remove_buffer`

Removes the buffer.

PARAMETER	DESCRIPTION
`inplace`	If True, the buffer is removed inplace TYPE: `bool` DEFAULT: `False`

RETURNS	DESCRIPTION
`ObjectChannel`	Object channel

`to_denormalized_data`

Converts the data to denormalized data.

PARAMETER	DESCRIPTION
`coordinates`	Coordinates (x_min, y_min) of each tile in meters TYPE: `CoordinatesSet`
`tile_size`	Tile size in meters TYPE: `TileSize`

RETURNS	DESCRIPTION
`list[Objects]`	Data