is_ramp

typhoon.test.signals. is_ramp ( signalslopetolduring = Nonestrictness = 1time_tol = 0initial_value = Nonereport_plot = None )

信号が目的の傾斜を持つランプであるかどうかを確認します。

パラメータ:
  • signal ( pandas.Series ) – テストするシグナル。

  • slope ( float ) – 信号が持つべきランプ勾配(単位/秒)。

  • tol ( float ) – 結果が True か False かを判断するときに、信号が参照ランプに対してとどまることができる許容値。

  • during (タプル) – 分析の対象となる期間(範囲)。

  • 厳密さ( float ) - テストに合格するために定義された範囲内にある必要がある時間信号の割合を決定する 0.0 から 1.0 までの数値。

  • time_tol ( floatまたはtimedelta ) – 時間許容値 - 作成された参照と比較して、信号が指定された時間(秒単位)まで進んでいるか遅れているかを許可する引数。

  • initial_value ( float ) – 指定されている場合、この値から始まる参照ランプが作成されます。指定されていない場合、参照の初期値は解析対象信号の初期値と等しくなります。

  • レポートプロット

    Allureレポートのプロット添付のデフォルトの動作をオーバーライドする辞書。また、コマンドライン引数でテスト実行全体に指定された動作もオーバーライドします。 --分析プロットタイプ そして --分析プロット失敗時のみ辞書には指定するキーが 2 つあります。

    1. タイプ: 使用するアリュールプロットの種類を指定します。有効な値:

      • 静的 - .png 画像として添付された matplotlib プロットのみが添付されます

      • 相互の作用 - bokehライブラリで作成されたインタラクティブなHTMLプロットのみが添付されています。このプロットの利点は、ズームイン/ズームアウトのオプションがあることです。欠点は、メモリ消費量が大幅に増加することです。

      • なし - 区画は添付されません

      • 全て - すべてのプロットが追加されます。現在サポートされているのはmatplotlib plot(static)とbokeh plot(interactive)です。

    2. いつ: 前のキーで指定されたプロットをレポートに追加するタイミングを指定します。使用可能なオプション:

      • いつも - 常に指定されたプロットを追加します

      • 失敗時 - 参照信号と測定信号の比較が失敗した場合にのみプロットを追加します。これは、Allureプロットのサイズを縮小するのに適した方法です。

    注記

    もし レポートプロット 引数が指定されておらず、コマンドライン引数 --分析プロットタイプ そして 失敗時のみの解析プロット 指定されていない場合、デフォルトの動作は常に静的プロットとしてアタッチされます。コマンドライン引数が指定されている場合は、テスト実行全体にわたる新しいデフォルトの動作が定義されます。

戻り値:

結果– 分析の結果。

戻り値の型:

分析結果

t=2 から t=5 までのシミュレーションを考慮すると、信号は 1 秒あたり 1 単位の傾きを持つ必要があり、信号は ±0.5 の範囲内で変化する可能性があります。

>>> result = is_ramp ( signal  slope = 1  tol = 0.5  during = ( 2  5 )) >>> assert result == True

より簡潔なアサーションの方法は、アサーション ヘルパー関数を使用することです。

>>> assert_is_ramp (信号傾き= 1 許容誤差= 0.5 実行中= ( 2  5 ))

参照

台風テストシグナル分析結果, 台風テストシグナルアサートランプ