New functions of PPOCRLabel release

New functions: Open the dataset folder, image rotation, add shortcut key description, repair the direction shortcut key movement function under batch processing 

PPOCRLabel/PPOCRLabel.py

@@ -467,10 +467,10 @@ class MainWindow(QMainWindow, WindowMixin):
         undoLastPoint = action(getStr("undoLastPoint"), self.canvas.undoLastPoint,
                                'Ctrl+Z', "undo", getStr("undoLastPoint"), enabled=False)
 
-        rotateLeft = action(getStr("rotateLeft"), self.rotateLeftImg,
+        rotateLeft = action(getStr("rotateLeft"), partial(self.rotateImgAction,1),
                                'Ctrl+Alt+L', "rotateLeft", getStr("rotateLeft"), enabled=False)
 
-        rotateRight = action(getStr("rotateRight"), self.rotateRightImg,
+        rotateRight = action(getStr("rotateRight"), partial(self.rotateImgAction,-1),
                                'Ctrl+Alt+R', "rotateRight", getStr("rotateRight"), enabled=False)
 
         undo = action(getStr("undo"), self.undoShapeEdit,
@@ -811,7 +811,7 @@ class MainWindow(QMainWindow, WindowMixin):
             self.msgBox.warning (self, "Warn", "\n The picture already has a label box, and rotation will disrupt the label.\
              It is recommended to clear the label box and rotate it.")
 
-    def rotateLeftImg(self, _value=False):
+    def rotateImgAction(self, k=1, _value=False):
 
         filename = self.mImgList[self.currIndex]
 
@@ -819,23 +819,13 @@ class MainWindow(QMainWindow, WindowMixin):
             if self.itemsToShapesbox:
                 self.rotateImgWarn()
             else:
-                self.rotateImg(filename=filename, k=1, _value=True)
-        else:
-            self.rotateImgWarn()
-            self.actions.rotateRight.setEnabled(False)
-
-    def rotateRightImg(self, _value=False):
-
-        filename = self.mImgList[self.currIndex]
-
-        if os.path.exists(filename):
-            if self.itemsToShapesbox:
-                self.rotateImgWarn()
-            else:
-                self.rotateImg(filename=filename, k=-1, _value=True)
+                self.saveFile()
+                self.dirty = False
+                self.rotateImg(filename=filename, k=k, _value=True)
         else:
             self.rotateImgWarn()
             self.actions.rotateRight.setEnabled(False)
+            self.actions.rotateLeft.setEnabled(False)
 
     def toggleDrawingSensitive(self, drawing=True):
         """In the middle of drawing, toggling between modes should be disabled."""
@@ -1519,12 +1509,13 @@ class MainWindow(QMainWindow, WindowMixin):
         self.importDirImages(targetDirPath)
 
     def openDatasetDirDialog(self,):
-        if not self.mayContinue():
-            return
-
         if self.lastOpenDir and os.path.exists(self.lastOpenDir):
-            os.startfile(self.lastOpenDir)
+            if platform.system() == 'Windows':
+                os.startfile(self.lastOpenDir)
+            else:
+                os.system('open ' + os.path.normpath(self.lastOpenDir))
             defaultOpenDirPath = self.lastOpenDir
+
         else:
             if self.lang == 'ch':
                 self.msgBox.warning(self, "提示", "\n 原文件夹已不存在,请从新选择数据集路径!")

PPOCRLabel/README.md

@@ -8,9 +8,12 @@ PPOCRLabel is a semi-automatic graphic annotation tool suitable for OCR field, w
 
 ### Recent Update
 
+- 2021.8.11：
+  - New functions: Open the dataset folder, image rotation (Note: Please delete the label box before rotating the image) (by [Wei-JL](https://github.com/Wei-JL))
+  - Added shortcut key description (Help-Shortcut Key), repaired the direction shortcut key movement function under batch processing (by [d2623587501](https://github.com/d2623587501))
 - 2021.2.5: New batch processing and undo functions (by [Evezerest](https://github.com/Evezerest)):
-  - Batch processing function: Press and hold the Ctrl key to select the box, you can move, copy, and delete in batches.
-  - Undo function: In the process of drawing a four-point label box or after editing the box, press Ctrl+Z to undo the previous operation.
+  - **Batch processing function**: Press and hold the Ctrl key to select the box, you can move, copy, and delete in batches.
+  - **Undo function**: In the process of drawing a four-point label box or after editing the box, press Ctrl+Z to undo the previous operation.
   - Fix image rotation and size problems, optimize the process of editing the mark frame (by [ninetailskim](https://github.com/ninetailskim)、 [edencfc](https://github.com/edencfc)).
 - 2021.1.11: Optimize the labeling experience (by [edencfc](https://github.com/edencfc)),
   - Users can choose whether to pop up the label input dialog after drawing the detection box in "View - Pop-up Label Input Dialog".
@@ -23,15 +26,51 @@ PPOCRLabel is a semi-automatic graphic annotation tool suitable for OCR field, w
 
 ## Installation
 
-### 1. Install PaddleOCR
+### 1. Environment Preparation
 
-PaddleOCR models has been built in PPOCRLabel, please refer to [PaddleOCR installation document](https://github.com/PaddlePaddle/PaddleOCR/blob/develop/doc/doc_ch/installation.md) to prepare PaddleOCR and make sure it works.
+#### **Install PaddlePaddle 2.0**
+
+```bash
+pip3 install --upgrade pip
+
+# If you have cuda9 or cuda10 installed on your machine, please run the following command to install
+python3 -m pip install paddlepaddle-gpu==2.0.0 -i https://mirror.baidu.com/pypi/simple
+
+# If you only have cpu on your machine, please run the following command to install
+python3 -m pip install paddlepaddle==2.0.0 -i https://mirror.baidu.com/pypi/simple
+```
+
+For more software version requirements, please refer to the instructions in [Installation Document](https://www.paddlepaddle.org.cn/install/quick) for operation.
+
+#### **Install PaddleOCR**
+
+```bash
+# Recommend
+git clone https://github.com/PaddlePaddle/PaddleOCR
+
+# If you cannot pull successfully due to network problems, you can also choose to use the code hosting on the cloud:
+
+git clone https://gitee.com/paddlepaddle/PaddleOCR
+
+# Note: The cloud-hosting code may not be able to synchronize the update with this GitHub project in real time. There might be a delay of 3-5 days. Please give priority to the recommended method.
+```
+
+#### **Install Third-party Libraries**
+
+```bash
+cd PaddleOCR
+pip3 install -r requirements.txt
+```
+
+If you getting this error `OSError: [WinError 126] The specified module could not be found` when you install shapely on windows. Please try to download Shapely whl file using http://www.lfd.uci.edu/~gohlke/pythonlibs/#shapely.
+
+Reference: [Solve shapely installation on windows](https://stackoverflow.com/questions/44398265/install-shapely-oserror-winerror-126-the-specified-module-could-not-be-found)
 
 ### 2. Install PPOCRLabel
 
 #### Windows
 
-```
+```bash
 pip install pyqt5
 cd ./PPOCRLabel # Change the directory to the PPOCRLabel folder
 python PPOCRLabel.py
@@ -39,15 +78,15 @@ python PPOCRLabel.py
 
 #### Ubuntu Linux
 
-```
+```bash
 pip3 install pyqt5
 pip3 install trash-cli
 cd ./PPOCRLabel # Change the directory to the PPOCRLabel folder
 python3 PPOCRLabel.py
 ```
 
-#### macOS
-```
+#### MacOS
+```bash
 pip3 install pyqt5
 pip3 uninstall opencv-python # Uninstall opencv manually as it conflicts with pyqt
 pip3 install opencv-contrib-python-headless==4.2.0.32 # Install the headless version of opencv
@@ -77,11 +116,11 @@ python3 PPOCRLabel.py
 
 7. Double click the result in 'recognition result' list to manually change inaccurate recognition results.
 
-8. Click "Check", the image status will switch to "√",then the program automatically jump to the next.
+8. **Click "Check", the image status will switch to "√",then the program automatically jump to the next.**
 
 9. Click "Delete Image" and the image will be deleted to the recycle bin.
 
-10. Labeling result: the user can save manually through the menu "File - Save Label", while the program will also save automatically if "File - Auto Save Label Mode" is selected. The manually checked label will be stored in *Label.txt* under the opened picture folder. Click "PaddleOCR"-"Save Recognition Results" in the menu bar, the recognition training data of such pictures will be saved in the *crop_img* folder, and the recognition label will be saved in *rec_gt.txt*<sup>[4]</sup>.
+10. Labeling result: the user can export the label result manually through the menu "File - Export Label", while the program will also export automatically if "File - Auto export Label Mode" is selected. The manually checked label will be stored in *Label.txt* under the opened picture folder. Click "File"-"Export Recognition Results" in the menu bar, the recognition training data of such pictures will be saved in the *crop_img* folder, and the recognition label will be saved in *rec_gt.txt*<sup>[4]</sup>.
 
 ### Note
 
@@ -95,10 +134,10 @@ python3 PPOCRLabel.py
 
 |   File name   |                         Description                          |
 | :-----------: | :----------------------------------------------------------: |
-|   Label.txt   | The detection label file can be directly used for PPOCR detection model training. After the user saves 5 label results, the file will be automatically saved. It will also be written when the user closes the application or changes the file folder. |
+|   Label.txt   | The detection label file can be directly used for PPOCR detection model training. After the user saves 5 label results, the file will be automatically exported. It will also be written when the user closes the application or changes the file folder. |
 | fileState.txt | The picture status file save the image in the current folder that has been manually confirmed by the user. |
 |  Cache.cach   |    Cache files to save the results of model recognition.     |
-|  rec_gt.txt   | The recognition label file, which can be directly used for PPOCR identification model training, is generated after the user clicks on the menu bar "File"-"Save recognition result". |
+|  rec_gt.txt   | The recognition label file, which can be directly used for PPOCR identification model training, is generated after the user clicks on the menu bar "File"-"Export recognition result". |
 |   crop_img    | The recognition data, generated at the same time with *rec_gt.txt* |
 
 ## Explanation
@@ -132,16 +171,16 @@ python3 PPOCRLabel.py
 
 - Custom model: The model trained by users can be replaced by modifying PPOCRLabel.py in [PaddleOCR class instantiation](https://github.com/PaddlePaddle/PaddleOCR/blob/develop/PPOCRLabel/PPOCRLabel.py#L110) referring [Custom Model Code](https://github.com/PaddlePaddle/PaddleOCR/blob/develop/doc/doc_en/whl_en.md#use-custom-model)
 
-### Save
+### Export Label Result
 
-PPOCRLabel supports three ways to save Label.txt
+PPOCRLabel supports three ways to export Label.txt
 
-- Automatically save: After selecting "File - Auto Save Label Mode", the program will automatically write the annotations into Label.txt every time the user confirms an image. If this option is not turned on, it will be automatically saved after detecting that the user has manually checked 5 images.
-- Manual save: Click "File-Save Marking Results" to manually save the label.
-- Close application save
+- Automatically export: After selecting "File - Auto Export Label Mode", the program will automatically write the annotations into Label.txt every time the user confirms an image. If this option is not turned on, it will be automatically exported after detecting that the user has manually checked 5 images.
+- Manual export: Click "File-Export Marking Results" to manually export the label.
+- Close application export
 
 
-### Export partial recognition results
+### Export Partial Recognition Results
 
 For some data that are difficult to recognize, the recognition results will not be exported by **unchecking** the corresponding tags in the recognition results checkbox.
 

PPOCRLabel/README_ch.md

@@ -8,9 +8,12 @@ PPOCRLabel是一款适用于OCR领域的半自动化图形标注工具，内置P
 
 #### 近期更新
 
+- 2021.8.11：
+  - 新增功能：打开数据所在文件夹、图像旋转（注意：旋转前的图片上不能存在标记框）（by [Wei-JL](https://github.com/Wei-JL)）
+  - 新增快捷键说明（帮助-快捷键）、修复批处理下的方向快捷键移动功能（by [d2623587501](https://github.com/d2623587501)）
 - 2021.2.5：新增批处理与撤销功能（by [Evezerest](https://github.com/Evezerest))
-  - 批处理功能：按住Ctrl键选择标记框后可批量移动、复制、删除。
-  - 撤销功能：在绘制四点标注框过程中或对框进行编辑操作后，按下Ctrl+Z可撤销上一部操作。
+  - **批处理功能**：按住Ctrl键选择标记框后可批量移动、复制、删除、重新识别。
+  - **撤销功能**：在绘制四点标注框过程中或对框进行编辑操作后，按下Ctrl+Z可撤销上一部操作。
   - 修复图像旋转和尺寸问题、优化编辑标记框过程（by [ninetailskim](https://github.com/ninetailskim)、 [edencfc](https://github.com/edencfc)）
 - 2021.1.11：优化标注体验（by [edencfc](https://github.com/edencfc)）：
   - 用户可在“视图 - 弹出标记输入框”选择在画完检测框后标记输入框是否弹出。
@@ -27,13 +30,48 @@ PPOCRLabel是一款适用于OCR领域的半自动化图形标注工具，内置P
 
 ## 安装
 
-### 1. 安装PaddleOCR
-PPOCRLabel内置PaddleOCR模型，故请参考[PaddleOCR安装文档](https://github.com/PaddlePaddle/PaddleOCR/blob/develop/doc/doc_ch/installation.md)准备好PaddleOCR，并确保PaddleOCR安装成功。
+### 1. 环境搭建
+#### 安装PaddlePaddle
+
+```bash
+pip3 install --upgrade pip
+
+如果您的机器安装的是CUDA9或CUDA10，请运行以下命令安装
+python3 -m pip install paddlepaddle-gpu==2.0.0 -i https://mirror.baidu.com/pypi/simple
+
+如果您的机器是CPU，请运行以下命令安装
+
+python3 -m pip install paddlepaddle==2.0.0 -i https://mirror.baidu.com/pypi/simple
+```
+
+更多的版本需求，请参照[安装文档](https://www.paddlepaddle.org.cn/install/quick)中的说明进行操作。
+
+#### **安装PaddleOCR**
+
+```bash
+【推荐】git clone https://github.com/PaddlePaddle/PaddleOCR
+
+如果因为网络问题无法pull成功，也可选择使用码云上的托管：
+
+git clone https://gitee.com/paddlepaddle/PaddleOCR
+
+注：码云托管代码可能无法实时同步本github项目更新，存在3~5天延时，请优先使用推荐方式。
+```
+
+#### 安装第三方库
+
+```bash
+cd PaddleOCR
+pip3 install -r requirements.txt
+```
+
+注意，windows环境下，建议从[这里](https://www.lfd.uci.edu/~gohlke/pythonlibs/#shapely)下载shapely安装包完成安装， 直接通过pip安装的shapely库可能出现`[winRrror 126] 找不到指定模块的问题`。
 
 ### 2. 安装PPOCRLabel
+
 #### Windows
 
-```
+```bash
 pip install pyqt5
 cd ./PPOCRLabel # 将目录切换到PPOCRLabel文件夹下
 python PPOCRLabel.py --lang ch
@@ -41,15 +79,15 @@ python PPOCRLabel.py --lang ch
 
 #### Ubuntu Linux
 
-```
+```bash
 pip3 install pyqt5
 pip3 install trash-cli
 cd ./PPOCRLabel # 将目录切换到PPOCRLabel文件夹下
 python3 PPOCRLabel.py --lang ch
 ```
 
-#### macOS
-```
+#### MacOS
+```bash
 pip3 install pyqt5
 pip3 uninstall opencv-python # 由于mac版本的opencv与pyqt有冲突，需先手动卸载opencv
 pip3 install opencv-contrib-python-headless==4.2.0.32 # 安装headless版本的open-cv
@@ -57,6 +95,8 @@ cd ./PPOCRLabel # 将目录切换到PPOCRLabel文件夹下
 python3 PPOCRLabel.py --lang ch
 ```
 
+
+
 ## 使用
 
 ### 操作步骤
@@ -68,9 +108,9 @@ python3 PPOCRLabel.py --lang ch
 5. 标记框绘制完成后，用户点击 “确认”，检测框会先被预分配一个 “待识别” 标签。
 6. 重新识别：将图片中的所有检测画绘制/调整完成后，点击 “重新识别”，PPOCR模型会对当前图片中的**所有检测框**重新识别<sup>[3]</sup>。
 7. 内容更改：双击识别结果，对不准确的识别结果进行手动更改。
-8. **确认标记**：点击 “确认”，图片状态切换为 “√”，跳转至下一张。
+8. **确认标记：点击 “确认”，图片状态切换为 “√”，跳转至下一张。**
 9. 删除：点击 “删除图像”，图片将会被删除至回收站。
-10. 保存结果：用户可以通过菜单中“文件-保存标记结果”手动保存，同时也可以点击“文件 - 自动保存标记结果”开启自动保存。手动确认过的标记将会被存放在所打开图片文件夹下的*Label.txt*中。在菜单栏点击 “文件” - "保存识别结果"后，会将此类图片的识别训练数据保存在*crop_img*文件夹下，识别标签保存在*rec_gt.txt*中<sup>[4]</sup>。
+10. 导出结果：用户可以通过菜单中“文件-导出标记结果”手动导出，同时也可以点击“文件 - 自动导出标记结果”开启自动导出。手动确认过的标记将会被存放在所打开图片文件夹下的*Label.txt*中。在菜单栏点击 “文件” - "导出识别结果"后，会将此类图片的识别训练数据保存在*crop_img*文件夹下，识别标签保存在*rec_gt.txt*中<sup>[4]</sup>。
 
 ### 注意
 
@@ -84,10 +124,10 @@ python3 PPOCRLabel.py --lang ch
 
 |    文件名     |                             说明                             |
 | :-----------: | :----------------------------------------------------------: |
-|   Label.txt   | 检测标签，可直接用于PPOCR检测模型训练。用户每保存5张检测结果后，程序会进行自动写入。当用户关闭应用程序或切换文件路径后同样会进行写入。 |
+|   Label.txt   | 检测标签，可直接用于PPOCR检测模型训练。用户每确认5张检测结果后，程序会进行自动写入。当用户关闭应用程序或切换文件路径后同样会进行写入。 |
 | fileState.txt | 图片状态标记文件，保存当前文件夹下已经被用户手动确认过的图片名称。 |
 |  Cache.cach   |              缓存文件，保存模型自动识别的结果。              |
-|  rec_gt.txt   | 识别标签。可直接用于PPOCR识别模型训练。需用户手动点击菜单栏“文件” - "保存识别结果"后产生。 |
+|  rec_gt.txt   | 识别标签。可直接用于PPOCR识别模型训练。需用户手动点击菜单栏“文件” - "导出识别结果"后产生。 |
 |   crop_img    |   识别数据。按照检测框切割后的图片。与rec_gt.txt同时产生。   |
 
 ## 说明
@@ -120,19 +160,19 @@ python3 PPOCRLabel.py --lang ch
 
  - 自定义模型：用户可根据[自定义模型代码使用](https://github.com/PaddlePaddle/PaddleOCR/blob/develop/doc/doc_ch/whl.md#%E8%87%AA%E5%AE%9A%E4%B9%89%E6%A8%A1%E5%9E%8B)，通过修改PPOCRLabel.py中针对[PaddleOCR类的实例化](https://github.com/PaddlePaddle/PaddleOCR/blob/develop/PPOCRLabel/PPOCRLabel.py#L110)替换成自己训练的模型。
 
-### 保存方式
+### 导出标记结果
 
-PPOCRLabel支持三种保存方式：
+PPOCRLabel支持三种导出方式：
 
-- 自动保存：点击“文件 - 自动保存标记结果”后，用户每确认过一张图片，程序自动将标记结果写入Label.txt中。若未开启此选项，则检测到用户手动确认过5张图片后进行自动保存。
-- 手动保存：点击“文件 - 保存标记结果”手动保存标记。
-- 关闭应用程序保存
+- 自动导出：点击“文件 - 自动导出标记结果”后，用户每确认过一张图片，程序自动将标记结果写入Label.txt中。若未开启此选项，则检测到用户手动确认过5张图片后进行自动导出。
+- 手动导出：点击“文件 - 导出标记结果”手动导出标记。
+- 关闭应用程序导出
 
 ### 导出部分识别结果
 
 针对部分难以识别的数据，通过在识别结果的复选框中**取消勾选**相应的标记，其识别结果不会被导出。
 
-*注意：识别结果中的复选框状态仍需用户手动点击保存后才能保留*
+*注意：识别结果中的复选框状态仍需用户手动点击确认后才能保留*
 
 ### 错误提示
 - 如果同时使用whl包安装了paddleocr，其优先级大于通过paddleocr.py调用PaddleOCR类，whl包未更新时会导致程序异常。

PPOCRLabel/libs/canvas.py

@@ -754,11 +754,11 @@ class Canvas(QWidget):
                 self.selectedShape.points[1] += QPointF(0, 1.0)
                 self.selectedShape.points[2] += QPointF(0, 1.0)
                 self.selectedShape.points[3] += QPointF(0, 1.0)
-            shapesBackup = []
-            shapesBackup = copy.deepcopy(self.shapes)
-            self.shapesBackups.append(shapesBackup)
-            self.shapeMoved.emit()
-            self.repaint()
+        shapesBackup = []
+        shapesBackup = copy.deepcopy(self.shapes)
+        self.shapesBackups.append(shapesBackup)
+        self.shapeMoved.emit()
+        self.repaint()
 
     def moveOutOfBound(self, step):
         points = [p1+p2 for p1, p2 in zip(self.selectedShape.points, [step]*4)]
@@ -853,10 +853,7 @@ class Canvas(QWidget):
     def restoreShape(self):
         if not self.isShapeRestorable:
             return
-        if self.selectCountShape:
-            if len(self.shapesBackups) > 2:
-                for i in range(1,self.selectCount):
-                    self.shapesBackups.pop()
+
         self.shapesBackups.pop()  # latest
         shapesBackup = self.shapesBackups.pop()
         self.shapes = shapesBackup

PPOCRLabel/resources/strings/strings-zh-CN.properties

@@ -88,7 +88,7 @@ creatPolygon=四点标注
 drawSquares=正方形标注
 rotateLeft=图片左旋转90度
 rotateRight=图片右旋转90度
-saveRec=保存识别结果
+saveRec=导出识别结果
 tempLabel=待识别
 nullLabel=无法识别
 steps=操作步骤
@@ -99,9 +99,9 @@ ok=确认
 autolabeling=自动标注中
 hideBox=隐藏所有标注
 showBox=显示所有标注
-saveLabel=保存标记结果
+saveLabel=导出标记结果
 singleRe=重识别此区块
 labelDialogOption=弹出标记输入框
 undo=撤销
 undoLastPoint=撤销上个点
-autoSaveMode=自动保存标记结果
\ No newline at end of file
+autoSaveMode=自动导出标记结果
\ No newline at end of file

PPOCRLabel/resources/strings/strings.properties

@@ -88,7 +88,7 @@ creatPolygon=Create Quadrilateral
 rotateLeft=Left turn 90 degrees
 rotateRight=Right turn 90 degrees
 drawSquares=Draw Squares
-saveRec=Save Recognition Result
+saveRec=Export Recognition Result
 tempLabel=TEMPORARY
 nullLabel=NULL
 steps=Steps
@@ -99,9 +99,9 @@ ok=OK
 autolabeling=Automatic Labeling
 hideBox=Hide All Box
 showBox=Show All Box
-saveLabel=Save Label
+saveLabel=Export Label
 singleRe=Re-recognition RectBox
 labelDialogOption=Pop-up Label Input Dialog
 undo=Undo
 undoLastPoint=Undo Last Point
-autoSaveMode=Auto Save Label Mode
\ No newline at end of file
+autoSaveMode=Auto Export Label Mode
\ No newline at end of file