SG++-Doxygen-Documentation
Loading...
Searching...
No Matches
Public Member Functions | Protected Attributes | List of all members
python.uq.sampler.asgc.ASGCSamplerSpecification.ASGCSamplerSpecification Class Reference
Inheritance diagram for python.uq.sampler.asgc.ASGCSamplerSpecification.ASGCSamplerSpecification:

Public Member Functions

 __init__ (self)
 
 getKnowledgeTypes (self)
 
 getLearnWithFolding (self)
 
 getLearnWithTest (self)
 
 getParameters (self)
 
 getQoI (self)
 
 getRefinement (self)
 
 getStopPolicy (self)
 
 getTestSet (self)
 
 getTimeStepsOfInterest (self)
 
 setKnowledgeTypes (self, value)
 
 setLearnWithFolding (self, value)
 
 setLearnWithTest (self, value)
 
 setParameters (self, value)
 
 setQoI (self, value)
 
 setRefinement (self, value)
 
 setStopPolicy (self, value)
 
 setTestSet (self, value)
 
 setTimeStepsOfInterest (self, value)
 

Protected Attributes

 _qoi
 
 _refinement
 

Detailed Description

Collection of parameters, which specify the ASGC process.
An object of the class is aggregated by the ASGC object.

Constructor & Destructor Documentation

◆ __init__()

python.uq.sampler.asgc.ASGCSamplerSpecification.ASGCSamplerSpecification.__init__ (   self)

References python.uq.learner.SimulationLearnerSpecification.SimulationLearnerSpecification.__knowledgeTypes, python.uq.manager.ASGCUQManager.ASGCUQManager.__knowledgeTypes, python.uq.sampler.asgc.ASGCSamplerSpecification.ASGCSamplerSpecification.__knowledgeTypes, python.uq.analysis.asgc.anova.hdmrAnalytic.HDMRAnalytic.__params, python.uq.analysis.asgc.ASGCAnalysis.ASGCAnalysis.__params, python.uq.analysis.asgc.ASGCAnalysisSpecification.ASGCAnalysisSpecification.__params, python.uq.analysis.mc.MCAnalysis.MCAnalysis.__params, python.uq.estimators.SparseGridEstimator.SparseGridEstimator.__params, python.uq.learner.SimulationLearnerSpecification.SimulationLearnerSpecification.__params, python.uq.manager.ASGCUQManager.ASGCUQManager.__params, python.uq.parameters.ParameterSet.ParameterSet.__params, python.uq.parameters.ParameterSet.ParameterSetIterator.__params, python.uq.sampler.asgc.ASGCSampler.ASGCSampler.__params, and python.uq.sampler.asgc.ASGCSamplerSpecification.ASGCSamplerSpecification.__params.

Member Function Documentation

◆ getKnowledgeTypes()

python.uq.sampler.asgc.ASGCSamplerSpecification.ASGCSamplerSpecification.getKnowledgeTypes (   self)

References python.uq.learner.SimulationLearnerSpecification.SimulationLearnerSpecification.__knowledgeTypes, python.uq.manager.ASGCUQManager.ASGCUQManager.__knowledgeTypes, and python.uq.sampler.asgc.ASGCSamplerSpecification.ASGCSamplerSpecification.__knowledgeTypes.

Referenced by python.uq.learner.SimulationLearner.SimulationLearner.getLearner(), and python.uq.manager.ASGCUQManager.ASGCUQManager.runNextSamples().

◆ getLearnWithFolding()

python.uq.sampler.asgc.ASGCSamplerSpecification.ASGCSamplerSpecification.getLearnWithFolding (   self)

References python.uq.sampler.asgc.ASGCSamplerSpecification.ASGCSamplerSpecification.__learnWithFolding.

◆ getLearnWithTest()

python.uq.sampler.asgc.ASGCSamplerSpecification.ASGCSamplerSpecification.getLearnWithTest (   self)

References python.uq.sampler.asgc.ASGCSamplerSpecification.ASGCSamplerSpecification.__learnWithTest.

◆ getParameters()

python.uq.sampler.asgc.ASGCSamplerSpecification.ASGCSamplerSpecification.getParameters (   self)

References python.uq.analysis.asgc.anova.hdmrAnalytic.HDMRAnalytic.__params, python.uq.analysis.asgc.ASGCAnalysis.ASGCAnalysis.__params, python.uq.analysis.asgc.ASGCAnalysisSpecification.ASGCAnalysisSpecification.__params, python.uq.analysis.mc.MCAnalysis.MCAnalysis.__params, python.uq.estimators.SparseGridEstimator.SparseGridEstimator.__params, python.uq.learner.SimulationLearnerSpecification.SimulationLearnerSpecification.__params, python.uq.manager.ASGCUQManager.ASGCUQManager.__params, python.uq.parameters.ParameterSet.ParameterSet.__params, python.uq.parameters.ParameterSet.ParameterSetIterator.__params, python.uq.sampler.asgc.ASGCSampler.ASGCSampler.__params, and python.uq.sampler.asgc.ASGCSamplerSpecification.ASGCSamplerSpecification.__params.

Referenced by python.uq.learner.SimulationLearner.SimulationLearner.getLearner().

◆ getQoI()

python.uq.sampler.asgc.ASGCSamplerSpecification.ASGCSamplerSpecification.getQoI (   self)

References python.uq.analysis.Analysis.Analysis._qoi, python.uq.analysis.asgc.ASGCAnalysis.ASGCAnalysis._qoi, python.uq.analysis.asgc.ASGCAnalysisSpecification.ASGCAnalysisSpecification._qoi, python.uq.learner.SimulationLearnerSpecification.SimulationLearnerSpecification._qoi, python.uq.manager.ASGCUQManager.ASGCUQManager._qoi, and python.uq.sampler.asgc.ASGCSamplerSpecification.ASGCSamplerSpecification._qoi.

Referenced by python.uq.learner.SimulationLearner.SimulationLearner.setDataContainer(), and python.uq.learner.SimulationLearner.SimulationLearner.updateResults().

◆ getRefinement()

python.uq.sampler.asgc.ASGCSamplerSpecification.ASGCSamplerSpecification.getRefinement (   self)

References python.uq.analysis.asgc.ASGCAnalysisSpecification.ASGCAnalysisSpecification._refinement, python.uq.learner.SimulationLearnerSpecification.SimulationLearnerSpecification._refinement, python.uq.refinement.RefinementManagerDescriptor.RefinementManagerDescriptor._refinement, python.uq.refinement.RefinementManagerDescriptor.AdmissibleSetDescriptor._refinement, and python.uq.sampler.asgc.ASGCSamplerSpecification.ASGCSamplerSpecification._refinement.

Referenced by python.uq.learner.SimulationLearner.SimulationLearner.refineGrid().

◆ getStopPolicy()

python.uq.sampler.asgc.ASGCSamplerSpecification.ASGCSamplerSpecification.getStopPolicy (   self)

References python.uq.sampler.asgc.ASGCSampler.ASGCSampler.__stopPolicy, and python.uq.sampler.asgc.ASGCSamplerSpecification.ASGCSamplerSpecification.__stopPolicy.

◆ getTestSet()

python.uq.sampler.asgc.ASGCSamplerSpecification.ASGCSamplerSpecification.getTestSet (   self)

References python.uq.sampler.asgc.ASGCSamplerSpecification.ASGCSamplerSpecification.__testSet.

◆ getTimeStepsOfInterest()

python.uq.sampler.asgc.ASGCSamplerSpecification.ASGCSamplerSpecification.getTimeStepsOfInterest (   self)

References python.uq.analysis.asgc.ASGCAnalysisSpecification.ASGCAnalysisSpecification.__timeStepsOfInterest, python.uq.learner.SimulationLearnerSpecification.SimulationLearnerSpecification.__timeStepsOfInterest, python.uq.manager.ASGCUQManager.ASGCUQManager.__timeStepsOfInterest, and python.uq.sampler.asgc.ASGCSamplerSpecification.ASGCSamplerSpecification.__timeStepsOfInterest.

Referenced by python.uq.learner.SimulationLearner.SimulationLearner.refineGrid(), and python.uq.learner.SimulationLearner.SimulationLearner.setDataContainer().

◆ setKnowledgeTypes()

python.uq.sampler.asgc.ASGCSamplerSpecification.ASGCSamplerSpecification.setKnowledgeTypes (   self,
  value 
)

References python.uq.learner.SimulationLearnerSpecification.SimulationLearnerSpecification.__knowledgeTypes, python.uq.manager.ASGCUQManager.ASGCUQManager.__knowledgeTypes, and python.uq.sampler.asgc.ASGCSamplerSpecification.ASGCSamplerSpecification.__knowledgeTypes.

◆ setLearnWithFolding()

python.uq.sampler.asgc.ASGCSamplerSpecification.ASGCSamplerSpecification.setLearnWithFolding (   self,
  value 
)

References python.uq.sampler.asgc.ASGCSamplerSpecification.ASGCSamplerSpecification.__learnWithFolding.

◆ setLearnWithTest()

python.uq.sampler.asgc.ASGCSamplerSpecification.ASGCSamplerSpecification.setLearnWithTest (   self,
  value 
)

References python.uq.sampler.asgc.ASGCSamplerSpecification.ASGCSamplerSpecification.__learnWithTest.

◆ setParameters()

python.uq.sampler.asgc.ASGCSamplerSpecification.ASGCSamplerSpecification.setParameters (   self,
  value 
)

References python.uq.analysis.asgc.anova.hdmrAnalytic.HDMRAnalytic.__params, python.uq.analysis.asgc.ASGCAnalysis.ASGCAnalysis.__params, python.uq.analysis.asgc.ASGCAnalysisSpecification.ASGCAnalysisSpecification.__params, python.uq.analysis.mc.MCAnalysis.MCAnalysis.__params, python.uq.estimators.SparseGridEstimator.SparseGridEstimator.__params, python.uq.learner.SimulationLearnerSpecification.SimulationLearnerSpecification.__params, python.uq.manager.ASGCUQManager.ASGCUQManager.__params, python.uq.parameters.ParameterSet.ParameterSet.__params, python.uq.parameters.ParameterSet.ParameterSetIterator.__params, python.uq.sampler.asgc.ASGCSampler.ASGCSampler.__params, and python.uq.sampler.asgc.ASGCSamplerSpecification.ASGCSamplerSpecification.__params.

◆ setQoI()

python.uq.sampler.asgc.ASGCSamplerSpecification.ASGCSamplerSpecification.setQoI (   self,
  value 
)

References python.uq.analysis.Analysis.Analysis._qoi, python.uq.analysis.asgc.ASGCAnalysis.ASGCAnalysis._qoi, python.uq.analysis.asgc.ASGCAnalysisSpecification.ASGCAnalysisSpecification._qoi, python.uq.learner.SimulationLearnerSpecification.SimulationLearnerSpecification._qoi, python.uq.manager.ASGCUQManager.ASGCUQManager._qoi, and python.uq.sampler.asgc.ASGCSamplerSpecification.ASGCSamplerSpecification._qoi.

◆ setRefinement()

python.uq.sampler.asgc.ASGCSamplerSpecification.ASGCSamplerSpecification.setRefinement (   self,
  value 
)

◆ setStopPolicy()

python.uq.sampler.asgc.ASGCSamplerSpecification.ASGCSamplerSpecification.setStopPolicy (   self,
  value 
)

References python.uq.sampler.asgc.ASGCSampler.ASGCSampler.__stopPolicy, and python.uq.sampler.asgc.ASGCSamplerSpecification.ASGCSamplerSpecification.__stopPolicy.

◆ setTestSet()

python.uq.sampler.asgc.ASGCSamplerSpecification.ASGCSamplerSpecification.setTestSet (   self,
  value 
)

References python.uq.sampler.asgc.ASGCSamplerSpecification.ASGCSamplerSpecification.__testSet.

◆ setTimeStepsOfInterest()

python.uq.sampler.asgc.ASGCSamplerSpecification.ASGCSamplerSpecification.setTimeStepsOfInterest (   self,
  value 
)

References python.uq.analysis.asgc.ASGCAnalysisSpecification.ASGCAnalysisSpecification.__timeStepsOfInterest, python.uq.learner.SimulationLearnerSpecification.SimulationLearnerSpecification.__timeStepsOfInterest, python.uq.manager.ASGCUQManager.ASGCUQManager.__timeStepsOfInterest, and python.uq.sampler.asgc.ASGCSamplerSpecification.ASGCSamplerSpecification.__timeStepsOfInterest.

Member Data Documentation

◆ _qoi

python.uq.sampler.asgc.ASGCSamplerSpecification.ASGCSamplerSpecification._qoi
protected

Referenced by python.uq.analysis.asgc.ASGCAnalysis.ASGCAnalysis.computeMoments(), python.uq.analysis.asgc.ASGCAnalysis.ASGCAnalysis.computeStats(), python.uq.analysis.asgc.ASGCAnalysis.ASGCAnalysis.computeSurplusesLevelWise(), python.uq.analysis.asgc.ASGCAnalysis.ASGCAnalysis.computeVar(), python.uq.analysis.asgc.ASGCAnalysis.ASGCAnalysis.getAnovaDecomposition(), python.uq.analysis.asgc.ASGCAnalysisSpecification.ASGCAnalysisSpecification.getQoI(), python.uq.learner.SimulationLearnerSpecification.SimulationLearnerSpecification.getQoI(), python.uq.manager.ASGCUQManager.ASGCUQManager.getQoI(), python.uq.sampler.asgc.ASGCSamplerSpecification.ASGCSamplerSpecification.getQoI(), python.uq.manager.ASGCUQManager.ASGCUQManager.learnDataWithoutTest(), python.uq.manager.ASGCUQManager.ASGCUQManager.learnDataWithTest(), python.uq.analysis.Analysis.Analysis.mean(), python.uq.manager.ASGCUQManager.ASGCUQManager.recomputeStats(), python.uq.manager.ASGCUQManager.ASGCUQManager.runNextSamples(), python.uq.analysis.asgc.ASGCAnalysis.ASGCAnalysis.sampleGrids(), python.uq.analysis.asgc.ASGCAnalysis.ASGCAnalysis.setEstimationStrategy(), python.uq.analysis.asgc.ASGCAnalysisSpecification.ASGCAnalysisSpecification.setQoI(), python.uq.learner.SimulationLearnerSpecification.SimulationLearnerSpecification.setQoI(), python.uq.manager.ASGCUQManager.ASGCUQManager.setQoI(), python.uq.sampler.asgc.ASGCSamplerSpecification.ASGCSamplerSpecification.setQoI(), python.uq.manager.ASGCUQManager.ASGCUQManager.updateDataContainer(), python.uq.analysis.Analysis.Analysis.var(), python.uq.analysis.asgc.ASGCAnalysis.ASGCAnalysis.writeCheckpoints(), and python.uq.analysis.asgc.ASGCAnalysis.ASGCAnalysis.writeSensitivityValues().

◆ _refinement

python.uq.sampler.asgc.ASGCSamplerSpecification.ASGCSamplerSpecification._refinement
protected

Referenced by python.uq.refinement.RefinementManagerDescriptor.MostPromisingChildrenDescriptor.__init__(), python.uq.refinement.RefinementManagerDescriptor.RefinementManagerDescriptor.addMostPromisingChildren(), python.uq.refinement.RefinementManagerDescriptor.RefinementManagerDescriptor.create(), python.uq.refinement.RefinementManagerDescriptor.RefineCurrentNodesDescriptor.createAllChildrenOnRefinement(), python.uq.analysis.asgc.ASGCAnalysisSpecification.ASGCAnalysisSpecification.getRefinement(), python.uq.learner.SimulationLearnerSpecification.SimulationLearnerSpecification.getRefinement(), python.uq.manager.ASGCUQManager.ASGCUQManager.getRefinement(), python.uq.sampler.asgc.ASGCSamplerSpecification.ASGCSamplerSpecification.getRefinement(), python.uq.refinement.RefinementManagerDescriptor.AdmissibleSetDescriptor.refineInnerNodes(), python.uq.refinement.RefinementManagerDescriptor.RefinementManagerDescriptor.refineMostPromisingNodes(), python.uq.analysis.asgc.ASGCAnalysisSpecification.ASGCAnalysisSpecification.setRefinement(), python.uq.learner.SimulationLearnerSpecification.SimulationLearnerSpecification.setRefinement(), python.uq.refinement.RefinementManagerDescriptor.RefineCurrentNodesDescriptor.useANOVARefinement(), python.uq.refinement.RefinementManagerDescriptor.RefinementManagerDescriptor.withAdaptMaxLevel(), python.uq.refinement.RefinementManagerDescriptor.RefinementManagerDescriptor.withAdaptPoints(), python.uq.refinement.RefinementManagerDescriptor.RefinementManagerDescriptor.withAdaptRate(), python.uq.refinement.RefinementManagerDescriptor.RefinementManagerDescriptor.withAdaptThreshold(), python.uq.refinement.RefinementManagerDescriptor.RefinementManagerDescriptor.withAdaptTimeWindow(), python.uq.refinement.RefinementManagerDescriptor.RefineCurrentNodesDescriptor.withAnchoredExpectationValueOptimizationRanking(), python.uq.refinement.RefinementManagerDescriptor.RefineCurrentNodesDescriptor.withAnchoredMeanSquaredOptRanking(), python.uq.refinement.RefinementManagerDescriptor.RefineCurrentNodesDescriptor.withAnchoredVarianceOptimizationRanking(), python.uq.refinement.RefinementManagerDescriptor.RefineCurrentNodesDescriptor.withAnchoredWeightedL2OptimizationRanking(), python.uq.refinement.RefinementManagerDescriptor.RefinementManagerDescriptor.withAverageWeightening(), python.uq.refinement.RefinementManagerDescriptor.RefinementManagerDescriptor.withBalancing(), python.uq.refinement.RefinementManagerDescriptor.RefineCurrentNodesDescriptor.withExpectationValueOptimizationRanking(), python.uq.refinement.RefinementManagerDescriptor.MostPromisingChildrenDescriptor.withExpectationValueOptimizationRanking(), python.uq.refinement.RefinementManagerDescriptor.RefineCurrentNodesDescriptor.withMeanSquaredOptRanking(), python.uq.refinement.RefinementManagerDescriptor.RefineCurrentNodesDescriptor.withPM1D_MC_Ranking(), python.uq.refinement.RefinementManagerDescriptor.MostPromisingChildrenDescriptor.withPredictiveRanking(), python.uq.refinement.RefinementManagerDescriptor.RefineCurrentNodesDescriptor.withSquaredSurplusRanking(), python.uq.refinement.RefinementManagerDescriptor.MostPromisingChildrenDescriptor.withSquaredSurplusRanking(), python.uq.refinement.RefinementManagerDescriptor.AdmissibleSetDescriptor.withSurplusRanking(), python.uq.refinement.RefinementManagerDescriptor.MostPromisingChildrenDescriptor.withSurplusRatioEstimationRanking(), python.uq.refinement.RefinementManagerDescriptor.AdmissibleSetDescriptor.withSurplusRatioRanking(), python.uq.refinement.RefinementManagerDescriptor.RefineCurrentNodesDescriptor.withVarianceOptimizationRanking(), python.uq.refinement.RefinementManagerDescriptor.MostPromisingChildrenDescriptor.withVarianceOptimizationRanking(), python.uq.refinement.RefinementManagerDescriptor.RefineCurrentNodesDescriptor.withWeightedL2OptimizationRanking(), python.uq.refinement.RefinementManagerDescriptor.MostPromisingChildrenDescriptor.withWeightedL2OptimizationRanking(), python.uq.refinement.RefinementManagerDescriptor.MostPromisingChildrenDescriptor.withWeightedSurplusOptimizationRanking(), and python.uq.refinement.RefinementManagerDescriptor.RefineCurrentNodesDescriptor.withWeightedSurplusRanking().

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