opticam.utils.transforms
========================

.. py:module:: opticam.utils.transforms


Functions
---------

.. autoapisummary::

   opticam.utils.transforms.find_translation


Module Contents
---------------

.. py:function:: find_translation(reference_coords, coords)

   Find the translation that maps `reference_coords` onto `coords`. An advantage of this over
   `astroalign.find_transform()` is that it requires fewer sources, however it is therefore more prone to errors. In
   general, `astroalign.find_transform()` should be used, but `find_translation()` is available if there are too few
   sources for `astroalign.find_transform()`.

   Parameters
   ----------
   reference_coords : NDArray
       The reference source coordinates.
   coords : NDArray
       The source coordinates.

   Returns
   -------
   SimilarityTransform
       The transformation matrix that maps `coords` onto `reference_coords`.