geost.accessor.GeostFrame.to_collection#

GeostFrame.to_collection(crs: str | int | CRS = None, vertical_datum: str | int | CRS = None, has_inclined: bool = False, coordinate_names: tuple[str, str] = None, include_in_header: str | Iterable[str] | None = None)[source]#

Create a geost.base.Collection from the current GeoDataFrame or DataFrame.

Parameters:

  • crs (str | int | CRS, optional) – Coordinate reference system for the geometry column. The default is None, which means no CRS will be assigned to the resulting GeoDataFrame.

  • vertical_datum (str | int | CRS, optional) – Vertical datum for the collection. The default is None.

  • has_inclined (bool, optional) – Indicates whether the collection has inclined data. The default is False.

  • coordinate_names (tuple[str, str], optional) – Tuple specifying the names of the columns to be used as coordinates for the geometry column. The default is None, which means that it automatically tries to find the names of the x and y columns (see column_names ). If not found, no geometry column will be created.

  • include_in_header (str | Iterable[str] | None, optional) – Columns to aditionally include in the header. The default is None, which means that only the default columns ‘nr’, ‘surface’, ‘x’ and ‘y’ or their aliases are included.

Returns:

A Collection instance created from the current GeoDataFrame or DataFrame.

Return type:

geost.base.Collection