curryer.correction.data_structures
==================================

.. py:module:: curryer.correction.data_structures


Classes
-------

.. autoapisummary::

   curryer.correction.data_structures.ImageGrid
   curryer.correction.data_structures.NamedImageGrid
   curryer.correction.data_structures.PSFGrid
   curryer.correction.data_structures.ProjectedPSF
   curryer.correction.data_structures.OpticalPSFEntry
   curryer.correction.data_structures.GeolocationConfig
   curryer.correction.data_structures.SearchConfig


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

.. py:class:: ImageGrid

   Container for image data sampled on a latitude/longitude grid.


   .. py:attribute:: data
      :type:  numpy.ndarray


   .. py:attribute:: lat
      :type:  numpy.ndarray


   .. py:attribute:: lon
      :type:  numpy.ndarray


   .. py:attribute:: h
      :type:  numpy.ndarray | None
      :value: None



   .. py:method:: __post_init__() -> None


   .. py:method:: _validate_shapes() -> None


   .. py:property:: mid_indices
      :type: tuple[int, int]


      Return the row/column indices of the central pixel.


.. py:class:: NamedImageGrid

   Bases: :py:obj:`ImageGrid`


   Image grid with an associated descriptive name.


   .. py:attribute:: name
      :type:  str | None
      :value: None



.. py:class:: PSFGrid

   Point spread function sampled on a latitude/longitude grid.


   .. py:attribute:: data
      :type:  numpy.ndarray


   .. py:attribute:: lat
      :type:  numpy.ndarray


   .. py:attribute:: lon
      :type:  numpy.ndarray


   .. py:method:: __post_init__() -> None


   .. py:method:: _validate_shapes() -> None


.. py:class:: ProjectedPSF

   Bases: :py:obj:`PSFGrid`


   PSF sampled on the Earth's surface, optionally carrying heights.


   .. py:attribute:: height
      :type:  numpy.ndarray | None
      :value: None



   .. py:method:: __post_init__() -> None


.. py:class:: OpticalPSFEntry

   Optical PSF sample defined by cross/along slit angles.


   .. py:attribute:: data
      :type:  numpy.ndarray


   .. py:attribute:: x
      :type:  numpy.ndarray


   .. py:attribute:: field_angle
      :type:  numpy.ndarray


   .. py:method:: __post_init__() -> None


.. py:class:: GeolocationConfig

   Configuration parameters for PSF geolocation modelling.


   .. py:attribute:: gcp_step_m
      :type:  float
      :value: 30.0



   .. py:attribute:: motion_convolution_step_m
      :type:  float
      :value: 1.5



   .. py:attribute:: psf_lat_sample_dist_deg
      :type:  float
      :value: 2.4397105613972e-05



   .. py:attribute:: psf_lon_sample_dist_deg
      :type:  float
      :value: 2.8737038710207e-05



.. py:class:: SearchConfig

   Parameters controlling the image matching search grid.


   .. py:attribute:: grid_size
      :type:  int
      :value: 44



   .. py:attribute:: grid_span_km
      :type:  float
      :value: 11.0



   .. py:attribute:: reduction_factor
      :type:  float
      :value: 0.8



   .. py:attribute:: spacing_limit_m
      :type:  float
      :value: 10.0