TransformPart - スコープ指定、グローバル

Xanadu API リファレンス

Release

xanadu

ft:locale

ja-JP

ft:publication_title

Xanadu API リファレンス

ft:clusterId

crapiref

bundleId

crapiref

workflow

Creator

TransformPart - スコープ指定、グローバル

リリースバージョン: Xanadu

更新日 2024年08月01日

所要時間：17分

TransformPart API には、実行する変換の詳細を指定するメソッドが用意されています。

このクラスは、スコープ対象のサーバースクリプトおよびグローバルサーバースクリプトで呼び出すことができます。TransformPart クラスを使用する場合は、sn_clotho名前空間識別子を使用します。

このクラスにはコンストラクターはありません。TransformPart オブジェクトは、多くの Transformer メソッドと TransformPart メソッドによって返されます。

このクラスのメソッドで、実行する変換を定義します。実際の変換は、 Transformer オブジェクトで execute() メソッドが呼び出されたときに行われます。

TransformPart メソッドが呼び出される順序が重要となります。

変換メソッドを呼び出す前に、metric() メソッドを呼び出す必要があります。
変換メソッドを呼び出した後に metric() または groupBy() メソッドを使用することはできません。

必要な中間結果に対して collect() メソッドが呼び出されないと、中間変換が結果として返されません。

// where tp is a TransformPart object
// example 1
tp.avg().add(2);
var tr = tp.execute(); 
// tr contains avg+2, but not avg
 
// example 2
tp.avg().add(2);
tp.avg();
var tr = tp.execute(); 
// tr contains both avg and avg + 2

// example 3
tp.avg().collect().add(2);
var tr = tp.execute(); 
// tr contains both avg and avg + 2

このクラスは、メトリックベースアプリケーションの一部です。

TransformPart - add(数値 constant)

指定された数字を各タイムスタンプの値に加算します。

表 : 1. パラメーター
名前	タイプ	説明
constant	数字	各タイムスタンプの値に加算する数字。

表 : 2. 返される内容
タイプ	説明
TransformPart	変換の特性を指定するために使用できる TransformPart オブジェクト。

TransformPart - avg()

選択した測定基準系列を、各タイムスタンプに対する平均値を含む 1 つの系列に集計します。

表 : 3. パラメーター
名前	タイプ	説明
なし

表 : 4. 返される内容
タイプ	説明
TransformPart	変換の特性を指定するために使用できる TransformPart オブジェクト。

TransformPart - bottom(数字 count)

タイムスタンプごとに指定された数の下限値を返す結果セットを作成します。このメソッドでは系列の「count」の数値が得られます。それぞれの値には、その値のソース系列のラベルが保持されます。

表 : 5. パラメーター
名前	タイプ	説明
count	数字	返される系列の数。系列には -1 をカウントする 0 のラベルが付きます。

表 : 6. 返される内容
タイプ	説明
TransformPart	変換の特性を指定するために使用できる TransformPart オブジェクト。

TransformPart - ceil(数字 certification)

指定の値より大きいタイムスタンプの値を、指定の値に置き換えます。

表 : 7. パラメーター
名前	タイプ	説明
ceiling	数字	タイムスタンプに対する最大許容値。

表 : 8. 返される内容
タイプ	説明
TransformPart	変換の特性を指定するために使用できる TransformPart オブジェクト。

TransformPart - collect()

この変換を収集対象としてマークします。

チェーンの一部であるが最後の変換でない変換は、デフォルトでは収集されません。収集された変換は、変換結果の一部として返されます。

表 : 9. パラメーター
名前	タイプ	説明
なし

表 : 10. 返される内容
タイプ	説明
TransformPart	変換の特性を指定するために使用できる TransformPart オブジェクト。

TransformPart - count()

選択した測定基準系列を、各タイムスタンプに対する値の数を含む 1 つの系列に集計します。

表 : 11. パラメーター
名前	タイプ	説明
なし

表 : 12. 返される内容
タイプ	説明
TransformPart	変換の特性を指定するために使用できる TransformPart オブジェクト。

TransformPart - div(数字 constant)

各タイムスタンプの値を、指定した数字で割ります。

表 : 13. パラメーター
名前	タイプ	説明
constant	数字	各タイムスタンプの値を割る数。

表 : 14. 返される内容
タイプ	説明
TransformPart	変換の特性を指定するために使用できる TransformPart オブジェクト。

TransformPart - filter(オブジェクト aggregator, オブジェクト duration)

指定された期間の指定された集計を使用して系列を作成します。

表 : 15. パラメーター
名前	タイプ	説明
aggregator	オブジェクト	設定可能なオブジェクトは次のとおりです。 AVG カイ 2 乗最後最大 MEDIAN 最小 STDDEV これらのオプションの定義については、「メトリックベース変換」を参照してください。
期間	オブジェクト	系列の期間。

表 : 16. 返される内容
タイプ	説明
TransformPart	変換の特性を指定するために使用できる TransformPart オブジェクト。

TransformPart - floor(数字 floor)

指定の値より小さいタイムスタンプの値を、指定の値に置き換えます。

表 : 17. パラメーター
名前	タイプ	説明
floor	数字	タイムスタンプに対する最小値。

表 : 18. 返される内容
タイプ	説明
TransformPart	変換の特性を指定するために使用できる TransformPart オブジェクト。

TransformPart - fractiles(アレイ fractions)

値の指定したパーセント値が下回る値で構成される系列を作成します。指定したアレイ内の各小数部の系列を返します。

返される系列のタイムスタンプ内の値は、そのタイムスタンプのサンプルの指定された小数部を上限とする値です。例えば、小数が 0.5 の場合、タイムスタンプの値は、入力された系列の値の半分を上限とする値 (中央値) となります。

表 : 19. パラメーター
名前	タイプ	説明
fractions	数値のアレイ	入力系列で使用する小数部。

表 : 20. 返される内容
タイプ	説明
TransformPart	変換の特性を指定するために使用できる TransformPart オブジェクト。指定された小数部それぞれに 1 つの系列が含まれます。

// returns a single series containing the median for each time stamp, which
// means that half a time stamp's values are below the returned value 
fractiles([.5]) 
// returns four series, one series for each of the 25%, 50%, 75%, and 100% quartiles 
fractiles([.25, .5, .75, 1])
// returns the median, 95% percentile, the max value
fractiles([.50, .95, 1])

TransformPart - getResult()

この変換に関連する結果の部分を返します。

collect() メソッドは execute() メソッドの前に呼び出す必要があり、execute() メソッドは getResult() メソッドの前に呼び出す必要があります。

表 : 21. パラメーター
名前	タイプ	説明
なし

表 : 22. 返される内容
タイプ	説明
TransformResult	変換のこの部分に関連付けられた変換結果が入ります。

var t = new sn_clotho.Transformer(drones);
t.metric("mb_demo_mt_altitude");
var avgTform = t.avg();
t.execute();
var avgTformResult = avgTform.getResult();

TransformPart - groupBy(文字列 field)

データのグループ化の基準となるフィールドを指定します。複数のフィールドを指定するには、呼び出しを個別に連続して実行します。

注:

変換が実行された後に groupBy() メソッドを呼び出すことはできません。

表 : 23. パラメーター
名前	タイプ	説明
フィールド	文字列	変換結果をグループ化する際の基準となるテーブル内のフィールドの名前。

表 : 24. 返される内容
タイプ	説明
TransformPart	変換の特性を指定するために使用できる TransformPart オブジェクト。

次の例では、フリートフィールドとモデルフィールドを基準に高度の平均測定基準をグループ化する方法を示します。

transformer.groupBy("fleet,model").metric("mb_demo_mt_altitude").avg().label('%g:fleet: - %g:model:');

var transformPart = transformer.groupBy("fleet,model")

transformPart.metric("mb_demo_mt_altitude").avg().label('%g:fleet: - %g:model:');

TransformPart - interpolate(オブジェクト count)

隣接するデータ値から挿入して NaN データアイテムのデータ値を作成します。

表 : 25. パラメーター
名前	タイプ	説明
count	オブジェクト	非 NaN 値をチェックする各方向のデータサンプルの数を指定します。NaN 以外の値が見つからない場合は、NaN が使用されます。

表 : 26. 返される内容
タイプ	説明
TransformPart	変換の特性を指定するために使用できる TransformPart オブジェクト。

TransformPart - iqr()

四分位範囲変換を実行します。

4 つの系列の結果セットを作成します。

IQR (すべてのエントリーの中央値)
IQR 範囲 (Q1-1.5IQR 未満、または Q3+1.5IQR より上)
Q1 (エントリーの最小の半分の中央値)
Q3 (エントリーの最大の半分の中央値)

表 : 27. パラメーター
名前	タイプ	説明
なし

表 : 28. 返される内容
タイプ	説明
TransformPart	変換の特性を指定するために使用できる TransformPart オブジェクト。

TransformPart - label(文字列 label)

結果の系列のラベルを追加します。

表 : 29. パラメーター
名前	タイプ	説明
label	文字列	変換結果のラベル。

表 : 30. 返される内容
タイプ	説明
TransformPart	変換の特性を指定するために使用できる TransformPart オブジェクト。

TransformPart - limit(オブジェクト count)

最後の非 NaN 値から始めて、指定された値の最大数を返します。

表 : 31. パラメーター
名前	タイプ	説明
count	オブジェクト	多数のタイムスタンプ。

表 : 32. 返される内容
タイプ	説明
TransformPart	変換の特性を指定するために使用できる TransformPart オブジェクト。

TransformPart - log(数字 base)

各タイムスタンプの値に対して対数計算を実行します。結果は、タイムスタンプ値の指定された基準値のログです。

表 : 33. パラメーター
名前	タイプ	説明
base	数字	対数計算の基準。

表 : 34. 返される内容
タイプ	説明
TransformPart	変換の特性を指定するために使用できる TransformPart オブジェクト。

TransformPart - max()

各タイムスタンプの最大値を含む系列を返します。

表 : 35. パラメーター
名前	タイプ	説明
なし

表 : 36. 返される内容
タイプ	説明
TransformPart	変換の特性を指定するために使用できる TransformPart オブジェクト。

TransformPart - median()

系列のセット全体での各タイムスタンプの値の中央値を含む系列を作成します。

TranformPart オブジェクトに n 個の系列があって、n が奇数の場合、タイムスタンプに対する (n / 2 + 1) の値が中央値となります。n が偶数の場合、タイムスタンプに対する (n / 2) の値と (n / 2 + 1) の値の平均が中央値となります。

表 : 37. パラメーター
名前	タイプ	説明
なし

表 : 38. 返される内容
タイプ	説明
TransformPart	変換の特性を指定するために使用できる TransformPart オブジェクト。

TransformPart - metric(文字列 metric)

変換で使用する測定基準フィールドを指定します。

変換で使用する複数の測定基準を指定できます。変換が実行された後に metric() メソッドを呼び出すことはできません。

表 : 39. パラメーター
名前	タイプ	説明
metric	文字列	基準フィールドの名前

表 : 40. 返される内容
タイプ	説明
TransformPart	変換の特性を指定するために使用できる TransformPart オブジェクト。

TransformPart - min()

各タイムスタンプの最小値を含む系列を返します。

表 : 41. パラメーター
名前	タイプ	説明
なし

表 : 42. 返される内容
タイプ	説明
TransformPart	変換の特性を指定するために使用できる TransformPart オブジェクト。

TransformPart - mul(数字 constant)

各タイムスタンプの値を指定された数値で乗算します。

表 : 43. パラメーター
名前	タイプ	説明
constant	数字	各タイムスタンプの値に乗じる数。

表 : 44. 返される内容
タイプ	説明
TransformPart	変換の特性を指定するために使用できる TransformPart オブジェクト。

TransformPart - partition(文字列 aggregator, GlideDateTime duration, GlideDateTime base)

系列を同じ期間の間隔に分割します。

表 : 45. パラメーター
名前	タイプ	説明
aggregator	文字列	使用する集計。min、max、avg、または last を指定できます。
duration	GlideDateTime または ISO 8601 形式の文字列	間隔の長さ。
base	GlideDateTime または ISO 8601 形式の文字列	パーティショニングに使用するゼロオフセット。例えば、日 (24 時間) で分割するには、この基準を自身のタイムゾーンの月曜日の午前 0 時に設定します。30 日ごとに分割する場合は、基準を最新の月の 1 日に設定します。

表 : 46. 返される内容
タイプ	説明
TransformPart	変換の特性を指定するために使用できる TransformPart オブジェクト。

TransformPart - resample(数字 count)

結果に含めるデータポイントの数を指定します。

指定の範囲内に固定数のデータポイントで系列を配置します。元の系列のデータポイント数が指定より多い場合は、複数の値が平均されます。元の系列のデータポイント数が指定より少ない場合は、既存のデータポイント間にデータポイントを補間することでデータポイントが追加されます。

resample() メソッドを使用することで、結果のサンプル数を減らし、表示するサンプル数により近い値にすることができます。

表 : 47. パラメーター
名前	タイプ	説明
count	数字	結果に含めるサンプルの数。

表 : 48. 返される内容
タイプ	説明
TransformPart	変換の特性を指定するために使用できる TransformPart オブジェクト。

TransformPart - resample(数字 min, 数字 max)

結果に含めるサンプルの最少数と最大数を指定します。

このメソッドは、さまざまな期間 (粒度) で系列を表示する場合に便利です。

このメソッドで系列ごとの平均ポイント数が決定されます。その数が指定された最小値と最大値の間に収まる場合、各系列はその平均ポイント数にリサンプルされます。計算された平均が指定の最大値より大きいか指定の最小値より小さい場合は、指定された最大値または最小値が使用されます。

表 : 49. パラメーター
名前	タイプ	説明
min	数字	結果に含めるサンプルの最小数。十分なサンプルがない場合は、補間を使用してサンプルが作成されます。
max	数字	結果に含めるサンプルの最大数。

表 : 50. 返される内容
タイプ	説明
TransformPart	変換の特性を指定するために使用できる TransformPart オブジェクト。

TransformPart - resample(文字列 aggregator, 数字 numValues)

指定されたサイズの結果セットを作成するために使用する集計関数を指定します。集計関数は、LAST、AVG、MIN、MAX のいずれかに指定できます。

resample() メソッドを使用することで、結果のサンプル数を減らし、表示するサンプル数により近い値にすることができます。

表 : 51. パラメーター
名前	タイプ	説明
aggregator	文字列	LAST、AVG、MIN、または MAX を指定できます。
numValues	数字	結果セットに含めるサンプルの数。要求された値の数が要求された期間のデータ内の値の数よりも多い場合は、interpoate() を使用して既存のポイント間で値を追加し、要求された値の数に合わせます。

表 : 52. 返される内容
タイプ	説明
TransformPart	変換の特性を指定するために使用できる TransformPart オブジェクト。

TransformPart - resample(文字列 aggregator, GlideDuration duration)

指定された期間の結果セットを作成するために使用する集計関数を指定します。集計関数は、LAST、AVG、MIN、MAX のいずれかに指定できます。

基になるデータを要求された期間にリサンプルします。

時系列が 1 分間隔で保存され、resample(AVG, new GlideDuration("1:00")) が呼び出された場合、結果には前の 60 件の値の平均を反映したデータポイントが 1 時間あたり 1 つできます。
要求された期間がデータの期間よりも短い場合、途中のデータポイントが補間によって計算されます。

resample() メソッドを使用することで、結果のサンプル数を減らし、表示するサンプル数により近い値にすることができます。

表 : 53. パラメーター
名前	タイプ	説明
aggregator	文字列	LAST、AVG、MIN、または MAX を指定できます。
duration	GlideDuration	結果セットの期間。

表 : 54. 返される内容
タイプ	説明
TransformPart	変換の特性を指定するために使用できる TransformPart オブジェクト。

TransformPart - round(数字 precision)

各タイムスタンプの値を指定された精度に丸めます。

それぞれの値でこの計算を実行します。

(v / precision) * precision

表 : 55. パラメーター
名前	タイプ	説明
precision	数字	丸め計算で使用される値。

表 : 56. 返される内容
タイプ	説明
TransformPart	変換の特性を指定するために使用できる TransformPart オブジェクト。

TransformPart - stddev()

系列のセット全体の各タイムスタンプの値の標準偏差を含む系列を作成します。

表 : 57. パラメーター
名前	タイプ	説明
なし

表 : 58. 返される内容
タイプ	説明
TransformPart	変換の特性を指定するために使用できる TransformPart オブジェクト。

TransformPart - sub(オブジェクト constant)

指定された数字を各タイムスタンプの値から減算します。

表 : 59. パラメーター
名前	タイプ	説明
constant	オブジェクト	各タイムスタンプの値から減算する数字。

表 : 60. 返される内容
タイプ	説明
TransformPart	変換の特性を指定するために使用できる TransformPart オブジェクト。

TransformPart - sum()

選択した測定基準系列を、各タイムスタンプに対するすべての値の合計を含む 1 つの系列に集計します。

表 : 61. パラメーター
名前	タイプ	説明
なし

表 : 62. 返される内容
タイプ	説明
TransformPart	変換の特性を指定するために使用できる TransformPart オブジェクト。

TransformPart - top(数字 count)

タイムスタンプごとに指定された数の上限値を返す結果セットを作成します。このメソッドでは系列の「count」の数値が得られます。それぞれの値には、その値のソース系列のラベルが保持されます。

表 : 63. パラメーター
名前	タイプ	説明
count	数字	返される系列の数。系列には -1 をカウントする 0 のラベルが付きます。

表 : 64. 返される内容
タイプ	説明
TransformPart	変換の特性を指定するために使用できる TransformPart オブジェクト。