Skip to content

Commit 4240fdf

Browse files
ahms5f-brinkmann
andauthored
Apply suggestions from code review
Co-authored-by: Fabian Brinkmann <[email protected]>
1 parent 56f680f commit 4240fdf

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

imkar/utils.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,16 +6,16 @@
66
def paris_formula(coefficients, incident_directions):
77
r"""
88
Calculate the random-incidence coefficient
9-
according to Paris formula.
9+
according to the Paris formula.
1010
1111
The implementation follows the Equation 2.53 from [#]_ and is
1212
discretized as:
1313
1414
.. math::
1515
c_{rand} = \sum_{\Omega_S} c(\Omega_S) \cdot |\Omega_S \cdot n| \cdot w
1616
17-
with the ``coefficients`` :math:`c`, and the
18-
area weights :math:`w` from the ``incident_directions``.
17+
with the `coefficients` :math:`c`, and the
18+
area weights :math:`w` from the `incident_directions`.
1919
:math:`|\Omega_S \cdot n|` represent the cosine of the angle between the
2020
surface normal and the incident direction.
2121
@@ -31,8 +31,8 @@ def paris_formula(coefficients, incident_directions):
3131
incident_directions : pyfar.Coordinates
3232
Defines the incidence directions of each `coefficients` in a
3333
Coordinates object. Its cshape needs to be (n_incident_directions). In
34-
sperical coordinates the radii needs to be constant. The weights need
35-
to reflect the area weights.
34+
sperical coordinates the radii needs to be constant. The area weights must be
35+
stored in ``ìncedent_directions.weights``.
3636
3737
Returns
3838
-------

0 commit comments

Comments
 (0)