BoreholeCollection

Constructor

BoreholeCollection(*args, **kwargs)

A collection combines header and borehole data and ensures that they remain aligned when applying methods.

Methods

BoreholeCollection.add_header_column_to_data(...)	Add a column from the header to the data table.
BoreholeCollection.change_horizontal_reference(to_epsg)	Change the horizontal reference (i.e. coordinate reference system, crs) of the collection to the given target crs.
BoreholeCollection.change_vertical_reference(to_epsg)	Change the vertical reference of the collection object's surface levels
BoreholeCollection.check_header_to_data_alignment()	Two-way check to warn of any misalignment between the header and data attributes.
BoreholeCollection.get(selection_values[, ...])	Get a subset of a collection through a string or iterable of object id(s).
BoreholeCollection.get_area_labels(...[, ...])	Find in which area (polygons) the point data locations fall.
BoreholeCollection.get_cumulative_layer_thickness(...)	Get the cumulative thickness of layers where a column contains a specified search value or values.
BoreholeCollection.get_layer_top(column, values)	Find the depth at which a specified layer first occurs.
BoreholeCollection.reset_header()	Refresh the header based on the loaded data in case the header got messed up.
BoreholeCollection.select_by_condition(condition)	Select from collection.data using a manual condition that results in a boolean mask.
BoreholeCollection.select_by_depth([...])	Select data from depth constraints.
BoreholeCollection.select_by_length([...])	Select data from length constraints: e.g. all boreholes between 50 and 150 m long.
BoreholeCollection.select_by_values(column, ...)	Select data based on the presence of given values in a given column.
BoreholeCollection.select_with_lines(lines, ...)	Make a selection of the collection based on line geometries.
BoreholeCollection.select_with_points(...[, ...])	Make a selection of the collection based on point geometries.
BoreholeCollection.select_within_bbox(xmin, ...)	Make a selection of the collection based on a bounding box.
BoreholeCollection.select_within_polygons(...)	Make a selection of the collection based on polygon geometries.
BoreholeCollection.slice_by_values(column, ...)	Slice rows from data based on matching condition.
BoreholeCollection.slice_depth_interval([...])	Slice data based on given upper and lower boundaries.
BoreholeCollection.to_csv(outfile[, data_table])	Export the data or header table to a csv file.
BoreholeCollection.to_datafusiontools(columns)	Export all data to the core "Data" class of Deltares DataFusionTools.
BoreholeCollection.to_geopackage(outfile, ...)	Write header data to geopackage.
BoreholeCollection.to_geoparquet(outfile, ...)	Write header data to geoparquet.
BoreholeCollection.to_kingdom(outfile[, ...])	Write data to 2 csv files: interval data and time-depth chart,
BoreholeCollection.to_multiblock(data_columns)	Create a Pyvista MultiBlock object from the data that can be used for 3D plotting and other spatial analyses.
BoreholeCollection.to_parquet(outfile[, ...])	Export the data or header table to a parquet file.
BoreholeCollection.to_qgis3d(outfile[, ...])	Write data to geopackage file that can be directly loaded in the Qgis2threejs plugin.
BoreholeCollection.to_shape(outfile, **kwargs)	Write header data to shapefile.
BoreholeCollection.to_vtm(outfile, data_columns)	Save data as VTM (Multiblock file, an XML VTK file pointing to multiple other VTK files) for viewing in external GUI software like ParaView or other VTK viewers.

Attributes

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