.. role:: mat:func
   :class: func
.. role:: func
   :class: func

Matlab supporting functions
===========================

Main calculation functions
--------------------------

.. mat:module:: functions
   :noindex:

:mat:func:`MagFldParent`
++++++++++++++++++++++++

.. mat:autofunction:: MagFldParent

:mat:func:`MpauseFld`
+++++++++++++++++++++

.. mat:autofunction:: MpauseFld

:mat:func:`MagFldParentSingle`
++++++++++++++++++++++++++++++

.. mat:autofunction:: MagFldParentSingle

:mat:func:`LLSdecomposition`
++++++++++++++++++++++++++++

.. mat:autofunction:: LLSdecomposition

:mat:func:`LegendreS`
+++++++++++++++++++++

.. mat:autofunction:: LegendreS

:mat:func:`dLegendreS`
++++++++++++++++++++++

.. mat:autofunction:: dLegendreS


Coordinate transformation functions
-----------------------------------

.. mat:module:: functions.coordinates
   :noindex:

:mat:func:`Bcyl2Bxyz`
+++++++++++++++++++++

.. mat:autofunction:: Bcyl2Bxyz

:mat:func:`Bsph2Bxyz`
+++++++++++++++++++++

.. mat:autofunction:: Bsph2Bxyz

:mat:func:`Bxyz2Bcyl`
+++++++++++++++++++++

.. mat:autofunction:: Bxyz2Bcyl

:mat:func:`Bxyz2Bsph`
+++++++++++++++++++++

.. mat:autofunction:: Bxyz2Bsph

:mat:func:`cyl2xyz`
+++++++++++++++++++

.. mat:autofunction:: cyl2xyz

:mat:func:`KS_BJSMtoBS3C`
+++++++++++++++++++++++++

.. mat:autofunction:: KS_BJSMtoBS3C

:mat:func:`KS_BpJSOtoBxyz`
++++++++++++++++++++++++++

.. mat:autofunction:: KS_BpJSOtoBxyz

:mat:func:`KS_S3CtoJSM`
+++++++++++++++++++++++

.. mat:autofunction:: KS_S3CtoJSM

:mat:func:`KS_S3CtoJSO`
+++++++++++++++++++++++

.. mat:autofunction:: KS_S3CtoJSO

:mat:func:`KS_xyz2pJSO`
+++++++++++++++++++++++

.. mat:autofunction:: KS_xyz2pJSO

:mat:func:`RotateVecSpice`
++++++++++++++++++++++++++

.. mat:autofunction:: RotateVecSpice

:mat:func:`sph2xyz`
+++++++++++++++++++

.. mat:autofunction:: sph2xyz

:mat:func:`xyz2cyl`
+++++++++++++++++++

.. mat:autofunction:: xyz2cyl

:mat:func:`xyz2sph`
+++++++++++++++++++

.. mat:autofunction:: xyz2sph


Khurana and Schwarzl (2005) Jupiter model functions
---------------------------------------------------

.. mat:module:: functions.KS2005functions
   :noindex:

:mat:func:`MagFldJupiterKS2005`
+++++++++++++++++++++++++++++++

.. mat:autofunction:: MagFldJupiterKS2005

:mat:func:`KS_BMPperp`
++++++++++++++++++++++

.. mat:autofunction:: KS_BMPperp

:mat:func:`KS_BtailShield`
++++++++++++++++++++++++++

.. mat:autofunction:: KS_BtailShield

:mat:func:`KS_CheckIfInsideMappedMP`
++++++++++++++++++++++++++++++++++++

.. mat:autofunction:: KS_CheckIfInsideMappedMP

:mat:func:`KS_CheckIfInsideMP`
++++++++++++++++++++++++++++++

.. mat:autofunction:: KS_CheckIfInsideMP

:mat:func:`KS_CsheetN`
++++++++++++++++++++++

.. mat:autofunction:: KS_CsheetN

:mat:func:`KS_CsheetStruc`
++++++++++++++++++++++++++

.. mat:autofunction:: KS_CsheetStruc

:mat:func:`KS_ctime2et`
+++++++++++++++++++++++

.. mat:autofunction:: KS_ctime2et

:mat:func:`KS_ctimer`
+++++++++++++++++++++

.. mat:autofunction:: KS_ctimer

:mat:func:`KS_DipoleFld`
++++++++++++++++++++++++

.. mat:autofunction:: KS_DipoleFld

:mat:func:`KS_DipoleShieldCylS3`
++++++++++++++++++++++++++++++++

.. mat:autofunction:: KS_DipoleShieldCylS3

:mat:func:`KS_DipoleShielded`
+++++++++++++++++++++++++++++

.. mat:autofunction:: KS_DipoleShielded

:mat:func:`KS_etimer`
+++++++++++++++++++++

.. mat:autofunction:: KS_etimer

:mat:func:`KS_GetBIMF`
++++++++++++++++++++++

.. mat:autofunction:: KS_GetBIMF

:mat:func:`KS_GetMappedSunAngle`
++++++++++++++++++++++++++++++++

.. mat:autofunction:: KS_GetMappedSunAngle

:mat:func:`KS_JSun`
+++++++++++++++++++

.. mat:autofunction:: KS_JSun

:mat:func:`KS_TailMagNoTilt`
++++++++++++++++++++++++++++

.. mat:autofunction:: KS_TailMagNoTilt

:mat:func:`KS_TailMagShieldCylS3`
+++++++++++++++++++++++++++++++++

.. mat:autofunction:: KS_TailMagShieldCylS3

:mat:func:`KS_Upot`
+++++++++++++++++++

.. mat:autofunction:: KS_Upot

:mat:func:`KS_VIP4noDipole`
+++++++++++++++++++++++++++

.. mat:autofunction:: KS_VIP4noDipole


Additional supporting functions
-------------------------------

.. mat:module:: functions
   :noindex:

:mat:func:`ExcitationSpectrum`
++++++++++++++++++++++++++++++

.. mat:autofunction:: ExcitationSpectrum

:mat:func:`GetBodyParams`
+++++++++++++++++++++++++

.. mat:autofunction:: GetBodyParams

:mat:func:`GetDespun`
+++++++++++++++++++++

.. mat:autofunction:: GetDespun

:mat:func:`GetExcitations`
++++++++++++++++++++++++++

.. mat:autofunction:: GetExcitations

:mat:func:`GetModelOpts`
++++++++++++++++++++++++

.. mat:autofunction:: GetModelOpts

:mat:func:`GetMinMoonDist`
++++++++++++++++++++++++++

.. mat:autofunction:: GetMinMoonDist

:mat:func:`GetPosSpice`
+++++++++++++++++++++++

.. mat:autofunction:: GetPosSpice

:mat:func:`GetTargetMoonDist`
+++++++++++++++++++++++++++++

.. mat:autofunction:: GetTargetMoonDist

:mat:func:`HodogramSingle`
++++++++++++++++++++++++++

.. mat:autofunction:: HodogramSingle

:mat:func:`LoadSpice`
+++++++++++++++++++++

.. mat:autofunction:: LoadSpice

:mat:func:`LshellTrace`
+++++++++++++++++++++++

.. mat:autofunction:: LshellTrace

:mat:func:`WriteTimeSeries`
+++++++++++++++++++++++++++

.. mat:autofunction:: WriteTimeSeries


Model coefficient functions
---------------------------

.. automodule:: modelCoeffs.printIGRFcoeffs
   :members:
   :undoc-members:

.. mat:module:: modelCoeffs
   :noindex:

:mat:func:`coeffsBode1994G`
+++++++++++++++++++++++++++

.. mat:autofunction:: coeffsBode1994G

:mat:func:`ConvertSwarmCDF`
+++++++++++++++++++++++++++

.. mat:autofunction:: ConvertSwarmCDF

:mat:func:`GetGaussCoeffs`
++++++++++++++++++++++++++

.. mat:autofunction:: GetGaussCoeffs

:mat:func:`KS_coeffsBIMF`
+++++++++++++++++++++++++

.. mat:autofunction:: KS_coeffsBIMF

:mat:func:`KS_coeffsCSdeform`
+++++++++++++++++++++++++++++

.. mat:autofunction:: KS_coeffsCSdeform

:mat:func:`KS_coeffsCsheet`
+++++++++++++++++++++++++++

.. mat:autofunction:: KS_coeffsCsheet

:mat:func:`KS_coeffsCsheetStruc`
++++++++++++++++++++++++++++++++

.. mat:autofunction:: KS_coeffsCsheetStruc

:mat:func:`KS_coeffsJSMdipole`
++++++++++++++++++++++++++++++

.. mat:autofunction:: KS_coeffsJSMdipole

:mat:func:`KS_coeffsJSun`
+++++++++++++++++++++++++

.. mat:autofunction:: KS_coeffsJSun

:mat:func:`KS_coeffsMpause`
+++++++++++++++++++++++++++

.. mat:autofunction:: KS_coeffsMpause

:mat:func:`KS_coeffsMtail`
++++++++++++++++++++++++++

.. mat:autofunction:: KS_coeffsMtail

:mat:func:`KS_coeffsVIP4`
+++++++++++++++++++++++++

.. mat:autofunction:: KS_coeffsVIP4


Magnetopause functions
----------------------

.. mat:module:: functions.magnetopauseModels
   :noindex:

:mat:func:`GetMPsurfAB2005`
+++++++++++++++++++++++++++

.. mat:autofunction:: GetMPsurfAB2005

:mat:func:`GetMPsurfS1997`
++++++++++++++++++++++++++

.. mat:autofunction:: GetMPsurfS1997

:mat:func:`GetMPsurfSM1996`
+++++++++++++++++++++++++++

.. mat:autofunction:: GetMPsurfSM1996

:mat:func:`MPboxHarmonic`
+++++++++++++++++++++++++

.. mat:autofunction:: MPboxHarmonic

:mat:func:`MPsphericalHarmonic`
+++++++++++++++++++++++++++++++

.. mat:autofunction:: MPsphericalHarmonic


Figure plotting functions
-------------------------

.. mat:module:: functions.plotting
   :noindex:

:mat:func:`ApplyPlotDefaults`
+++++++++++++++++++++++++++++

.. mat:autofunction:: ApplyPlotDefaults

:mat:func:`PlotBandLsq`
+++++++++++++++++++++++

.. mat:autofunction:: PlotBandLsq

:mat:func:`PlotBandLsqMoon`
+++++++++++++++++++++++++++

.. mat:autofunction:: PlotBandLsqMoon

:mat:func:`PlotBandLsqNeptune`
++++++++++++++++++++++++++++++

.. mat:autofunction:: PlotBandLsqNeptune

:mat:func:`PlotSpectrum`
++++++++++++++++++++++++

.. mat:autofunction:: PlotSpectrum

:mat:func:`SetPlotDefaults`
+++++++++++++++++++++++++++

.. mat:autofunction:: SetPlotDefaults

:mat:func:`vlines`
++++++++++++++++++

.. mat:autofunction:: vlines