# Issue Error Codes

1. Category: Errors are to be grouped so that they can be easily distinguishable on the UI and analytics can be prepared based on this category.
   * A category is assigned a color so that on the Audit tool, an Auditor can associate which Issue(s) belong to the same category when they select an Issue from the list.
2. Add an [Issue Type](https://docs.imerit-prod.io/audit-tool#issue-type-selection), that will be visible on the Audit tool

## Setting Up Error Codes

A default Error Code template is provided by Ango Hub. Authorized users can modify it to create a new template from it.

<div data-full-width="false" data-with-frame="true"><figure><img src="https://3895963154-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FTcOUG6rfWxqGM0N4db2P%2Fuploads%2FWneyVT2pTH9T5HF6uFer%2Fimage.png?alt=media&#x26;token=0184c671-beca-4f8e-a4ca-6167d0e34e43" alt=""><figcaption></figcaption></figure></div>

## Assigning Error Codes During Review

To raise an issue the reviewer can follow either of the two:

1. Clicking on 'Issue' on the [Header](https://docs.imerit-prod.io/annotation-tool/tool-layout#id-1.-header) opens the Issue Panel. Click on the '+' icon on the issue title row.

   <div data-with-frame="true"><figure><img src="https://3895963154-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FTcOUG6rfWxqGM0N4db2P%2Fuploads%2FCzzLVKwHZKjDpAuuZTIL%2Fimage.png?alt=media&#x26;token=02a5c09e-6f67-4482-af2e-9c8c7abafea5" alt=""><figcaption></figcaption></figure></div>
2. Right-clicking on the annotation and select the ‘Create Issue’ option.&#x20;

   <figure><img src="https://3895963154-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FTcOUG6rfWxqGM0N4db2P%2Fuploads%2Fr0nLJzetXokGJsKJ70Cd%2Fimage.png?alt=media&#x26;token=9b4be218-d869-4725-a985-29ad7e73c14d" alt="" width="375"><figcaption></figcaption></figure>

### Create Issue

Create Issue prompt appears on the Issue panel.

<figure><img src="https://3895963154-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FTcOUG6rfWxqGM0N4db2P%2Fuploads%2FQWe2xCpu1OAhwVUAnbO3%2Fimage.png?alt=media&#x26;token=2afb7876-a34b-4c5c-9a8c-aaf17bf58b74" alt="" width="148"><figcaption></figcaption></figure>

#### **Frame**

* Start: Frame number where the issue is observed. The tool will automatically populate this with the current frame and will not prompt for an input
* End: Frame number till where the issue is observed if it spans across multiple frames. The tool will automatically populate this with the current frame assuming the error doesn't span beyond the current frame. The user can update to the frame till where it is applicable.

#### **Class, Instance, Attribute Selection**

Dropdown selection from the list defined in the Category Schema.

#### **Severity**

Leverage this field to indicates the level of impact of an issue, ranging from critical to minor.

#### Error Code **Selection**

All the error codes that can be observed are listed under [default](https://docs.imerit-prod.io/project-setup/create-taskflow/1.-taskflow-details#default-template). The user must select whichever is applicable. The list of options for Issues is customisable.

Each error category is assigned a specific color, making it easier for the Auditor to quickly identify the type of issue they are looking for within the list. For example, in the below image, 'blue' represents *wrong* annotations, 'green' indicates *missing* annotations, 'orange' indicates *inconsistency*, and 'purple' refers to miscellaneous error code.

<div data-with-frame="true"><figure><img src="https://docs.imerit-prod.io/~gitbook/image?url=https%3A%2F%2F254647936-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FzGccvqLYeyaJ6Dgazh7K%252Fuploads%252Fv3Q28GjLKJX44YQ7SoCq%252Fimage.png%3Falt%3Dmedia%26token%3D218dd642-2950-48ff-8df9-5ea7bde89412&#x26;width=768&#x26;dpr=4&#x26;quality=100&#x26;sign=a1bd807f&#x26;sv=2" alt="" width="188"><figcaption></figcaption></figure></div>

#### **Comments (if any)**

Add comments to give more context about the issue raised

### Issue Menu <a href="#issue-menu" id="issue-menu"></a>

Each Issue Card created has a few options which can be pulled up by clicking on the 3 vertical dots on the top right corner.

<div data-with-frame="true"><figure><img src="https://docs.imerit-prod.io/~gitbook/image?url=https%3A%2F%2F254647936-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FzGccvqLYeyaJ6Dgazh7K%252Fuploads%252FObnnczYTOlnoApReYMAq%252Fimage.png%3Falt%3Dmedia%26token%3Df7a4159a-172e-4a95-be49-f118857c6833&#x26;width=768&#x26;dpr=4&#x26;quality=100&#x26;sign=179c10a7&#x26;sv=2" alt="" width="188"><figcaption></figcaption></figure></div>

* Reply to the issue
* Ignore/ Close the Issue (the same gets reflected on the Audit Dashboard)
* 3D/ 2D markers to redirect the annotator's attention to a location.
  * For a Missed Annotation: In this case Select the Class and Issue type as 'Missing Object'. After saving, click on the three dots to mark the location of the expected Annotation on the Image/ point cloud using 2D/ 3D Marker respectively.

> Quick Tip: To associate the card to the existing annotation, provide the class and instance details. This will allow users to click on the card to be redirected to where the issue lies.

## Reviewing Complete <a href="#auditing-complete" id="auditing-complete"></a>

Once reviewing is completed, click on Accept or Reject on the top right of the tool.

1. Accept will change the status of the batch to Audit Accepted in the sequence lifecycle
2. Reject will change the status of the batch to Audit Rejected in the sequence lifecycle