Classes
class	BiasCorrectedObs

class	BiasCorrection

class	BiasCorrectedObsMinusModel

class	RelativeBiasCorrectedObsMinusModel

class	ObsMinusModel

class	RelativeObsMinusModel

class	AnalysisMinusBackground

class	RelativeAnalysisMinusBackground

class	AnalysisMinusBackgroundOverObsMinusBackground

class	STDofHofX

Functions
def	ConsistencyRatioFromDFW (dfw, stateType)

def	diagnosticConfigs (diagnosticNames_, ObsSpaceName, includeEnsembleDiagnostics=True, analysisStatistics=su.allFileStats, fileFormat=vu.hdfFileFormat)

Variables
	_logger = logging.getLogger(__name__)

list	CRStatNames = ['CRd','CRh','CRo']

dictionary	availableDiagnostics
	Table of available diagnostics format of each entry: diagName: { variable: variable name or class used to calculate this diag iter: iteration of "self" type variables ('bg', 'an', int, default: None OR vu.bgIter depending on appName) vu.mean (optional): whether to apply this diagnostic to the mean state (default: True) vu.ensemble (optional): whether this diagnostic requires variables from ensemble IODA files (default: False) onlyObsSpaces (optional): list of ObsSpaces for which this diag applies see config.DiagSpaceConfig keys for available options analyze (optional): whether to analyze this diagnostic (defualt: True). More...

Function Documentation

◆ ConsistencyRatioFromDFW()

def diag_utils.ConsistencyRatioFromDFW	(	dfw,
		stateType
	)

Definition at line 181 of file diag_utils.py.

Here is the caller graph for this function:

◆ diagnosticConfigs()

def diag_utils.diagnosticConfigs	(	diagnosticNames_,
		ObsSpaceName,
		includeEnsembleDiagnostics = `True`,
		analysisStatistics = `su.allFileStats`,
		fileFormat = `vu.hdfFileFormat`
	)

Definition at line 458 of file diag_utils.py.

Here is the caller graph for this function:

Variable Documentation

◆ _logger

diag_utils._logger = logging.getLogger(__name__)

private

Definition at line 13 of file diag_utils.py.

◆ availableDiagnostics

dictionary diag_utils.availableDiagnostics

Table of available diagnostics format of each entry: diagName: { variable: variable name or class used to calculate this diag iter: iteration of "self" type variables ('bg', 'an', int, default: None OR vu.bgIter depending on appName) vu.mean (optional): whether to apply this diagnostic to the mean state (default: True) vu.ensemble (optional): whether this diagnostic requires variables from ensemble IODA files (default: False) onlyObsSpaces (optional): list of ObsSpaces for which this diag applies see config.DiagSpaceConfig keys for available options analyze (optional): whether to analyze this diagnostic (defualt: True).

Useful for turning off analyses for diagnostics that are only needed for calculating other derived diagnostics. derived (optional): whether the diagnostic is derived from statistics of other diagnostics if True, then will be calculated in analysis step, not statistics calculation step (default: False) function (optional): if derived, the python function used to calculate this diagnostic there will be 2 arguments to this function (1) a StatisticsDatabase.DFWrapper object and (2) 'staticArg' below staticArg (optional): a static argument to function (default: None) analysisStatistics (optional): statistics selected for this diagnostic (default: application dependent, see Analyses module) label (optional): label for plot axes (TODO: hookup in Analyses.py) }

Definition at line 275 of file diag_utils.py.

◆ CRStatNames

list diag_utils.CRStatNames = ['CRd','CRh','CRo']

Definition at line 179 of file diag_utils.py.

Classes

Functions