Skip to main content
Ctrl+K
Geological Subsurface Toolbox  documentation - Home Geological Subsurface Toolbox  documentation - Home
  • Home
  • About
  • Getting started
  • Documentation
  • Examples
  • Community
    • Changelog
    • Deltares website
  • GitHub
  • PyPI
  • Home
  • About
  • Getting started
  • Documentation
  • Examples
  • Community
  • Changelog
  • Deltares website
  • GitHub
  • PyPI

Section Navigation

Documentation

  • User guide
    • Data structures
    • Survey data
    • Model data
    • Data validation
    • Reading XML files
    • BRO GeoTOP
  • API Reference
    • Input/Output
      • geost.bro_api_read
      • geost.read_borehole_table
      • geost.read_cpt_table
      • geost.read_nlog_cores
      • geost.read_uullg_tables
      • geost.read_table
      • geost.base.Collection.to_csv
      • geost.base.Collection.to_parquet
      • geost.read_bhrgt
      • geost.read_bhrgt_samples
      • geost.read_bhrg
      • geost.read_bhrp
      • geost.read_cpt
      • geost.read_gef_cpts
      • geost.read_sfr
      • geost.read_xml_boris
      • geost.read_model_netcdf
      • geost.read_model_from_opendap
      • geost.read_geotop_netcdf
      • geost.read_geotop_from_opendap
      • geost.read_regis_netcdf
      • geost.read_regis_from_opendap
      • geost.read_collection_geopackage
      • geost.base.Collection.to_geopackage
      • geost.base.Collection.to_geoparquet
      • geost.base.Collection.to_shape
      • geost.io.Geopackage
      • geost.read_pickle
    • Generic functions
      • geost.concat
      • geost.pandas_dataframe
      • geost.bro.geotop_lithok_units
      • geost.bro.geotop_strat_units
      • geost.bro.regis_units
      • geost.add_positional_columns
      • geost.delete_user_positional_column_aliases
    • Collection
      • geost.base.Collection
      • geost.base.Collection.compute_discretized_fractions
      • geost.base.Collection.get_cumulative_thickness
      • geost.base.Collection.get_layer_base
      • geost.base.Collection.get_layer_top
      • geost.base.Collection.set_crs
      • geost.base.Collection.set_vertical_datum
      • geost.base.Collection.to_crs
      • geost.base.Collection.to_vertical_datum
      • geost.base.Collection.to_csv
      • geost.base.Collection.to_geopackage
      • geost.base.Collection.to_geopackage_3d
      • geost.base.Collection.to_geoparquet
      • geost.base.Collection.to_kingdom
      • geost.base.Collection.to_pickle
      • geost.base.Collection.to_pyvista_cylinders
      • geost.base.Collection.to_pyvista_grid
      • geost.base.Collection.to_parquet
      • geost.base.Collection.to_qgis3d
      • geost.base.Collection.to_shape
      • geost.base.Collection.add_header_column_to_data
      • geost.base.Collection.reset_header
      • geost.base.Collection.synchronize_tables
      • geost.base.Collection.add_model_data
      • geost.base.Collection.aggregate_consecutive_layers
      • geost.base.Collection.get
      • geost.base.Collection.select_by_condition
      • geost.base.Collection.select_by_elevation
      • geost.base.Collection.select_by_length
      • geost.base.Collection.select_by_values
      • geost.base.Collection.slice_by_values
      • geost.base.Collection.slice_depth_interval
      • geost.base.Collection.select_with_lines
      • geost.base.Collection.select_with_points
      • geost.base.Collection.select_within_bbox
      • geost.base.Collection.select_within_polygons
      • geost.base.Collection.find_point_pairs
      • geost.base.Collection.spatial_join
      • geost.base.Collection.crs
      • geost.base.Collection.data
      • geost.base.Collection.has_inclined
      • geost.base.Collection.header
      • geost.base.Collection.n_points
      • geost.base.Collection.vertical_datum
    • GeostFrame
      • geost.accessor.GeostFrame
      • geost.accessor.GeostFrame.calculate_thickness
      • geost.accessor.GeostFrame.get_cumulative_thickness
      • geost.accessor.GeostFrame.get_layer_base
      • geost.accessor.GeostFrame.get_layer_top
      • geost.accessor.GeostFrame.to_crs
      • geost.accessor.GeostFrame.to_vertical_datum
      • geost.accessor.GeostFrame.transform_coordinates
      • geost.accessor.GeostFrame.to_collection
      • geost.accessor.GeostFrame.to_header
      • geost.accessor.GeostFrame.standardize_column_names
      • geost.accessor.GeostFrame.validate
      • geost.accessor.GeostFrame.add_model_data
      • geost.accessor.GeostFrame.aggregate_consecutive_layers
      • geost.accessor.GeostFrame.merge_sorted
      • geost.accessor.GeostFrame.to_kingdom
      • geost.accessor.GeostFrame.to_pyvista_cylinders
      • geost.accessor.GeostFrame.to_pyvista_grid
      • geost.accessor.GeostFrame.to_qgis3d
      • geost.accessor.GeostFrame.select_by_condition
      • geost.accessor.GeostFrame.select_by_elevation
      • geost.accessor.GeostFrame.select_by_length
      • geost.accessor.GeostFrame.select_by_values
      • geost.accessor.GeostFrame.slice_by_values
      • geost.accessor.GeostFrame.slice_depth_interval
      • geost.accessor.GeostFrame.select_with_lines
      • geost.accessor.GeostFrame.select_with_points
      • geost.accessor.GeostFrame.select_within_bbox
      • geost.accessor.GeostFrame.select_within_polygons
      • geost.accessor.GeostFrame.find_point_pairs
      • geost.accessor.GeostFrame.spatial_join
      • geost.accessor.GeostFrame.first_row_survey
      • geost.accessor.GeostFrame.has_depth_columns
      • geost.accessor.GeostFrame.has_geometry
      • geost.accessor.GeostFrame.has_xy_columns
      • geost.accessor.GeostFrame.is_layered
      • geost.accessor.GeostFrame.last_row_survey
      • geost.accessor.GeostFrame.nr
    • ModelDataArray
      • geost.models.model_array.ModelDataArray.get_thickness
      • geost.models.model_array.ModelDataArray.get_top_bottom
      • geost.models.model_array.ModelDataArray.most_common
      • geost.models.model_array.ModelDataArray.value_counts
      • geost.models.model_array.ModelDataArray.unique
      • geost.models.model_array.ModelDataArray.write_crs
      • geost.models.model_array.ModelDataArray.to_collection
      • geost.models.model_array.ModelDataArray.to_geopackage_3d
      • geost.models.model_array.ModelDataArray.to_pyvista_grid
      • geost.models.model_array.ModelDataArray.bounds
      • geost.models.model_array.ModelDataArray.resolution
      • geost.models.model_array.ModelDataArray.vertical_bounds
      • geost.models.model_array.ModelDataArray.slice_depth_interval
      • geost.models.model_array.ModelDataArray.slice_xy
      • geost.models.model_array.ModelDataArray.mask_geometries
      • geost.models.model_array.ModelDataArray.select_points
      • geost.models.model_array.ModelDataArray.select_along_lines
      • geost.models.model_array.ModelDataArray.select_within_bbox
      • geost.models.model_array.ModelDataArray.bottom
      • geost.models.model_array.ModelDataArray.crs
      • geost.models.model_array.ModelDataArray.model_type
      • geost.models.model_array.ModelDataArray.ndims
      • geost.models.model_array.ModelDataArray.shape
      • geost.models.model_array.ModelDataArray.surface_level
      • geost.models.model_array.ModelDataArray.top
      • geost.models.model_array.ModelDataArray.x
      • geost.models.model_array.ModelDataArray.x_dim
      • geost.models.model_array.ModelDataArray.y
      • geost.models.model_array.ModelDataArray.y_dim
      • geost.models.model_array.ModelDataArray.z
      • geost.models.model_array.ModelDataArray.z_dim
    • ModelDataset
      • geost.models.model_dataset.ModelDataset.get_thickness
      • geost.models.model_dataset.ModelDataset.get_top_bottom
      • geost.models.model_dataset.ModelDataset.most_common
      • geost.models.model_dataset.ModelDataset.write_crs
      • geost.models.model_dataset.ModelDataset.to_collection
      • geost.models.model_dataset.ModelDataset.to_geopackage_3d
      • geost.models.model_dataset.ModelDataset.to_pyvista_grid
      • geost.models.model_dataset.ModelDataset.bounds
      • geost.models.model_dataset.ModelDataset.resolution
      • geost.models.model_dataset.ModelDataset.vertical_bounds
      • geost.models.model_dataset.ModelDataset.slice_depth_interval
      • geost.models.model_dataset.ModelDataset.slice_xy
      • geost.models.model_dataset.ModelDataset.mask_geometries
      • geost.models.model_dataset.ModelDataset.select_points
      • geost.models.model_dataset.ModelDataset.select_along_lines
      • geost.models.model_dataset.ModelDataset.select_within_bbox
      • geost.models.model_dataset.ModelDataset.bottom
      • geost.models.model_dataset.ModelDataset.crs
      • geost.models.model_dataset.ModelDataset.model_type
      • geost.models.model_dataset.ModelDataset.ndims
      • geost.models.model_dataset.ModelDataset.shape
      • geost.models.model_dataset.ModelDataset.surface_level
      • geost.models.model_dataset.ModelDataset.top
      • geost.models.model_dataset.ModelDataset.x
      • geost.models.model_dataset.ModelDataset.x_dim
      • geost.models.model_dataset.ModelDataset.y
      • geost.models.model_dataset.ModelDataset.y_dim
      • geost.models.model_dataset.ModelDataset.z
      • geost.models.model_dataset.ModelDataset.z_dim
    • GeotopUnits
      • geost.bro.geotop.GeotopUnits
      • geost.bro.geotop.GeotopUnits.to_qml
      • geost.bro.geotop.GeotopUnits.check_version_matches
      • geost.bro.geotop.GeotopUnits.get_plot_colormap
      • geost.bro.geotop.GeotopUnits.get_antropogenic_units
      • geost.bro.geotop.GeotopUnits.get_holocene_channel_units
      • geost.bro.geotop.GeotopUnits.get_holocene_units
      • geost.bro.geotop.GeotopUnits.select_description_contains
      • geost.bro.geotop.GeotopUnits.select_unit_contains
      • geost.bro.geotop.GeotopUnits.select_unit
      • geost.bro.geotop.GeotopUnits.select_voxel_nr
      • geost.bro.geotop.GeotopUnits.colors_rgb
      • geost.bro.geotop.GeotopUnits.description
      • geost.bro.geotop.GeotopUnits.geotop_version
      • geost.bro.geotop.GeotopUnits.unit
      • geost.bro.geotop.GeotopUnits.voxel_nr
    • RegisUnits
      • geost.bro.regis.RegisUnits
      • geost.bro.regis.RegisUnits.to_qml
      • geost.bro.regis.RegisUnits.check_version_matches
      • geost.bro.regis.RegisUnits.select_unit
      • geost.bro.regis.RegisUnits.select_unit_contains
      • geost.bro.regis.RegisUnits.select_description_contains
      • geost.bro.regis.RegisUnits.colors_rgb
      • geost.bro.regis.RegisUnits.description
      • geost.bro.regis.RegisUnits.regis_version
      • geost.bro.regis.RegisUnits.unit
    • Analysis
      • geost.analysis.layers.get_layer_base
      • geost.analysis.layers.get_layer_top
      • geost.analysis.cpt.calc_ic
      • geost.analysis.cpt.calc_lithology
      • geost.analysis.classification.nen5104_to_lithoclass
      • geost.analysis.grainsize.calculate_bhrgt_grainsize_percentiles
      • geost.analysis.grainsize.calculate_bhrgt_grainsize_fractions
      • geost.analysis.combine.add_model_data
      • geost.analysis.combine.add_nearest_voxelmodel_variable
    • BroApi
      • geost.bro.BroApi
      • geost.bro.BroApi.get_objects
      • geost.bro.BroApi.search_objects_in_bbox
      • geost.bro.BroApi.apis
    • Readers
      • geost.io.Geopackage
      • geost.io.Geopackage.close
      • geost.io.Geopackage.get_column_names
      • geost.io.Geopackage.get_connection
      • geost.io.Geopackage.layers
      • geost.io.Geopackage.query
      • geost.io.Geopackage.read_table
      • geost.io.Geopackage.table_head
      • geost.bro.BroCptGeopackage
      • geost.bro.BroCptGeopackage.from_geopackage
      • geost.bro.BroCptGeopackage.select_location_info
    • Validation
      • geost.validation.validate.ValidationResult.add
      • geost.validation.validate.ValidationResult.handle_errors
      • geost.validation.validate.ValidationResult.display_warnings
      • geost.validation.validate.ValidationResult.has_errors
      • geost.validation.validate.ValidationResult.error_nrs
      • geost.validation.validate.ValidationResult.error_indices
    • Utils
      • geost.utils.spatial.get_raster_values
      • geost.utils.spatial.select_points_near_lines
      • geost.utils.spatial.select_points_near_points
      • geost.utils.spatial.select_points_within_bbox
      • geost.utils.spatial.select_points_within_polygons
      • geost.utils.projections.horizontal_reference_transformer
      • geost.utils.projections.vertical_reference_transformer
      • geost.utils.collection.concat
      • geost.models.model_utils.label_consecutive_2d
      • geost.models.model_utils.sample_with_coords
      • geost.models.model_utils.sample_along_line
  • Documentation
  • API reference
  • BroApi

BroApi#

Constructor#

BroApi([server_url])

Methods#

BroApi.get_objects(bro_ids[, object_type])

Retrieve BRO objects via API requests to the public BRO REST-API.

BroApi.search_objects_in_bbox(xmin, ymin, ...)

Search for BRO objects of the given object type within the given bounding box.

Attributes#

BroApi.apis

previous

geost.analysis.combine.add_nearest_voxelmodel_variable

next

geost.bro.BroApi

On this page
  • Constructor
  • Methods
  • Attributes
Show Source

© Copyright 2026, Deltares.

Created using Sphinx 9.2.0.

Built with the PyData Sphinx Theme 0.23.0.