GXIEXP class

class GXIEXP(handle=0)[source]

GXIEXP class.

The GXIEXP class is similar to the GXEXP class, but is used to apply math expressions to grids (GXIMG objects).

__init__(handle=0)[source]
add_grid(img, var)[source]

This method adds an image to the GXIEXP object with a variable name.

Parameters:

  • img (GXIMG) – Image to add

  • var (str) – Variable name

New in version 5.0.

License: Geosoft End-User License

classmethod create()[source]

This method creates an GXIEXP object.

Returns:

GXIEXP Object

Return type:

GXIEXP

New in version 5.0.

License: Geosoft End-User License

do_formula(formula, unused)[source]

This method runs a formula on the grids.

Parameters:

  • formula (str) – Formula

  • unused (int) – Legacy parameter, no longer used.

New in version 5.0.

License: Geosoft End-User License

is_null()[source]

Check if this is a null (undefined) instance

Returns:

True if this is a null (undefined) instance, False otherwise.

Return type:

bool

classmethod null()[source]

A null (undefined) instance of GXIEXP

Returns:

A null GXIEXP

Return type:

GXIEXP