dcmmkdir: DICOMDIR ファイルを作成する

書式

dcmmkdir [options] [dcmfile-in...]

説明

dcmmkdir は、指定した参照先 DICOM ファイルから、DICOM Part 11 のメディア保存アプリケーションプロファイル（Media Storage Application Profiles）に従って DICOMDIR ファイルを作成するユーティリティです。

現在サポートしているプロファイルは次のとおりです（今後追加される可能性があります）。

General Purpose CD-R Interchange (STD-GEN-CD)
General Purpose Interchange on DVD-RAM Media (STD-GEN-DVD-RAM)
General Purpose Interchange on BD Media (STD-GEN-BD)
General Purpose DVD Interchange with JPEG (STD-GEN-DVD-JPEG)
General Purpose DVD Interchange with JPEG 2000 (STD-GEN-DVD-J2K)
General Purpose BD Interchange with JPEG (STD-GEN-BD-JPEG)
General Purpose BD Interchange with JPEG 2000 (STD-GEN-BD-J2K)
General Purpose BD Interchange with MPEG2 MP@ML (STD-GEN-BD-MPEG2-MPML)
General Purpose BD Interchange with MPEG2 MP@HL (STD-GEN-BD-MPEG2-MPHL)
General Purpose BD Interchange with MPEG-4 AVC/H.264 HiP@Level4.1 (STD-GEN-BD-MPEG4-HPLV41)
General Purpose BD Interchange with MPEG-4 AVC/H.264 BD-Compatible HiP@Level4.1 (STD-GEN-BD-MPEG4-HPLV41BD)
General Purpose BD Interchange with MPEG-4 AVC/H.264 HiP@Level4.2 for 2D video (STD-GEN-BD-MPEG4-HPLV42-2D)
General Purpose BD Interchange with MPEG-4 AVC/H.264 HiP@Level4.2 for 3D video (STD-GEN-BD-MPEG4-HPLV42-3D)
General Purpose BD Interchange with MPEG-4 AVC/H.264 Stereo HiP@Level4.2 (STD-GEN-BD-MPEG4-SHPLV42)
General Purpose USB and Flash Memory Interchange with JPEG (STD-GEN-USB/MMC/CF/SD-JPEG)
General Purpose USB and Flash Memory Interchange with JPEG 2000 (STD-GEN-USB/MMC/CF/SD-J2K)
General Purpose MIME Interchange (STD-GEN-MIME)
DVD Interchange with MPEG2 MP@ML (STD-DVD-MPEG2-MPML)
Basic Cardiac X-Ray Angiographic Studies on CD-R Media (STD-XABC-CD)
1024 X-Ray Angiographic Studies on CD-R Media (STD-XA1K-CD)
1024 X-Ray Angiographic Studies on DVD Media (STD-XA1K-DVD)
Dental Radiograph Interchange (STD-DEN-CD)
CT/MR Studies on various Media (STD-CTMR-xxxx)
Ultrasound Single Frame for Image Display (STD-US-ID-SF-xxxx)
Ultrasound Single Frame with Spatial Calibration (STD-US-SC-SF-xxxx)
Ultrasound Single Frame with Combined Calibration (STD-US-CC-SF-xxxx)
Ultrasound Single & Multi-Frame for Image Display (STD-US-ID-MF-xxxx)
Ultrasound Single & Multi-Frame with Spatial Calibration (STD-US-SC-MF-xxxx)
Ultrasound Single & Multi-Frame with Combined Calibration (STD-US-CC-MF-xxxx)
12-lead ECG Interchange on Diskette (STD-WVFM-ECG-FD)
Hemodynamic Waveform Interchange on Diskette (STD-WVFM-HD-FD)

このツールは、General Purpose の DICOMDIR ファイルしか作成できない dcmgpdir を拡張したものです。dcmmkdir の既定の動作（–general-purpose 指定時）は dcmgpdir と同等です。

引数

dcmfile-in  referenced DICOM file (or directory to be scanned)

オプション

全般オプション

-h --help: このヘルプを表示して終了します
--version: バージョン情報を表示して終了します
--arguments: 展開後のコマンドライン引数を表示します
-q --quiet: quiet モード。警告やエラーを表示しません
-v --verbose: verbose モード。処理の詳細を表示します
-d --debug: debug モード。デバッグ情報を表示します
-ll --log-level [l]evel: string constant: (fatal, error, warn, info, debug, trace) ロガーにレベル l を使用します
-lc --log-config [f]ilename: string: ロガーに設定ファイル f を使用します

入力オプション

+F --fileset-id [i]d: string: 指定の file-set ID を使用します（既定値: DCMTK_MEDIA_DEMO、なしにするには ""）
+R --descriptor [f]ilename: string: file-set ディスクリプタファイルの ID を追加します（例: README、既定: ディスクリプタなし）
+C --char-set [c]harset: string: ディスクリプタ用に特定の文字セットを追加します（既定: ディスクリプタがある場合は "ISO_IR 100"） reading:
+id --input-directory [d]irectory: string: 参照先 DICOM ファイルをディレクトリ d から読み込みます（--recurse の既定: カレントディレクトリ）
-m --keep-filenames: ファイル名が DICOM 形式であることを前提とします（既定）
+m --map-filenames: DICOM ファイル名へ変換します（小文字→大文字、末尾のピリオドを除去）
-r --no-recurse: ディレクトリ内を再帰しません（既定）
+r --recurse: ファイルシステムのディレクトリ内を再帰します
+p --pattern [p]attern: string (only with --recurse): ファイル名照合のパターン（ワイルドカード） # システムによっては利用できない場合があります

処理オプション

-W --no-consistency-check: ファイルの整合性チェックを行いません
+W --warn-inconsist-files: 整合性のないファイルについて警告します（既定）
-a --abort-inconsist-file: 最初の整合性のないファイルで中断します type 1 attributes:
-I --strict: DICOM ファイルに DICOMDIR の type 1 属性が欠けている場合はエラーで終了します（既定）
+I --invent: DICOM ファイルに DICOMDIR の type 1 属性が欠けている場合は補完します
+Ipi --invent-patient-id: PatientName 属性が不整合な場合に新しい PatientID を補完します other checks:
+Nrs --allow-retired-sop: 旧版の DICOM 規格で定義された廃止済み SOP クラスを許可します
-Nxc --no-xfer-check: 非標準の転送構文を持つ画像を拒否しません（警告のみ）
-Nec --no-encoding-check: 非標準のピクセルエンコードを持つ画像を拒否しません（警告のみ）
-Nrc --no-resolution-check: 非標準の空間解像度を持つ画像を拒否しません（警告のみ） icon images:
+X --add-icon-image: IMAGE レベルにモノクロのアイコン画像を追加します（心臓系プロファイルの既定）
-Xs --icon-image-size [s]ize: integer (1..128): アイコン画像の幅と高さ（ピクセル単位）（固定値: XA は 128、CT/MR プロファイルは 64）
-Xi --icon-file-prefix [p]refix: string: PGM 画像 'prefix'+'dcmfile-in' をアイコンとして使用します（既定: DICOM 画像からアイコンを生成）
-Xd --default-icon [f]ilename: string: アイコンを自動生成できない場合に指定の PGM 画像を使用します（既定: 黒画像）

出力オプション

+D --output-file [f]ilename: string: 指定の DICOMDIR ファイルを生成します（既定: カレントディレクトリの DICOMDIR） profiles:
-Pgp --general-purpose: General Purpose Interchange on CD-R, DVD-RAM or BD Media (STD-GEN-CD/DVD-RAM/BD, default)
-Pdv --general-dvd-jpeg: General Purpose DVD Interchange with JPEG (STD-GEN-DVD-JPEG)
-Pd2 --general-dvd-j2k: General Purpose DVD Interchange with JPEG 2000 (STD-GEN-DVD-J2K)
-Pbd --general-bd-jpeg: General Purpose BD Interchange with JPEG (STD-GEN-BD-JPEG)
-Pb2 --general-bd-j2k: General Purpose BD Interchange with JPEG 2000 (STD-GEN-BD-J2K)
-Pbm --general-bd-mpeg2-mpml: General Purpose BD Interchange with MPEG2 MP@ML (STD-GEN-BD-MPEG2-MPML)
-Pbh --general-bd-mpeg2-mphl: General Purpose BD Interchange with MPEG2 MP@HL (STD-GEN-BD-MPEG2-MPHL)
-Pba --general-bd-mpeg4-hp: General Purpose BD Interchange with MPEG-4 AVC/H.264 HiP@Level4.1 (STD-GEN-BD-MPEG4-HPLV41)
-Pbb --general-bd-mpeg4-hpbd: General Purpose BD Interchange with MPEG-4 AVC/H.264 BD-Compatible HiP@Level4.1 (STD-GEN-BD-MPEG4-HPLV41BD)
--general-bd-mpeg4-hp2d: General Purpose BD Interchange with MPEG-4 AVC/H.264 HiP@Level4.2 for 2D video (STD-GEN-BD-MPEG4-HPLV42-2D)
--general-bd-mpeg4-hp3d: General Purpose BD Interchange with MPEG-4 AVC/H.264 HiP@Level4.2 for 3D video (STD-GEN-BD-MPEG4-HPLV42-3D)
--general-bd-mpeg4-hpst: General Purpose BD Interchange with MPEG-4 AVC/H.264 Stereo HiP@Level4.2 (STD-GEN-BD-MPEG4-SHPLV42)
-Pfl --usb-and-flash-jpeg: General Purpose USB/Flash Memory Interchange with JPEG (STD-GEN-USB/MMC/CF/SD-JPEG)
-Pf2 --usb-and-flash-j2k: General Purpose USB/Flash Memory Interchange with JPEG 2000 (STD-GEN-USB/MMC/CF/SD-J2K)
-Pmi --general-mime: General Purpose MIME Interchange (STD-GEN-MIME)
-Pmp --mpeg2-mpml-dvd: DVD Interchange with MPEG2 Main Profile @ Main Level (STD-DVD-MPEG2-MPML)
-Pbc --basic-cardiac: Basic Cardiac X-Ray Angiographic Studies on CD-R Media (STD-XABC-CD)
-Pxa --xray-angiographic: 1024 X-Ray Angiographic Studies on CD-R Media (STD-XA1K-CD)
-Pxd --xray-angiographic-dvd: 1024 X-Ray Angiographic Studies on DVD Media (STD-XA1K-DVD)
-Pde --dental-radiograph: Dental Radiograph Interchange (STD-DEN-CD)
-Pcm --ct-and-mr: CT/MR Studies (STD-CTMR-xxxx)
-Pus --ultrasound-id-sf: Ultrasound Single Frame for Image Display (STD-US-ID-SF-xxxx)
--ultrasound-sc-sf: Ultrasound Single Frame with Spatial Calibration (STD-US-SC-SF-xxxx)
--ultrasound-cc-sf: Ultrasound Single Frame with Combined Calibration (STD-US-CC-SF-xxxx)
-Pum --ultrasound-id-mf: Ultrasound Single & Multi-Frame for Image Display (STD-US-ID-MF-xxxx)
--ultrasound-sc-mf: Ultrasound Single & Multi-Frame with Spatial Calibration (STD-UD-SC-MF-xxxx)
--ultrasound-cc-mf: Ultrasound Single & Multi-Frame with Combined Calibration (STD-UD-CC-MF-xxxx)
-Pec --12-lead-ecg: 12-lead ECG Interchange on Diskette (STD-WVFM-ECG-FD)
-Phd --hemodynamic-waveform: Hemodynamic Waveform Interchange on Diskette (STD-WVFM-HD-FD) writing:
-A --replace: 既存の DICOMDIR を置き換えます（既定）
+A --append: 既存の DICOMDIR に追記します
+U --update: 既存の DICOMDIR を更新します
-w --discard: DICOMDIR を書き出しません backup:
--create-backup: 既存の DICOMDIR のバックアップを作成します（既定）
-nb --no-backup: 既存の DICOMDIR のバックアップを作成しません post-1993 value representations:
+u --enable-new-vr: 新しい VR（UN/UT）のサポートを有効にします（既定）
-u --disable-new-vr: 新しい VR のサポートを無効にし、OB に変換します group length encoding:
-g --group-length-remove: グループ長要素なしで書き出します（既定）
+g --group-length-create: グループ長要素ありで書き出します length encoding in sequences and items:
+e --length-explicit: 明示的な長さで書き出します（既定）
-e --length-undefined: 未定義の長さで書き出します

注記

コマンドラインで指定したファイル（または +r オプションでディレクトリの内容を再帰的に調べて見つかったファイル）は、まず指定したメディア保存アプリケーションプロファイル（Part 11）への適合性が評価されます。許可された転送構文のいずれかでエンコードされた適切なファイルのみが受け入れられます。無効なファイル名を持つファイルは拒否されます（このルールは +m オプションで緩和できます）。必須の属性が欠けているファイルも拒否されます（+I オプションでこの動作を緩和できます）。

すべてのファイルが初期テストに合格して初めて DICOMDIR ファイルが構築されます。

dcmmkdir では、DICOMDIR ファイルへの新規エントリの追記や、既存エントリの更新も行えます。+A オプションを使うと新規エントリが DICOMDIR に追記されるだけで、PATIENT 情報などの既存レコードは更新されません。+U オプションを使うと、参照先 DICOM ファイルから得た情報に従って既存レコードも更新されます。この更新処理は、単に新規エントリを追記するよりも遅くなる場合がある点に注意してください。ただし、選択したアプリケーションプロファイルが必要とする追加情報が既存レコードにも確実に追加されます。

アイコン画像のサポートは現在モノクロ画像に限られています。将来変わる可能性はありますが、それまではカラー画像は自動的にグレースケールへ変換されます。アイコンのサイズは、心臓系プロファイルでは（DICOM 規格の要件により）128128 ピクセル、それ以外ではすべて 6464 ピクセルです。

ディレクトリのスキャン

ディレクトリからファイルを追加するには –recurse オプションを使います。これ以上のコマンドラインパラメータを与えない場合、–input-directory オプションで指定したディレクトリ（既定: カレントディレクトリ）がスキャン対象になります。パラメータを与えた場合は、ファイル名でもディレクトリ名でも指定でき、入力ディレクトリが常に先頭に付加されます。指定したディレクトリ内のファイルを特定の名前パターン（例: ワイルドカード照合）で選別したい場合は、–pattern オプションを使う必要があります。このファイルパターンはスキャン対象のディレクトリ内のファイルにのみ適用される点に注意してください。また、–input-directory オプション以外でコマンドラインに指定したパターン（例: さらに別のファイルを選択するためのもの）は、上記のディレクトリには適用されません。

ロギング

各種コマンドラインツールおよびその基盤となるライブラリのロギング出力のレベルは、ユーザーが指定できます。既定では、エラーと警告のみが標準エラー出力へ書き出されます。–verbose オプションを使うと、処理の詳細などの情報メッセージも報告されます。–debug オプションを使うと、内部動作に関するより詳しい情報が得られ、デバッグなどに役立ちます。その他のロギングレベルは –log-level オプションで選択できます。–quiet モードでは致命的なエラーのみが報告されます。そのような非常に重大なエラーが発生した場合、アプリケーションは通常終了します。各ロギングレベルの詳細については、モジュール "oflog" のドキュメントを参照してください。

ロギング出力をファイルへ書き出す場合（必要に応じてログファイルのローテーションを伴う）、または syslog（Unix）やイベントログ（Windows）へ書き出す場合は、–log-config オプションを使えます。この設定ファイルでは、特定のメッセージのみを特定の出力ストリームへ振り分けることや、メッセージを生成したモジュールやアプリケーションに基づいて特定のメッセージをフィルタリングすることもできます。設定ファイルの例は < etcdir>/logger.cfg に用意されています。

コマンドライン

すべてのコマンドラインツールは、パラメータについて次の表記を用います。角括弧は省略可能な値（0〜1）を囲み、末尾の 3 つのドットは複数の値が許されること（1〜n）を示し、両者の組み合わせは 0〜n 個の値を意味します。

コマンドラインオプションは、先頭の '+' または '-' 記号によってパラメータと区別されます。通常、コマンドラインオプションの順序や位置は任意です（つまりどこに現れてもかまいません）。ただし、オプションが相互排他的な場合は、最も右に現れたものが使われます。この挙動は一般的な Unix シェルの標準的な評価規則に準じます。

さらに、ファイル名の前に '@' 記号を付けることで、1 つ以上のコマンドファイルを指定できます（例: @command.txt）。このようなコマンド引数は、それ以上の評価を行う前に、対応するテキストファイルの内容に置き換えられます（連続する空白は、引用符で囲まれている場合を除き、1 つの区切りとして扱われます）。コマンドファイルの中に別のコマンドファイルを含めることはできない点に注意してください。この単純ながら効果的な仕組みにより、よく使うオプションやパラメータの組み合わせをまとめられ、長く分かりにくいコマンドラインを避けられます（例は < datadir>/dumppat.txt にあります）。

環境変数

dcmmkdir は、環境変数 DCMDICTPATH に指定された DICOM データ辞書の読み込みを試みます。既定では、すなわち DCMDICTPATH 環境変数が設定されていない場合は、データ辞書がアプリケーションに組み込まれていない限り（Windows での既定）、ファイル < datadir>/dicom.dic が読み込まれます。

既定の動作を優先し、DCMDICTPATH 環境変数は別のデータ辞書が必要な場合にのみ使うべきです。DCMDICTPATH 環境変数の書式は Unix シェルの PATH 変数と同じで、コロン（":"）でエントリを区切ります。Windows システムでは区切りにセミコロン（";"）を使います。データ辞書のコードは、DCMDICTPATH 環境変数に指定された各ファイルの読み込みを試みます。データ辞書を 1 つも読み込めない場合はエラーとなります。