Issues.issue client

​

IssueFrameRange Objects

class IssueFrameRange(BaseDTO)

​

SceneCoordinateIssue Objects

class SceneCoordinateIssue(_BaseIssue)

​

FrameRangeIssue Objects

class FrameRangeIssue(_BaseIssue)

​

AnnotationIssue Objects

class AnnotationIssue(_BaseIssue)

​

TaskIssues Objects

class TaskIssues()

​

list

def list() -> Iterable[Issue]

• FileIssue: Issues anchored to the entire data unit
• FrameIssue: Issues anchored to a specific frame
• CoordinateIssue: Issues anchored to specific 2D coordinates on a frame
• SceneCoordinateIssue: Issues anchored to 3D scene coordinates on a frame
• FrameRangeIssue: Issues anchored to a range of frames
• AnnotationIssue: Issues anchored to a specific annotation

• Iterable[Issue] - An iterator of Issue objects (discriminated union of all issue types).

for issue in task.issues.list():
    if isinstance(issue, FileIssue):
        print(f"File issue: {issue.comments[0].content}")
    elif isinstance(issue, FrameIssue):
        print(f"Frame {issue.frame_index}: {issue.comments[0].content}")

​

add_file_issue

def add_file_issue(comment: str,
                   issue_tags: List[str],
                   space_id: Optional[str] = None) -> None

• comment str - The comment for the issue.
• issue_tags List[str] - The issue tags for the issue.
• space_id Optional[str] - For data units that use spaces (Data Groups and scenes), identifies which space the issue is attached to. Leave as None for data units without spaces.

​

add_frame_issue

def add_frame_issue(frame_index: int,
                    comment: str,
                    issue_tags: List[str],
                    space_id: Optional[str] = None) -> None

• frame_index int - The index of the frame to add the issue to.
• comment str - The comment for the issue.
• issue_tags List[str] - The issue tags for the issue.
• space_id Optional[str] - For data units that use spaces (Data Groups and scenes), identifies which space the issue is attached to. Leave as None for data units without spaces.

​

add_coordinate_issue

def add_coordinate_issue(frame_index: int,
                         x: float,
                         y: float,
                         comment: str,
                         issue_tags: List[str],
                         space_id: Optional[str] = None) -> None

• frame_index int - The index of the frame to add the issue to.
• x float - The x coordinate of the issue.
• y float - The y coordinate of the issue.
• comment str - The comment for the issue.
• issue_tags List[str] - The issue tags for the issue.
• space_id Optional[str] - For data units that use spaces (Data Groups and scenes), identifies which space the issue is attached to. Leave as None for data units without spaces.

​

add_scene_coordinate_issue

def add_scene_coordinate_issue(frame_index: int, x: float, y: float, z: float,
                               comment: str, issue_tags: List[str]) -> None

• frame_index int - The index of the frame to add the issue to.
• x float - The x coordinate (in scene space).
• y float - The y coordinate (in scene space).
• z float - The z coordinate (in scene space).
• comment str - The comment for the issue.
• issue_tags List[str] - The issue tags for the issue.

​

add_annotation_issue

def add_annotation_issue(annotation_id: str,
                         comment: str,
                         issue_tags: List[str],
                         frame_ranges: Optional[List[IssueFrameRange]] = None,
                         space_id: Optional[str] = None) -> None

• annotation_id str - The annotation the issue is attached to. This is the object instance object_hash (or classification instance classification_hash) of the annotation within this task’s data unit.
• comment str - The comment for the issue.
• issue_tags List[str] - The issue tags for the issue.
• frame_ranges Optional[List[IssueFrameRange]] - The frame ranges to pin the issue to, each an inclusive [start, end] range. Leave as None to flag the whole annotation instance across every frame it appears on (e.g. a wrong attribute value). Provide one or more ranges to target the instance on those frames (e.g. a bad contour over a span of frames). A single frame is a range where start == end.
• space_id Optional[str] - For data units that use spaces (Data Groups and scenes), identifies which space the annotation belongs to. Leave as None for data units without spaces.

for obj in label_row.get_object_instances():
    # Flag the whole instance (e.g. wrong attribute value):
    if not passes_attribute_qa(obj):
        task.issues.add_annotation_issue(
            annotation_id=obj.object_hash,
            comment="Wrong attribute value",
            issue_tags=["qa-automation"],
        )
    # Flag the instance over a span of frames (e.g. bad contour on frames 30-45):
    task.issues.add_annotation_issue(
        annotation_id=obj.object_hash,
        comment="Bad contour",
        issue_tags=["qa-automation"],
        frame_ranges=[IssueFrameRange(start=30, end=45)],
    )

• ValueError - If frame_ranges is an empty list (omit it, or pass None, to target the whole annotation instance) or contains an invalid range where start is negative or start > end.

​

delete

def delete(issues: List[Union[Issue, UUID]]) -> None

• issues - A list of Issue objects or UUIDs to delete.

# Delete a single issue:
task.issues.delete([issue])

# Or delete several at once:
obsolete = [i for i in task.issues.list() if i.comments[0].content.startswith("[obsolete]")]
task.issues.delete(obsolete)