dgtimer

移動先: 概要 戻り値 キーワード. 関連項目. フラグ. Python 例.

概要

dgtimer([combineType=boolean], [hide=string], [hierarchy=boolean], [maxDisplay=int], [name=string], [noHeader=boolean], [outputFile=string], [overhead=boolean], [rangeLower=float], [rangeUpper=float], [reset=boolean], [returnCode=string], [returnType=string], [show=string], [sortMetric=string], [sortType=string], [threshold=float], [timerOff=boolean], [timerOn=boolean], [trace=boolean], [type=string], [uniqueName=boolean], [updateHeatMap=int])

注意: オブジェクト名や引数を表す文字列はカンマで区切ります。これは概要には示されていません。

dgtimer は 「元に戻す」が不可能、「照会」が可能、「編集」が不可能 です。

計測する各種操作を「メトリック」と呼び、タイマーのタイプを「タイマー タイプ」と呼びます。各種メトリックはタイミングがオンであれば必ず計測されますが、-show および -hide フラグで指定した場合のみ照会されます。現時点でサポートしているメトリックを、下記の -show フラグ以下に詳細にリストします。各メトリックで、標準のタイマー タイプ セットを使用できます。これには次の 3 セットがあります。セルフ タイム用の「self」（ノードに限定した時間でノードの子は含まない）、「inclusive」（ノードの子を含む時間）、および「count」（ノード上での指定したメトリックの操作回数）。

dgtimer が使用するタイミングの仕組みは DG 自体に組み込まれているため、すべてのディペンデンシー ノードが計測可能です。OpenMaya API を使ってプラグインを作成する場合、ノード計測のための特別なコードを追加する必要はなく、すべてが透過的に処理されます。

dgtimer コマンドでは、ノード タイマーのオン/オフの切り替え、ゼロ リセット、カレント値の表示が可能です。これらの操作は、すべてのノード上でグローバルに実行することも、名前、タイプ、親子関係で定義された特定のノード セットに実行することもできます。タイマー計測はすべて「リアルタイム」（実時間）で計算されるので、「CPU 時間」（プロセッサがコードを実行している時間のみの計測）とは異なります。時間はすべて秒単位で表示されます。

-query フラグを使用してノード上のカレント タイマー値を表示し、
-on フラグを使用してタイミングをオンに切り替え、
-off フラグを使用してタイミングをオフに切り替え、
-reset フラグを使用してタイマーをゼロにリセットします。

タイミング中に計測した値を表示するには、2 つの方法があります。1 つは、計測した情報をレポートできる -query フラグを使用する方法です。もう 1 つは、OpenMaya クラスの MFnDependencyNode で使用できる照会を使用する方法です（詳細は OpenMaya マニュアルを参照）。

次に、-query フラグで生成される出力について説明します。出力は複数のセクションに分割され、次のように表示されます。

SECTION 1:
dgtimer 出力のセクション 1 は、グローバル情報を含みます。このセクションは、-hoHeader フラグで無効にできます。これらの値は、グローバル タイマーがリセットされる度に（dgtimer -reset; を指定する度に）リセットされます。レポートされるグローバル値を以下に示します。

• Total real time: 最後のグローバル タイマー リセット以降の実経過時間の合計。これは、時計で計測する時間と同様の実時間です。 user time や sys time とは異なり、マルチプロセッシング システムでは、この値は実時間と常に一致しています。
• Total user time: 最後のグローバル タイマー リセット以降、CPU が Maya の処理に消費した合計時間（システム時間を除く）。
• Total sys time: 最後のグローバル タイマー リセット以降、CPU が Maya に由来するオペレーティング システムの呼び出しに消費した合計時間。
• Summary of each metric for all nodes: 計測する各メトリックの self と count の概要
。
• Real time in callbacks は、「callback」メトリックの self 時間と count をレポートします。
• Real time in compute は、「compute」メトリックの self 時間と count をレポートします。
• Real time in dirty propagation は、「dirty」メトリックの self 時間と count をレポートします。
• Real time in drawing は、「draw」メトリックの self 時間と count をレポートします。
• Real time fetching data from plugs は、「fetch」メトリックの self 時間と count をレポートします。
• Breakdown of select metrics in greater detail: 計測するメトリックの特定の組み合わせのレポートです。
• Real time in compute invoked from callback は、コールバックによって直接的または間接的に起動された計算にかかる self 時間をレポートします。
• Real time in compute not invoked from callback は、コールバックによって直接的または間接的に起動されたのではない計算にかかる self 時間をレポートします。

次の列が表示されます。

• Rank: すべてのノードをソートしたリスト内でのこのノードの順位です。リストは -sortMetric フラグと -sortType フラグの値でソートされます（これらの値を省略すると、デフォルトとして self 計算時間でソートされます）。
• ON: ノードのタイマーのオン/オフ状態を示します（dgtimer を使用すると、タイマーのオン/オフをノード単位で切り替えることができます）。
• Per-metric information: メトリックごとに各種の列をレポートします。ヘッダーにはメトリック名が大文字（例: 「DRAW」）で表示されます。各メトリックの標準の列は次のとおりです。
• Self: 操作の実行にかかった実時間の合計（つまり、ストップウォッチで計測した場合の経過時間）。たとえばメトリックが「DRAW」であれば、ノードの描画にかかった時間になります。
• Inclusive: 操作のために起動された子の操作をすべて含めて、操作の実行にかかった実時間の合計（つまり、ストップウォッチで計測した場合の経過時間）。たとえばメトリックが「DRAW」であれば、子の操作をすべて含めてノードの描画にかかった合計時間になります。
• Count: このノード上で行われた操作の回数（つまり、メトリックが「DRAW」であれば、ノード上での描画操作の回数をレポートします）。
• Sort information: ノード単位のすべての dgtimer 情報のソートに使用する列であれば、その後に Percent 列と Cumulative 列を続けて、リスト内の実行時間の合計を表示します。「-sortType none」を付けると、この 2 列は表示されずに自動的に「self」時間でソートされます。
• メトリック単位の列の後には、ノード名とタイプをレポートします。
• Type ノードのタイプ。
• Name ノード名。ノードがファイル参照されていて、ネームスペースが使用されている場合は、そのネームスペースを含めます。 -uniqueName フラグを使用して強制的に DAG パスを表示することもできます。
• Plug-in name ノードが OpenMaya プラグインに実装されている場合は、そのプラグインの名前をレポートします。

SECTION 3.1 の最初の部分に、次の構成する各エントリとともに、コールバックごとの時間をリストします。

• コールバック名（例: attributeChangedMsg）。これは Maya の内部で使用する名前で、OpenMaya API を介してコールバックを使用できる場合には、コールバックにアクセスする API 名も同様に表示されます。
• 名前は callbackId ごとに分類して表示されます。callbackId は、コールバックに登録された各クライアントに固有の識別番号で、これにより OpenMaya API を介しているなど、ユーザがクライアントを推測できます。SECTION 3.1 と SECTION 3.3 のリストから同じ callbackId 値を探して、相互参照できます。
• Self time（その callbackId タイプ内でかかる実時間で、そのコールバックの処理中に発生する子の操作は含まない）。
• Percent（-sortType フラグを参照）。パーセント値は、そのコールバックに対して合計 100% までリストされます。これはグローバル パーセントではありません。
• Cumulative（-sortType フラグを参照）。
• Inclusive time（子の操作すべてを含めてそのコールバック内でかかった実時間）。
• Count（callbackId が起動された回数）。
• API では、callbackId が OpenMaya API を介して定義された場合は「Y」、Maya 内で内部的に定義された場合は「N」をリストします。
• ノードでは、この callbackId がコネクトしているノード名をリストします。callbackId が複数のノードにコネクトしている場合は、文字列「*multiple*」を出力します。callbackId にコネクトされたノードがない場合、（またはノードを推測しにくいコールバック タイプの場合）、 エントリは空白になります。
• callbackId エントリのリストの後に、破線を挟んでコールバックの self、inclusive、および count の値が一行に表示されます。パーセントは、コールバック時間全体に対する比率であることに注意してください。

2 番目の部分は SECTION 3.2 で、callbackId ごとにデータをリストします。前記のように、callbackId はコールバックに登録された各クライアントに固有の識別番号で、OpenMaya API を介しているなど、ユーザがクライアントを推測できるようにします。SECTION 3.2 のエントリは次のように表示されます。

• CallbackId コールバックの数値識別子。SECTION 3.1 と SECTION 3.3 のリストから同じ callbackId 値を探して、相互参照できます。
• 各 callbackId に対して、データは次のコールバック単位に分類されます。
• Callback コールバックの名前（例: attributeChangedMsg
）。
• SECTION 3.1 に記載する Percent、Cumulative、Inclusive、Count、API、および Node エントリ
。
• callbackId に対するコールバック エントリのリストの後に、破線を挟んで総計行を出力します。総計行には、コールバックに対する self、inclusive、count の値をリストします。パーセントは、コールバック時間全体に対する比率であることに注意してください。

3 番目の部分は SECTION 3.3 で、ノード単位にコールバックごとにデータをリストします。ノードは -sortType フラグに基づいてソートされ、各ノードに対して同様に -sortType フラグに基づいてソートされたコールバックがリストされます。このリストは長くなる場合があるため、ゼロのエントリは表示しません。SECTION 3.3 での重要な注意点は、まだ存在しているノードのみが表示されるということです。ノードが削除されている場合は、情報はリストされません。

戻り値

戻り値の型は照会モードでは照会フラグが基になります。

キーワード

関連項目

フラグ

ロング ネーム（ショート ネーム）	引数型	プロパティ
combineType(ct)	boolean
animCurveTA など、同タイプのすべてのノードが、出力ディスプレイで結合されます。
hierarchy(h)	boolean
ディペンデンシー グラフの階層が作用されるように指定することができます。「-reset -hierarchy -name ball」とすれば、「ball」という名前のノードと、ディペンデンシー グラフにあるすべての子孫のタイマーがリセットされます。
uniqueName(un)	boolean
出力にリストされる DAG ノードを固有の名前でリストするように指定することができます。ノード名の代わりに、オブジェクトへの DAG のフル パスを出力します。
maxDisplay(m)	int
処理コストが最も高い「n」エントリのみを出力ディスプレイに出力するように、ディスプレイを切り捨てます。
name(n)	string
-reset や -query と併用し、タイマー値をリセットまたは出力するノード名を指定します。単一のタイマーを照会する場合は、一列のみ出力します（すなわち、グローバル タイマーとヘッダーは省略されます）。「-outputFile MEL」オプションを使用して、出力をスクリプト エディタ（Script Editor）ウィンドウに強制し、MEL スクリプトで値を簡単に取得できます。注: -name フラグと -type フラグを併用することはできません。
noHeader(nh)	boolean
-query フラグと併用し、ヘッダー情報やフッター情報の出力を防止します。ノード単位のタイミング データのみが出力されます。 このオプションは、-outputFile オプションでディスク上のファイルに照会結果を出力する場合など、出力の解析をを容易にします。
show(sh)	string
-query フラグと併用し、出力のノード単位のセクションに表示される列を指定します。-show には次の引数を使用できます。 「all」（すべての列を出力）、 「callback」（評価ではなくノードのコールバック処理にかかる時間を表示）、 「compute」（ノードの計算にかかる時間を表示）、 「dirty」（ノードの代わりにダーティの伝播にかかる時間を表示）、 「draw」（ノードの描画にかかる時間を表示）、 「compcb」（計算のためにノードのコールバック処理にかかる時間を表示）、 「compncb」（計算以外のためにノードのコールバック処理にかかる時間を表示） -show フラグは複数回使用できますが、-hide を使用して指定することはできません。デフォルトでは、-show、-hide、または -sort を指定した場合の有効な表示モードは、 「dgtimer -show compute -query」です。
hide(hi)	string
このフラグは -show の反対です。-show と同様に、何度でも指定できる照会専用のフラグです。-hide を指定すると、-hide フラグでリストした列以外のすべての列が表示されます。
overhead(oh)	boolean
タイミング オーバーヘッドの計測をオン/オフにします。通常の環境では、タイミング オーバーヘッドの合計は計測されるイベントより小さいですが、複雑なシーンでは、計測可能なオーバーヘッドが見つかることがあります。デフォルトでは、このオプションはオフです。有効にするには、タイミングの開始前に「dgtimer -overhead true」を指定します。タイミングを照会すると、dgtimer 出力の SECTION 1.2 にオーバーヘッドがレポートされます。個々の操作には分けられません。
sortMetric(sm)	string
-query フラグと併用し、出力のノード単位のセクションを生成する場合にどのメトリックでソートするかを指定します（例:「draw」時間）。 -sortType フラグを指定して、どのタイマーでソートするか定義することもできます。たとえば、「dgtimer -sortMetric draw -sortType count -query」は、各ノードを描画した回数によって出力をソートします。-sortMetric と -sortType はどちらもオプションで、どちらか 1 つのみ指定することもできます。-sortMetric フラグは 1 回しか指定できません。このフラグは次の引数をとります。 「callback」（ノードのコールバック処理中にかかる時間でソート）、 「compute」（ノードの計算にかかる時間でソート）、 「dirty」（ノードの代わりのダーティの伝播にかかる時間でソート）、 「draw」（ノードの描画にかかる時間でソート）、 「fetch」（データをデータ ブロックからコピーするのにかかる時間でソート）。 -sortMetric を省略すると、デフォルトとして最初に表示された列でソートします。 sortMetric は、-show および -hide フラグによる列の表示/非表示には依存しません。非表示の列でソートすることも可能です。-sortMetric および -sortType で選択した列が、MEL コマンド行の dgtimer コマンドで返される合計列になります。このフラグは、-updateHeatMap と併用してヒートマップを構築するメトリックを指定することもできます。
sortType(st)	string
-query フラグと併用して、出力のノード単位のセクションを生成するときに、どのタイマーでソートするかを指定します（例: 「self」時間）。-sortMetric フラグを指定して、どのメトリックでソートするか定義することもできます。たとえば、「dgtimer -sortMetric draw -sortType count -query」は、各ノードを描画した回数によって出力をソートします。-sortMetric と -sortType はどちらもオプションで、どちらか 1 つのみ指定することもできます。-sortType フラグは 1 回しか指定できません。このフラグは次の引数をとります。 「self」（セルフ タイムでソート。これはノードに特定した時間で、その子は含まない）、 「inclusive」（ノードの子を含む時間でソート）、 「count」（ノードが起動された回数でソート）、 「none」（self 時間でソートするが、ノード単位の表示で Percent 列と Cumulative 列は表示しない、またコマンド ラインに Maya のノードの合計数を返す）。 -sortType を省略すると、デフォルトで self 時間でソートされます。 -sortMetric および -sortType で選択した列が、MEL コマンド行の dgtimer コマンドで返される合計列になります。リストの SECTION 1 に表示されるグローバル合計が返されます。例外として、「-sortType none」を使用すると、代わりに Maya のノード数が返されます。 このフラグは、-updateHeatMap と併用してヒートマップを構築するメトリックを指定することもできます。
timerOff(off)	boolean
ノード タイマーをオフにします。デフォルトではすべてのノード上のタイマーがオフになりますが、-name フラグか -type フラグで指定した場合は、指定したノード タイマーのみがオフになります。 すべてのノード上のタイマーがオフになると、グローバル タイマーもオフになります。
timerOn(on)	boolean
ノード タイマーをオンにします。デフォルトではすべてのノード上のタイマーがオンになりますが -name フラグか -type フラグで指定した場合は、指定したノード タイマーのみがオンになります。 このコマンドによってグローバル タイマーもオンになります。 タイマーをオンにしても、タイマーはゼロにリセットされません。タイマーをリセットするには、-reset フラグを使用します。タイマーがリセットされない理由は、タイミングを任意でオンとオフに切り替えて、既存のタイマー値に追加できるようにするためです。
returnCode(rc)	string
このフラグは、より一般的な -returnType フラグに置き換えられました。 -returnCode フラグは計算メトリックにしか使用できなかったためです。 これは下位互換性のためだけに残してあります。 今後のリリースでは削除される予定です。 次に便利な比較表を示します。 ノードの合計数を取得するには: 古い方法: dgtimer -rc nodecount -q; // Result:325// 新しい方法: dgtimer -returnType total -sortType none -q; // Result:325// 古い方法: dgtimer -rc count -q; // Result:1270// count 計算列の合計を取得するには: 新しい方法: dgtimer -returnType total -sortMetric compute -sortType count -q; // Result:1270// 古い方法: dgtimer -rc selftime -q; // Result:0.112898// self 計算列の合計を取得するには: 新しい方法: dgtimer -returnType total -sortMetric compute -sortType self -q; // Result:0.112898//
returnType(rt)	string
このフラグは、dgtimer コマンドが返す double 値が何を表すかを指定します。 デフォルトでは、SECTION 1 に表示される、ノード単位の出力のソート列のグローバル合計が返されます（ソート列は -sortMetric および -sortType フラグで指定できます）。ただし、合計の代わりに列の個々のエントリを返すように指定することもできます。このフラグは、おもに出力を強制せずに照会で使用するのに役立ちます。フラグに値「total」を指定すると列の合計のみが表示され、「all」を指定すると個々のエントリがすべて表示されます。 たとえば、描画の self 時間の合計以外は何も出力したくない場合には、単純に次のように指定します。 dgtimer -returnType total -sortMetric draw -sortType self -threshold 100 -noHeader -query; // Result: 7718.01 // 反対に個々のエントリを取得するには、上記のクエリを次のように変更します。 dgtimer -returnType all -sortMetric draw -sortType self -threshold 100 -noHeader -query; // Result: 6576.01 21.91 11.17 1108.92 // 特定のノードの子を含めたダーティ時間を取得するには、-returnType all と -name を併用します。 dgtimer -name "virginia" -returnType all -sortMetric dirty -sortType inclusive -threshold 100 -noHeader -query; 注: ノードの合計数を取得するには、「-sortType none -returnType total」を使用します。各ノードのオン/オフ状態を取得するには、「-sortType none -returnType all」を使用します。
outputFile(o)	string
-query フラグと併用して、出力先を出力ファイルに設定します。デフォルトの出力先は stdout ですが、たとえば -outputFile "/home/virginia/timing/dgtrace.txt" に設定することができます。スプレッドシート プログラムなどの外部アプリケーションにデータをロードする場合に便利です。スクリプト エディタ（Script Editor）への出力を強制する場合は、MEL スクリプト内から値を取得するために便利な「-outputFile MEL」を使用します。 このフラグは照会モードでは値が必要になります。
reset(r)	boolean
ノード タイマーをゼロにリセットします。デフォルトでは、グローバル タイマーだけでなく全ノードのタイマーがリセットされますが、-name フラグや -type フラグで指定した場合、指定したノードのタイマーのみがリセットされます。
threshold(th)	float
値がしきい値より小さくなると、表示を切り捨てます。しきい値はソートに使用するすべてのタイマーに適用されます。たとえば、ソート キーが self 計算時間（つまり、-sortMetric が「compute」で -sortType が「self」）で、しきい値のパラメータが 20.0 の場合、計算結果の self 時間が 20.0 以上のノードのみ表示します。（-threshold は絶対時間を使用することに注意してください。これと似た -rangeUpper および -rangeLower パラメータは、パーセンテージを使用して範囲を指定します）。
trace(tr)	boolean
ターミナル ウィンドウ（Linux と Macintosh では stderr）および Windows のステータス ウィンドウに対する詳細な実行トレーシングをオン/オフします。デフォルトでは、トレーシングはオフです。有効にすると、時間を記録できる各操作の開始時と終了時にログが記録されます。次に出力のフォーマット例を示します。 dgtimer:begin: compute 3 particleShape1Deformed particleShape1Deformed.lastPosition 上記は、操作の開始を記録する -trace が true の場合の出力例です。各フィールドの詳細を次に示します。「dgtimer:begin:」文字列は、これが操作記録の開始であることを示す識別マーカです。例中の 2 番目の引数「compute」は、操作のメトリックです。「dgtimer -q」に -show フラグを指定すると、指定した各メトリックの出力を表示できます。後に続く整数（この例では 3）は操作スタックの深さで、3 番目の引数はノードの名前です（particleShape1Deformed）。4 番目の引数はメトリックによって異なります。「compute」では、計算するプラグ名を指定します。「callback」では、Maya の内部的なコールバック名です。「dirty」では、ダーティの伝播元のプラグ名です。 dgtimer:end: compute 3 particleShape1Deformed 0.000305685 0.000305685 上記は操作の終了の記録です。「compute」、「3」、「particleShapeDeformed」引数については、上述の「dgtimer:begin」の概要で説明しました。2 つの浮動小数点の引数は、秒単位で計測された操作の self 時間と inclusive 時間です。inclusive 計測では合計時間をリストします。これはこの操作の「dgtimer:begin:」エントリと一致します。一方、self 計測は inclusive 時間からカレント操作の実行中に発生した子の操作によって消費された時間を引いた時間をリストします。 このマニュアルの別の場所で注記したように、この 2 つの時間は「実経過時間」で、Maya がアイドル状態かシステム コールを実行中かに関係なく、すべての時間を含めた経過時間を計測します。 dgtimer は、グローバル メッセージ コールバックなど、Maya のノード以外の精度も計測できるので、このような場合は通常ノード名が表示される場所に「-」を表示します。「-」は「適用不可」を意味します。
type(t)	string
-reset フラグや -query フラグと併用して、タイマー値をリセットまたは出力するノード タイプ（animCurveTA など）を指定します。 照会時には、-combineType フラグを使用すると同じタイプの全ノードが 1 つのエントリに統合され、一列のみを出力します（すなわち、グローバル タイマーやヘッダーは省略されます）。 「-outputFile MEL」オプションを使用して、出力をスクリプト エディタ（Script Editor）ウィンドウに強制し、MEL スクリプトで値を簡単に取得できます。注: -name フラグと -type フラグを併用することはできません。
updateHeatMap(uhm)	int
指定したパラメータに基づいて Maya のヒート マップを再構築するよう強制します。 ヒート マップは内部の dgtimer 構造で、ハイパーグラフ（Hyper Graph）エディタで表示中に、強度値をカラーマップ エントリにマッピングするのに使用します。ヒート マップ表示モードを使用するすべてのエディタが 1 つのヒート マップを共有します。ヒート マップを更新すると、すべてのノード上のタイマー値が分析され、ヒート マップのエントリが均等に分配されます。 パラメータはマップの分割数（整数）で、これはヒート マップの表示に使用可能なカラー数と同じにする必要があります。このフラグを -rangeLower および -rangeUpper フラグと併用して、表示可能な範囲が指定した比率の範囲内に収まるように制限できます。dgtimer コマンドは、指定したメトリックとタイプに対して、Maya のすべてのノードの最大タイミング値を返します。注: 表示範囲に 0 が含まれる場合は、ヒート マップ内の特殊な 0 番目（正確にゼロ）のスロットを使用できます。
rangeLower(rgl)	float
このフラグは、照会で表示するノードの範囲を制限したり、-updateHeatMap と併用してヒート マップを制限したりするのに使用します。この値は処理されるノードの下限のパーセンテージです。範囲の下限を設定する -rangeLower フラグもあります。デフォルト値は 0 で、範囲の上限より下のタイミング値を持つすべてのノードが対象になります。
rangeUpper(rgu)	float
このフラグは、照会で表示するノードの範囲を制限したり、-updateHeatMap と併用してヒート マップを制限したりするのに使用します。この値は処理されるノードの上限のパーセンテージです。範囲の下限を設定する -rangeLower フラグもあります。デフォルト値は 100 で、範囲の下限より上のタイミング値を持つすべてのノードが対象になります。

: コマンドの作成モードで使用可能なフラグ	: コマンドの編集モードで使用可能なフラグ
: コマンドの照会モードで使用可能なフラグ	: タプルまたはリストとして渡された複数の引数を持てるフラグ

Python 例

import maya.cmds as cmds

# Turns on node timing and resets the timers.
cmds.dgtimer( on=True )
# Turns off node timing. Note that this does not reset the
# timers.
cmds.dgtimer( off=True )
# Prints the current timer values to the default (stdout).
cmds.dgtimer( query=True )
# To reset the timers:
cmds.dgtimer( reset=True )
# Turn on node timing and reset the timer values to zero.
# Then, playback the scene, turn off timing and dump to a file.
# Turn on timing without resetting the timers, and repeat.
cmds.dgtimer( on=True, reset=True )
cmds.play( wait=True )
cmds.dgtimer( off=True )
cmds.dgtimer( outputFile='/home/virginia/timing/dgtrace_once.txt', query=True )
cmds.dgtimer( on=True )
cmds.play( wait=True )
cmds.dgtimer( off=True )
cmds.dgtimer( outputFile='/home/virginia/timing/dgtrace_twice.txt', query=True )