sambuca_core.forward_model

class sambuca_core.forward_model.ForwardModelResults(r_substratum, rrs, rrsdp, r_0_minus, rdp_0_minus, kd, kub, kuc, a, a_ph_star, a_cdom_star, a_nap_star, a_ph, a_cdom, a_nap, a_water, bb, bb_ph_star, bb_nap_star, bb_ph, bb_nap, bb_water)

A namedtuple containing the forward model results.

r_substratum

numpy.ndarray – The combined substrate, or substrate1 if the optional second substrate was not provided.

rrs

numpy.ndarray – Modelled remotely-sensed reflectance.

rrsdp

numpy.ndarray – Modelled optically-deep remotely-sensed reflectance.

r_0_minus

numpy.ndarray – Modelled remotely-sensed closed reflectance (R(0-)).

rdp_0_minus

numpy.ndarray – Modelled optically-deep remotely-sensed closed reflectance (Rdp(0-)).

kd

numpy.ndarray – TODO

kub

numpy.ndarray – TODO

kuc

numpy.ndarray – TODO

a

numpy.ndarray – Modelled total absorption (absorption due to water + a_ph + a_cdom + a_nap)

a_ph_star

numpy.ndarray – Specific absorption of phytoplankton. Although this is an input to the Sambuca model, it is included here for ease of access by client code.

a_cdom_star

numpy.ndarray – Modelled specific absorption of coloured dissolved organic particulates (CDOM).

a_nap_star

numpy.ndarray – Modelled specific absorption of non-algal particulates (NAP).

a_ph

numpy.ndarray – Modelled absorption of phytoplankton.

a_cdom

numpy.ndarray – Modelled absorption of CDOM.

a_nap

numpy.ndarray – Modelled absorption of NAP.

a_water

numpy.ndarray – Absorption coefficient of water. Another model input included in the results structure for convenience.

bb

numpy.ndarray – Modelled total backscatter (bb_water + bb_ph + bb_nap).

bb_ph_star

numpy.ndarray – Modelled specific backscatter of phytoplankton.

bb_nap_star

numpy.ndarray – Modelled specific backscatter of NAP.

bb_ph

numpy.ndarray – Modelled backscatter of phytoplankton.

bb_nap

numpy.ndarray – Modelled backscatter of NAP.

bb_water

numpy.ndarray – Modelled backscatter of water.

sambuca_core.forward_model(chl, cdom, nap, depth, substrate1, wavelengths, a_water, a_ph_star, num_bands, substrate_fraction=1, substrate2=None, a_cdom_slope=0.0168052, a_nap_slope=0.00977262, bb_ph_slope=0.878138, bb_nap_slope=None, lambda0cdom=550.0, lambda0nap=550.0, lambda0x=546.0, x_ph_lambda0x=0.00157747, x_nap_lambda0x=0.0225353, a_cdom_lambda0cdom=1.0, a_nap_lambda0nap=0.00433, bb_lambda_ref=550, water_refractive_index=1.33784, theta_air=30.0, off_nadir=0.0, q_factor=3.141592653589793)[source]

Semi-analytical Lee/Sambuca forward model.

TODO: Extended description goes here.

TODO: For those arguments which have units, the units should be stated.

Parameters:
  • chl (float) – Concentration of chlorophyll (algal organic particulates).
  • cdom (float) – Concentration of coloured dissolved organic particulates (CDOM).
  • nap (float) – Concentration of non-algal particulates (NAP).
  • depth (float) – Water column depth.
  • substrate1 (array-like) – A benthic substrate.
  • wavelengths (array-like) – Central wavelengths of the modelled spectral bands.
  • a_water (array-like) – Absorption coefficient of pure water
  • a_ph_star (array-like) – Specific absorption of phytoplankton.
  • num_bands (int) – The number of spectral bands.
  • substrate_fraction (float) – Substrate proportion, used to generate a convex combination of substrate1 and substrate2.
  • substrate2 (array-like, optional) – A benthic substrate.
  • a_cdom_slope (float, optional) – slope of CDOM absorption
  • a_nap_slope (float, optional) – slope of NAP absorption
  • bb_ph_slope (float, optional) – Power law exponent for the phytoplankton backscattering coefficient.
  • bb_nap_slope (float, optional) – Power law exponent for the NAP backscattering coefficient. If no value is supplied, the default behaviour is to use the bb_ph_slope value.
  • lambda0cdom (float, optional) – Reference wavelength for CDOM absorption.
  • lambda0nap (float, optional) – Reference wavelength for NAP absorption.
  • lambda0x (float, optional) – Backscattering reference wavelength.
  • x_ph_lambda0x (float, optional) – Specific backscatter of chlorophyl at lambda0x.
  • x_nap_lambda0x (float, optional) – Specific backscatter of NAP at lambda0x.
  • a_cdom_lambda0cdom (float, optional) – Absorption of CDOM at lambda0cdom.
  • a_nap_lambda0nap (float, optional) – Absorption of NAP at lambda0nap.
  • bb_lambda_ref (float, optional) – Reference wavelength for backscattering coefficient.
  • water_refractive_index (float, optional) – refractive index of water.
  • theta_air (float, optional) – solar zenith angle in degrees.
  • off_nadir (float, optional) – off-nadir angle.
  • q_factor (float, optional) – q value for producing the R(0-) values from modelled remotely-sensed reflectance (rrs) values.
Returns:

A namedtuple containing the model outputs.
Return type:

ForwardModelResults