GXST2 class

class geosoft.gx.GXST2
Bi-variate statistics. The ST2 class accumulates statistics
on two data vectors simultaneously in order to compute correlation
information. Statistics are accumulated using the geosoft.gx.GXST2.data_vv() function.
See also ST (mono-variate statistics).
static create((GXContext)ctx) → GXST2:
Creates a statistics object which is used to accumulate statistics.
Parameters:ctx (geosoft.gx.GXContext) – The GX execution context
Returns:ST2 Object
Return type:geosoft.gx.GXST2

New in version 5.0.0.

data_vv((GXVV)arg1, (GXVV)arg2) → None:
Add all the values in VVx and VVy to ST2 object.
Parameters:
Returns:

Nothing
Return type:

None

New in version 5.0.0.

get((int)arg1) → float:
Gets correlation coeff. from the ST2 object.
Parameters:arg1 (int) – ST2_CORRELATION constants
Returns:Data you asked for GS_R8DM for none
Return type:float

New in version 5.0.0.

is_null() → bool

Check if the instance of geosoft.gx.GXST2 is null (undefined)

Returns:True if this is a null instance of geosoft.gx.GXST2, False otherwise.
Return type:bool`
items() → int:
Gets Number of items
Returns:Number of items in ST2
Return type:int

New in version 5.0.0.

static null() → GXST2

A null (undefined) instance of geosoft.gx.GXST2

Returns:A null geosoft.gx.GXST2
Return type:geosoft.gx.GXST2
reset() → None:
Resets the Statistics.
Returns:Nothing
Return type:None

New in version 5.0.0.

ST2_CORRELATION constants

Correlation style
gx.ST2_CORR = 0
Simple correlation
gx.ST2_PCORR = 1
Pearson's correlation (normalized to standard deviations)