dcmencap: 文書をDICOM形式にカプセル化する

書式

dcmencap [options] docfile-in dcmfile-out

説明

dcmencap ユーティリティは、サポートされているいずれかのファイル形式で記述された文書ファイルを読み込み、対応するDICOM Encapsulated Storage SOP Class のSOPインスタンスに変換し、変換後のデータを出力ファイル(dcmfile-out)に保存します。

引数

docfile-in   input filename to be converted

dcmfile-out  DICOM output filename ("-" for stdout)

オプション

全般オプション

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

入力オプション

+fa --filetype-auto: ファイル形式を自動判定します(既定)
+fp --filetype-pdf: PDFファイルとして扱います
+fc --filetype-cda: CDAファイルとして扱います
+fs --filetype-stl: STLファイルとして扱います
+fm --filetype-mtl: MTLファイルとして扱います
+fo --filetype-obj: OBJファイルとして扱います

DICOM文書オプション

+t --title [t]itle: string (default: empty): 文書のタイトル
+cn --concept-name [CSD] [CV] [CM]: string (default: empty): coding scheme designator CSD、code value CV、code meaning CM で定義される文書タイトルのコード化表現 patient data:
+pn --patient-name [n]ame: string: DICOM PN構文による患者氏名
+pi --patient-id [i]d: string: 患者識別子
+pb --patient-birthdate [d]ate: string (YYYYMMDD): 患者の生年月日
+ps --patient-sex [s]ex: string (M, F or O): 患者の性別 device data:
+mn --manufacturer [n]ame: string: 製造業者名
+mm --manufacturer-model [n]ame: string: 製造業者のモデル名
+ds --device-serial [n]umber: string: 装置のシリアル番号
+sv --software-versions [v]ersions: string: ソフトウェアのバージョン manufacturing 3d model data (STL/MTL/OBJ only):
+mu --measurement-units [CSD] [CV] [CM]: string: coding scheme designator CSD、code value CV、code meaning CM を伴う測定単位(既定: UCUM, um, um) study and series:
+sg --generate: 新しいstudy UIDとseries UIDを生成します(既定)
+st --study-from [f]ilename: string: DICOMファイルから患者/studyデータを読み込みます
+se --series-from [f]ilename: string: DICOMファイルから患者/study/seriesデータを読み込みます instance number:
+i1 --instance-one: インスタンス番号1を使用します(既定、+se とは併用不可)
+ii --instance-inc: インスタンス番号を増分します(+se との併用時のみ)
+is --instance-set [i]nstance number: integer: インスタンス番号 i を使用します burned-in annotation:
+an --annotation-yes: 文書に患者を識別できるデータが含まれます(既定)
-an --annotation-no: 文書に患者を識別できるデータは含まれません

処理オプション

-ov --no-override: CDAの患者データおよび文書データは、study・series・手入力した情報と一致していなければなりません(既定)
+ov --override: CDAのデータをstudy・series・手入力した情報で上書きします other processing options:
-k --key [k]ey: gggg,eeee="str", path or dictionary name="str": 属性を追加します

出力オプション

+te --write-xfer-little: explicit VR little endian で書き出します(既定)
+tb --write-xfer-big: explicit VR big endian TSで書き出します
+ti --write-xfer-implicit: implicit VR little endian TSで書き出します group length encoding:
-g --group-length-remove: group length 要素なしで書き出します(既定)
+g --group-length-create: group length 要素ありで書き出します length encoding in sequences and items:
+e --length-explicit: 明示的な長さで書き出します(既定)
-e --length-undefined: 未定義長で書き出します data set trailing padding (not with --write-dataset):
-p --padding-off: パディングなし(--write-dataset 指定時は暗黙的にこの動作)
+p --padding-create [f]ile-pad [i]tem-pad: integer: ファイルを f バイト単位、アイテムを i バイト単位に整列します

注記

属性の供給元

本アプリケーションには、新しいDICOMファイルの必須属性(および任意属性)、たとえば患者・study・series の情報を埋めるための追加入力を与えられます。

–key オプションを使うと、DICOM出力ファイルに属性を追加できます。
–key オプションでは、sequence・item・入れ子になった属性を指定することもできます。その場合は特別な「パス」記法を用います。このパス記法の詳細は dcmodify のドキュメントを参照してください。
–key オプションは複数回指定できます。
('=' より後ろの)値の部分は省略でき、その場合は属性が長さゼロで設定されます。
なお –key オプションは、DICOMファイルを保存する直前という最終段階で適用されるため、値の検証は一切行われない点に注意してください。

ロギング

各種コマンドラインツールおよびその基盤となるライブラリのログ出力レベルは、ユーザーが指定できます。既定では、エラーと警告のみが標準エラー出力に書き出されます。–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)。このようなコマンド引数は、それ以上の評価が行われる前に、対応するテキストファイルの内容に置き換えられます(連続する空白は、引用符で囲まれていない限り単一の区切りとして扱われます)。なお、コマンドファイルの中に別のコマンドファイルを含めることはできません。この単純ながら効果的な仕組みにより、よく使うオプションや引数の組み合わせをまとめられ、長く分かりにくいコマンドラインを避けられます(例は < datadir>/dumppat.txt に用意されています)。

終了コード

dcmencap ユーティリティは終了時に次の終了コードを使います。これにより、アプリケーションが終了した理由をユーザーが確認できます。

全般

EXITCODE_NO_ERROR                 0

入力ファイルエラー

EXITCODE_INVALID_INPUT_FILE       22

出力ファイルエラー

EXITCODE_CANNOT_WRITE_OUTPUT_FILE 40

環境変数

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

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