Collection

Constructor

Collection([data, header, has_inclined, ...])

A Collection is GeoST's data container for any kind of subsurface data.

Analysis

Collection.get_cumulative_thickness(column, ...)	Get the cumulative thickness of layers where a column contains a specified search value or values.
Collection.get_layer_base(column, values[, ...])	Find the depth at which a specified layer occurs last, starting at min_depth and looking downwards until the first layer of min_thickness is found of the specified layer.
Collection.get_layer_top(column, values[, ...])	Find the depth at which a specified layer first occurs, starting at min_depth and looking downwards until the first layer of min_thickness is found of the specified layer.

Coordinate Reference System

Collection.set_crs(crs[, allow_override])	Set the coordinate reference system (CRS) for the collection's header geometry column.
Collection.set_vertical_datum(vertical_datum)	Set the vertical datum of the collection's surface levels without performing a transformation of the surface levels.
Collection.to_crs(crs[, xbot, ybot])	Change the horizontal reference (i.e. coordinate reference system, crs) of the collection to the given target crs.
Collection.to_vertical_datum(vertical_datum)	Change the vertical reference of the collection object's surface levels

Export

Collection.to_csv(outfile[, data_table])	Export the data or header table to a csv file.
Collection.to_geopackage(outfile[, metadata])	Write header and data to a geopackage.
Collection.to_geoparquet(outfile, **kwargs)	Write header data to geoparquet.
Collection.to_kingdom(outfile[, tdstart, vw, vs])	Write 2 csv files for visualisation of data in Kingdom seismic interpretation software: - interval data: contains the layer boundaries and properties of the layers.
Collection.to_pyvista_cylinders(...[, ...])	Create a Pyvista MultiBlock object of cylinder-shaped geometries to represent boreholes.
Collection.to_pyvista_grid(displayed_variables)	Create a PyVista UnstructuredGrid object of the data in this instance.
Collection.to_parquet(outfile[, data_table])	Export the data or header table to a parquet file.
Collection.to_qgis3d(outfile[, crs])	Write data to geopackage file that can be directly loaded in the Qgis2threejs plugin.
Collection.to_shape(outfile, **kwargs)	Write header data to shapefile.

Generic

Collection.add_header_column_to_data(column_name)	Add a column from the header to the data table.
Collection.check_header_to_data_alignment()	Two-way check to warn of any misalignment between the header and data attributes.
Collection.reset_header()	Refresh the header based on the loaded data in case the header got messed up.

Selection

Collection.get(selection_values[, column])	Select all survey data by selecting a subset of the header table of the Collection instance.
Collection.select_by_condition(condition[, ...])	Do a condition-based selection on the data table of the `Collection: return the rows in the data where the 'condition' evaluates to True, see examples below.
Collection.select_by_elevation([top_min, ...])	Select surveys by elevation constraints: e.g. all surveys with their surface level and end depths between specified minimum and maximum values.
Collection.select_by_length([min_length, ...])	Select data from length constraints: e.g. all surveys between 50 and 150 m long.
Collection.select_by_values(column, values)	Select data based on the presence of values in a given column.
Collection.slice_by_values(column, values[, ...])	Slice rows from data based on matching condition.
Collection.slice_depth_interval([...])	Slice data based on given upper and lower boundaries.

Spatial

Collection.select_with_lines(lines, max_distance)	Select all data that lie within a maximum distance from given line geometries.
Collection.select_with_points(points, ...[, ...])	Select all data that lie within a maximum distance from given point geometries.
Collection.select_within_bbox(xmin, ymin, ...)	Make a selection of the collection based on a bounding box.
Collection.select_within_polygons(polygons)	Select all data that lie within given polygon geometries.
Collection.spatial_join(geometries, label_id)	Join information from another GeoDataFrame by a spatial relationship (e.g. overlap) between the geometries in the header table of the Collection with the geometries in the other GeoDataFrame.

Attributes

Collection.crs	Coordinate reference system represented by an instance of pyproj.crs.CRS.
Collection.data	The collection's data.
Collection.has_inclined	Boolean indicating whether there are inclined objects within the collection
Collection.header	The collection's header.
Collection.n_points	Number of objects in the collection.
Collection.vertical_datum	Vertical datum represented by an instance of pyproj.crs.CRS.