CopickFilamentsFile

Bases: BaseModel

Datamodel for the traced filaments of one pickable object in one run, by one user or tool and session.

Stored as {run}/Filaments/{user_id}_{session_id}_{pickable_object_name}.json.

Attributes:

• pickable_object_name (str) –

  Pickable object name from CopickConfig.pickable_objects[X].name

• user_id (str) –

  Unique identifier for the user or tool name.

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

  Unique identifier for the session. If it is 0, the filaments were generated by a tool.

• run_name (Optional[str]) –

  Name of the run the filaments belong to.

• voxel_spacing (Optional[float]) –

  Voxel spacing of the data the filaments were traced in, if any.

• unit (str) –

  Unit of the point coordinates.

• version (int) –

  Version of this file format.

• filaments (List[CopickFilament]) –

  The filaments.

pickable_object_name: str

user_id: str

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

run_name: Optional[str] = None

voxel_spacing: Optional[float] = None

unit: str = 'angstrom'

version: int = 1

filaments: List[CopickFilament] = Field(default_factory=list)

validate_unique_ids() -> CopickFilamentsFile