update_map_metadata#

sunkit_image.coalignment.interface.update_map_metadata(target_map, reference_map, affine_params)[source]#

Update the metadata of a sunpy.map.Map` based on affine transformation parameters.

Warning

This function is currently only designed to update the reference coordinate metadata based on the translation component of the affine transformation. Changes to the rotation and scale metadata are not currently supported. If you have a use case that requires changes to the rotation or scale metadata please open an issue on the issue tracker.

Parameters:

  • target_map (sunpy.map.Map) – The original map object whose metadata is to be updated.

  • reference_map (sunpy.map.Map) – The reference map object to which the target map is to be coaligned.

  • affine_params (NamedTuple) – A NamedTuple containing the affine transformation parameters.

Returns:

sunpy.map.Map – A new sunpy map object with updated metadata reflecting the affine transformation.

On this page