spatialdata.transformations.get_transformation_between_coordinate_systems

spatialdata.transformations.get_transformation_between_coordinate_systems#

spatialdata.transformations.get_transformation_between_coordinate_systems(sdata, source_coordinate_system, target_coordinate_system, intermediate_coordinate_systems=None, shortest_path=True)#

Get the transformation to map a coordinate system (intrinsic or extrinsic) to another one.

Parameters:
  • source_coordinate_system (Union[DataArray, DataTree, GeoDataFrame, DataFrame, str]) – The source coordinate system. Can be a SpatialElement (intrinsic coordinate system) or a string (extrinsic coordinate system).

  • target_coordinate_system (Union[DataArray, DataTree, GeoDataFrame, DataFrame, str]) – The target coordinate system. Can be a SpatialElement (intrinsic coordinate system) or a string (extrinsic coordinate system).

  • shortest_path (bool (default: True)) – Whether to return the shortest paths when multiple paths are found between the coordinate systems and a single shortest path is found. If False, an error is raised when multiple paths exist. The same error is raised if True, but multiple paths of the same shortest lenghts are found.

Return type:

BaseTransformation

Returns:

: The transformation to map the source coordinate system to the target coordinate system.