PickableObject

Bases: BaseModel

Metadata for a pickable objects.

Attributes:

• name (str) –

  Name of the object.

• is_particle (bool) –

  Whether this object should be represented by points (True) or segmentation masks (False).

• label (Optional[int]) –

  Numeric label/id for the object, as used in multilabel segmentation masks. Must be unique.

• color (Optional[Tuple[int, int, int, int]]) –

  RGBA color for the object.

• emdb_id (Optional[str]) –

  EMDB ID for the object.

• pdb_id (Optional[str]) –

  PDB ID for the object.

• identifier (Optional[str]) –

  Identifier for the object, drawn from an ontology/database namespace (GO, UniProtKB, CHEBI, PDB [dash separator, e.g. PDB-1BXN], UBERON, CL, or CDPO). When using the data portal, this must match the annotation object_id exactly.

• map_threshold (Optional[float]) –

  Threshold to apply to the map when rendering the isosurface.

• radius (Optional[float]) –

  Radius of the particle, when displaying as a sphere. For a filament, the tube radius.

• metadata (Optional[Dict[str, Any]]) –

  Additional metadata for the object (user-defined contents). The key "copick" is reserved for copick's own extensions of the object spec; metadata["copick"]["filament"] declares the object a filament (see FilamentSpec) and is validated when present.

name: str

is_particle: bool

label: Optional[int] = 1

color: Optional[Tuple[int, int, int, int]] = (100, 100, 100, 255)

emdb_id: Optional[str] = None

pdb_id: Optional[str] = None

identifier: Optional[str] = Field(None, alias=AliasChoices('go_id', 'identifier'))

map_threshold: Optional[float] = None

radius: Optional[float] = None

metadata: Optional[Dict[str, Any]] = Field(default_factory=dict)

go_id

filament: Optional[FilamentSpec]

is_filament: bool

validate_label(v) -> int

validate_color(v) -> Tuple[int, int, int, int]

validate_name(v) -> Optional[str]

none_to_empty_dict(v)

validate_filament_spec() -> PickableObject

set_filament(filament: Union[FilamentSpec, Dict[str, Any], None]) -> None