pyIntensityFeatures.tests.test_proc_boundaries
==============================================

.. py:module:: pyIntensityFeatures.tests.test_proc_boundaries

.. autoapi-nested-parse::

   Tests for functions in `proc.boundaries`.

   ..
       !! processed by numpydoc !!


Classes
-------

.. autoapisummary::

   pyIntensityFeatures.tests.test_proc_boundaries.TestBoundariesFuncs


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

.. py:class:: TestBoundariesFuncs(methodName='runTest')

   Bases: :py:obj:`unittest.TestCase`


   
   Tests for the boundary ID functions.
















   ..
       !! processed by numpydoc !!

   .. py:method:: setUp()

      
      Set up the test runs.
















      ..
          !! processed by numpydoc !!


   .. py:method:: tearDown()

      
      Tear down the test environment.
















      ..
          !! processed by numpydoc !!


   .. py:method:: get_coeffs_by_peak_and_hemisphere(npeaks, hemisphere)

      
      Obtain temporary copies of the fit coefficients and covariance.


      :Parameters:

          **npeaks** : int
              Number of peaks to be in the covariance matrix (max of 3)

          **hemisphere** : int
              -1 for Southern, 1 for Northern



      :Returns:

          **coeff** : list
              List of adjusted coefficients

          **covar** : array
              Covariance matrix adjusted to the correct size.











      ..
          !! processed by numpydoc !!


   .. py:method:: eval_boundaries(npeaks, hemisphere)

      
      Evaluate the output boundaries.


      :Parameters:

          **npeaks** : int
              Number of peaks to be in the covariance matrix (max of 3)

          **hemisphere** : int
              -1 for Southern, 1 for Northern














      ..
          !! processed by numpydoc !!


   .. py:method:: test_get_eval_boundares_single()

      
      Test outcome specifying a single fit.
















      ..
          !! processed by numpydoc !!


   .. py:method:: test_get_eval_boundares_mult()

      
      Test outcome specifying a multi-peaked fit.
















      ..
          !! processed by numpydoc !!


   .. py:method:: test_get_eval_boundares_best()

      
      Test outcome specifying the best fitting method.
















      ..
          !! processed by numpydoc !!


   .. py:method:: test_get_eval_boundares_bad_correlation()

      
      Test outcome with a bad covariance.
















      ..
          !! processed by numpydoc !!


   .. py:method:: test_get_eval_boundares_bad_background()

      
      Test outcome with a bad background.
















      ..
          !! processed by numpydoc !!


   .. py:method:: test_get_eval_boundares_bad_background_threshold()

      
      Test a bad background outcome by changing the dayglow threshold.
















      ..
          !! processed by numpydoc !!


   .. py:method:: test_get_eval_boundares_strict_fit()

      
      Test outcome with a negative sigma.
















      ..
          !! processed by numpydoc !!


   .. py:method:: test_locate_mult_peak_boundaries()

      
      Test boundary ID for a multi-peaked fit.
















      ..
          !! processed by numpydoc !!


   .. py:method:: test_locate_mult_peak_boundaries_all_bad()

      
      Test boundary ID for a multi-peaked fit.
















      ..
          !! processed by numpydoc !!


   .. py:method:: test_locate_mult_peak_boundaries_max_spread()

      
      Test boundary ID rejection for separated peaks.
















      ..
          !! processed by numpydoc !!


   .. py:method:: test_locate_mult_peak_boundaries_strict_fit()

      
      Test multiple boundary ID with a negative sigma.
















      ..
          !! processed by numpydoc !!


   .. py:method:: test_locate_single_peak_boundaries()

      
      Test boundary ID for a single-peaked fit.
















      ..
          !! processed by numpydoc !!


   .. py:method:: test_locate_single_peak_boundaries_outside_fit_region()

      
      Test boundary ID for a single-peaked fit that fail region test.
















      ..
          !! processed by numpydoc !!


   .. py:method:: test_locate_single_peak_boundaries_strict_fit()

      
      Test single-peak boundary ID with a negative sigma.
















      ..
          !! processed by numpydoc !!


   .. py:method:: test_calc_boundary_uncertainty()

      
      Test the outcome of the uncertainty calculation.
















      ..
          !! processed by numpydoc !!


   .. py:method:: test_locate_boundares_single()

      
      Test general boundary ID specifying a single fit.
















      ..
          !! processed by numpydoc !!


   .. py:method:: test_locate_boundaries_using_mult_peak()

      
      Test general boundary ID specifying a multi-peaked fit.
















      ..
          !! processed by numpydoc !!


   .. py:method:: test_locate_boundaries_mult_peak_outside_fit_region()

      
      Test general multi-peaked boundary ID with bounds outside region.
















      ..
          !! processed by numpydoc !!


   .. py:method:: test_locate_boundaries_with_best()

      
      Test general boundary ID specifying the best fitting method.
















      ..
          !! processed by numpydoc !!


   .. py:method:: test_locate_boundaries_max_spread()

      
      Test general boundary ID rejection for separated peaks.
















      ..
          !! processed by numpydoc !!


   .. py:method:: test_locate_boundares_strict_fit()

      
      Test general boundary ID outcome with a negative sigma.
















      ..
          !! processed by numpydoc !!


   .. py:method:: test_locate_boundares_bad_method()

      
      Test general boundary ID raises ValueError with a bad method.
















      ..
          !! processed by numpydoc !!