GXDSEL class

class GXDSEL(handle=0)[source]

GXDSEL class.

The GXDSEL object is used to select subsets of data from the DATA object

__init__(handle=0)[source]
classmethod create()[source]

Create a Selection object

Returns:

GXDSEL handle, terminates if creation fails

Return type:

GXDSEL

New in version 5.0.3.

License: Geosoft Open License

data_significant_figures(sf)[source]

Specify the data significant figures required

Parameters:

sf (float) – Significant figures (positive, can be fractional)

New in version 5.0.8.

License: Geosoft Open License

Note: This is the number of significant figures that you require for the data. You can reduce this number to achieve better compression ratios. This should only be used when there is one data type in the data.

See sSpatialResolution_DSEL to set the desired spatial resolution.

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

meta_query(query)[source]

Specify a metadata query string.

Parameters:

query (str) – Meta query string

New in version 5.1.3.

License: Geosoft Open License

classmethod null()[source]

A null (undefined) instance of GXDSEL

Returns:

A null GXDSEL

Return type:

GXDSEL

picture_quality(quality)[source]

Specify the quality of pictures being returned.

Parameters:

quality (int) – Quality

New in version 5.1.4.

License: Geosoft Open License

Note: Affected Data Types: PICTURE

request_all_info(request)[source]

Request that all meta-data info be sent

Parameters:

request (int) – TRUE to for all data, FALSE - for normal data

New in version 5.1.3.

License: Geosoft Open License

select_area(pply)[source]

Select a complex clipping area

Parameters:

pply (GXPLY) – GXPLY containing complex area (must contain a projection)

New in version 5.1.3.

License: Geosoft Open License

Note: The DAP server may not handle clipping and may return more data than requested.

select_rect(min_x, min_y, max_x, max_y)[source]

Select a rectangular area.

Parameters:

  • min_x (float) – Min X

  • min_y (float) – Min Y

  • max_x (float) – Max X

  • max_y (float) – Max Y

New in version 5.0.3.

License: Geosoft Open License

select_resolution(res, force)[source]

Specify the resolution desired

Parameters:

  • res (float) – Minimum Resolution

  • force (int) – TRUE to force this resolution, if possible

New in version 5.0.3.

License: Geosoft Open License

Note: Resolution must be specified in the units of the selection GXIPJ.

This will be the optimum data resoulution. (grid cell for grids, data separation for other data types). You will normally get a reasonable resolution as near to or smaller than this unless sRequireResolution_DSEL has been set.

Call sRequireResolution_DSEL with TRUE to force the client to re-sample the data to the resolution requested.

select_size(width, height)[source]

Specify the image size desired

Parameters:

  • width (int) – Image width in pixels

  • height (int) – Image height in pixels

New in version 7.0.

License: Geosoft Open License

set_extract_as_document(value)[source]

Specify that we want to extract this file as a document

Parameters:

value (int) – TRUE (1) if we want as a document

New in version 8.0.

License: Geosoft Open License

set_ipj(ipj, force)[source]

Set the desired projection

Parameters:

  • ipj (GXIPJ) – GXIPJ to set

  • force (int) – TRUE to force reprojection, if possible

New in version 5.0.8.

License: Geosoft Open License

Note: If the server supports reprojection, the data will be reprojected at the server.

If reprojection is not forced, the data may come in any projection.

The spatial resolution and accuracy are accumed to be in the coordinate system defined by this GXIPJ.

spatial_accuracy(acc)[source]

Specify the spatial accuracy required.

Parameters:

acc (float) – Spatial accuracy desired

New in version 5.0.8.

License: Geosoft Open License

Note: Must be specified in the units of the selection GXIPJ.

The spatial accuracy is used improve compression performance for the spatial component of the data returned. You can reduce this number to achieve better compression ratios. This should only be used when there is one data type in the data.

DSEL_PICTURE_QUALITY constants

Line Label Formats

DSEL_PICTURE_QUALITY_DEFAULT

Default

gxapi.DSEL_PICTURE_QUALITY_DEFAULT = 0
DSEL_PICTURE_QUALITY_LOSSLESS

Lossless

gxapi.DSEL_PICTURE_QUALITY_LOSSLESS = 1
DSEL_PICTURE_QUALITY_SEMILOSSY

Semilossy

gxapi.DSEL_PICTURE_QUALITY_SEMILOSSY = 2
DSEL_PICTURE_QUALITY_LOSSY

Lossy

gxapi.DSEL_PICTURE_QUALITY_LOSSY = 3
DSEL_PICTURE_QUALITY_NATIVE

Native

gxapi.DSEL_PICTURE_QUALITY_NATIVE = 4
DSEL_PICTURE_QUALITY_ECW

Ecw

gxapi.DSEL_PICTURE_QUALITY_ECW = 5
DSEL_PICTURE_QUALITY_JPG

Jpg

gxapi.DSEL_PICTURE_QUALITY_JPG = 6
DSEL_PICTURE_QUALITY_PNG

Png

gxapi.DSEL_PICTURE_QUALITY_PNG = 7
DSEL_PICTURE_QUALITY_BMP

Bmp

gxapi.DSEL_PICTURE_QUALITY_BMP = 8
DSEL_PICTURE_QUALITY_TIF

Tif

gxapi.DSEL_PICTURE_QUALITY_TIF = 9