CptCollection#

Constructor#

CptCollection(*args, **kwargs)

Methods#

`CptCollection.add_header_column_to_data`(...)	Add a column from the header to the data table.
`CptCollection.change_horizontal_reference`(to_epsg)	Change the horizontal reference (i.e. coordinate reference system, crs) of the collection to the given target crs.
`CptCollection.change_vertical_reference`(to_epsg)	Change the vertical reference of the collection object's surface levels
`CptCollection.check_header_to_data_alignment`()	Two-way check to warn of any misalignment between the header and data attributes.
`CptCollection.get`(selection_values[, column])	Get a subset of a collection through a string or iterable of object id(s).
`CptCollection.get_area_labels`(polygon_gdf, ...)	Find in which area (polygons) the point data locations fall.
`CptCollection.get_cumulative_layer_thickness`()
`CptCollection.get_layer_top`()
`CptCollection.reset_header`()	Refresh the header based on the loaded data in case the header got messed up.
`CptCollection.select_by_condition`(condition)	Select from collection.data using a manual condition that results in a boolean mask.
`CptCollection.select_by_depth`([top_min, ...])	Select data from depth constraints.
`CptCollection.select_by_length`([min_length, ...])	Select data from length constraints: e.g. all boreholes between 50 and 150 m long.
`CptCollection.select_by_values`(column, ...)	Select data based on the presence of given values in a given column.
`CptCollection.select_with_lines`(lines, buffer)	Make a selection of the collection based on line geometries.
`CptCollection.select_with_points`(points, buffer)	Make a selection of the collection based on point geometries.
`CptCollection.select_within_bbox`(xmin, ymin, ...)	Make a selection of the collection based on a bounding box.
`CptCollection.select_within_polygons`(polygons)	Make a selection of the collection based on polygon geometries.
`CptCollection.slice_by_values`(column, ...[, ...])	Slice rows from data based on matching condition.
`CptCollection.slice_depth_interval`([...])	Slice data based on given upper and lower boundaries.
`CptCollection.to_csv`(outfile[, data_table])	Export the data or header table to a csv file.
`CptCollection.to_datafusiontools`(columns[, ...])	Export all data to the core "Data" class of Deltares DataFusionTools.
`CptCollection.to_geopackage`(outfile, **kwargs)	Write header data to geopackage.
`CptCollection.to_geoparquet`(outfile, **kwargs)	Write header data to geoparquet.
`CptCollection.to_multiblock`(data_columns[, ...])	Create a Pyvista MultiBlock object from the data that can be used for 3D plotting and other spatial analyses.
`CptCollection.to_parquet`(outfile[, data_table])	Export the data or header table to a parquet file.
`CptCollection.to_shape`(outfile, **kwargs)	Write header data to shapefile.
`CptCollection.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#

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