Ivt.Thresh()

<< Click to Display Table of Contents >>

Navigation:  Explain™ Control Language  > Library Routines > Curve classes > class IVT >

Ivt.Thresh()

Description

Set 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:

 

IMin

I < I_MinThresh

IMax

I > I_MaxThresh

EMin

E < E_MinThresh

EMax

E > E_MaxThresh

AMin

A < A_MinThresh

AMax

A > A_MaxThresh

 

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.

 

Gamry tip bulb

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.

 

Type

INSTANCE FUNCTION

 

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.