Ivt.Thresh()

Ivt.Thresh()

Type: INSTANCE FUNCTION

Purpose: Sets up threshold conditions which must be met before Ivt.StopAt() tests are performed.

After any of the threshold tests is met, the StopAt criteria are evaluated for the rest of the scan. There are six threshold tests that you can perform:

 

1.

IMin

I < I_MinThresh

 

2.

IMax

I > I_MaxThresh

 

3.

EMin

E < E_MinThresh

 

4.

EMax

E > E_MaxThresh

 

5.

Amin

A < A_MinThresh

 

6.

Amax

A > A_MinThresh

Threshold tests allow you to tune the StopAt tests more carefully. For example, you can avoid a premature experiment termination caused by an initial transient.

In general you only enable one of the threshold tests. The others are turned off by a NIL argument in the function call.

NOTE: Any threshold test starts all StopAt tests. Also, when StopAt testing is enabled, it is never disabled, even if the Threshold test that enabled it is no longer valid.

Usage: Ivt.Thresh(Imin, Imax, Vmin, Vmax, Amin, Amax)

  Imin

REAL

Enable StopAt if I < IMin
  NIL Disable this test
  Imax

REAL

Enable StopAt if I > IMax
 

NIL

Disable this test
  Vmin

REAL

Enable StopAt if E < EMin
  NIL Disable this test
  Vmax

REAL

Enable StopAt if E > EMax
  NIL Disable this test
  Amin

REAL

Enable StopAt if A < AMin
  NIL Disable this test
  Amax

REAL

Enable StopAt if A > AMax
  NIL Disable this test

Related Topics Link IconRelated Topics