GXITR class¶
-
class
GXITR
(handle=0)¶ GXITR class.
The
GXITR
class provides access toGXITR
files. AnGXITR
file maps ranges of values to specific colors. TheGXITR
object is typically used in conjunction withGXMVIEW
objects (seeGXMVIEW
andGXMVU
).Note:
Histogram ranges and color zone ranges
Histogram bins are defined with inclusive minima and exclusive maxima; for instance if Min = 0 and Inc = 1, then the second bin would include all values z such that 0 <= z < 1 (the first bin has all values < 0).
Color zones used in displaying grids (
GXITR
, ZON etc...) are the opposite, with exclusive minima and inclusive maxima. For instance, if a zone is defined from 0 to 1, then it would contain all values of z such that 0 < z <= 1.These definitions mean that it is impossible to perfectly assign
GXITR
colors to individual bars of a histogram. The best work-around when the data values are integers is to define the color zones using 0.5 values between the integers. A general work-around is to make the number of histogram bins much larger than the number of color zones.The
ITR_NULL
is used to hold a NULL handle to anGXITR
class.-
change_brightness
(brt)¶ Change the brightness.
Parameters: brt (float) – -1.0 - black; 0.0 no change; 1.0 white New in version 5.0.
License: Geosoft Open License
Note: 0.0 brightness does nothing. -1.0 to 0.0 makes colors darker, -1.0 is black 0.0 to 1.0 makes colors lighter, 1.0 is white
-
color_value
(val)¶ Transform single data value to color
Parameters: val (float) – Data value Returns: MVIEW_COLOR constants Return type: int New in version 5.1.
License: Geosoft Open License
-
color_vv
(vv_d, vv_c)¶ Get color transform of a
GXVV
.Parameters: New in version 5.1.6.
License: Geosoft Open License
Note: If the input value is a dummy, then the output color is 0 (no color).
-
copy
(it_rs)¶ Copies ITRs
Parameters: it_rs (GXITR) – GXITR
SourceNew in version 5.0.
License: Geosoft Open License
-
classmethod
create
()¶ Create an
GXITR
objectReturns: GXITR
objectReturn type: GXITR New in version 5.0.
License: Geosoft Open License
-
classmethod
create_file
(file)¶ Create an
GXITR
object from an itr, tbl, zon, lut file.Parameters: file (str) – File name, type determined from extension Returns: GXITR
objectReturn type: GXITR New in version 5.0.
License: Geosoft Open License
-
classmethod
create_img
(img, tbl, zone, contour)¶ Create an
GXITR
for an image.Parameters: - tbl (str) – Color table name, NULL for default
- zone (int) – ITR_ZONE constants
- contour (float) – Color contour interval or
rDUMMY
Returns: GXITR
objectReturn type: New in version 5.1.
License: Geosoft Open License
Note: The
ITR_ZONE_DEFAULT
model will ask theGXIMG
to provide a model if it can.If a shaded relief model is selected, a shaded image will be created and a shaded image file will be created with the same name as the original grid but with the suffux “_s” added to the name part of the grid.
-
classmethod
create_map
(map, name)¶ Create
GXITR
from Map withGXAGG
Group name.Parameters: Returns: GXITR
objectReturn type: New in version 5.0.
License: Geosoft Open License
-
classmethod
create_s
(bf)¶ Create an
GXITR
object from aGXBF
Parameters: bf (GXBF) – GXBF
to serialize fromReturns: GXITR
objectReturn type: GXITR New in version 5.0.
License: Geosoft Open License
-
equal_area
(st, contour)¶ Calculate an equal area transform.
Parameters: - st (GXST) – Stat object with a histogram
- contour (float) – Color contour interval or dummy for none
New in version 5.1.2.
License: Geosoft Open License
-
get_brightness
()¶ Get the brightness setting of the
GXITR
Returns: The brightness setting of the GXITR
Return type: float New in version 5.0.
License: Geosoft Open License
Note: Brightness can range from -1.0 (black) to 1.0 (white). This brightness control is relative to the normal color when the
GXITR
is created.
-
get_data_limits
(min, max)¶ Get
GXITR
max/min data limits.Parameters: New in version 6.0.
License: Geosoft Open License
Note: In some ITRs, especially those defined and embedded inside grid (
GXIMG
) objects, the actual data minimum and maximum values are stored. This function retrieves those values. This is NOT true of allGXITR
objects, and in those cases dummy values will be returned.
-
get_reg
()¶ -
Returns: GXREG
objectReturn type: GXREG New in version 5.0.
License: Geosoft Open License
-
get_size
()¶ Get the number of zones in an
GXITR
Returns: The number of zones. Return type: int New in version 5.0.
License: Geosoft Open License
-
get_zone_color
(zone, color)¶ Get the color in a zone of the
GXITR
Parameters: - zone (int) – Number of the zone to set.
- color (int_ref) – MVIEW_COLOR constants
New in version 5.0.
License: Geosoft Open License
Note: Valid indices are 0 to N-1, where N is the size of the
GXITR
.
-
get_zone_model_type
()¶ Get the
GXITR
zone model (e.g. Linear, LogLin, Equal Area).Returns: ITR_ZONE_MODEL constants Return type: int New in version 6.4.
License: Geosoft Open License
Note: This function may be used to determine if a color transform is included in an
GXITR
.
-
get_zone_value
(zone)¶ Get the value in a zone of the
GXITR
Parameters: zone (int) – Number of the zone to set. Returns: The value of the specified zone. Return type: float New in version 5.0.
License: Geosoft Open License
Note: Valid indices are 0 to N-2, where N is the size of the
GXITR
.
-
is_null
()¶ Check if this is a null (undefined) instance
Returns: True if this is a null (undefined) instance, False otherwise. Return type: bool
-
linear
(min, max, contour)¶ Calculate a linear transform.
Parameters: - min (float) – Minimum
- max (float) – Maximum
- contour (float) – Color contour interval or dummy for none
New in version 5.0.
License: Geosoft Open License
-
load_a
(file)¶ Load to an ASCII file, ZON, TBL or ER-Mapper LUT
Parameters: file (str) – File name New in version 5.1.6.
License: Geosoft Open License
-
log_linear
(min, max, contour)¶ Calculate a log transform.
Parameters: - min (float) – Minimum ( > 0)
- max (float) – Maximum ( > minimum)
- contour (float) – Color contour interval or dummy for none
New in version 5.0.
License: Geosoft Open License
Note: The function name is a misnomer. This is a pure log transform.
-
normal
(std_dev, mean, exp, contour)¶ Calculate a normal distribution transform.
Parameters: - std_dev (float) – Standard deviation
- mean (float) – Mean
- exp (float) – Expansion, normally 1.0
- contour (float) – Color contour interval or dummy for none
New in version 5.1.2.
License: Geosoft Open License
-
power_zone
(pow)¶ Modified
GXITR
zone values to 10 (or e) raized to the power of the valuesParameters: pow (int) – ITR_POWER constants New in version 5.0.
License: Geosoft Open License
-
save_a
(file)¶ Save to an ASCII file, ZON, TBL or ER-Mapper LUT
Parameters: file (str) – File name New in version 5.1.2.
License: Geosoft Open License
-
save_file
(file)¶ Save to any type (based on the extension of the input file name).
Parameters: file (str) – File name New in version 8.2.
License: Geosoft Open License
-
serial
(bf)¶ -
Parameters: bf (GXBF) – GXBF
to serialize toNew in version 5.0.
License: Geosoft Open License
-
classmethod
set_agg_map
(map, name, itr)¶ -
Parameters: New in version 5.0.
License: Geosoft Open License
Note: See the
create_map
function
-
set_bright_contrast
(brt, con)¶ Set the brightness of the
GXITR
colorsParameters: - brt (float) – 0.0 - black; 0.5 normal; 1.0 white
- con (float) – 0.0 - flat; 1.0 normal
New in version 5.0.
License: Geosoft Open License
Note: Brightness settings: 0.0 - black 0.5 - normal (no change) 1.0 - white
Contrast 0.0 - flat 1.0 - full contrast (normal)
-
set_color_model
(model)¶ Set the color model of an
GXITR
.Parameters: model (int) – ITR_COLOR_MODEL constants New in version 5.0.2.
License: Geosoft Open License
-
set_data_limits
(min, max)¶ Set
GXITR
max/min data limits.Parameters: - min (float) – Data minimum value
- max (float) – Data maximum value
New in version 6.3.
License: Geosoft Open License
-
set_size
(zones)¶ Set the number of zones in an
GXITR
Parameters: zones (int) – Number of zones to set GXITR
to.New in version 5.0.
License: Geosoft Open License
-
set_zone_color
(zone, color)¶ Set the color in a zone of the
GXITR
Parameters: - zone (int) – Number of the zone to set.
- color (int) – MVIEW_COLOR constants
New in version 5.0.
License: Geosoft Open License
Note: Valid indices are 0 to N-1, where N is the size of the
GXITR
.
-
set_zone_value
(zone, value)¶ Set the value in a zone of the
GXITR
Parameters: - zone (int) – Number of the zone to set.
- value (float) – The value to set
New in version 5.0.
License: Geosoft Open License
Note: Valid indices are 0 to N-2, where N is the size of the
GXITR
.
-
ITR_COLOR_MODEL constants¶
GXITR
Color Model defines
-
ITR_COLOR_MODEL_HSV
¶ Hsv
-
gxapi.
ITR_COLOR_MODEL_HSV
= 1
-
-
ITR_COLOR_MODEL_RGB
¶ Rgb
-
gxapi.
ITR_COLOR_MODEL_RGB
= 2
-
-
ITR_COLOR_MODEL_CMY
¶ Cmy
-
gxapi.
ITR_COLOR_MODEL_CMY
= 3
-
ITR_POWER constants¶
Power Zoning defines
-
ITR_POWER_10
¶ Power of 10
-
gxapi.
ITR_POWER_10
= 0
-
-
ITR_POWER_EXP
¶ Exponential
-
gxapi.
ITR_POWER_EXP
= 1
-
ITR_ZONE constants¶
Zoning Methods
-
ITR_ZONE_DEFAULT
¶ Default
-
gxapi.
ITR_ZONE_DEFAULT
= 0
-
-
ITR_ZONE_LINEAR
¶ Linear
-
gxapi.
ITR_ZONE_LINEAR
= 1
-
-
ITR_ZONE_NORMAL
¶ Normal
-
gxapi.
ITR_ZONE_NORMAL
= 2
-
-
ITR_ZONE_EQUALAREA
¶ Equalarea
-
gxapi.
ITR_ZONE_EQUALAREA
= 3
-
-
ITR_ZONE_SHADE
¶ Shade
-
gxapi.
ITR_ZONE_SHADE
= 4
-
-
ITR_ZONE_LOGLINEAR
¶ Loglinear
-
gxapi.
ITR_ZONE_LOGLINEAR
= 5
-
ITR_ZONE_MODEL constants¶
GXITR
Zone Model defines
-
ITR_ZONE_MODEL_NOZONE
¶ The
GXITR
has no numeric zones defined (e.g. from a TBL file)-
gxapi.
ITR_ZONE_MODEL_NOZONE
= -1
-
-
ITR_ZONE_MODEL_NONE
¶ There is no specific zone model defined.
-
gxapi.
ITR_ZONE_MODEL_NONE
= 0
-
-
ITR_ZONE_MODEL_NORMAL
¶ The
GXITR
is set up with a normal distribution transform.-
gxapi.
ITR_ZONE_MODEL_NORMAL
= 2
-