Examples¶
Thirty scripts, each for one kind of reader. Each runs against the
installed package, needs nothing beyond NumPy, and prints what it
computes; closure_with_jerlov_kd.py and shallow_water_closure.py
also read results kept beside them, and so does part 3 of phase_function_choice.py. CI runs every one of them, so an example that has stopped working is
a failed build rather than something a reader discovers. They are in the
repository, not in the installed package; from a clone:
python examples/sources_disagree.py
examples/README.md says what each shows in more detail.
If you |
Start with |
|---|---|
wonder why |
|
have measurements from an instrument, including a backscattering sensor |
|
need synthetic underwater imagery |
|
write an ocean circulation model |
|
study vision, or design a sensor |
|
need the light at depth, below the top 10 m |
|
need a backscatter ratio and have no instrument |
|
work with absorption, or with phytoplankton and CDOM |
|
need the depth of the euphotic zone, or the light phytoplankton get |
|
design an underwater optical link or a lidar |
|
work on seagrass, or on restoring a meadow |
|
study vertical migration, or where animals sit in the light |
|
design or test painted fishing lures or other gear |
|
study ultraviolet exposure under water, of reefs, plankton or chemistry |
|
need the radiance distribution, the mean cosine or scalar irradiance |
|
render or photograph objects under water, from any direction |
|
work with the flicker of light under waves, near the surface |
|
study fish vision, or how water changes colour differences for an animal |
|
have a chlorophyll concentration, or a and bb, rather than a water type; or want a Secchi depth |
|
have used D65 as the light above the sea, or need the sun’s spectrum at the surface |
|
see under water along a slanted line, looking up or down |
|
render water, in film, games or simulation |
|
make images of water in RGB, and wonder what it costs the colours |
|
draw water every frame from a precomputed table, in a game or simulator |
|
choose a phase function for light in water |
|
need reference colours to check a rendering or photograph against |
|
run OSOAA or HydroLight with a Jerlov type as the water |
|
see whether one source of a Jerlov type confirms another |
|
see why a shallow-water reflectance model misses where it does |
|
see where Morel et al.’s f/Q archive dips at a 45-degree sun (needs your copy) |