Skip to content

Commit

Permalink
minor
Browse files Browse the repository at this point in the history
updated some function names in the docs per v. 1.3.1.
  • Loading branch information
bsumlin committed Oct 16, 2017
1 parent 1d8a0f1 commit 43816d4
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions docs/forward.rst
Original file line number Diff line number Diff line change
Expand Up @@ -351,7 +351,7 @@ The bulk asymmetry parameter *G* is calculated by:
Bext, Bsca, Babs, G, Bpr, Bback, Bratio : float
The Mie coefficients calculated by :py:func:`AutoMieQ`, integrated over the size distribution.
q : dict
If asDict==True, :py:func:`MieQ_withSizeDistribution` returns a dict of the above values with appropriate keys.
If asDict==True, :py:func:`MieQ_SD` returns a dict of the above values with appropriate keys.

.. py:Function:: Mie_Lognormal(m, wavelength, geoStdDev, geoMean, numberOfParticles[, numberOfBins=1000, lower=1, upper=1000, gamma=[1], returnDistribution=False, decomposeMultimodal=False, asDict=False])
Expand All @@ -363,7 +363,7 @@ The bulk asymmetry parameter *G* is calculated by:

where :math:`d_{p}` is the diameter of the particle (in nm), :math:`n(d_{p})` is the number of particles of diameter :math:`d_{p}` (per cubic centimeter), :math:`N_\infty` is the total number of particles in the distribution, :math:`\sigma_{g_i}` is the geometric standard deviation of mode :math:`i`, and :math:`d_{pg_i}` is the geometric mean diameter (in nm) of the *i*\ :sup:`th` moment. :math:`\gamma_i` is a porportionality constant that determines the fraction of total particles in the *i*\ :sup:`th` moment.

This function is essentially a wrapper for :py:func:`Mie_withSizeDistribution`. A warning will be raised if the distribution is not compactly-supported on the interval specified by **lower** and **upper**.
This function is essentially a wrapper for :py:func:`Mie_SD`. A warning will be raised if the distribution is not compactly-supported on the interval specified by **lower** and **upper**.


**Parameters**
Expand Down

0 comments on commit 43816d4

Please sign in to comment.