ATMI - Atmospheric Impact Simulation
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | List of all members
variable Class Reference

This class represents the generic atmospheric variable. More...

Public Member Functions

 __init__ (self, name, values)
 The constructor for the class.
 
 plot_pdf (self)
 This method plots the variable pdf on a canvas.
 
 sample (self, N)
 This method samples one value for the variable, using his pdf.
 
 termplot_pdf (self)
 This method plots the variable pdf over the terminal.
 

Public Attributes

 name
 The name of the variable.
 
 pdf
 The probability density function calculated using KDE.
 
 values
 The values defining the variable statistics.
 

Detailed Description

This class represents the generic atmospheric variable.

More details.

Constructor & Destructor Documentation

◆ __init__()

__init__ ( self,
name,
values )

The constructor for the class.

Parameters
selfThe object pointer.
nameThe name of the variable.
valuesThe values assumed by the variable.

Member Function Documentation

◆ plot_pdf()

plot_pdf ( self)

This method plots the variable pdf on a canvas.

Parameters
selfThe object pointer.

◆ sample()

sample ( self,
N )

This method samples one value for the variable, using his pdf.

Parameters
selfThe object pointer.
NThe number of desired samplings.

◆ termplot_pdf()

termplot_pdf ( self)

This method plots the variable pdf over the terminal.

Parameters
selfThe object pointer.

Member Data Documentation

◆ name

name

The name of the variable.

◆ pdf

pdf

The probability density function calculated using KDE.

◆ values

values

The values defining the variable statistics.


The documentation for this class was generated from the following file: