GXUSERMETA class¶
-
class
GXUSERMETA
(handle=0)¶ GXUSERMETA class.
The
GXUSERMETA
class handles user style metadata tied to real data.-
compare
(usermeta2)¶ Compare 2
GXUSERMETA
’sParameters: usermeta2 (GXUSERMETA) – Second UERMETA Returns: 0 - No 1 - Yes Return type: int New in version 7.0.
License: Geosoft Open License
-
classmethod
create
(format)¶ Creates an empty
GXUSERMETA
objectParameters: format (int) – USERMETA_FORMAT constants Type of Meta to create Returns: GXUSERMETA
ObjectReturn type: GXUSERMETA New in version 7.0.
License: Geosoft Open License
-
classmethod
create_s
(file)¶ Create a
GXUSERMETA
from a fileParameters: file (str) – File Name Returns: GXUSERMETA
ObjectReturn type: GXUSERMETA New in version 7.0.
License: Geosoft Open License
-
get_data_creation_date
(date)¶ Get the Data Creation Date
Parameters: date (float_ref) – Date New in version 7.0.
License: Geosoft Open License
-
get_data_creator
(data_creator)¶ Get the Data Creator
Parameters: data_creator (str_ref) – DataCreator returned New in version 7.0.
License: Geosoft Open License
-
get_extents2d
(min_x, min_y, max_x, max_y)¶ Get the 2d Extents
Parameters: New in version 7.0.
License: Geosoft Open License
-
get_extents3d
(min_x, min_y, min_z, max_x, max_y, max_z)¶ Get the 3d Extents
Parameters: New in version 7.0.
License: Geosoft Open License
-
get_format
(format)¶ Get the File Format
Parameters: format (str_ref) – Title returned New in version 7.0.
License: Geosoft Open License
-
get_ipj
(ipj)¶ Get the
GXIPJ
Parameters: ipj (GXIPJ) – Date New in version 7.0.
License: Geosoft Open License
-
get_meta_creation_date
(date)¶ Get the Meta Creation Date
Parameters: date (float_ref) – Date New in version 7.0.
License: Geosoft Open License
-
get_meta_creator
(meta_creator)¶ Get the Meta Creator
Parameters: meta_creator (str_ref) – MetaCreator returned New in version 7.0.
License: Geosoft Open License
-
get_project
(project)¶ Get the File Project
Parameters: project (str_ref) – Title returned New in version 7.0.
License: Geosoft Open License
-
get_title
(title)¶ Get the Title
Parameters: title (str_ref) – Title returned New in version 7.0.
License: Geosoft Open License
-
get_xml_format
(format)¶ Get the XML Format
Parameters: format (int_ref) – USERMETA_FORMAT constants New in version 7.0.
License: Geosoft Open 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
-
classmethod
null
()¶ A null (undefined) instance of
GXUSERMETA
Returns: A null GXUSERMETA
Return type: GXUSERMETA
-
classmethod
save_file_lineage
(file_name, save_geo)¶ Add lineage to XML
Parameters: - file_name (str) – Filename of existing metadata to update
- save_geo (bool) – Output Geosoft Metadata?
New in version 8.2.
License: Geosoft Open License
-
serial
(save_geo, file)¶ Serialize
GXUSERMETA
to aGXBF
.Parameters: - save_geo (bool) – Output Geosoft Metadata?
- file (str) – File name to save to
New in version 7.0.
License: Geosoft Open License
-
set_data_creation_date
(date)¶ Set the Data Creation Date
Parameters: date (float) – Date New in version 7.0.
License: Geosoft Open License
-
set_data_creator
(data_creator)¶ Set the Data Creator
Parameters: data_creator (str) – DataCreator New in version 7.0.
License: Geosoft Open License
-
set_extents2d
(min_x, min_y, max_x, max_y)¶ Set the 2d Extents
Parameters: - min_x (float) – MinX
- min_y (float) – MinY
- max_x (float) – MaxX
- max_y (float) – MaxY
New in version 7.0.
License: Geosoft Open License
-
set_extents3d
(min_x, min_y, min_z, max_x, max_y, max_z)¶ Set the 3d Extents
Parameters: - min_x (float) – MinX
- min_y (float) – MinY
- min_z (float) – MinZ
- max_x (float) – MaxX
- max_y (float) – MaxY
- max_z (float) – MaxZ
New in version 7.0.
License: Geosoft Open License
-
set_format
(format)¶ Set the File Format
Parameters: format (str) – Format New in version 7.0.
License: Geosoft Open License
-
set_ipj
(ipj)¶ Set the
GXIPJ
Parameters: ipj (GXIPJ) – Date New in version 7.0.
License: Geosoft Open License
-
set_meta_creation_date
(date)¶ Set the Meta Creation Date
Parameters: date (float) – Date New in version 7.0.
License: Geosoft Open License
-
set_meta_creator
(meta_creator)¶ Set the Meta Creator
Parameters: meta_creator (str) – MetaCreator New in version 7.0.
License: Geosoft Open License
-
set_project
(project)¶ Set the File Project
Parameters: project (str) – Project New in version 7.0.
License: Geosoft Open License
-
set_title
(title)¶ Set the Title
Parameters: title (str) – Title New in version 7.0.
License: Geosoft Open License
-
classmethod
update_extents_2d
(filename, ipj, min_x, min_y, max_x, max_y)¶ Edit an existing XML metadata file by changing the extents and projection data
Parameters: - filename (str) – Filename of existing metadata to update
- ipj (GXIPJ) – New projection
- min_x (float) – New MinX value
- min_y (float) – New MinY value
- max_x (float) – New MaxX value
- max_y (float) – New MaxY value
New in version 7.0.1.
License: Geosoft Open License
-
classmethod
update_file_type
(file_name, new_file_type)¶ Edit an existing XML metadata file by changing the file type
Parameters: - file_name (str) – Filename of existing metadata to update
- new_file_type (str) – New file type
New in version 7.2.
License: Geosoft Open License
-
USERMETA_FORMAT constants¶
GXUSERMETA
Format Types
-
USERMETA_FORMAT_DEFAULT
¶ Use the standard type for the system
-
gxapi.
USERMETA_FORMAT_DEFAULT
= -1
-
-
USERMETA_FORMAT_ISO
¶ ISO 19139 standard
-
gxapi.
USERMETA_FORMAT_ISO
= 0
-
-
USERMETA_FORMAT_FGDC
¶ FGDC Metadata Standard
-
gxapi.
USERMETA_FORMAT_FGDC
= 1
-