annofabcli 1.113.0__tar.gz → 1.113.1__tar.gz

{annofabcli-1.113.0 → annofabcli-1.113.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: annofabcli
-Version: 1.113.0
+Version: 1.113.1
 Summary: Utility Command Line Interface for AnnoFab
 Author: Kurusugawa Computer Inc.
 License: MIT

{annofabcli-1.113.0 → annofabcli-1.113.1}/annofabcli/annotation/dump_annotation.py

@@ -68,7 +68,7 @@ class DumpAnnotationMain:
         json_path = task_dir / f"{input_data_id}.json"
         self.dump_editor_annotation(editor_annotation=editor_annotation, json_path=json_path)
 
-    def dump_annotation_for_task(self, task_id: str, output_dir: Path, *, task_index: int | None = None, task_history_index: int | None = None) -> bool:
+    def dump_annotation_for_task(self, task_id: str, output_dir: Path, *, task_index: int | None = None, task_history_index: int | None = None, task_history_id: str | None = None) -> bool:
         """
         タスク配下のアノテーションをファイルに保存する。
 
@@ -85,23 +85,23 @@ class DumpAnnotationMain:
             logger.warning(f"task_id = '{task_id}' のタスクは存在しません。スキップします。")
             return False
 
-        task_history_id: str | None = None
+        actual_task_history_id: str | None = task_history_id
         if task_history_index is not None:
             task_histories, _ = self.service.api.get_task_histories(self.project_id, task_id)
             if task_history_index >= len(task_histories):
                 logger.warning(f"task_id='{task_id}' :: task_history_index='{task_history_index}'のタスク履歴は存在しません。タスク履歴は{len(task_histories)}件です。スキップします。")
                 return False
-            task_history_id = task_histories[task_history_index]["task_history_id"]
+            actual_task_history_id = task_histories[task_history_index]["task_history_id"]
 
         input_data_id_list = task["input_data_id_list"]
         task_dir = output_dir / task_id
         task_dir.mkdir(exist_ok=True, parents=True)
-        logger.debug(f"{logger_prefix}task_id = '{task_id}' のアノテーション情報を '{task_dir}' ディレクトリに保存します。 :: task_history_id='{task_history_id}'")
+        logger.debug(f"{logger_prefix}task_id = '{task_id}' のアノテーション情報を '{task_dir}' ディレクトリに保存します。 :: task_history_id='{actual_task_history_id}'")
 
         is_failure = False
         for input_data_id in input_data_id_list:
             try:
-                self.dump_annotation_for_input_data(task_id, input_data_id, task_dir=task_dir, task_history_id=task_history_id)
+                self.dump_annotation_for_input_data(task_id, input_data_id, task_dir=task_dir, task_history_id=actual_task_history_id)
             except Exception:
                 logger.warning(f"タスク'{task_id}', 入力データ'{input_data_id}' のアノテーション情報のダンプに失敗しました。", exc_info=True)
                 is_failure = True
@@ -109,15 +109,15 @@ class DumpAnnotationMain:
 
         return not is_failure
 
-    def dump_annotation_for_task_wrapper(self, tpl: tuple[int, str], output_dir: Path, *, task_history_index: int | None = None) -> bool:
+    def dump_annotation_for_task_wrapper(self, tpl: tuple[int, str], output_dir: Path, *, task_history_index: int | None = None, task_history_id: str | None = None) -> bool:
         task_index, task_id = tpl
         try:
-            return self.dump_annotation_for_task(task_id, output_dir=output_dir, task_index=task_index, task_history_index=task_history_index)
+            return self.dump_annotation_for_task(task_id, output_dir=output_dir, task_index=task_index, task_history_index=task_history_index, task_history_id=task_history_id)
         except Exception:  # pylint: disable=broad-except
             logger.warning(f"タスク'{task_id}'のアノテーション情報のダンプに失敗しました。", exc_info=True)
             return False
 
-    def dump_annotation(self, task_id_list: list[str], output_dir: Path, *, task_history_index: int | None = None, parallelism: int | None = None) -> None:
+    def dump_annotation(self, task_id_list: list[str], output_dir: Path, *, task_history_index: int | None = None, task_history_id: str | None = None, parallelism: int | None = None) -> None:
         project_title = self.facade.get_project_title(self.project_id)
         logger.info(f"プロジェクト'{project_title}'に対して、タスク{len(task_id_list)} 件のアノテーションをファイルに保存します。")
 
@@ -126,7 +126,7 @@ class DumpAnnotationMain:
         success_count = 0
 
         if parallelism is not None:
-            func = functools.partial(self.dump_annotation_for_task_wrapper, task_history_index=task_history_index, output_dir=output_dir)
+            func = functools.partial(self.dump_annotation_for_task_wrapper, task_history_index=task_history_index, task_history_id=task_history_id, output_dir=output_dir)
             with multiprocessing.Pool(parallelism) as pool:
                 result_bool_list = pool.map(func, enumerate(task_id_list))
                 success_count = len([e for e in result_bool_list if e])
@@ -134,7 +134,7 @@ class DumpAnnotationMain:
         else:
             for task_index, task_id in enumerate(task_id_list):
                 try:
-                    result = self.dump_annotation_for_task(task_id, output_dir=output_dir, task_history_index=task_history_index, task_index=task_index)
+                    result = self.dump_annotation_for_task(task_id, output_dir=output_dir, task_history_index=task_history_index, task_history_id=task_history_id, task_index=task_index)
                     if result:
                         success_count += 1
                 except Exception:
@@ -157,7 +157,7 @@ class DumpAnnotation(CommandLine):
         super().validate_project(project_id, project_member_roles=None)
 
         main_obj = DumpAnnotationMain(self.service, project_id)
-        main_obj.dump_annotation(task_id_list, output_dir=output_dir, parallelism=args.parallelism, task_history_index=args.task_history_index)
+        main_obj.dump_annotation(task_id_list, output_dir=output_dir, parallelism=args.parallelism, task_history_index=args.task_history_index, task_history_id=args.task_history_id)
 
 
 def main(args: argparse.Namespace) -> None:
@@ -174,12 +174,19 @@ def parse_args(parser: argparse.ArgumentParser) -> None:
 
     parser.add_argument("-o", "--output_dir", type=str, required=True, help="出力先ディレクトリのパス")
 
-    parser.add_argument(
+    task_history_group = parser.add_mutually_exclusive_group()
+    task_history_group.add_argument(
         "--task_history_index",
         type=int,
         help="指定したタスク履歴のインデックス（ゼロ始まり）で付与されたアノテーション情報をダンプします。過去のアノテーション結果をダンプする場合に指定します。"
         "ただし、過去のアノテーションデータは30日間しか保持されません。30日より前に更新されたアノテーションをダンプした場合は、アノテーションが0件の状態でダンプされます。",
     )
+    task_history_group.add_argument(
+        "--task_history_id",
+        type=str,
+        help="指定したタスク履歴IDで付与されたアノテーション情報をダンプします。過去のアノテーション結果をダンプする場合に指定します。"
+        "ただし、過去のアノテーションデータは30日間しか保持されません。30日より前に更新されたアノテーションをダンプした場合は、アノテーションが0件の状態でダンプされます。",
+    )
 
     parser.add_argument(
         "--parallelism",

{annofabcli-1.113.0 → annofabcli-1.113.1}/annofabcli/annotation_zip/list_annotation_3d_bounding_box.py

@@ -1,5 +1,6 @@
 import argparse
 import logging
+import math
 import sys
 import tempfile
 from collections.abc import Collection
@@ -65,6 +66,9 @@ class Annotation3DBoundingBoxInfo(DataClassJsonMixin):
     top_z: float
     """天面のZ座標（location.z + height/2）。回転は考慮していない。"""
 
+    horizontal_distance: float
+    """原点(0, 0)からのXY平面上の距離（sqrt(location.x² + location.y²)）"""
+
     attributes: dict[str, str | int | bool]
     """属性情報"""
 
@@ -96,6 +100,7 @@ def get_annotation_3d_bounding_box_info_list(simple_annotation: dict[str, Any],
         footprint_area = width * depth
         bottom_z = location.z - height / 2
         top_z = location.z + height / 2
+        horizontal_distance = math.hypot(location.x, location.y)
 
         result.append(
             Annotation3DBoundingBoxInfo(
@@ -116,6 +121,7 @@ def get_annotation_3d_bounding_box_info_list(simple_annotation: dict[str, Any],
                 footprint_area=footprint_area,
                 bottom_z=bottom_z,
                 top_z=top_z,
+                horizontal_distance=horizontal_distance,
                 attributes=detail["attributes"],
                 updated_datetime=simple_annotation["updated_datetime"],
             )
@@ -177,6 +183,7 @@ def create_df(
         "footprint_area",
         "bottom_z",
         "top_z",
+        "horizontal_distance",
     ]
 
     if len(tmp_annotation_bbox_list) == 0:

{annofabcli-1.113.0 → annofabcli-1.113.1}/docs/command_reference/annotation/dump.rst

@@ -56,7 +56,12 @@ Examples
 
 過去のアノテーション情報をダンプする
 ----------------------------------------------------
-``--task_history_index`` を指定すると、該当するタスク履歴で付与されたアノテーション情報をダンプできます。
+``--task_history_index`` または ``--task_history_id`` を指定すると、該当するタスク履歴で付与されたアノテーション情報をダンプできます。
+
+* ``--task_history_index`` : タスク履歴のインデックス（0始まり）を指定します。
+* ``--task_history_id`` : タスク履歴IDを直接指定します。
+
+これらのオプションは排他的で、同時に指定することはできません。
 
 たとえばタスク履歴が以下のような場合に ``--task_history_index 1`` （0始まり）を指定すると、2番目（1始まり）のタスク履歴の完了日時である ``2025/07/09 12:28:52`` 時点のアノテーション情報をダンプします。
 

{annofabcli-1.113.0 → annofabcli-1.113.1}/docs/command_reference/annotation_zip/list_3d_bounding_box_annotation.rst

@@ -73,6 +73,7 @@ Examples
         "footprint_area": 12.3,
         "bottom_z": -0.06,
         "top_z": 1.49,
+        "horizontal_distance": 13.09,
         "attributes": {
           "occluded": true,
           "type": "sedan"
@@ -135,6 +136,7 @@ CSVまたはJSON形式で以下の項目が出力されます。
 * footprint_area: 底面積（width × depth）。地面占有面積。
 * bottom_z: 底面のZ座標（location.z - height/2）。回転は考慮していない。
 * top_z: 天面のZ座標（location.z + height/2）。回転は考慮していない。
+* horizontal_distance: 原点(0, 0)からのXY平面上の距離（sqrt(location.x² + location.y²)）
 
 
 属性情報

{annofabcli-1.113.0 → annofabcli-1.113.1}/tests/annotation_zip/test_list_annotation_3d_bounding_box.py

@@ -2,6 +2,7 @@
 Test cases for annofabcli.annotation_zip.list_annotation_3d_bounding_box module
 """
 
+import math
 from pathlib import Path
 
 import pytest
@@ -79,6 +80,8 @@ class TestGetAnnotation3DBoundingBoxInfoList:
         assert first_annotation.bottom_z == pytest.approx(0.208 - 1.673 / 2, rel=1e-3)
         # top_z = location.z + height/2
         assert first_annotation.top_z == pytest.approx(0.208 + 1.673 / 2, rel=1e-3)
+        # horizontal_distance = sqrt(x^2 + y^2)
+        assert first_annotation.horizontal_distance == pytest.approx(math.sqrt((-7.878) ** 2 + 36.813**2), rel=1e-3)
 
         # 2番目のアノテーション（Pedestrian）
         second_annotation = result[1]
@@ -296,7 +299,7 @@ class TestCreateDf:
 
         # DataFrameは空だが、base_columnsの列は存在する
         assert len(df) == 0
-        assert len(df.columns) == 23  # base_columnsの数
+        assert len(df.columns) == 24  # base_columnsの数（horizontal_distance追加により24列）
 
         # 基本列が存在することを確認
         assert "project_id" in df.columns