sasktran2.mie.distribution.ParticleSizeDistribution

class sasktran2.mie.distribution.ParticleSizeDistribution(identifier: str)

Bases: ABC

Abstract class to define particle size distributions that Mie parameters can be integrated over. This class is a light wrapper on top of scipy.stats.rv_continuous which adds some additional information.

Parameters:

identifier (str) – A unique identifier for the distribution

__init__(identifier: str) → None

Abstract class to define particle size distributions that Mie parameters can be integrated over. This class is a light wrapper on top of scipy.stats.rv_continuous which adds some additional information.

Parameters:

identifier (str) – A unique identifier for the distribution

Methods

__init__(identifier)	Abstract class to define particle size distributions that Mie parameters can be integrated over.
args()	A list of arguments that are required to define this distribution when calling distribution
distribution(**kwargs)	Returns back the scipy object representing this distribution
freeze(**kwargs)	Freeze some of the arguments of this distribution.

Attributes

identifier

Get the unique identifier for this distribution

abstractmethod args()

A list of arguments that are required to define this distribution when calling distribution

abstractmethod distribution(**kwargs) → rv_continuous

Returns back the scipy object representing this distribution

Return type:

rv_continuous

freeze(**kwargs)

Freeze some of the arguments of this distribution. E.g. if y is an argument of this distrubtion, calling freeze(y=5) will return a new distribution that is the same as this one, but with y frozen to 5.

Returns:

A new distribution with some of args frozen

Return type:

ParticleSizeDistribution

property identifier: str

Get the unique identifier for this distribution

Return type:

str