| On this page |
概要 ¶
このコマンドは、KarmaでレンダリングされたEXRファイルを指定することで、そのEXRファイルに保存されているレンダリング統計情報を表示したHTMLレポートを生成することができます。
レンダリング統計情報を確認する方法の詳細は、レンダリング統計情報を参照してください。
シングルモード vs. マルチモード ¶
このコマンドには、出力を生成するモードが2つあります:
--single(デフォルト)は、スタイルシート、スクリプト、すべてのサムネイル画像がインラインで含まれた単一の自己完結型HTMLファイルを生成します。
どこでも見れるように単一ファイルを作成するのでこのモードの方が便利ですが、各レポートに独自のリソースのコピーが追加され、画像がBase64でエンコードされるので容量が若干増えます。
--multiは、HTMLファイルとサムネイル画像のディレクトリを生成し、スタイルシートとスクリプトを別ファイルとしてコピーします。これは、レポートをたくさん生成し、すべて同じ共有リソースを参照するようにしたい場合に役立ちます。
--multiを使用する場合、さらに--prefixオプションを使用することで、レポートがセントラルの場所からリソースを参照するようにすることができます。
役立つ情報とメモ ¶
-
Karma XPUで生成された画像は、Karma CPUと比べていくつかの統計情報が欠落しています。
-
このコマンドにAOV名を渡す場合、番号を使用することでAOVインデックスを指定することができます。例えば、1番目のAOVを指定する場合は
0を使用します。 -
--titleと--subtitleのオプションを使用することで、レポートのタイトルとサブタイトルをカスタマイズすることができます。これは、サイト特有の情報を表示するのに役立ちます。 -
このコマンドがHTMLの生成に使用するテンプレートは、Karmaで保存されたレンダリング統計情報に特化していて、(
--titleと--subtitleのオプション以外は)カスタマイズできるようになっていません。将来のバージョンでは、おそらくテンプレートをモジュール化して、修正と再利用がしやすくなる予定です。
使用方法 ¶
renderstatsreport [options] infile.exr [ outfile.html ]
-
出力ファイルを指定しなかった場合、このコマンドは、入力ファイルと同じ名前で同じディレクトリ内にHTMLファイルを作成します。
-
2番目の引数が既存ディレクトリの場合、このコマンドは、そのディレクトリ内に入力ファイルと同じ名前のHTMLファイルを作成します。
-
--multiモードでは、このコマンドはサムネイル画像のディレクトリを作成します。
renderstatsreport example.exr ~/reports/example_report.html
オプション ¶
ファイルのオプション ¶
--create-dirs / --no-create-dirs
--single / --multi
自己完結型のHTMLファイルを保存するか、それとも、HTMLファイルと画像のディレクトリを作成するか(上記のシングルモード vs. マルチモードを参照)。 デフォルトは単一ファイルです。
サムネイルのオプション ¶
-t ‹level› / --thumbnails ‹level›
レポートするAOVサムネイルの生成方法。
--include-aovsと--exclude-aovsのオプションを使用することで、取得するサムネイルのAOVを明示的に指定することができます。
none
AOVサムネイル画像を生成しません。
diagnositc
1番目のAOVとheatmap AOVのサムネイルのみを生成します。
default
CryptoMatteデータ平面などの視覚的でないAOV以外のすべてのAOVのサムネイルを生成します。 これがデフォルトです。
all
すべてのAOVのサムネイルを生成します。
-s ‹size› / --thumbnail-size
AOVサムネイルの幅(単位はピクセル)。
-F png|jpg / --thumbnail-format png|jpg
AOVサムネイルに使用する画像フォーマット。デフォルトはjpgです。
(技術的には、ここにはOIIOライブラリが出力可能なフォーマットを指定することができますが、ブラウザで動作するフォーマットを指定する必要があります。)
-i ‹aov_names› / --include-aovs ‹aov_names›
このオプションを指定すると、このコマンドは、ここで指定したカンマ区切りのAOVのリストのサムネイルのみを生成します。
renderstatsreport example.exr -i C,directdiffuse,directemission
-x ‹aov_names› / --exclude-aovs ‹aov_names›
このオプションを指定すると、このコマンドは、--thumbnailsオプションで指定されたAOVのうち、ここで指定したカンマ区切りのAOVのリストを 除く AOVのサムネイルを生成します。
--thumbnail-dir ‹name›
--multiモードでは、(HTMLファイルと同じディレクトリ内で)AOVサムネイル画像が格納されるディレクトリの名前を指定します。
デフォルトはaov_thumbnailsです。
--color-space ‹name›
AOVサムネイルをこのカラー空間に変換します。
デフォルトはsRGBです。
-H ‹aov_names› / --heatmap-aovs ‹aov_names›
ここで指定したカンマ区切りのAOVのリストに対して、このコマンドは擬色グラデーションを使用したサムネイルを生成します。
--colormapオプションを使用することで、このグラデーションを指定することができます。
renderstatsreport example.exr --heatmap-aovs loadtime,shadertime
--colormap ‹name›
“heatmap” AOVに使用するカラーマップの名前。
別の方法として、ここには、カンマ区切りで浮動小数点のR,G,B三成分のリストを指定することができます。
利用可能な値は、oiiotoolのドキュメントを参照してください。
デフォルトはmagmaです。
renderstatsreport example.exr --colormap plasma renderstatsreport example.exr --colormap .25,.25,.25,0,.5,0,1,0,0
--heatmap-scale ‹fraction›
“heatmap” AOVに対して、このコマンドは、カラーマップ適用前にこの係数で明度をスケールします。
デフォルトは0.9です。
renderstatsreport example.exr --heatmap-scale 1.0
テンプレートのオプション ¶
--title ‹string›
標準のページタイトルの代わりに、この文字列を使用します。 これは、サイト固有の情報をレポートに追加するのに役立ちます。
--subtitle ‹string›
標準のサブタイトルの代わりに、この文字列を使用します。 このサブタイトルは、ページがスクロールする時にブラウザビューの上部に引っ付きます。 これは、サイト固有の情報をレポートに追加するのに役立ちます。
-r ‹dir› / --resources ‹dir›
このコマンドがCSSファイルとJavascriptファイルを取得するディレクトリ。
デフォルトは$HFS/houdini/config/RenderReportです。
-p ‹prefix› / --prefix ‹prefix›
このオプションを指定した場合、スクリプトはリソースファイル(スタイルシートやスクリプトなど)をコピーせず、レポート内のリソースのリンクの頭にこの文字列が付きます。 これは、レポートをウェブサーバー上に残す場合に、レポート毎に別々のコピーを作成することなく、すべてのレポートがサーバー上の同じリソースにリンクさせるのに役立ちます。
renderstatsreport example.exr --prefix http://example.com/render-report/resources/
| See also |