sigma0¶
This is the documentation of sigma0.
Contents¶
License¶
The MIT License (MIT)
Copyright (c) 2020 TU Wien
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Contributors¶
- Sebastian Hahn <sebastian.hahn@geo.tuwien.ac.at>
- Raphael Quast <raphael.quast@geo.tuwien.ac.at>
sigma0¶
sigma0 package¶
Submodules¶
sigma0.oh_model module¶
-
sigma0.oh_model.gammah(eps, theta)[source]¶ Incoherent reflectivity for H-pol.
Parameters: - eps (complex number) – Complex dielectric constant.
- theta (float) – Angle in degrees.
Returns: gammah – Incoherent reflectivity for H-pol.
Return type:
-
sigma0.oh_model.gammav(eps, theta)[source]¶ Incoherent reflectivity for V-pol.
Parameters: - eps (complex number) – Complex dielectric constant.
- theta (float) – Angle in degrees.
Returns: gammav – Incoherent reflectivity for V-pol.
Return type:
-
sigma0.oh_model.sigma0_bare(theta, eps_low, f_rms, f, eps_top=1)[source]¶ Oh et.al. (1992) surface backscatter calculations
This functions calculations surface backscatter using the Oh et al. (1992) surface model.
References Oh et al., 1992, An empirical model and an inversion technique for rader scattering from bare soil surfaces. IEEE Trans. Geos. Rem., 30, pp. 370-380
Parameters: - theta (float) – incidence angle in degrees
- eps_low (complex number) – complex permittivity of lower medium
- f (float) – frequency in hertz
- f_rms (float) – fractional rms height. rms_height in meters divided by wavelength
- eps_top (complex number, optional) – complex permittivity of upper(incoming) medium
Returns: sigma0 – Surface backscatter.
Return type:
sigma0.skeleton module¶
This is a skeleton file that can serve as a starting point for a Python console script. To run this script uncomment the following line in the entry_points section in setup.py:
[console_scripts] fibonacci = sigma0.skeleton:run
Then run python setup.py install which will install the command fibonacci inside your current environment. Besides console scripts, the header (i.e. until _logger...) of this file can also be used as template for Python modules.
Note: This skeleton file can be safely removed if not needed!
-
sigma0.skeleton.fib(n)[source]¶ Fibonacci example function
Parameters: n (int) – integer Returns: n-th Fibonacci number Return type: int
-
sigma0.skeleton.main(args)[source]¶ Main entry point allowing external calls
Parameters: args ([str]) – command line parameter list
-
sigma0.skeleton.parse_args(args)[source]¶ Parse command line parameters
Parameters: args ([str]) – command line parameters as list of strings Returns: command line parameters namespace Return type: argparse.Namespace