Reduction
=========

.. currentmodule:: sofia_redux.scan.reduction.reduction

.. autoclass:: Reduction
   :show-inheritance:

   .. rubric:: Attributes Summary

   .. autosummary::

      ~Reduction.configuration
      ~Reduction.info
      ~Reduction.instrument
      ~Reduction.is_sub_reduction
      ~Reduction.name
      ~Reduction.reduction_id
      ~Reduction.rounds
      ~Reduction.size
      ~Reduction.total_reductions

   .. rubric:: Methods Summary

   .. autosummary::

      ~Reduction.add_user_configuration
      ~Reduction.apply_options_to_scans
      ~Reduction.assign_parallel_jobs
      ~Reduction.assign_reduction_files
      ~Reduction.assign_sub_reductions
      ~Reduction.blank_copy
      ~Reduction.edit_header
      ~Reduction.get_total_observing_time
      ~Reduction.init_collective_source_model
      ~Reduction.init_pipelines
      ~Reduction.init_source_model
      ~Reduction.is_valid
      ~Reduction.iterate
      ~Reduction.iterate_pipeline
      ~Reduction.iteration
      ~Reduction.parallel_safe_init_pipelines
      ~Reduction.parallel_safe_read_all_files
      ~Reduction.parallel_safe_read_scan
      ~Reduction.parallel_safe_read_sub_reduction_scans
      ~Reduction.parallel_safe_reduce_sub_reduction
      ~Reduction.parallel_safe_validate_sub_reductions
      ~Reduction.pickle_sub_reductions
      ~Reduction.read_scan
      ~Reduction.read_scans
      ~Reduction.read_sub_reduction_scans
      ~Reduction.reduce
      ~Reduction.reduce_sub_reductions
      ~Reduction.return_scan_from_read_arguments
      ~Reduction.run
      ~Reduction.set_iteration
      ~Reduction.set_object_options
      ~Reduction.set_observing_time_options
      ~Reduction.set_outpath
      ~Reduction.solve_source
      ~Reduction.summarize
      ~Reduction.summarize_integration
      ~Reduction.terminate_reduction
      ~Reduction.unpickle_sub_reductions
      ~Reduction.update_parallel_config
      ~Reduction.update_runtime_config
      ~Reduction.validate
      ~Reduction.validate_scans
      ~Reduction.validate_sub_reductions
      ~Reduction.write_products

   .. rubric:: Attributes Documentation

   .. autoattribute:: configuration
   .. autoattribute:: info
   .. autoattribute:: instrument
   .. autoattribute:: is_sub_reduction
   .. autoattribute:: name
   .. autoattribute:: reduction_id
   .. autoattribute:: rounds
   .. autoattribute:: size
   .. autoattribute:: total_reductions

   .. rubric:: Methods Documentation

   .. automethod:: add_user_configuration
   .. automethod:: apply_options_to_scans
   .. automethod:: assign_parallel_jobs
   .. automethod:: assign_reduction_files
   .. automethod:: assign_sub_reductions
   .. automethod:: blank_copy
   .. automethod:: edit_header
   .. automethod:: get_total_observing_time
   .. automethod:: init_collective_source_model
   .. automethod:: init_pipelines
   .. automethod:: init_source_model
   .. automethod:: is_valid
   .. automethod:: iterate
   .. automethod:: iterate_pipeline
   .. automethod:: iteration
   .. automethod:: parallel_safe_init_pipelines
   .. automethod:: parallel_safe_read_all_files
   .. automethod:: parallel_safe_read_scan
   .. automethod:: parallel_safe_read_sub_reduction_scans
   .. automethod:: parallel_safe_reduce_sub_reduction
   .. automethod:: parallel_safe_validate_sub_reductions
   .. automethod:: pickle_sub_reductions
   .. automethod:: read_scan
   .. automethod:: read_scans
   .. automethod:: read_sub_reduction_scans
   .. automethod:: reduce
   .. automethod:: reduce_sub_reductions
   .. automethod:: return_scan_from_read_arguments
   .. automethod:: run
   .. automethod:: set_iteration
   .. automethod:: set_object_options
   .. automethod:: set_observing_time_options
   .. automethod:: set_outpath
   .. automethod:: solve_source
   .. automethod:: summarize
   .. automethod:: summarize_integration
   .. automethod:: terminate_reduction
   .. automethod:: unpickle_sub_reductions
   .. automethod:: update_parallel_config
   .. automethod:: update_runtime_config
   .. automethod:: validate
   .. automethod:: validate_scans
   .. automethod:: validate_sub_reductions
   .. automethod:: write_products