refmod.hapke.functions.h#

Module Contents#

refmod.hapke.functions.h.h_function_1(x, w)#

Calculates the H-function (level 1).

Parameters:

  • x (npt.NDArray) – Input parameter.

  • w (npt.NDArray) – Single scattering albedo.

Returns:

H-function values.

Return type:

npt.NDArray

References

Hapke (1993, p. 121, Eq. 8.31a).

refmod.hapke.functions.h.h_function_2(x, w)#

Calculates the H-function (level 2).

Parameters:

  • x (npt.NDArray) – Input parameter, often mu or mu_0 (cosine of angles).

  • w (npt.NDArray) – Single scattering albedo.

Returns:

H-function values.

Return type:

npt.NDArray

References

Cornette and Shanks (1992)

refmod.hapke.functions.h.h_function_2_derivative(x, w)#

Calculates the derivative of the H-function (level 2) with respect to w.

Parameters:

  • x (npt.NDArray) – Input parameter, often mu or mu_0 (cosine of angles).

  • w (npt.NDArray) – Single scattering albedo.

Returns:

Derivative of the H-function (level 2) with respect to w.

Return type:

npt.NDArray

refmod.hapke.functions.h.h_function(x, w, level=1)#

Calculates the Hapke H-function.

This function can compute two different versions (levels) of the H-function.

Parameters:

  • x (npt.NDArray) – Input parameter, often mu or mu_0 (cosine of angles).

  • w (npt.NDArray) – Single scattering albedo.

  • level (int, optional) – Level of the H-function to calculate (1 or 2), by default 1. Level 1 refers to h_function_1. Level 2 refers to h_function_2.

Returns:

Calculated H-function values.

Return type:

npt.NDArray

Raises:

Exception – If an invalid level (not 1 or 2) is provided.

refmod.hapke.functions.h.h_function_derivative(x, w, level=1)#

Calculates the derivative of the Hapke H-function with respect to w.

This function can compute the derivative for two different versions (levels) of the H-function.

Parameters:

  • x (npt.NDArray) – Input parameter, often mu or mu_0 (cosine of angles).

  • w (npt.NDArray) – Single scattering albedo.

  • level (int, optional) – Level of the H-function derivative to calculate (1 or 2), by default 1. Level 1 derivative is not implemented. Level 2 refers to h_function_2_derivative.

Returns:

Calculated H-function derivative values.

Return type:

npt.NDArray

Raises:

  • NotImplementedError – If level 1 is selected, as its derivative is not implemented.

  • Exception – If an invalid level (not 1 or 2) is provided.