geost.utils.collection.concat#
- geost.utils.collection.concat(collections: Iterable[Collection], *, join: Literal['inner', 'outer'] = 'outer') Collection[source]#
Concatenate multiple Collection instances into one Collection instance. The header and data tables of the given Collection instances will be concatenated separately and then combined into a new Collection instance.
- Parameters:
collections (Iterable[
Collection]) – Collection instances to concatenate.join ({"inner", "outer"}, optional) – How to handle columns that are not shared between the header and data tables of the given Collection instances. “inner” will keep only the columns that are shared between all tables, while “outer” will keep all columns and fill missing values with NaN. The default is “outer”.
- Returns:
New Collection instance resulting from the concatenation of the given Collection instances.
- Return type:
Note
The names of positional columns (e.g. “nr”, “x”, “y”, “surface”, “depth”) in the header and data tables of the given Collection instances will be set to the positional column names of the first Collection in the iterable. For example, if the first Collection has “nr” as positional column for the survey name, but the second Collection has “id”, the concatenated Collection will have “nr” as positional column for survey name.