PyCoxMunk
stable

Contents:

  • Quickstart
  • The pycoxmunk API
    • PyCoxMunk Class
    • The CM_Constants module
    • The CM_PixMask Module
    • The CM_SceneGeom Module
    • The CM_Shared_Wind Module
    • The CM_Utils Functions
  • Details of the pycoxmunk algorithm
  • The pycoxmunk testing suite
PyCoxMunk
  • The pycoxmunk API
  • Edit on GitHub

The pycoxmunk API

The main functionality of pycoxmunk is accessible through the PyCoxMunk class, which makes use of several helper classes and functions:

Contents:

  • PyCoxMunk Class
    • Using the PyCoxMunk class
    • The setup_pixmask function
  • The CM_Constants module
    • The WaterData class
    • The constants
  • The CM_PixMask Module
    • The CMPixMask class
    • The cut_high_zen helper function
  • The CM_SceneGeom Module
    • The CMSceneGeom class
    • The cm_calcangles function
  • The CM_Shared_Wind Module
    • The CMSharedWind class
  • The CM_Utils Functions
    • The gauss_leg_quadx function
    • The check_and_reshape function
    • The check_type function
    • The _write_gdal function
    • The _gauss_leg_point function

The individual pages above give more details about each of these.

Previous Next

© Copyright 2023, Simon R Proud. Revision 6d3e1eba.

Built with Sphinx using a theme provided by Read the Docs.