pyepr.fieldsweep_analysis.FieldSweepAnalysis
============================================

.. py:class:: pyepr.fieldsweep_analysis.FieldSweepAnalysis(dataset)

   

   Analysis and calculation of FieldSweep Experiment. 


   :Parameters:

       **dataset** : xarray.Dataarray
           _description_














   ..
       !! processed by numpydoc !!


   .. py:attribute:: data


   .. py:method:: find_max()

      
      Calculates the maximum field





      :Returns:

          float
              Max field











      ..
          !! processed by numpydoc !!


   .. py:method:: calc_gyro(LO = None)

      
      Calculates the gyromagnetic ratio for a given frequency


      :Parameters:

          **det_frq** : float
              The detection frequency for the field sweep.



      :Returns:

          float
              The gyromagnetic ratio in G/GHz.











      ..
          !! processed by numpydoc !!


   .. py:method:: calc_noise_level(SNR_target=30)


   .. py:method:: smooth(*args, **kwargs)

      
      Generates a smoothed version of the data using a 1D smoothing spline.





      :Returns:

          np.ndarray
              The smoothed data.











      ..
          !! processed by numpydoc !!


   .. py:method:: fit(spintype='N', **kwargs)


   .. py:method:: plot(norm = True, axis = 'field', axs=None, fig=None)

      
      Generate a field sweep plot


      :Parameters:

          **norm** : bool, optional
              Nomarlisation of the plot to a maximum of 1, by default True

          **axis** : str, optional
              plot field sweep on either the "field" axis or "freq" axis



      :Returns:

          Matplotlib.Figure
              matplotlib figure











      ..
          !! processed by numpydoc !!