OB.DAAC Logo
NASA Logo
Ocean Color Science Software

ocssw V2022
Inheritance diagram for tmatrix:
[legend]
Collaboration diagram for tmatrix:
[legend]

Public Member Functions

def __init__ (self, **kwargs)
 
def generate_tables (self)
 
def mie (self, wl, m, sz, sig, nang)
 
def __getattr__ (self, name)
 
def __setattr__ (self, name, value)
 

Public Attributes

 radii
 
 radius_max
 
 radius_type
 
 wavelength
 
 m
 
 axial_ratio
 
 shape
 
 ddelt
 
 distr
 
 dvpoints
 
 gqpoints
 
 ncoeff
 
 angles
 
 bcoeff
 
 gamma
 
 reff
 
 veff
 
 cext
 
 csca
 
 albedo
 
 asym
 
 f
 

Static Public Attributes

float RADIUS_EQUAL_VOLUME = 1.0
 
float RADIUS_EQUAL_AREA = 0.5
 
float RADIUS_MAXIMUM = 2.0
 
int SHAPE_SPHEROID = -1
 
int SHAPE_CYLINDER = -2
 
int SHAPE_CHEBYSHEV = 1
 
int DISTRIBUTION_MODIFIED_GAMMA = 1
 
int DISTRIBUTION_LOGNORMAL = 2
 
int DISTRIBUTION_POWERLAW = 3
 
int DISTRIBUTION_GAMMA = 4
 
int DISTRIBUTION_MODIFIED_POWERLAW = 5
 

Detailed Description

T-Matrix scattering from nonspherical particles.

Class for simulating scattering from nonspherical particles with the 
T-Matrix method. Uses a wrapper to the Fortran code by M. Mishchenko.

Usage instructions:

First, the class should be be initialized. Any attributes (see below)
can be passed as keyword arguments to the constructor. For example:
sca = tmatrix.tmatrix(wavelength=2.0, m=complex(0,2))

The properties of the scattering and the radiation should then be set 
as attributes of this object. 

Attributes: 
    radius: Equivalent radius.
    radius_type: If radius_type==tmatrix.RADIUS_EQUAL_VOLUME (default),
        radius is the equivalent volume radius.
        If radius_type==tmatrix.RADIUS_MAXIMUM, radius is the maximum 
        radius.
        If radius_type==tmatrix.RADIUS_EQUAL_AREA, 
        radius is the equivalent area radius.
    wavelength: The wavelength of incident light (same units as axi).
    m: The complex refractive index.
    axis_ratio: The horizontal-to-rotational axis ratio.
    shape: Particle shape. 
        tmatrix.SHAPE_SPHEROID: spheroid
        tmatrix.SHAPE_CYLINDER: cylinders; 
        tmatrix.SHAPE_CHEBYSHEV: Chebyshev particles (not yet 
            supported).

Definition at line 11 of file tmatrix.py.

Constructor & Destructor Documentation

◆ __init__()

def __init__ (   self,
**  kwargs 
)

Definition at line 71 of file tmatrix.py.

Member Function Documentation

◆ __getattr__()

def __getattr__ (   self,
  name 
)

Definition at line 133 of file tmatrix.py.

◆ __setattr__()

def __setattr__ (   self,
  name,
  value 
)

Definition at line 138 of file tmatrix.py.

◆ generate_tables()

def generate_tables (   self)
Generate aerosol tables using tmatrix.

Args:

Definition at line 101 of file tmatrix.py.

◆ mie()

def mie (   self,
  wl,
  m,
  sz,
  sig,
  nang 
)
Generate Mie scattering values using lognormal distribution

Definition at line 116 of file tmatrix.py.

Member Data Documentation

◆ albedo

albedo

Definition at line 92 of file tmatrix.py.

◆ angles

angles

Definition at line 84 of file tmatrix.py.

◆ asym

asym

Definition at line 93 of file tmatrix.py.

◆ axial_ratio

axial_ratio

Definition at line 77 of file tmatrix.py.

◆ bcoeff

bcoeff

Definition at line 85 of file tmatrix.py.

◆ cext

cext

Definition at line 90 of file tmatrix.py.

◆ csca

csca

Definition at line 91 of file tmatrix.py.

◆ ddelt

ddelt

Definition at line 79 of file tmatrix.py.

◆ distr

distr

Definition at line 80 of file tmatrix.py.

◆ DISTRIBUTION_GAMMA

int DISTRIBUTION_GAMMA = 4
static

Definition at line 68 of file tmatrix.py.

◆ DISTRIBUTION_LOGNORMAL

int DISTRIBUTION_LOGNORMAL = 2
static

Definition at line 66 of file tmatrix.py.

◆ DISTRIBUTION_MODIFIED_GAMMA

int DISTRIBUTION_MODIFIED_GAMMA = 1
static

Definition at line 65 of file tmatrix.py.

◆ DISTRIBUTION_MODIFIED_POWERLAW

int DISTRIBUTION_MODIFIED_POWERLAW = 5
static

Definition at line 69 of file tmatrix.py.

◆ DISTRIBUTION_POWERLAW

int DISTRIBUTION_POWERLAW = 3
static

Definition at line 67 of file tmatrix.py.

◆ dvpoints

dvpoints

Definition at line 81 of file tmatrix.py.

◆ f

f

Definition at line 94 of file tmatrix.py.

◆ gamma

gamma

Definition at line 86 of file tmatrix.py.

◆ gqpoints

gqpoints

Definition at line 82 of file tmatrix.py.

◆ m

m

Definition at line 76 of file tmatrix.py.

◆ ncoeff

ncoeff

Definition at line 83 of file tmatrix.py.

◆ radii

radii

Definition at line 72 of file tmatrix.py.

◆ RADIUS_EQUAL_AREA

float RADIUS_EQUAL_AREA = 0.5
static

Definition at line 58 of file tmatrix.py.

◆ RADIUS_EQUAL_VOLUME

float RADIUS_EQUAL_VOLUME = 1.0
static

Definition at line 57 of file tmatrix.py.

◆ radius_max

radius_max

Definition at line 73 of file tmatrix.py.

◆ RADIUS_MAXIMUM

float RADIUS_MAXIMUM = 2.0
static

Definition at line 59 of file tmatrix.py.

◆ radius_type

radius_type

Definition at line 74 of file tmatrix.py.

◆ reff

reff

Definition at line 88 of file tmatrix.py.

◆ shape

shape

Definition at line 78 of file tmatrix.py.

◆ SHAPE_CHEBYSHEV

int SHAPE_CHEBYSHEV = 1
static

Definition at line 63 of file tmatrix.py.

◆ SHAPE_CYLINDER

int SHAPE_CYLINDER = -2
static

Definition at line 62 of file tmatrix.py.

◆ SHAPE_SPHEROID

int SHAPE_SPHEROID = -1
static

Definition at line 61 of file tmatrix.py.

◆ veff

veff

Definition at line 89 of file tmatrix.py.

◆ wavelength

wavelength

Definition at line 75 of file tmatrix.py.


The documentation for this class was generated from the following file:
  • /gfs-oceanweb/web/ocssw/ocssw_src/src/tmatrix/python/tmatrix.py