geost.base.BoreholeCollection.to_datafusiontools#

BoreholeCollection.to_datafusiontools(columns: List[str], outfile: str | Path = None, encode: bool = False, relative_to_vertical_reference: bool = True)#

Export all data to the core “Data” class of Deltares DataFusionTools. Returns a list of “Data” objects, one for each data object that is exported. This list can directly be used within DataFusionTools. If out_file is given, the list of Data objects is saved to a pickle file.

For DataFusionTools visit: https://bitbucket.org/DeltaresGEO/datafusiontools/src/master/

Parameters:

  • columns (List[str]) – Which columns in the data to include for the export. These will become variables in the DataFusionTools “Data” class.

  • outfile (str | Path, optional) – If a path to outfile is given, the data is written to a pickle file.

  • encode (bool, default True) – If True, categorical data columns are encoded to additional binary columns (all possible values become a seperate feature that is 0 or 1). The default is False. Warning: if there is a large number of possible categories, many columns with categorical data or both, the export process may become slow and may consume a large amount memory. Please consider carefully which categorical data columns need to be included.

  • relative_to_vertical_reference (bool, optional) – If True, the depth of all data objects will converted to a depth with respect to a reference plane (e.g. “NAP”, “Ostend height”). If False, the depth will be kept as original in the “top” and “bottom” columns which is in meter below the surface. The default is True.

Returns:

List containing the DataFusionTools Data objects.

Return type:

List[Data]