CopickSegmentationMeta

Bases: BaseModel

Datamodel for segmentation metadata.

Attributes:

• user_id (str) –

  Unique identifier for the user or tool name.

• session_id (Union[str, Literal['0']]) –

  Unique identifier for the segmentation session. If it is 0, this segmentation was generated by a tool.

• name (str) –

  Pickable Object name or multilabel name of the segmentation.

• is_multilabel (bool) –

  Flag to indicate if this is a multilabel segmentation: several objects, each voxel holding an object's label.

• is_instance (bool) –

  Flag to indicate if this is an instance segmentation: one object (name), each voxel holding the ID of the instance it belongs to, 0 for background.

• is_panoptic (bool) –

  Flag to indicate if this is a panoptic segmentation: two channels, each voxel's object label (channel 0) and its instance ID within that object (channel 1).

• voxel_size (float) –

  Voxel size in angstrom of the tomogram this segmentation belongs to. Rounded to the third decimal.

A segmentation with no flag is binary: one object (name), 1 inside, 0 outside. At most one flag is set.

user_id: str

session_id: Union[str, Literal['0']]

name: str

is_multilabel: bool

is_instance: bool = False

is_panoptic: bool = False

voxel_size: float