punchbowl.level1.alignment#

Functions#

align_task() → ndcube.NDCube)

Determine the pointing of the image and updates the metadata appropriately.

Module Contents#

punchbowl.level1.alignment.align_task(data_object: ndcube.NDCube, distortion_path: str | None, mask: collections.abc.Callable | None = None, pointing_shift: tuple[float, float] = (0, 0)) → ndcube.NDCube#

Determine the pointing of the image and updates the metadata appropriately.

Parameters:

  • data_object (NDCube) – data object to align

  • mask (Callable | None) – function accepting coordinates and returning them only if they are not masked out

  • distortion_path (str | None) – path to a distortion model

  • pointing_shift (tuple[float, float]) – offset to pre-apply to the pointing to account for boresight to satellite-x shift

Returns:

a modified version of the input with the WCS more accurately determined

Return type:

NDCube