CopickConfig

copick.models.CopickConfig

Bases: BaseModel

Configuration for a copick project. Defines the available objects, user_id and optionally an index for runs.

Attributes:

• name (Optional[str]) –

  Name of the CoPick project.

• description (Optional[str]) –

  Description of the CoPick project.

• version (Optional[str]) –

  Version of the CoPick API.

• pickable_objects (List[PickableObject]) –

  Index for available pickable objects.

• user_id (Optional[str]) –

  Unique identifier for the user (e.g. when distributing the config file to users).

• session_id (Optional[str]) –

  Unique identifier for the session.

• voxel_spacings (Optional[List[float]]) –

  Index for available voxel spacings.

• runs (Optional[List[str]]) –

  Index for run names.

• tomograms (Optional[Dict[float, List[str]]]) –

  Index for available voxel spacings and tomogram types.

name

name: Optional[str] = 'CoPick'

description

description: Optional[str] = "Let's CoPick!"

version

version: Optional[str] = '0.2.0'

pickable_objects

pickable_objects: List[PickableObject]

user_id

user_id: Optional[str] = None

session_id

session_id: Optional[str] = None

runs

runs: Optional[List[str]] = None

voxel_spacings

voxel_spacings: Optional[List[float]] = None

tomograms

tomograms: Optional[Dict[float, List[str]]] = {}

from_file

from_file(filename: str) -> CopickConfig

Load a CopickConfig from a file and create a CopickConfig object.

Parameters:

• filename (str) –

  path to the file

Returns:

• CopickConfig ( CopickConfig ) –

  Initialized CopickConfig object

validate_user_id

validate_user_id(v) -> Optional[str]

Validate the user_id.

validate_session_id

validate_session_id(v) -> Optional[str]

Validate the session_id.