spatialdata.transformations.remove_transformation#
- spatialdata.transformations.remove_transformation(element, to_coordinate_system=None, remove_all=False, write_to_sdata=None)#
Remove a transformation/s from an element, in-memory or from disk.
- Parameters:
element (
DataArray
|DataTree
|GeoDataFrame
|DataFrame
) – The element to remove the transformation/s from.to_coordinate_system (
Optional
[str
] (default:None
)) –The coordinate system to remove the transformation/s from. If None, all transformations are removed.
- If None and
remove_all=False
removes the transformation from the ‘global’ coordinate system (default system).
- If None and
If None and
remove_all=True
removes all transformations.
remove_all (
bool
(default:False
)) – If True, all transformations are removed. If True,to_coordinate_system
needs to be None.write_to_sdata (
Optional
[SpatialData
] (default:None
)) – The SpatialData object to remove the transformation/s from. If None, the transformation/s are removed in-memory. If not None, the element needs to belong to the SpatialData object, and the SpatialData object needs to be backed.
- Return type:
None