API Reference#
- geoh5py.data package
- Submodules
- geoh5py.data.blob_data module
- geoh5py.data.boolean_data module
- geoh5py.data.color_map module
- geoh5py.data.data module
DataData.associationData.copy()Data.copy_from_extent()Data.default_type_uid()Data.entity_typeData.format_length()Data.formatted_valuesData.mask_by_extent()Data.modifiableData.n_valuesData.nan_valueData.primitive_type()Data.validate_association()Data.validate_entity_type()Data.validate_values()Data.valuesData.visible
- geoh5py.data.data_association_enum module
- geoh5py.data.data_type module
DataTypeDataType.color_mapDataType.dtypeDataType.duplicate_on_copyDataType.duplicate_type_on_copyDataType.find_or_create_type()DataType.hiddenDataType.mappingDataType.number_of_binsDataType.precisionDataType.primitive_typeDataType.primitive_type_from_values()DataType.scaleDataType.scientific_notationDataType.transparent_no_dataDataType.unitsDataType.validate_primitive_type()
GeometricDataValueMapTypeGeometricDataXTypeGeometricDataYTypeGeometricDataZTypeGeometricDynamicDataTypeReferenceDataTypeReferencedBooleanTypeReferencedValueMapType
- geoh5py.data.data_unit module
- geoh5py.data.datetime_data module
- geoh5py.data.filename_data module
- geoh5py.data.float_data module
- geoh5py.data.geometric_data module
- geoh5py.data.integer_data module
- geoh5py.data.numeric_data module
- geoh5py.data.primitive_type_enum module
- geoh5py.data.reference_value_map module
- geoh5py.data.referenced_data module
- geoh5py.data.text_data module
- geoh5py.data.unknown_data module
- geoh5py.data.visual_parameters module
- Module contents
DataTypeEnumPrimitiveTypeEnumPrimitiveTypeEnum.BLOBPrimitiveTypeEnum.BOOLEANPrimitiveTypeEnum.COLOURPrimitiveTypeEnum.COMMENTSPrimitiveTypeEnum.DATETIMEPrimitiveTypeEnum.FILENAMEPrimitiveTypeEnum.FLOATPrimitiveTypeEnum.GEOMETRICPrimitiveTypeEnum.INTEGERPrimitiveTypeEnum.INVALIDPrimitiveTypeEnum.MULTI_TEXTPrimitiveTypeEnum.REFERENCEDPrimitiveTypeEnum.TEXTPrimitiveTypeEnum.UNKNOWNPrimitiveTypeEnum.VECTORPrimitiveTypeEnum.VISUAL_PARAMETERS
- geoh5py.groups package
- Submodules
- geoh5py.groups.base module
- geoh5py.groups.container module
- geoh5py.groups.custom module
- geoh5py.groups.drillhole module
- geoh5py.groups.giftools module
- geoh5py.groups.group_type module
- geoh5py.groups.integrator module
AirborneThemeBlastingDataSetBlastingThemeEarthModelsThemeGeochemistryMineralogyDataSetGeochemistryMineralogyThemeGeophysicsThemeGroundThemeIncidentDataSetIncidentsThemeIntegratorGroupIntegratorMapFileIntegratorMapsIntegratorNeighbourhoodsIntegratorProjectMineProductionThemeObservationPointsThemeQueryGroupRockPropertiesThemeSamplesTheme
- geoh5py.groups.interpretation_section module
InterpretationSectionInterpretationSection.add_interpretation_curve()InterpretationSection.add_interpretation_section()InterpretationSection.can_add_groupInterpretationSection.interpretation_curvesInterpretationSection.interpretation_sectionsInterpretationSection.remove_interpretation_curve()InterpretationSection.remove_interpretation_section()InterpretationSection.section_object
InterpretationSectionParamsInterpretationSectionParams.create_section()InterpretationSectionParams.model_configInterpretationSectionParams.normal_xInterpretationSectionParams.normal_yInterpretationSectionParams.normal_zInterpretationSectionParams.position_xInterpretationSectionParams.position_yInterpretationSectionParams.position_z
- geoh5py.groups.maps module
- geoh5py.groups.notype module
- geoh5py.groups.property_group module
PropertyGroupPropertyGroup.add_properties()PropertyGroup.allow_deletePropertyGroup.associationPropertyGroup.attribute_mapPropertyGroup.collect_valuesPropertyGroup.namePropertyGroup.on_filePropertyGroup.parentPropertyGroup.propertiesPropertyGroup.properties_namePropertyGroup.property_group_typePropertyGroup.remove_properties()PropertyGroup.tablePropertyGroup.uid
- geoh5py.groups.property_group_table module
- geoh5py.groups.property_group_type module
- geoh5py.groups.root module
- geoh5py.groups.simpeg module
- geoh5py.groups.survey module
- geoh5py.groups.uijson module
- Module contents
- geoh5py.io package
- Submodules
- geoh5py.io.h5_reader module
H5ReaderH5Reader.fetch_array_attribute()H5Reader.fetch_attributes()H5Reader.fetch_children()H5Reader.fetch_concatenated_attributes()H5Reader.fetch_concatenated_values()H5Reader.fetch_file_object()H5Reader.fetch_metadata()H5Reader.fetch_project_attributes()H5Reader.fetch_property_groups()H5Reader.fetch_type()H5Reader.fetch_type_attributes()H5Reader.fetch_uuids()H5Reader.fetch_values()H5Reader.format_type_string()
- geoh5py.io.h5_writer module
H5WriterH5Writer.add_or_update_property_group()H5Writer.clear_stats_cache()H5Writer.create_dataset()H5Writer.fetch_handle()H5Writer.init_geoh5()H5Writer.prepare_data_to_write()H5Writer.remove_child()H5Writer.remove_entity()H5Writer.save_entity()H5Writer.str_typeH5Writer.update_concatenated_field()H5Writer.update_field()H5Writer.write_array_attribute()H5Writer.write_attributes()H5Writer.write_color_map()H5Writer.write_data_map()H5Writer.write_data_values()H5Writer.write_entity()H5Writer.write_entity_type()H5Writer.write_file_name_data()H5Writer.write_group_values()H5Writer.write_metadata()H5Writer.write_properties()H5Writer.write_property_groups()H5Writer.write_to_parent()H5Writer.write_value_map()H5Writer.write_visible()
- geoh5py.io.utils module
- Module contents
- geoh5py.objects package
- Subpackages
- Submodules
- geoh5py.objects.block_model module
- geoh5py.objects.cell_object module
- geoh5py.objects.curve module
- geoh5py.objects.drape_model module
- geoh5py.objects.drillhole module
DrillholeDrillhole.add_vertices()Drillhole.cellsDrillhole.collarDrillhole.compute_intervals()Drillhole.costDrillhole.default_collocation_distanceDrillhole.densify_survey_values()Drillhole.depthsDrillhole.depths_to_xyz()Drillhole.desurvey()Drillhole.end_of_holeDrillhole.extentDrillhole.format_survey_values()Drillhole.from_Drillhole.intervalsDrillhole.locationsDrillhole.mask_by_extent()Drillhole.n_cellsDrillhole.planningDrillhole.post_processing()Drillhole.surveysDrillhole.to_Drillhole.traceDrillhole.trace_depthDrillhole.validate_association()Drillhole.validate_depth_data()Drillhole.validate_interval_data()Drillhole.validate_mask()Drillhole.vertices
- geoh5py.objects.geo_image module
GeoImageGeoImage.cellsGeoImage.copy_from_extent()GeoImage.default_verticesGeoImage.dipGeoImage.georeference()GeoImage.georeferencing_from_image()GeoImage.georeferencing_from_tiff()GeoImage.imageGeoImage.image_dataGeoImage.image_georeferencedGeoImage.mask_by_extent()GeoImage.n_cellsGeoImage.n_verticesGeoImage.originGeoImage.rotationGeoImage.save_as()GeoImage.set_tag_from_vertices()GeoImage.tagGeoImage.to_grid2d()GeoImage.validate_image_data()GeoImage.vertices
- geoh5py.objects.grid2d module
- geoh5py.objects.grid_object module
- geoh5py.objects.integrator module
- geoh5py.objects.label module
- geoh5py.objects.notype_object module
- geoh5py.objects.object_base module
ObjectBaseObjectBase.add_children()ObjectBase.add_data()ObjectBase.add_data_map()ObjectBase.add_data_map_type()ObjectBase.add_data_to_group()ObjectBase.add_default_visual_parameters()ObjectBase.converterObjectBase.copy()ObjectBase.create_property_group()ObjectBase.entity_typeObjectBase.extentObjectBase.fetch_property_group()ObjectBase.find_association()ObjectBase.find_or_create_property_group()ObjectBase.find_or_create_type()ObjectBase.get_data()ObjectBase.get_data_list()ObjectBase.get_property_group()ObjectBase.last_focusObjectBase.load_children_values()ObjectBase.locationsObjectBase.mask_by_extent()ObjectBase.post_processing()ObjectBase.property_groupsObjectBase.reference_to_data()ObjectBase.remove_children()ObjectBase.remove_data_from_groups()ObjectBase.validate_association()ObjectBase.validate_entity_type()ObjectBase.validate_mask()ObjectBase.visual_parameters
- geoh5py.objects.object_type module
- geoh5py.objects.octree module
- geoh5py.objects.points module
- geoh5py.objects.slicer module
- geoh5py.objects.surface module
- Module contents
- geoh5py.shared package
- Subpackages
- geoh5py.shared.concatenation package
- Submodules
- geoh5py.shared.concatenation.concatenated module
- geoh5py.shared.concatenation.concatenator module
- geoh5py.shared.concatenation.data module
- geoh5py.shared.concatenation.drillhole module
- geoh5py.shared.concatenation.drillholes_group_table module
- geoh5py.shared.concatenation.object module
- geoh5py.shared.concatenation.property_group module
- Module contents
- geoh5py.shared.conversion package
- geoh5py.shared.merging package
- geoh5py.shared.concatenation package
- Submodules
- geoh5py.shared.entity module
EntityEntity.allow_deleteEntity.allow_moveEntity.allow_renameEntity.attribute_mapEntity.clipping_idsEntity.coordinate_reference_systemEntity.create()Entity.default_type_uid()Entity.entity_typeEntity.find_or_create_type()Entity.fix_up_name()Entity.mask_by_extent()Entity.metadataEntity.nameEntity.on_fileEntity.parentEntity.partially_hiddenEntity.publicEntity.uidEntity.update_metadata()Entity.validate_entity_type()Entity.validate_metadata()Entity.visibleEntity.workspace
- geoh5py.shared.entity_container module
EntityContainerEntityContainer.add_children()EntityContainer.add_comment()EntityContainer.add_file()EntityContainer.childrenEntityContainer.commentsEntityContainer.copy()EntityContainer.copy_from_extent()EntityContainer.default_type_uid()EntityContainer.get_entity()EntityContainer.get_entity_list()EntityContainer.remove_children()
- geoh5py.shared.entity_type module
- geoh5py.shared.exceptions module
AggregateValidationErrorAssociationValidationErrorAtLeastOneValidationErrorBaseValidationErrorGeoh5FileClosedErrorInCollectionValidationErrorJSONParameterValidationErrorOptionalValidationErrorPropertyGroupValidationErrorRequiredFormMemberValidationErrorRequiredObjectDataValidationErrorRequiredUIJsonParameterValidationErrorRequiredValidationErrorRequiredWorkspaceObjectValidationErrorShapeValidationErrorTypeUIDValidationErrorTypeValidationErrorUIJsonFormatErrorUUIDValidationErrorValueValidationErroriterable()iterable_message()
- geoh5py.shared.utils module
SetDictare_objects_similar()array_is_colour()as_float_if_isnumeric()as_str_if_utf8_bytes()as_str_if_uuid()bool_value()box_intersect()clear_array_attributes()compare_arrays()compare_bytes()compare_entities()compare_floats()compare_list()copy_dict_relatives()copy_no_reference()decode_byte_array()dict_mapper()dict_to_json_str()dip_azimuth_to_vector()dip_points()ensure_uuid()entity2uuid()extract_uids()fetch_active_workspace()fetch_h5_handle()find_unique_name()format_numeric_values()get_attributes()get_unique_name_from_entities()inf2str()is_uuid()list2str()map_attributes()map_name_attributes()mask_by_extent()match_values()merge_arrays()min_max_scaler()nan2str()none2str()path2str()remove_duplicates_in_list()set_attributes()str2none()str2uuid()str_json_to_dict()stringify()to_list()to_tuple()uuid2entity()uuid_from_values()workspace2path()xy_rotation_matrix()yz_rotation_matrix()
- geoh5py.shared.validators module
AssociationValidatorAtLeastOneValidatorBaseValidatorOptionalValidatorPropertyGroupValidatorRequiredValidatorShapeValidatorTypeValidatorUUIDValidatorValueValidatorclass_or_raise()empty_string_to_none()none_to_empty_string()to_class()to_list()to_path()to_uuid()types_to_string()uuid_to_string()uuid_to_string_or_numeric()
- geoh5py.shared.weakref_utils module
- Module contents
- Subpackages
- geoh5py.ui_json package
- Subpackages
- Submodules
- geoh5py.ui_json.constants module
- geoh5py.ui_json.enforcers module
- geoh5py.ui_json.forms module
AssociationBaseFormBaseForm.dependencyBaseForm.dependency_typeBaseForm.enabledBaseForm.flatten()BaseForm.groupBaseForm.group_dependencyBaseForm.group_dependency_typeBaseForm.group_optionalBaseForm.infer()BaseForm.json_stringBaseForm.labelBaseForm.mainBaseForm.model_configBaseForm.optionalBaseForm.tooltipBaseForm.validate_data()BaseForm.value
BoolFormChoiceFormDataFormDataTypeDependencyTypeFileFormFloatFormGroupFormIntegerFormMultiChoiceFormObjectFormRadioLabelFormStringForm
- geoh5py.ui_json.input_file module
InputFileInputFile.association_validatorInputFile.copy()InputFile.copy_relatives()InputFile.dataInputFile.geoh5InputFile.nameInputFile.numify()InputFile.pathInputFile.path_nameInputFile.promote()InputFile.read_ui_json()InputFile.set_data_value()InputFile.ui_jsonInputFile.ui_validation()InputFile.update_ui_values()InputFile.validateInputFile.validation_optionsInputFile.validationsInputFile.validatorsInputFile.workspaceInputFile.write_ui_json()
- geoh5py.ui_json.parameters module
- geoh5py.ui_json.templates module
- geoh5py.ui_json.ui_json module
BaseUIJsonBaseUIJson.conda_environmentBaseUIJson.geoh5BaseUIJson.groupsBaseUIJson.is_disabled()BaseUIJson.model_configBaseUIJson.model_post_init()BaseUIJson.monitoring_directoryBaseUIJson.read()BaseUIJson.run_commandBaseUIJson.titleBaseUIJson.to_params()BaseUIJson.validate_data()BaseUIJson.versionBaseUIJson.workspace_geoh5BaseUIJson.workspace_path_exists()BaseUIJson.write()
- geoh5py.ui_json.utils module
collect()container_group2name()dependency_requires_value()find_all()flatten()group_enabled()group_optional()group_requires_value()is_form()is_uijson()monitored_directory_copy()optional_requires_value()path2workspace()requires_value()set_enabled()str2inf()str2list()truth()workspace2path()
- geoh5py.ui_json.validation module
- Module contents
- geoh5py.workspace package
- Submodules
- geoh5py.workspace.workspace module
WorkspaceWorkspace.activate()Workspace.active()Workspace.add_or_update_property_group()Workspace.attribute_mapWorkspace.close()Workspace.contributorsWorkspace.copy_property_groups()Workspace.copy_to_parent()Workspace.create()Workspace.create_data()Workspace.create_entity()Workspace.create_from_concatenation()Workspace.create_object_or_group()Workspace.create_root()Workspace.dataWorkspace.deactivate()Workspace.distance_unitWorkspace.fetch_array_attribute()Workspace.fetch_children()Workspace.fetch_concatenated_attributes()Workspace.fetch_concatenated_list()Workspace.fetch_concatenated_values()Workspace.fetch_file_object()Workspace.fetch_metadata()Workspace.fetch_or_create_root()Workspace.fetch_property_groups()Workspace.fetch_type()Workspace.fetch_values()Workspace.finalize()Workspace.find_data()Workspace.find_entity()Workspace.find_group()Workspace.find_object()Workspace.find_property_group()Workspace.find_type()Workspace.ga_versionWorkspace.geoh5Workspace.get_entity()Workspace.groupsWorkspace.h5fileWorkspace.list_data_nameWorkspace.list_entities_nameWorkspace.list_groups_nameWorkspace.list_objects_nameWorkspace.list_property_groups_nameWorkspace.load_entity()Workspace.nameWorkspace.objectsWorkspace.open()Workspace.promote()Workspace.property_groupsWorkspace.register()Workspace.remove_children()Workspace.remove_entity()Workspace.remove_none_referents()Workspace.remove_recursively()Workspace.repackWorkspace.rootWorkspace.save()Workspace.save_as()Workspace.save_entity()Workspace.save_entity_type()Workspace.typesWorkspace.update_attribute()Workspace.validate_data_type()Workspace.versionWorkspace.workspace
active_workspace()get_type_uid_classes()
- Module contents