:py:mod:`kai.instruments`
=========================

.. py:module:: kai.instruments

.. autoapi-nested-parse::

   
   ..
       !! processed by numpydoc !!


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

Classes
~~~~~~~

.. autoapisummary::

   kai.instruments.Instrument
   kai.instruments.NIRC2
   kai.instruments.OSIRIS




Attributes
~~~~~~~~~~

.. autoapisummary::

   kai.instruments.module_dir
   kai.instruments.default_inst


.. py:data:: module_dir
   

   
















   ..
       !! processed by numpydoc !!

.. py:class:: Instrument

   Bases: :py:obj:`object`

   
















   ..
       !! processed by numpydoc !!
   .. py:method:: get_bad_pixel_mask_name(self)

      
















      ..
          !! processed by numpydoc !!

   .. py:method:: get_filter_name(self, hdr)

      
















      ..
          !! processed by numpydoc !!

   .. py:method:: get_plate_scale(self, hdr)

      
















      ..
          !! processed by numpydoc !!

   .. py:method:: get_position_angle(self, hdr)

      
















      ..
          !! processed by numpydoc !!

   .. py:method:: get_parallactic_angle(self, hdr)

      
















      ..
          !! processed by numpydoc !!

   .. py:method:: get_instrument_angle(self, hdr)

      
















      ..
          !! processed by numpydoc !!

   .. py:method:: get_central_wavelength(self, hdr)

      
















      ..
          !! processed by numpydoc !!

   .. py:method:: get_gain(self, hdr)

      
















      ..
          !! processed by numpydoc !!

   .. py:method:: make_filenames(self, files, rootDir='', prefix='n')

      
















      ..
          !! processed by numpydoc !!

   .. py:method:: get_distortion_maps(self, date)

      
















      ..
          !! processed by numpydoc !!

   .. py:method:: get_align_type(self, errors=False)

      
















      ..
          !! processed by numpydoc !!

   .. py:method:: get_saturation_level(self)

      
















      ..
          !! processed by numpydoc !!


.. py:class:: NIRC2

   Bases: :py:obj:`Instrument`

   
















   ..
       !! processed by numpydoc !!
   .. py:method:: get_filter_name(self, hdr)

      
















      ..
          !! processed by numpydoc !!

   .. py:method:: get_plate_scale(self, hdr)

      
      Return the plate scale in arcsec/pixel.
















      ..
          !! processed by numpydoc !!

   .. py:method:: get_position_angle(self, hdr)

      
      Get the sky PA in degrees East of North. 
















      ..
          !! processed by numpydoc !!

   .. py:method:: get_parallactic_angle(self, hdr)

      
      Get the parallactic angle in degrees East of North
















      ..
          !! processed by numpydoc !!

   .. py:method:: get_instrument_angle(self, hdr)

      
















      ..
          !! processed by numpydoc !!

   .. py:method:: get_central_wavelength(self, hdr)

      
      Return the central wavelength of the filter for 
      this observation in microns.
















      ..
          !! processed by numpydoc !!

   .. py:method:: get_gain(self, hdr)

      
















      ..
          !! processed by numpydoc !!

   .. py:method:: make_filenames(self, files, rootDir='', prefix='n')

      
















      ..
          !! processed by numpydoc !!

   .. py:method:: get_distortion_maps(self, hdr)

      

















      ..
          !! processed by numpydoc !!

   .. py:method:: get_align_type(self, hdr, errors=False)

      
















      ..
          !! processed by numpydoc !!

   .. py:method:: get_saturation_level(self)

      
      Set to the 95% saturation threshold in DN.
















      ..
          !! processed by numpydoc !!


.. py:class:: OSIRIS

   Bases: :py:obj:`Instrument`

   
   OSIRIS Imager - after 2019
















   ..
       !! processed by numpydoc !!
   .. py:method:: get_filter_name(self, hdr)

      
















      ..
          !! processed by numpydoc !!

   .. py:method:: get_plate_scale(self, hdr)

      
      Return the plate scale in arcsec/pix.
















      ..
          !! processed by numpydoc !!

   .. py:method:: get_position_angle(self, hdr)

      
      Get the sky PA in degrees East of North. 
















      ..
          !! processed by numpydoc !!

   .. py:method:: get_instrument_angle(self, hdr)

      
      Get the angle of the instrument w.r.t. to the telescope or 
      AO bench in degrees.
















      ..
          !! processed by numpydoc !!

   .. py:method:: get_parallactic_angle(self, hdr)

      
      Get the parallactic angle in degrees East of North
















      ..
          !! processed by numpydoc !!

   .. py:method:: get_central_wavelength(self, hdr)

      
      Return the central wavelength of the filter for 
      this observation in microns.
















      ..
          !! processed by numpydoc !!

   .. py:method:: get_gain(self, hdr)

      
















      ..
          !! processed by numpydoc !!

   .. py:method:: make_filenames(self, files, rootDir='', prefix='')

      
















      ..
          !! processed by numpydoc !!

   .. py:method:: flip_images(self, files, rootDir='')

      
      Flip images (as they come from the detector flipped) and
      subtract reference pixels.
















      ..
          !! processed by numpydoc !!

   .. py:method:: subtract_reference_pixels(self, img)

      
















      ..
          !! processed by numpydoc !!

   .. py:method:: get_distortion_maps(self, hdr)

      
















      ..
          !! processed by numpydoc !!

   .. py:method:: get_align_type(self, hdr, errors=False)

      
















      ..
          !! processed by numpydoc !!

   .. py:method:: get_saturation_level(self)

      
      Set to the 95% saturation threshold in DN.
















      ..
          !! processed by numpydoc !!


.. py:data:: default_inst
   

   
















   ..
       !! processed by numpydoc !!

