Models

Data models (Pydantic) for annotations, connections, properties, and more.

nimbusimage.models.Location

Bases: BaseModel

A position in the dataset coordinate space.

to_dict()

Serialize to the server's location format.

from_dict(data) classmethod

Deserialize from the server's location format.

nimbusimage.models.Annotation

Bases: BaseModel

A NimbusImage annotation.

Stores raw coordinates as the server provides them. Geometry conversion methods (polygon, point, get_mask, etc.) are in the coordinates module and called via convenience methods here.

to_dict()

Serialize to the server's annotation format.

from_dict(data) classmethod

Deserialize from the server's annotation format.

from_point(x, y, channel, tags, dataset_id, location=None, color=None) classmethod

Create a point annotation from image-space coordinates.

nimbusimage.models.Connection

Bases: BaseModel

A connection between two annotations.

to_dict()

Serialize to the server's connection format.

from_dict(data) classmethod

Deserialize from the server's connection format.

nimbusimage.models.Property

Bases: BaseModel

A property definition (schema, not values).

to_dict()

Serialize to the server's property format.

from_dict(data) classmethod

Deserialize from the server's property format.

nimbusimage.models.PixelSize

Bases: BaseModel

Physical pixel size with unit conversion.

to(unit)

Convert to a different unit.

nimbusimage.models.FrameInfo

Bases: BaseModel

Metadata for a single image frame.

to_dict()

Dict of coordinate keys for use as **kwargs.

to_large_image_params()

Dict for large_image addTile parameters.