GXST2 class

class GXST2(handle=0)

GXST2 class.

Bi-variate statistics. The GXST2 class accumulates statistics on two data vectors simultaneously in order to compute correlation information. Statistics are accumulated using the data_vv function. See also GXST (mono-variate statistics).

classmethod create()

Creates a statistics object which is used to accumulate statistics.

Returns:GXST2 Object Return type:GXST2

New in version 5.0.

License: Geosoft End-User License

data_vv(vv_x, vv_y)

Add all the values in VVx and VVy to GXST2 object.

Parameters:

• vv_x (GXVV) – VVx handle
• vv_y (GXVV) – VVy handle

New in version 5.0.

License: Geosoft End-User License

get(id)

Gets correlation coeff. from the GXST2 object.

Parameters:id (int) – ST2_CORRELATION constants Returns:Data you asked for GS_R8DM for none Return type:float

New in version 5.0.

License: Geosoft End-User License

is_null()

Check if this is a null (undefined) instance

Returns:True if this is a null (undefined) instance, False otherwise. Return type:bool

items()

Gets Number of items

Returns:Number of items in GXST2 Return type:int

New in version 5.0.

License: Geosoft End-User License

classmethod null()

A null (undefined) instance of GXST2

Returns:A null GXST2 Return type:GXST2

reset()

Resets the Statistics.

New in version 5.0.

License: Geosoft End-User License

ST2_CORRELATION constants

Correlation style

ST2_CORR

Simple correlation

gxapi.ST2_CORR = 0

ST2_PCORR

Pearson’s correlation (normalized to standard deviations)

gxapi.ST2_PCORR = 1