Welcome to ISAT-SAM’s documentation!
ISAT-SAM stands for Interactive Semi-Automatic Annotation Tool with Segment Anything Model
You can access the project on GitHub and view the source code.
Features
Hint
Focusing on the field of image segmentation, we strive to create the best image segmentation annotation software.
Better performance and a smoother annotation experience.
Supports SAM, SAM2, SAM3, Sam-HQ, MobileSAM, EdgeSAM and MedSAM.
Supports Segment anything model with
point promptandbox promptto semi-automatic annotation.Supports
text promptandvisual promptbased on sam3.Supports using remote server for SAM encoding.
Supports
video annotation.Supports plugin extensions.
Contents
- Installation
- User Guide
- Plugin
- Contact us
- API Reference
- ISAT
- ISAT package
- Subpackages
- ISAT.formats package
- Submodules
- ISAT.formats.coco module
- ISAT.formats.isat module
ISATISAT.annosISAT.catesISAT.ANNOISAT.ANNO.infoISAT.ANNO.objsISAT.ANNO.INFOISAT.ANNO.INFO.descriptionISAT.ANNO.INFO.folderISAT.ANNO.INFO.nameISAT.ANNO.INFO.widthISAT.ANNO.INFO.heightISAT.ANNO.INFO.depthISAT.ANNO.INFO.noteISAT.ANNO.INFO.descriptionISAT.ANNO.INFO.folderISAT.ANNO.INFO.nameISAT.ANNO.INFO.widthISAT.ANNO.INFO.heightISAT.ANNO.INFO.depthISAT.ANNO.INFO.note
ISAT.ANNO.OBJISAT.ANNO.OBJ.categoryISAT.ANNO.OBJ.groupISAT.ANNO.OBJ.segmentationISAT.ANNO.OBJ.areaISAT.ANNO.OBJ.layerISAT.ANNO.OBJ.bboxISAT.ANNO.OBJ.iscrowdISAT.ANNO.OBJ.noteISAT.ANNO.OBJ.categoryISAT.ANNO.OBJ.groupISAT.ANNO.OBJ.segmentationISAT.ANNO.OBJ.areaISAT.ANNO.OBJ.layerISAT.ANNO.OBJ.bboxISAT.ANNO.OBJ.iscrowdISAT.ANNO.OBJ.note
ISAT.ANNO.infoISAT.ANNO.objs
ISAT.annosISAT.catesISAT.read_from_ISAT()ISAT.save_to_ISAT()ISAT.remove_file_suffix()ISAT.load_one_isat_json()ISAT.save_one_isat_json()
- ISAT.formats.labelme module
- ISAT.formats.voc module
- ISAT.formats.voc_detection module
- ISAT.formats.yolo module
- Module contents
- ISAT.segment_any package
- ISAT.utils package
- ISAT.widgets package
- Submodules
- ISAT.widgets.about_dialog module
- ISAT.widgets.annos_dock_widget module
AnnosDockWidgetAnnosDockWidget.mainwindowAnnosDockWidget.polygon_item_dictAnnosDockWidget.right_button_menu()AnnosDockWidget.generate_item_and_itemwidget()AnnosDockWidget.update_listwidget()AnnosDockWidget.update_combobox_group_select()AnnosDockWidget.listwidget_add_polygon()AnnosDockWidget.listwidget_remove_polygon()AnnosDockWidget.set_selected()AnnosDockWidget.set_polygon_selected()AnnosDockWidget.set_polygon_show()AnnosDockWidget.set_all_polygon_visible()AnnosDockWidget.set_all_polygon_lock()AnnosDockWidget.set_group_polygon_visible()AnnosDockWidget.zoom_to_group()AnnosDockWidget.go_to_next_group()AnnosDockWidget.go_to_prev_group()
- ISAT.widgets.annos_validator_dialog module
- ISAT.widgets.auto_segment_dialog module
- ISAT.widgets.canvas module
AnnotationSceneAnnotationScene.image_itemAnnotationScene.mask_itemAnnotationScene.image_dataAnnotationScene.current_graphAnnotationScene.prompt_box_itemAnnotationScene.repaint_line_itemAnnotationScene.modeAnnotationScene.draw_modeAnnotationScene.contour_modeAnnotationScene.prompt_point_positionsAnnotationScene.prompt_point_labelsAnnotationScene.prompt_point_itemsAnnotationScene.maskAnnotationScene.mask_alphaAnnotationScene.guide_line_xAnnotationScene.guide_line_yAnnotationScene.last_draw_timeAnnotationScene.draw_intervalAnnotationScene.pressedAnnotationScene.selected_polygons_listAnnotationScene.repaint_start_vertexAnnotationScene.repaint_end_vertexAnnotationScene.hovered_vertexAnnotationScene.load_image()AnnotationScene.unload_image()AnnotationScene.change_mode_to_create()AnnotationScene.change_mode_to_view()AnnotationScene.change_mode_to_edit()AnnotationScene.change_mode_to_repaint()AnnotationScene.change_contour_mode_to_save_all()AnnotationScene.change_contour_mode_to_save_max_only()AnnotationScene.change_contour_mode_to_save_external()AnnotationScene.change_contour_method_to_simple()AnnotationScene.change_contour_method_to_tc89_kcos()AnnotationScene.change_contour_method_to_none()AnnotationScene.start_segment_anything()AnnotationScene.start_segment_anything_box()AnnotationScene.start_segment_anything_visual()AnnotationScene.start_draw_polygon()AnnotationScene.start_draw()AnnotationScene.finish_draw()AnnotationScene.cancel_draw()AnnotationScene.delete_selected_graph()AnnotationScene.edit_polygon()AnnotationScene.move_polygon_to_top()AnnotationScene.move_polygon_to_bottom()AnnotationScene.copy_item()AnnotationScene.polygons_union()AnnotationScene.polygons_difference()AnnotationScene.polygons_intersection()AnnotationScene.polygons_symmetric_difference()AnnotationScene.mousePressEvent()AnnotationScene.mouseReleaseEvent()AnnotationScene.mouseMoveEvent()AnnotationScene.update_mask()AnnotationScene.backspace()
AnnotationView
- ISAT.widgets.category_dock_widget module
CategoriesDockWidgetCategoriesDockWidget.choice_category()CategoriesDockWidget.update_widget()CategoriesDockWidget.radio_choice()CategoriesDockWidget.item_choice()CategoriesDockWidget.update_current_group()CategoriesDockWidget.increase_current_group()CategoriesDockWidget.decrease_current_group()CategoriesDockWidget.toggle_group_mode()
- ISAT.widgets.category_edit_dialog module
CategoryEditDialogCategoryEditDialog.check_category_enabled()CategoryEditDialog.check_group_enabled()CategoryEditDialog.check_note_enabled()CategoryEditDialog.check_crowded_enabled()CategoryEditDialog.load_cfg()CategoryEditDialog.get_category()CategoryEditDialog.apply()CategoryEditDialog.cancel()CategoryEditDialog.closeEvent()CategoryEditDialog.reject()
- ISAT.widgets.category_setting_dialog module
CategorySettingDialogCategorySettingDialog.get_item_and_widget()CategorySettingDialog.remove_category_item()CategorySettingDialog.load_cfg()CategorySettingDialog.add_new_category()CategorySettingDialog.choice_color()CategorySettingDialog.import_cfg()CategorySettingDialog.export_cfg()CategorySettingDialog.apply()CategorySettingDialog.cancel()CategorySettingDialog.init_connect()
- ISAT.widgets.converter_dialog module
- ISAT.widgets.files_dock_widget module
- ISAT.widgets.info_dock_widget module
- ISAT.widgets.mainwindow module
QtBoxStyleProgressBarcalculate_area()SegAnyThreadSegAnyVideoThreadInitSegAnyThreadCheckLatestVersionThreadMainWindowMainWindow.image_rootMainWindow.label_rootMainWindow.files_listMainWindow.current_indexMainWindow.current_groupMainWindow.config_fileMainWindow.software_config_fileMainWindow.savedMainWindow.can_be_annotatedMainWindow.load_finishedMainWindow.polygonsMainWindow.instance_cmapMainWindow.map_modeMainWindow.current_labelMainWindow.use_segment_anythingMainWindow.use_segment_anything_videoMainWindow.use_remote_samMainWindow.group_select_modeMainWindow.init_segment_anything()MainWindow.init_sam_finish()MainWindow.sam_encoder_finish()MainWindow.SeganyEnabled()MainWindow.seg_video_start()MainWindow.seg_video_finish()MainWindow.predict_current_image_with_text_prompt()MainWindow.predict_current_image_with_visual_prompt()MainWindow.mask_to_polygon()MainWindow.init_ui()MainWindow.statusbar_change_status()MainWindow.translate()MainWindow.change_language()MainWindow.reload_cfg()MainWindow.load_actions_shortcut()MainWindow.set_saved_state()MainWindow.open_dir()MainWindow.save_dir()MainWindow.save()MainWindow.update_group_display()MainWindow.show_image()MainWindow.prev_image()MainWindow.next_image()MainWindow.jump_to()MainWindow.category_setting()MainWindow.change_bit_map_to_semantic()MainWindow.change_bit_map_to_instance()MainWindow.change_bit_map_to_label()MainWindow.change_bit_map()MainWindow.set_labels_visible()MainWindow.model_manage()MainWindow.remote_sam()MainWindow.change_bfloat16_state()MainWindow.change_use_video_segmentation_state()MainWindow.change_contour_mode()MainWindow.change_contour_method()MainWindow.change_mask_alpha()MainWindow.change_polygon_alpha_hover()MainWindow.change_polygon_alpha_no_hover()MainWindow.change_vertex_size()MainWindow.change_auto_save_state()MainWindow.change_real_time_area_state()MainWindow.change_edge_state()MainWindow.change_approx_polygon_state()MainWindow.change_create_mode_invisible_polygon_state()MainWindow.change_saturation()MainWindow.change_prompt_visiable()MainWindow.converter()MainWindow.video2frames()MainWindow.auto_segment()MainWindow.annos_validator()MainWindow.process_exif()MainWindow.shortcut()MainWindow.about()MainWindow.setting()MainWindow.screen_shot()MainWindow.save_cfg()MainWindow.save_software_cfg()MainWindow.open_docs()MainWindow.exit()MainWindow.closeEvent()MainWindow.latest_version_tip()MainWindow.create_desktop_shortcut()MainWindow.init_connect()MainWindow.reset_action()
- ISAT.widgets.model_manager_dialog module
DownloadThreadModelManagerDialogModelManagerDialog.init_ui()ModelManagerDialog.update_ui()ModelManagerDialog.download()ModelManagerDialog.download_process()ModelManagerDialog.pause()ModelManagerDialog.delete()ModelManagerDialog.clear_tmp()ModelManagerDialog.open_checkpoint_dir()ModelManagerDialog.load_fine_tuned_model()ModelManagerDialog.use_fine_tune_model()
- ISAT.widgets.plugin_base module
PluginBasePluginBase.init_plugin()PluginBase.enable_plugin()PluginBase.disable_plugin()PluginBase.get_plugin_author()PluginBase.get_plugin_version()PluginBase.get_plugin_description()PluginBase.get_plugin_name()PluginBase.activate_state_changed()PluginBase.before_image_open_event()PluginBase.after_image_open_event()PluginBase.before_annotation_start_event()PluginBase.after_annotation_created_event()PluginBase.after_annotation_changed_event()PluginBase.before_annotations_save_event()PluginBase.after_annotations_saved_event()PluginBase.after_sam_encode_finished_event()PluginBase.on_mouse_move_event()PluginBase.on_mouse_press_event()PluginBase.on_mouse_release_event()PluginBase.on_mouse_pressed_and_mouse_move_event()PluginBase.application_start_event()PluginBase.application_shutdown_event()
- ISAT.widgets.plugin_manager_dialog module
PluginManagerDialogPluginManagerDialog.load_plugins()PluginManagerDialog.update_gui()PluginManagerDialog.trigger_before_image_open()PluginManagerDialog.trigger_after_image_open()PluginManagerDialog.trigger_before_annotation_start()PluginManagerDialog.trigger_after_annotation_created()PluginManagerDialog.trigger_after_annotation_changed()PluginManagerDialog.trigger_before_annotations_save()PluginManagerDialog.trigger_after_annotations_saved()PluginManagerDialog.trigger_after_sam_encode_finished()PluginManagerDialog.trigger_on_mouse_move()PluginManagerDialog.trigger_on_mouse_release()PluginManagerDialog.trigger_on_mouse_press()PluginManagerDialog.trigger_on_mouse_pressed_and_mouse_move()PluginManagerDialog.trigger_application_start()PluginManagerDialog.trigger_application_shutdown()
- ISAT.widgets.polygon module
PromptPointVertexPolygonPolygon.line_widthPolygon.hover_alphaPolygon.nohover_alphaPolygon.pointsPolygon.verticesPolygon.is_drawingPolygon.categoryPolygon.groupPolygon.iscrowdPolygon.notePolygon.areaPolygon.addPoint()Polygon.movePoint()Polygon.removePoint()Polygon.delete()Polygon.moveVertex()Polygon.itemChange()Polygon.hoverEnterEvent()Polygon.hoverLeaveEvent()Polygon.mouseDoubleClickEvent()Polygon.redraw()Polygon.change_color()Polygon.set_drawed()Polygon.calculate_area()Polygon.load_object()Polygon.to_object()
LineVertexLineRectVertexRect
- ISAT.widgets.process_exif_dialog module
- ISAT.widgets.remote_sam_dialog module
- ISAT.widgets.right_button_menu module
- ISAT.widgets.setting_dialog module
- ISAT.widgets.shortcut_dialog module
- ISAT.widgets.switch_button module
- ISAT.widgets.text_prompt_dock_widget module
- ISAT.widgets.video_to_frames_dialog module
- ISAT.widgets.visuall_prompt_dock_widget module
- Module contents
- ISAT.formats package
- Submodules
- ISAT.annotation module
- ISAT.configs module
- ISAT.main module
- Module contents
- Subpackages
- ISAT package
- ISAT