annotation_zip visualize_annotation_duration_by_attribute_value#

Description#

動画プロジェクトのタスクごとに区間アノテーションの長さを合計し、ラベル・属性・属性値別のヒストグラムをHTMLファイルに出力します。 既定の集計対象はドロップダウン、ラジオボタン、チェックボックスです。

入力、集計単位、表示単位、ビン幅、0件時の出力については annotation_zip visualize_annotation_duration_by_label と共通です。

Examples#

$ annofabcli annotation_zip visualize_annotation_duration_by_attribute_value \
    --project_id prj1 --output annotation_duration_by_attribute_value.html

出力される annotation_duration_by_attribute_value.html の例です。 横軸は区間アノテーションの合計長、縦軸はタスク数です。

属性値別の区間アノテーションの長さのヒストグラム

--attribute_name は指定した属性のみを集計します。 --additional_attribute_name は既定の属性に指定属性を追加します。この2引数は同時に指定できません。 いずれも複数の英語名、または file:// で属性名を記載したファイルを指定できます。 ラベルを絞り込む場合は --label_name を併用します。

$ annofabcli annotation_zip visualize_annotation_duration_by_attribute_value \
    --project_id prj1 --annotation annotation.zip \
    --label_name traffic_light --attribute_name color \
    --use_japanese_name --output annotation_duration_by_attribute_value.html

集計結果をCSV/JSONで出力する場合は annotation_zip sum_annotation_duration_by_attribute_value を使用してください。 日本語名表示については annotation_zip を参照してください。

Command line options#

属性値ごとにタスク単位の区間アノテーションの合計長をヒストグラムで可視化します。

usage: annofabcli annotation_zip visualize_annotation_duration_by_attribute_value
       [-h] [--yes] [--endpoint_url ENDPOINT_URL]
       [--annofab_user_id ANNOFAB_USER_ID]
       [--annofab_password ANNOFAB_PASSWORD] [--annofab_pat ANNOFAB_PAT]
       [--logdir LOGDIR] [--disable_log] [--debug] -p PROJECT_ID
       [--annotation ANNOTATION] -o OUTPUT [--time_unit {second,minute}]
       [--bin_width BIN_WIDTH] [--exclude_empty_value] [--arrange_bin_edge]
       [-t TASK_ID [TASK_ID ...]] [--task_query TASK_QUERY] [--latest]
       [--temp_dir TEMP_DIR] [--use_japanese_name]
       [--additional_attribute_name ADDITIONAL_ATTRIBUTE_NAME [ADDITIONAL_ATTRIBUTE_NAME ...] |
       --attribute_name ATTRIBUTE_NAME [ATTRIBUTE_NAME ...]]
       [--label_name LABEL_NAME [LABEL_NAME ...]]

Named Arguments#

-p, --project_id

対象のプロジェクトのproject_idを指定します。

--annotation

アノテーションZIPまたは展開済みディレクトリ。省略するとダウンロードします。

-o, --output

出力先HTMLファイルのパスを指定します。

--time_unit

Possible choices: second, minute

ヒストグラムに表示する時間の単位。

Default: 'second'

--bin_width

ビンの幅を正の秒数で指定します。表示単位が分でも秒で指定します。省略するとビンの個数が20になるように調整します。

--exclude_empty_value

すべてのタスクで区間長が0のヒストグラムを描画しません。

Default: False

--arrange_bin_edge

各ヒストグラムの範囲とビン幅をそろえます。

Default: False

-t, --task_id

対象のタスクのtask_idを指定します。 file:// を先頭に付けると、task_idの一覧が記載されたファイルを指定できます。ファイルを読み込む場合は、ファイル指定を1個だけ渡してください。直接指定するIDや別のファイル指定とは併用できません。

--task_query, -tq

対象タスクの条件をJSONで指定します。キーはtask_id, status, phase, phase_stageです。file://でファイルを指定できます。

--latest

ZIPのダウンロード時に最新のアノテーションZIPを取得します。数分待つ場合があります。

Default: False

--temp_dir

アノテーションZIPのダウンロード先ディレクトリ。

--use_japanese_name

ラベル名、属性名、選択肢名をアノテーション仕様に登録されている日本語名で出力します。日本語名がない場合は英語名を出力します。

Default: False

--additional_attribute_name

デフォルトで集計される選択肢系の属性(ドロップダウン、ラジオボタン、チェックボックス)に加えて、集計したい属性の英語名を指定します。ラベル名に関係なく、デフォルト属性と指定した属性名を持つ属性が集計対象になります。 file:// を先頭に付けると、属性名が記載されたファイルを指定できます。 ファイルを読み込む場合は、ファイル指定を1個だけ渡してください。直接指定する値や別のファイル指定とは併用できません。

--label_name

集計対象とするラベルの英語名を指定します。指定したラベルに属する属性値のみが集計対象になります。 file:// を先頭に付けると、ラベル名が記載されたファイルを指定できます。 ファイルを読み込む場合は、ファイル指定を1個だけ渡してください。直接指定する値や別のファイル指定とは併用できません。

--attribute_name

集計対象とする属性の英語名を指定します。指定した属性名のみが集計対象になります(デフォルトの選択肢系属性は含まれません)。ラベル名に関係なく、指定した属性名を持つ属性のみが集計対象になります。 file:// を先頭に付けると、属性名が記載されたファイルを指定できます。 ファイルを読み込む場合は、ファイル指定を1個だけ渡してください。直接指定する値や別のファイル指定とは併用できません。

common options (after the subcommand)#

--yes

処理中に現れる問い合わせに対して、常に yes と回答します。

Default: False

--endpoint_url

Annofab WebAPIのエンドポイントを指定します。

--annofab_user_id

Annofabにログインする際のユーザーID

--annofab_password

Annofabにログインする際のパスワード

--annofab_pat

Annofabにログインする際のパーソナルアクセストークン

--logdir

ログファイルを保存するディレクトリを指定します。

Default: .log

--disable_log

ログを無効にします。

Default: False

--debug

HTTPリクエストの内容やレスポンスのステータスコードなど、デバッグ用のログが出力されます。

Default: False

オーナーロールまたはアノテーションユーザーロールを持つユーザーで実行してください。