ISAT_with_segment_anything

An Interactive Semi-Automatic Annotation Tool Based on Segment Anything

[中文] [English]

Our tool enables interactive use of segment anything for rapid image segmentation with low RAM requirements (optional bf16 mode).

Demo Video：YouTube

Features

Annotaion modes

• Semi-automatic Annotation: utilizes SAM with point and bbox prompts.
• Manual Annotation: click or drag to draw polygons (0.15s per point).

Annotation adjustments

• Polygon Adjustments: delete points and adjust object occlusions.
• Polygon Visualization: Preview groups and semantic/instance segmentation masks.

Export annotations

• Supported formats: MSCOCO, YOLO, LabelMe, and VOC (also xml)

For more features, see the Features Description.

Installation

There are three ways to install ISAT-SAM:

1. from source code (recommended)
2. pip install
3. from .exe

Option 1: from source code

(1) Create environment

conda create -n isat_env python=3.8
conda activate isat_env

(2) Install ISAT_with_segment_anything and its dependencies

To use GPU, please install Pytorch-GPU on Windows OS frist.

git clone https://github.com/yatengLG/ISAT_with_segment_anything.git
cd ISAT_with_segment_anything
pip install -r requirements.txt

(3) Download Segment anything pretrained checkpoint.

Download the checkpoint, and save in under: ISAT_with_segment_anything/ISAT/checkpoints

After version 0.0.3, you can manage checkpoints within GUI, click [menubar]-[SAM]-[Model manage] to open the GUI.

Now support SAM, sam-hq, MobileSAM, and EdgeSAM etc.

(4) Run

python main.py

Option 2: pip install

Note that the version may be lower than source code version if installed with pip

(1) Create environment

conda create -n isat_env python=3.8
conda activate isat_env

(2) pip install isat-sam

To use GPU, please install Pytorch-GPU on Windows OS frist.

pip install isat-sam

(3) Run

isat-sam

Option 3: install with .exe

(1) download the .exe

The version of exe maybe older than source code.

Download three .zip files, total 2.7G

Click main.exe to run the tool.

(2) Download Segment anything pretrained checkpoint.

The download zip files, container sam_hq_vit_tiny.pth, but somebody told the model not support cpu. You can download mobile_sam.pt to test the tool.

If you want use other models, seeDownload Segment anything pretrained checkpoint

Usage

1. Annotation

1. Choose the categories in left window of software.
    Edit the category in Toolbar-File-Setting.
    
2. Start annotating
    2.1 semi-automatic annotate with SAM.
        Click button named [Segment anything] start annotate(shortcut Q).
        Click interested area with left button of mouse, click uninterested area with right button of mouse, SAM will calcute masks.
    2.2 draw polygons manually.
        Click the button [Draw polygon] to start annotation (shortcut C).
        Left click to add point into the polygon.
        Hold the left click and drag will automaticly add point into the polygon (time interval of 0.15 seconds).
    2.3 Undo
        Click the button [Backspace] to return to the previous state (shortcut Z).
3. Finish the annotation with [Annotate finished] or shortcut E.
4. Save the annotation with [Save] or shortcut S

2. Polygon Modification

1. Modify polygons coordinates
    Drag and drop polygon vertices to modify the shape of the polygon.
    Drag the polygon to adjust its position.
2. Modify polygons category
    Choose the polygon and click [Edit] or double click the polygon, and choose the new category in editing window. 
3. Occlusion modification
    Choose the polygon and click [To top] (shortcut T) or [To bottom] (shortcut B).
4. Delete polygon
    Choose the polygon and click [Delete] to delete the polygon.

3. Visualization

1. Preview annotations
    Click the [Bit map] to preview semantic and instance annotation masks (shortcut space).
    The order of swithing is polygons-semantic-instance.
2. Image window
    Click [Zoom in], [Zoom out], [Fit window] (shortcut F) to adjust the zooming distances.
3. Show / hide polygons
    Click [Visible] to show / hide polygons (shortcut V).
4. Mask aplha (only effective when using SAM)
    Drag the [mask aplha] bar to adjust the mask transparency.

4. Convet annotations

ISAT has a specific format with .json. You can use export it to other formarts.

1. ISAT to VOC
    Convert ISAT jsons to PNG images.
2. ISAT to COCO
    Convert ISAT jsons to COCO json.
3. ISAT to LABELME
    Convert ISAT jsons to LABELME jsons.
4. COCO to ISAT
    Convert COCO json to ISAT jsons.

Star History

Please support us with a star—it's like a virtual coffee!

Contributors

		...
yatengLG	Alias-z	...

Citation

@misc{ISAT with segment anything,
  title={{ISAT with segment anything}: An Interactive Semi-Automatic Annotation Tool Based on Segment Anything},
  url={https://github.com/yatengLG/ISAT_with_segment_anything},
  note={Open source software available from https://github.com/yatengLG/ISAT_with_segment_anything},
  author={yatengLG, Alias-z and horffmanwang},
  year={2023},
}