Base class for all analysisTypes. More...

Inheritance diagram for Analyses.AnalysisBase:

[legend]

Public Member Functions
def	__init__ (self, db, analysisType, diagnosticGroupings={})

def	binMethodFile (self, binMethod, before=True)

def	fcName (self, diagnosticGroup)

def	statPlotAttributes (self, diagnosticGroup, statName, allDiagnosticNames=None)

def	UNIONcntrlANDexpCYDTimes (self, dfw, myLoc={})

def	analyze (self, workers=None)

def	analyze_ (self, workers=None)

def	__init__ (self, db, analysisType, diagnosticGroupings={})

def	binMethodFile (self, binMethod, before=True)

def	fcName (self, diagnosticGroup)

def	statPlotAttributes (self, diagnosticGroup, statName, allDiagnosticNames=None)

def	UNIONcntrlANDexpCYDTimes (self, dfw, myLoc={})

def	analyze (self, workers=None)

def	analyze_ (self, workers=None)

Public Attributes
	analysisType

	DiagSpaceName

	diagnosticGroupings

	logger

	db
	Extract useful variables from the database. More...

	diagnosticConfigs

	availableDiagnostics

	expNames

	nExp

	cntrlExpName

	noncntrlExpNames

	fcTDeltas

	fcTDeltas_totmin

	fcMap

	nFC

	cyDTimes

	nCY

	varNames

	nVars

	varMap

	chlist

	allBinVals

	binNumVals

	binNumVals2DasStr

	blocking
	Establish default configuration. More...

	parallelism

	requiredStatistics

	requestAggDFW

	blankBinMethodFile

	subWidth

	subAspect

	MAX_FC_SUBFIGS

	MAX_FC_LINES

	DiagSpacePath
	Setup paths. More...

	myFigPath

Detailed Description

Base class for all analysisTypes.

Definition at line 40 of file Analyses.py.

Constructor & Destructor Documentation

◆ init() [1/2]

def Analyses.AnalysisBase.__init__	(	self,
		db,
		analysisType,
		diagnosticGroupings = `{}`
	)

Definition at line 41 of file Analyses.py.

Here is the caller graph for this function:

◆ init() [2/2]

def Analyses.AnalysisBase.__init__	(	self,
		db,
		analysisType,
		diagnosticGroupings = `{}`
	)

Definition at line 41 of file Analyses.py.

Here is the call graph for this function:

Member Function Documentation

◆ analyze() [1/2]

def Analyses.AnalysisBase.analyze	(	self,
		workers = `None`
	)

Definition at line 214 of file Analyses.py.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ analyze() [2/2]

def Analyses.AnalysisBase.analyze	(	self,
		workers = `None`
	)

Definition at line 214 of file Analyses.py.

Here is the call graph for this function:

◆ analyze_() [1/2]

def Analyses.AnalysisBase.analyze_	(	self,
		workers = `None`
	)

virtual method

Reimplemented in Analyses.GrossValues, Analyses.BinValAxisStatsComposite, Analyses.BinValAxisPDF, Analyses.OneDimBinMethodBase, Analyses.CategoryBinMethodBase, Analyses.GrossValues, Analyses.BinValAxisStatsComposite, Analyses.BinValAxisPDF, Analyses.OneDimBinMethodBase, and Analyses.CategoryBinMethodBase.

Definition at line 226 of file Analyses.py.

Here is the caller graph for this function:

◆ analyze_() [2/2]

def Analyses.AnalysisBase.analyze_	(	self,
		workers = `None`
	)

virtual method

Reimplemented in Analyses.GrossValues, Analyses.BinValAxisStatsComposite, Analyses.BinValAxisPDF, Analyses.OneDimBinMethodBase, Analyses.CategoryBinMethodBase, Analyses.GrossValues, Analyses.BinValAxisStatsComposite, Analyses.BinValAxisPDF, Analyses.OneDimBinMethodBase, and Analyses.CategoryBinMethodBase.

Definition at line 226 of file Analyses.py.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ binMethodFile() [1/2]

def Analyses.AnalysisBase.binMethodFile	(	self,
		binMethod,
		before = `True`
	)

Format the binMethod for file naming

Definition at line 114 of file Analyses.py.

Here is the caller graph for this function:

◆ binMethodFile() [2/2]

def Analyses.AnalysisBase.binMethodFile	(	self,
		binMethod,
		before = `True`
	)

Format the binMethod for file naming

Definition at line 114 of file Analyses.py.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ fcName() [1/2]

def Analyses.AnalysisBase.fcName	(	self,
		diagnosticGroup
	)

Format the diagnosticGroup for forecast analysisType's

Definition at line 127 of file Analyses.py.

Here is the caller graph for this function:

◆ fcName() [2/2]

def Analyses.AnalysisBase.fcName	(	self,
		diagnosticGroup
	)

Format the diagnosticGroup for forecast analysisType's

Definition at line 127 of file Analyses.py.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ statPlotAttributes() [1/2]

def Analyses.AnalysisBase.statPlotAttributes	(	self,
		diagnosticGroup,
		statName,
		allDiagnosticNames = `None`
	)

Define plotting attributes for the combination of diagnosticGroup and statName

Definition at line 141 of file Analyses.py.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ statPlotAttributes() [2/2]

def Analyses.AnalysisBase.statPlotAttributes	(	self,
		diagnosticGroup,
		statName,
		allDiagnosticNames = `None`
	)

Define plotting attributes for the combination of diagnosticGroup and statName

Definition at line 141 of file Analyses.py.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ UNIONcntrlANDexpCYDTimes() [1/2]

def Analyses.AnalysisBase.UNIONcntrlANDexpCYDTimes	(	self,
		dfw,
		myLoc = `{}`
	)

Determine the union of cyDTimes available between
the control and each other experiment at each fcTDelta

Definition at line 192 of file Analyses.py.

Here is the caller graph for this function:

◆ UNIONcntrlANDexpCYDTimes() [2/2]

def Analyses.AnalysisBase.UNIONcntrlANDexpCYDTimes	(	self,
		dfw,
		myLoc = `{}`
	)

Determine the union of cyDTimes available between
the control and each other experiment at each fcTDelta

Definition at line 192 of file Analyses.py.

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ allBinVals

Analyses.AnalysisBase.allBinVals

Definition at line 78 of file Analyses.py.

◆ analysisType

Analyses.AnalysisBase.analysisType

Definition at line 42 of file Analyses.py.

◆ availableDiagnostics

Analyses.AnalysisBase.availableDiagnostics

Definition at line 51 of file Analyses.py.

◆ binNumVals

Analyses.AnalysisBase.binNumVals

Definition at line 79 of file Analyses.py.

◆ binNumVals2DasStr

Analyses.AnalysisBase.binNumVals2DasStr

Definition at line 80 of file Analyses.py.

◆ blankBinMethodFile

Analyses.AnalysisBase.blankBinMethodFile

Definition at line 96 of file Analyses.py.

◆ blocking

Analyses.AnalysisBase.blocking

Establish default configuration.

Definition at line 83 of file Analyses.py.

◆ chlist

Analyses.AnalysisBase.chlist

Definition at line 76 of file Analyses.py.

◆ cntrlExpName

Analyses.AnalysisBase.cntrlExpName

Definition at line 55 of file Analyses.py.

◆ cyDTimes

Analyses.AnalysisBase.cyDTimes

Definition at line 63 of file Analyses.py.

◆ db

Analyses.AnalysisBase.db

Extract useful variables from the database.

Definition at line 49 of file Analyses.py.

◆ diagnosticConfigs

Analyses.AnalysisBase.diagnosticConfigs

Definition at line 50 of file Analyses.py.

◆ diagnosticGroupings

Analyses.AnalysisBase.diagnosticGroupings

Definition at line 44 of file Analyses.py.

◆ DiagSpaceName

Analyses.AnalysisBase.DiagSpaceName

Definition at line 43 of file Analyses.py.

◆ DiagSpacePath

Analyses.AnalysisBase.DiagSpacePath

Setup paths.

Definition at line 108 of file Analyses.py.

◆ expNames

Analyses.AnalysisBase.expNames

Definition at line 53 of file Analyses.py.

◆ fcMap

Analyses.AnalysisBase.fcMap

Definition at line 60 of file Analyses.py.

◆ fcTDeltas

Analyses.AnalysisBase.fcTDeltas

Definition at line 58 of file Analyses.py.

◆ fcTDeltas_totmin

Analyses.AnalysisBase.fcTDeltas_totmin

Definition at line 59 of file Analyses.py.

◆ logger

Analyses.AnalysisBase.logger

Definition at line 46 of file Analyses.py.

◆ MAX_FC_LINES

Analyses.AnalysisBase.MAX_FC_LINES

Definition at line 102 of file Analyses.py.

◆ MAX_FC_SUBFIGS

Analyses.AnalysisBase.MAX_FC_SUBFIGS

Definition at line 101 of file Analyses.py.

◆ myFigPath

Analyses.AnalysisBase.myFigPath

Definition at line 111 of file Analyses.py.

◆ nCY

Analyses.AnalysisBase.nCY

Definition at line 64 of file Analyses.py.

◆ nExp

Analyses.AnalysisBase.nExp

Definition at line 54 of file Analyses.py.

◆ nFC

Analyses.AnalysisBase.nFC

Definition at line 61 of file Analyses.py.

◆ noncntrlExpNames

Analyses.AnalysisBase.noncntrlExpNames

Definition at line 56 of file Analyses.py.

◆ nVars

Analyses.AnalysisBase.nVars

Definition at line 67 of file Analyses.py.

◆ parallelism

Analyses.AnalysisBase.parallelism

Definition at line 84 of file Analyses.py.

◆ requestAggDFW

Analyses.AnalysisBase.requestAggDFW

Definition at line 95 of file Analyses.py.

◆ requiredStatistics

Analyses.AnalysisBase.requiredStatistics

Definition at line 94 of file Analyses.py.

◆ subAspect

Analyses.AnalysisBase.subAspect

Definition at line 99 of file Analyses.py.

◆ subWidth

Analyses.AnalysisBase.subWidth

Definition at line 98 of file Analyses.py.

◆ varMap

Analyses.AnalysisBase.varMap

Definition at line 75 of file Analyses.py.

◆ varNames

Analyses.AnalysisBase.varNames

Definition at line 66 of file Analyses.py.

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

mpas-bundle/mpas-jedi/graphics/Analyses.py

Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __init__() [1/2]

◆ __init__() [2/2]

Member Function Documentation

◆ analyze() [1/2]

◆ analyze() [2/2]

◆ analyze_() [1/2]

◆ analyze_() [2/2]

◆ binMethodFile() [1/2]

◆ binMethodFile() [2/2]

◆ fcName() [1/2]

◆ fcName() [2/2]

◆ statPlotAttributes() [1/2]

◆ statPlotAttributes() [2/2]

◆ UNIONcntrlANDexpCYDTimes() [1/2]

◆ UNIONcntrlANDexpCYDTimes() [2/2]

Member Data Documentation

◆ allBinVals

◆ analysisType

◆ availableDiagnostics

◆ binNumVals

◆ binNumVals2DasStr

◆ blankBinMethodFile

◆ blocking

◆ chlist

◆ cntrlExpName

◆ cyDTimes

◆ db

◆ diagnosticConfigs

◆ diagnosticGroupings

◆ DiagSpaceName

◆ DiagSpacePath

◆ expNames

◆ fcMap

◆ fcTDeltas

◆ fcTDeltas_totmin

◆ logger

◆ MAX_FC_LINES

◆ MAX_FC_SUBFIGS

◆ myFigPath

◆ nCY

◆ nExp

◆ nFC

◆ noncntrlExpNames

◆ nVars

◆ parallelism

◆ requestAggDFW

◆ requiredStatistics

◆ subAspect

◆ subWidth

◆ varMap

◆ varNames

◆ init() [1/2]

◆ init() [2/2]