github.com/instill-ai/component@v0.16.0-beta/pkg/operator/image/v0/README.mdx (about)

     1  ---
     2  title: "Image"
     3  lang: "en-US"
     4  draft: false
     5  description: "Learn about how to set up a VDP Image operator https://github.com/instill-ai/instill-core"
     6  ---
     7  
     8  The Image component is an operator that allows users to manipulate image files.
     9  It can carry out the following tasks:
    10  
    11  - [Draw Classification](#draw-classification)
    12  - [Draw Detection](#draw-detection)
    13  - [Draw Keypoint](#draw-keypoint)
    14  - [Draw Ocr](#draw-ocr)
    15  - [Draw Instance Segmentation](#draw-instance-segmentation)
    16  - [Draw Semantic Segmentation](#draw-semantic-segmentation)
    17  
    18  ## Release Stage
    19  
    20  `Alpha`
    21  
    22  ## Configuration
    23  
    24  The component configuration is defined and maintained [here](https://github.com/instill-ai/component/blob/main/pkg/operator/image/v0/config/definition.json).
    25  
    26  ## Supported Tasks
    27  
    28  ### Draw Classification
    29  
    30  Draw classification result on the image.
    31  
    32  | Input | ID | Type | Description |
    33  | :--- | :--- | :--- | :--- |
    34  | Task ID (required) | `task` | string | `TASK_DRAW_CLASSIFICATION` |
    35  | Category (required) | `category` | string | The predicted category of the input. |
    36  | Image (required) | `image` | string | Input image |
    37  | Show Score | `showScore` | boolean | Show model confidence score on each instance |
    38  | Score (required) | `score` | number | The confidence score of the predicted category of the input. |
    39  
    40  | Output | ID | Type | Description |
    41  | :--- | :--- | :--- | :--- |
    42  | Image | `image` | string | Output image |
    43  
    44  ### Draw Detection
    45  
    46  Draw detection result on the image.
    47  
    48  | Input | ID | Type | Description |
    49  | :--- | :--- | :--- | :--- |
    50  | Task ID (required) | `task` | string | `TASK_DRAW_DETECTION` |
    51  | Image (required) | `image` | string | Input image |
    52  | Objects (required) | `objects` | array[object] | A list of detected objects. |
    53  | Show Score | `showScore` | boolean | Show model confidence score on each instance |
    54  
    55  | Output | ID | Type | Description |
    56  | :--- | :--- | :--- | :--- |
    57  | Image | `image` | string | Output image |
    58  
    59  ### Draw Keypoint
    60  
    61  Draw keypoint result on the image.
    62  
    63  | Input | ID | Type | Description |
    64  | :--- | :--- | :--- | :--- |
    65  | Task ID (required) | `task` | string | `TASK_DRAW_KEYPOINT` |
    66  | Image (required) | `image` | string | Input image |
    67  | Objects (required) | `objects` | array[object] | A list of keypoint objects, a keypoint object includes all the pre-defined keypoints of a detected object. |
    68  | Show Score | `showScore` | boolean | Show model confidence score on each instance |
    69  
    70  | Output | ID | Type | Description |
    71  | :--- | :--- | :--- | :--- |
    72  | Image | `image` | string | Output image |
    73  
    74  ### Draw Ocr
    75  
    76  Draw OCR result on the image.
    77  
    78  | Input | ID | Type | Description |
    79  | :--- | :--- | :--- | :--- |
    80  | Task ID (required) | `task` | string | `TASK_DRAW_OCR` |
    81  | Image (required) | `image` | string | Input image |
    82  | Objects (required) | `objects` | array[object] | A list of detected bounding boxes. |
    83  | Show Score | `showScore` | boolean | Show model confidence score on each instance |
    84  
    85  | Output | ID | Type | Description |
    86  | :--- | :--- | :--- | :--- |
    87  | Image | `image` | string | Output image |
    88  
    89  ### Draw Instance Segmentation
    90  
    91  Draw instance segmentation result on the image.
    92  
    93  | Input | ID | Type | Description |
    94  | :--- | :--- | :--- | :--- |
    95  | Task ID (required) | `task` | string | `TASK_DRAW_INSTANCE_SEGMENTATION` |
    96  | Image (required) | `image` | string | Input image |
    97  | Objects (required) | `objects` | array[object] | A list of detected instance bounding boxes. |
    98  | Show Score | `showScore` | boolean | Show model confidence score on each instance |
    99  
   100  | Output | ID | Type | Description |
   101  | :--- | :--- | :--- | :--- |
   102  | Image | `image` | string | Output image |
   103  
   104  ### Draw Semantic Segmentation
   105  
   106  Draw semantic segmentation result on the image.
   107  
   108  | Input | ID | Type | Description |
   109  | :--- | :--- | :--- | :--- |
   110  | Task ID (required) | `task` | string | `TASK_DRAW_SEMANTIC_SEGMENTATION` |
   111  | Image (required) | `image` | string | Input image |
   112  | Show Score | `showScore` | boolean | Show model confidence score on each instance |
   113  | Stuffs (required) | `stuffs` | array[object] | A list of RLE binary masks. |
   114  
   115  | Output | ID | Type | Description |
   116  | :--- | :--- | :--- | :--- |
   117  | Image | `image` | string | Output image |