Frames
======

.. currentmodule:: sofia_redux.scan.frames.frames

.. autoclass:: Frames
   :show-inheritance:

   .. rubric:: Attributes Summary

   .. autosummary::

      ~Frames.astrometry
      ~Frames.channel_fixed_index
      ~Frames.channel_size
      ~Frames.channels
      ~Frames.configuration
      ~Frames.default_channel_fields
      ~Frames.default_field_types
      ~Frames.info
      ~Frames.internal_attributes
      ~Frames.readout_attributes
      ~Frames.referenced_attributes
      ~Frames.scan
      ~Frames.scan_equatorial
      ~Frames.special_fields

   .. rubric:: Methods Summary

   .. autosummary::

      ~Frames.add_data_from
      ~Frames.add_dependents
      ~Frames.correct_factor_dimensions
      ~Frames.equatorial_to_native
      ~Frames.equatorial_to_native_offset
      ~Frames.find_channel_fixed_indices
      ~Frames.get_absolute_native_coordinates
      ~Frames.get_absolute_native_offsets
      ~Frames.get_apparent_equatorial
      ~Frames.get_base_equatorial_native_offset
      ~Frames.get_base_native_offset
      ~Frames.get_equatorial
      ~Frames.get_equatorial_native_offset
      ~Frames.get_equatorial_native_offset_from
      ~Frames.get_first_frame
      ~Frames.get_first_frame_index
      ~Frames.get_first_frame_index_from
      ~Frames.get_first_frame_value
      ~Frames.get_first_frame_value_from
      ~Frames.get_focal_plane_offset
      ~Frames.get_frame_count
      ~Frames.get_last_frame
      ~Frames.get_last_frame_from
      ~Frames.get_last_frame_index
      ~Frames.get_last_frame_value
      ~Frames.get_last_frame_value_from
      ~Frames.get_native_offset
      ~Frames.get_native_offset_from
      ~Frames.get_native_x
      ~Frames.get_native_xy
      ~Frames.get_native_y
      ~Frames.get_rotation
      ~Frames.get_source_gain
      ~Frames.initialize
      ~Frames.insert_blanks
      ~Frames.instance_from_instrument_name
      ~Frames.invert
      ~Frames.jackknife
      ~Frames.native_equatorial_to_native_offset
      ~Frames.native_to_equatorial
      ~Frames.native_to_equatorial_offset
      ~Frames.native_to_native_equatorial_offset
      ~Frames.pointing_at
      ~Frames.project
      ~Frames.remove_dependents
      ~Frames.scale
      ~Frames.set_channels
      ~Frames.set_default_channel_values
      ~Frames.set_frame_size
      ~Frames.set_from_downsampled
      ~Frames.set_rotation
      ~Frames.set_transmission
      ~Frames.shift_frames
      ~Frames.slim
      ~Frames.validate
      ~Frames.validate_channel_indices

   .. rubric:: Attributes Documentation

   .. autoattribute:: astrometry
   .. autoattribute:: channel_fixed_index
   .. autoattribute:: channel_size
   .. autoattribute:: channels
   .. autoattribute:: configuration
   .. autoattribute:: default_channel_fields
   .. autoattribute:: default_field_types
   .. autoattribute:: info
   .. autoattribute:: internal_attributes
   .. autoattribute:: readout_attributes
   .. autoattribute:: referenced_attributes
   .. autoattribute:: scan
   .. autoattribute:: scan_equatorial
   .. autoattribute:: special_fields

   .. rubric:: Methods Documentation

   .. automethod:: add_data_from
   .. automethod:: add_dependents
   .. automethod:: correct_factor_dimensions
   .. automethod:: equatorial_to_native
   .. automethod:: equatorial_to_native_offset
   .. automethod:: find_channel_fixed_indices
   .. automethod:: get_absolute_native_coordinates
   .. automethod:: get_absolute_native_offsets
   .. automethod:: get_apparent_equatorial
   .. automethod:: get_base_equatorial_native_offset
   .. automethod:: get_base_native_offset
   .. automethod:: get_equatorial
   .. automethod:: get_equatorial_native_offset
   .. automethod:: get_equatorial_native_offset_from
   .. automethod:: get_first_frame
   .. automethod:: get_first_frame_index
   .. automethod:: get_first_frame_index_from
   .. automethod:: get_first_frame_value
   .. automethod:: get_first_frame_value_from
   .. automethod:: get_focal_plane_offset
   .. automethod:: get_frame_count
   .. automethod:: get_last_frame
   .. automethod:: get_last_frame_from
   .. automethod:: get_last_frame_index
   .. automethod:: get_last_frame_value
   .. automethod:: get_last_frame_value_from
   .. automethod:: get_native_offset
   .. automethod:: get_native_offset_from
   .. automethod:: get_native_x
   .. automethod:: get_native_xy
   .. automethod:: get_native_y
   .. automethod:: get_rotation
   .. automethod:: get_source_gain
   .. automethod:: initialize
   .. automethod:: insert_blanks
   .. automethod:: instance_from_instrument_name
   .. automethod:: invert
   .. automethod:: jackknife
   .. automethod:: native_equatorial_to_native_offset
   .. automethod:: native_to_equatorial
   .. automethod:: native_to_equatorial_offset
   .. automethod:: native_to_native_equatorial_offset
   .. automethod:: pointing_at
   .. automethod:: project
   .. automethod:: remove_dependents
   .. automethod:: scale
   .. automethod:: set_channels
   .. automethod:: set_default_channel_values
   .. automethod:: set_frame_size
   .. automethod:: set_from_downsampled
   .. automethod:: set_rotation
   .. automethod:: set_transmission
   .. automethod:: shift_frames
   .. automethod:: slim
   .. automethod:: validate
   .. automethod:: validate_channel_indices