API Reference

DIPPR105Params

Parameters for the DIPPR105 formula

HenyeyGreenStein{T}

Struct for Henyey-Greenstein scattering function.

KopelevichScatteringModel{T, F<:AbstractScatteringFunction}

Struct for Kopelevich scattering model.

PolynomialScatteringFunction{T, P <: ImmutablePolynomial{T}}

Struct for polynomial scattering function.

QuanFryDispersion{T <: Real}

Struct to hold parameters for the Quan & Fry dispersion model.

QuanFryDispersion(a01, a2, a3, a4)

Constructor for QuanFryDispersion with given parameters.

QuanFryDispersion(salinity, temperature, pressure)

Constructor for QuanFryDispersion using salinity, temperature, and pressure.

SimplifiedLiu{T}

Struct for Simplified-Liu scattering function.

TwoComponentScatteringFunction{F1<:AbstractScatteringFunction, F2<:AbstractScatteringFunction}

Struct for two-component mixture scattering model.

WavelengthIndependentAbsorptionModel{T} <: AbstractAbsorptionModel

Struct for wavelength-independent absorption model.

WavelengthIndependentScatteringModel{T, F<:AbstractScatteringFunction} <: AbstractScatteringModel

Struct for wavelength-independent scattering model.

DIPPR105(temperature::Real, params::DIPPR105Params=DDBDIPR105Params)

Use DPPIR105 formula to calculate water density as function of temperature. temperature in K.

Reference: http://ddbonline.ddbst.de/DIPPR105DensityCalculation/DIPPR105CalculationCGI.exe?component=Water

Returns density in kg/m^3

_hg_scattering_func(g::Real)

Henyey-Greenstein scattering in one plane.

Arguments

• g::Real: mean scattering angle

Returns

• typeof(g) cosine of a scattering angle sampled from the distribution

_refractive_index_fry(wavelength, quan_fry_params)

The phase refractive index of sea water according to a model from Quan & Fry.

wavelength is given in nm, salinity in permille, temperature in °C and pressure in atm

The original model is taken from: X. Quan, E.S. Fry, Appl. Opt., 34, 18 (1995) 3477-3480.

An additional term describing pressure dependence was included according to: Wolfgang H.W.A. Schuster, "Measurement of the Optical Properties of the Deep Mediterranean - the ANTARES Detector Medium.", PhD thesis (2002), St. Catherine's College, Oxford downloaded Jan 2011 from: http://www.physics.ox.ac.uk/Users/schuster/thesis0098mmjhuyynh/thesis.ps

Adapted from clsim (https://github.com/claudiok/clsim)

sca_len_part_conc(wavelength; vol_conc_small_part, vol_conc_large_part)

Calculates the scattering length (in m) for a given wavelength based on concentrations of small (vol_conc_small_part) and large (vol_conc_large_part) particles. wavelength is given in nm, volconcsmallpart and volconclargepart in ppm

C.D. Mobley "Light and Water", ISBN 0-12-502750-8, pag. 119.

absorption_length(medium::MediumProperties, wavelength)

Return absorption length at wavelength in units m. wavelength is expected to be in units nm.

calc_quan_fry_params(salinity::Real, temperature::Real, pressure::Real)

Helper function to get the parameters for the Quan & Fry formula as function of salinity, temperature and pressure.

cherenkov_angle(medium, wavelength)

Calculate the cherenkov angle (in rad) for wavelength.

wavelength is expected to be in units nm.

cherenkov_angle(medium, wavelength)

Calculate the cherenkov angle (in rad) for wavelength.

wavelength is expected to be in units nm.

dispersion(disperion_model::AbstractDispersionModel)

Calculate the dispersion for a given dispersion model.

dispersion(medium::MediumProperties, wavelength)

Return the dispersion dn/dλ at wavelength in units 1/nm. wavelength is expected to be in units nm.

dispersion(dispersion_model::QuanFryDispersion, wavelength)

Calculate the dispersion for the Quan & Fry dispersion model.

dispersion_fry(wavelength, a2, a3, a4)

Calculate the dispersion for the Quan & Fry dispersion model.

es_scattering(cos_theta::T, b::T) where {T<:Real}

Einstein-Smoluchowsky Scattering PDF.

es_scattering_integral(cos_theta::T, b::T) where {T<:Real}

Integral of ES scattering function from -1 to cos_theta

es_scattering_integral(cos_theta::T, b::T) where {T<:Real}

Anti-derivative of the ES scattering function.

get_absorption_model(medium::MediumProperties)

Return the absorption model for a given medium.

get_dispersion_model(medium::MediumProperties)

Return the dispersion model for a given medium.

get_scattering_model(medium::MediumProperties)

Return the scattering model for a given medium.

group_refractive_index(medium, wavelength)

Return the group refractive index at wavelength.

wavelength is expected to be in units nm.

group_refractive_index(medium, wavelength)

Return the group refractive index at wavelength.

wavelength is expected to be in units nm.

group_velocity(dispersion_model, wavelength)

Return the group_velocity in m/ns at wavelength.

wavelength is expected to be in units nm.

group_velocity(medium, wavelength)

Return the group_velocity in m/ns at wavelength.

wavelength is expected to be in units nm.

make_inverse_es_polynomial(b::T) where {T<:Real}

Make a 3rd order polynomial that approximates the inverse of the ES scattering function.

material_density(medium::MediumProperties)

This function returns the material density for a given medium.

phase_refractive_index(disperion_model::AbstractDispersionModel)

Calculate the phase refractive index for a given dispersion model.

phase_refractive_index(medium::MediumProperties, wavelength)

Return the phase refractive index at wavelength. wavelength is expected to be in units nm.

phase_refractive_index(disperion_model::QuanFryDispersion, wavelength)

Calculate the phase refractive index for the Quan & Fry dispersion model.

pressure(medium::MediumProperties)

This function returns the pressure for a given medium.

radiation_length(medium::MediumProperties)

This function returns the radiation length for a given medium.

sample_scattering_function(medium::MediumProperties)

Return a cos(scattering angle) sampled from the scattering function of the medium.

scattering_length(model::KopelevichScatteringModel, wavelength::Real)

Calculate the scattering length for the Kopelevich scattering model.

scattering_length(medium::MediumProperties, wavelength)

Return scattering length at wavelength in units m. wavelength is expected to be in units nm. Returned length is in units m.

sl_scattering_func(g::Real)

Simplified-Liu scattering angle function. Implementation from: https://user-web.icecube.wisc.edu/~dima/work/WISC/ppc/spice/new/paper/a.pdf

Arguments

• g::Real: mean scattering angle

temperature(medium::MediumProperties)

This function returns the temperature for a given medium.