Skip to content

webknossos.administration.task

Classes:

Task

Data class containing information about a WEBKNOSSOS task

Methods:

  • create –

    Submits tasks in WEBKNOSSOS based on a dataset, starting position + rotation, and returns the Task objects

  • create_from_annotations –

    Submits tasks in WEBKNOSSOS based on existing annotations, and returns the Task objects

  • get_annotation_infos –

    Returns AnnotationInfo objects describing all task instances that have been started by annotators for this task

  • get_by_id –

    Returns the task specified by the passed id (if your token authorizes you to see it)

  • get_project –

    Returns the project this task belongs to

Attributes:

dataset_name instance-attribute 

dataset_name: str

project_id instance-attribute 

project_id: str

status instance-attribute 

status: TaskStatus

task_id instance-attribute 

task_id: str

task_type instance-attribute 

task_type: TaskType

create classmethod 

create(task_type_id: str, project_name: str, dataset_name: Union[str, RemoteDataset], needed_experience_domain: str, needed_experience_value: int, starting_position: Vec3Int, starting_rotation: Vec3Int = Vec3Int(0, 0, 0), instances: int = 1, script_id: Optional[str] = None, bounding_box: Optional[BoundingBox] = None) -> List[Task]

Submits tasks in WEBKNOSSOS based on a dataset, starting position + rotation, and returns the Task objects

create_from_annotations classmethod 

create_from_annotations(task_type_id: str, project_name: str, base_annotations: List[Annotation], needed_experience_domain: str, needed_experience_value: int, instances: int = 1, script_id: Optional[str] = None, bounding_box: Optional[BoundingBox] = None) -> List[Task]

Submits tasks in WEBKNOSSOS based on existing annotations, and returns the Task objects

get_annotation_infos 

get_annotation_infos() -> List[AnnotationInfo]

Returns AnnotationInfo objects describing all task instances that have been started by annotators for this task

get_by_id classmethod 

get_by_id(task_id: str) -> Task

Returns the task specified by the passed id (if your token authorizes you to see it)

get_project 

get_project() -> Project

Returns the project this task belongs to

TaskStatus

Attributes:

active_instance_count instance-attribute 

active_instance_count: int

finished_instance_count instance-attribute 

finished_instance_count: int

open_instance_count property 

open_instance_count: int

pending_instance_count instance-attribute 

pending_instance_count: int

TaskType

Attributes:

description instance-attribute 

description: str

name instance-attribute 

name: str

task_type_id instance-attribute 

task_type_id: str

team_id instance-attribute 

team_id: str

team_name instance-attribute 

team_name: str