python.uq.uq_setting.UQSetting.UQSetting Class Reference

Inheritance diagram for python.uq.uq_setting.UQSetting.UQSetting:

Public Member Functions
def	__getattr__ (self, attr)
def	__init__ (self)
def	__len__ (self)
def	__str__ (self)
def	changeParamSetting (self, params)
def	cleanUp (self)
def	convert (self, params)
def	createMemento (self)
def	defineSamples (self, params)
def	findEquivalent (self, sample, stats)
def	fromJson (cls, jsonObject)
def	getAvailableQoI (self)
def	getDim (self)
def	getPostprocessorStats (self)
def	getPreprocessorStats (self)
def	getPreprocessorStatsReverse (self)
def	getResult (self, sample, ts=[0], qoi='_')
def	getResults (self, qoi="_", sampleType=UQSampleType.RAW)
def	getSamplesStats (self)
def	getSimulationStats (self)
def	getSize (self, item="postprocessor")
def	getSpecification (self)
def	getTimeDependentResults (self, ts, qoi='_', ps=None, sampleType=UQSampleType.RAW)
def	getTimeSetting (self, q=None)
def	getVerbose (self)
def	hasResult (self, sample)
def	hasTimeSetting (self)
def	loadfile (self, filename)
def	loadResults (self)
def	merge (self, newSetting)
def	mergeStats (self, newSetting)
def	remove (self, sample)
def	run (self, sample, writeToFile=False, args, kws)
def	runPostprocessor (self)
def	runSamples (self, samples, dist=False, args, kws)
def	runSamples_dist (self, samples, starti=0, args, kws)
def	runSamples_withoutDistribution (self, samples, args, kws)
def	runSimulations (self)
def	sanityCheck (self)
def	setLastId (self, lastid)
def	setMemento (self, memento)
def	setPostprocessorStats (self, stats)
def	setPreprocessorStats (self, stats)
def	setPreprocessorStatsReverse (self, stats)
def	setSamplesStats (self, value)
def	setSimulationStats (self, stats)
def	setSpecification (self, specification)
def	setVerbose (self, verbose)
def	split (self, n=500)
def	toDataMatrix (self, ts=[0], qoi='_', dtype=SampleType.ACTIVEUNIT, sampleType=UQSampleType.RAW, args, kws)
def	toJson (self)
def	waitForResults (self)
def	writeToFile (self, filename=None)

Public Attributes
	children
	expectedsamplecount
	files
	lastid
	parallelprocesses

Detailed Description

UQSetting class

Constructor & Destructor Documentation

__init__()

def python.uq.uq_setting.UQSetting.UQSetting.__init__

(

self

)

Constructor

References python.uq.analysis.asgc.ASGCDescriptor.ASGCDescriptor.__specification, python.uq.learner.builder.RegressorSpecificationDescriptor.RegressorSpecificationDescriptor.__specification, python.uq.uq_setting.UQBuilder.UQBuilder.__specification, python.uq.uq_setting.UQSetting.UQSetting.__specification, python.uq.learner.builder.SimulationLearnerBuilder.SimulationLearnerDescriptor.__specification, python.learner.LearnerBuilder.LearnerBuilder.SpecificationDescriptor.__specification, python.uq.uq_setting.UQSetting.UQSetting.__stats_postprocessor, python.uq.uq_setting.UQSetting.UQSetting.__stats_preprocessor, python.uq.uq_setting.UQSetting.UQSetting.__stats_preprocessor_reverse, python.uq.uq_setting.UQSetting.UQSetting.__stats_samples, python.uq.uq_setting.UQSetting.UQSetting.__stats_simulation, python.uq.learner.SimulationLearner.SimulationLearner._verbose, python.uq.analysis.Analysis.Analysis._verbose, python.uq.uq_setting.UQSetting.UQSetting._verbose, and python.uq.analysis.asgc.anova.hdmrAnalytic.HDMRAnalytic._verbose.

Member Function Documentation

__getattr__()

def python.uq.uq_setting.UQSetting.UQSetting.__getattr__	(		self,
			attr
	)

Overrides built-in method if method called is not a object
method of this Descriptor, most probably it's a method of the
specification so it tries to call the method from UQSpecification.
@param attr: String method name

References python.uq.analysis.asgc.ASGCDescriptor.ASGCDescriptor.__specification, python.uq.learner.builder.RegressorSpecificationDescriptor.RegressorSpecificationDescriptor.__specification, python.uq.uq_setting.UQBuilder.UQBuilder.__specification, python.uq.uq_setting.UQSetting.UQSetting.__specification, python.uq.learner.builder.SimulationLearnerBuilder.SimulationLearnerDescriptor.__specification, and python.learner.LearnerBuilder.LearnerBuilder.SpecificationDescriptor.__specification.

__len__()

def python.uq.uq_setting.UQSetting.UQSetting.__len__

(

self

)

@return: number of simulation results

References python.uq.uq_setting.UQSetting.UQSetting.__stats_simulation.

__str__()

def python.uq.uq_setting.UQSetting.UQSetting.__str__

(

self

)

References python.uq.dists.CorrBeta.CorrBeta.toJson(), python.uq.parameters.Parameter.Parameter.toJson(), python.uq.estimators.SparseGridEstimationStrategy.SparseGridEstimationStrategy.toJson(), python.uq.dists.TLognormal.TLognormal.toJson(), python.uq.transformation.RosenblattTransformation.RosenblattTransformation.toJson(), python.uq.transformation.LinearTransformation.LinearTransformation.toJson(), python.uq.dists.Uniform.Uniform.toJson(), python.uq.dists.Beta.Beta.toJson(), python.uq.dists.Corr.Corr.toJson(), python.uq.transformation.JointTransformation.JointTransformation.toJson(), python.uq.dists.MultivariateNormal.MultivariateNormal.toJson(), python.uq.dists.Lognormal.Lognormal.toJson(), python.uq.dists.DataDist.DataDist.toJson(), python.uq.dists.TNormal.TNormal.toJson(), python.uq.dists.Normal.Normal.toJson(), python.uq.dists.KDEDist.KDEDist.toJson(), python.uq.dists.NatafDist.NatafDist.toJson(), python.uq.dists.J.J.toJson(), python.uq.sampler.asgc.ASGCSampler.ASGCSampler.toJson(), python.uq.sampler.Sample.Sample.toJson(), python.uq.analysis.asgc.ASGCKnowledge.ASGCKnowledge.toJson(), python.uq.dists.SGDEdist.SGDEdist.toJson(), python.uq.parameters.ParameterSet.ParameterSet.toJson(), and python.uq.uq_setting.UQSetting.UQSetting.toJson().

changeParamSetting()

def python.uq.uq_setting.UQSetting.UQSetting.changeParamSetting	(		self,
			params
	)

References python.uq.uq_setting.UQSetting.UQSetting.__stats_postprocessor, python.uq.uq_setting.UQSetting.UQSetting.__stats_preprocessor, python.uq.uq_setting.UQSetting.UQSetting.__stats_preprocessor_reverse, python.uq.uq_setting.UQSetting.UQSetting.__stats_samples, and python.uq.uq_setting.UQSetting.UQSetting.__stats_simulation.

cleanUp()

def python.uq.uq_setting.UQSetting.UQSetting.cleanUp

(

self

)

remove all the non-complete entries

References python.uq.uq_setting.UQSetting.UQSetting.__stats_postprocessor, python.uq.uq_setting.UQSetting.UQSetting.__stats_preprocessor, python.uq.uq_setting.UQSetting.UQSetting.__stats_samples, python.uq.uq_setting.UQSetting.UQSetting.__stats_simulation, sgpp::base::DataVector.remove(), sgpp::base::GridDataBase.remove(), and python.uq.uq_setting.UQSetting.UQSetting.remove().

convert()

def python.uq.uq_setting.UQSetting.UQSetting.convert	(		self,
			params
	)

References python.uq.uq_setting.UQSetting.UQSetting.__stats_preprocessor, python.uq.uq_setting.UQSetting.UQSetting.__stats_samples, python.uq.uq_setting.UQSetting.UQSetting.defineSamples(), python.uq.uq_setting.UQSetting.UQSetting.findEquivalent(), python.uq.refinement.AdmissibleSet.AdmissibleSetGenerator.getSize(), python.uq.transformation.Transformation.Transformation.getSize(), python.uq.transformation.RosenblattTransformation.RosenblattTransformation.getSize(), python.uq.transformation.LinearTransformation.LinearTransformation.getSize(), python.uq.transformation.JointTransformation.JointTransformation.getSize(), python.uq.learner.Interpolant.Interpolant.getSize(), python.uq.sampler.asgc.ASGCSampler.ASGCSampler.getSize(), sgpp::base::HashGridStorage.getSize(), sgpp::base::DataVector.getSize(), sgpp::base::DataVectorSP.getSize(), python.data.DataContainer.DataContainer.getSize(), sgpp::base::DataMatrixSP.getSize(), sgpp::base::DataMatrix.getSize(), sgpp::base::Grid.getSize(), and python.uq.uq_setting.UQSetting.UQSetting.getSize().

createMemento()

def python.uq.uq_setting.UQSetting.UQSetting.createMemento

(

self

)

Creates a new memento to hold the current state
@return: new memento

References python.uq.dists.CorrBeta.CorrBeta.toJson(), python.uq.parameters.Parameter.Parameter.toJson(), python.uq.estimators.SparseGridEstimationStrategy.SparseGridEstimationStrategy.toJson(), python.uq.dists.TLognormal.TLognormal.toJson(), python.uq.transformation.RosenblattTransformation.RosenblattTransformation.toJson(), python.uq.transformation.LinearTransformation.LinearTransformation.toJson(), python.uq.dists.Uniform.Uniform.toJson(), python.uq.dists.Beta.Beta.toJson(), python.uq.dists.Corr.Corr.toJson(), python.uq.transformation.JointTransformation.JointTransformation.toJson(), python.uq.dists.MultivariateNormal.MultivariateNormal.toJson(), python.uq.dists.Lognormal.Lognormal.toJson(), python.uq.dists.DataDist.DataDist.toJson(), python.uq.dists.TNormal.TNormal.toJson(), python.uq.dists.Normal.Normal.toJson(), python.uq.dists.KDEDist.KDEDist.toJson(), python.uq.dists.NatafDist.NatafDist.toJson(), python.uq.dists.J.J.toJson(), python.uq.sampler.asgc.ASGCSampler.ASGCSampler.toJson(), python.uq.sampler.Sample.Sample.toJson(), python.uq.analysis.asgc.ASGCKnowledge.ASGCKnowledge.toJson(), python.uq.dists.SGDEdist.SGDEdist.toJson(), python.uq.parameters.ParameterSet.ParameterSet.toJson(), and python.uq.uq_setting.UQSetting.UQSetting.toJson().

Referenced by python.uq.uq_setting.UQSetting.UQSetting.writeToFile().

defineSamples()

def python.uq.uq_setting.UQSetting.UQSetting.defineSamples	(		self,
			params
	)

add samples object to the UQ setting if they are missing

References python.uq.uq_setting.UQSetting.UQSetting.__stats_preprocessor, and python.uq.uq_setting.UQSetting.UQSetting.__stats_samples.

Referenced by python.uq.uq_setting.UQSetting.UQSetting.convert().

findEquivalent()

def python.uq.uq_setting.UQSetting.UQSetting.findEquivalent	(		self,
			sample,
			stats
	)

References python.uq.uq_setting.UQSetting.UQSetting.__stats_postprocessor, python.uq.uq_setting.UQSetting.UQSetting.__stats_preprocessor, python.uq.uq_setting.UQSetting.UQSetting.__stats_preprocessor_reverse, python.uq.uq_setting.UQSetting.UQSetting.__stats_samples, python.uq.uq_setting.UQSetting.UQSetting.__stats_simulation, python.uq.learner.SimulationLearner.SimulationLearner._verbose, python.uq.analysis.Analysis.Analysis._verbose, python.uq.uq_setting.UQSetting.UQSetting._verbose, python.uq.analysis.asgc.anova.hdmrAnalytic.HDMRAnalytic._verbose, python.uq.uq_setting.UQSetting.UQSetting.findEquivalent(), python.uq.uq_setting.UQSpecification.UQSpecification.getEndTime(), python.uq.uq_setting.UQSpecification.UQSpecification.getPostprocessor(), python.uq.uq_setting.UQSpecification.UQSpecification.getPreprocessor(), python.uq.uq_setting.UQSpecification.UQSpecification.getSimulation(), python.uq.uq_setting.UQSpecification.UQSpecification.getStartTime(), python.uq.uq_setting.UQSpecification.UQSpecification.getTimeStep(), and create_dataset.type.

Referenced by python.uq.uq_setting.UQSetting.UQSetting.convert(), and python.uq.uq_setting.UQSetting.UQSetting.findEquivalent().

fromJson()

def python.uq.uq_setting.UQSetting.UQSetting.fromJson	(		cls,
			jsonObject
	)

Restores the UQSetting object from the json object with its
attributes.
@param jsonObject: dictionary represeting a json object
@return: the restored UQSetting object

Referenced by python.uq.uq_setting.UQSetting.UQSetting.setMemento().

getAvailableQoI()

def python.uq.uq_setting.UQSetting.UQSetting.getAvailableQoI

(

self

)

Get the availbale quantities of interest.
@return: list of strings containing the available quantities of
interest defined by the post-processor function

References python.uq.uq_setting.UQSetting.UQSetting.__stats_postprocessor.

Referenced by python.uq.uq_setting.UQSetting.UQSetting.getResult(), and python.uq.uq_setting.UQSetting.UQSetting.getTimeDependentResults().

getDim()

def python.uq.uq_setting.UQSetting.UQSetting.getDim

(

self

)

@return: stochastic dimension

References python.uq.analysis.asgc.ASGCDescriptor.ASGCDescriptor.__specification, python.uq.learner.builder.RegressorSpecificationDescriptor.RegressorSpecificationDescriptor.__specification, python.uq.uq_setting.UQBuilder.UQBuilder.__specification, python.uq.uq_setting.UQSetting.UQSetting.__specification, python.uq.learner.builder.SimulationLearnerBuilder.SimulationLearnerDescriptor.__specification, python.learner.LearnerBuilder.LearnerBuilder.SpecificationDescriptor.__specification, sgpp::base::ImpurityRefinement_refinement_key.getDim(), python.uq.dists.TLognormal.TLognormal.getDim(), sgpp::base::ForwardSelectorRefinement_refinement_key.getDim(), sgpp::base::PredictiveRefinement_refinement_key.getDim(), python.uq.learner.SimulationLearnerSpecification.SimulationLearnerSpecification.getDim(), python.uq.analysis.asgc.ASGCAnalysisSpecification.ASGCAnalysisSpecification.getDim(), python.uq.dists.Beta.Beta.getDim(), python.uq.dists.Uniform.Uniform.getDim(), python.uq.dists.Corr.Corr.getDim(), python.uq.dists.EstimatedDist.EstimatedDist.getDim(), python.uq.dists.MultivariateNormal.MultivariateNormal.getDim(), python.uq.dists.Dist.Dist.getDim(), python.uq.dists.Lognormal.Lognormal.getDim(), python.uq.dists.DataDist.DataDist.getDim(), python.uq.dists.TNormal.TNormal.getDim(), python.uq.dists.Normal.Normal.getDim(), python.uq.sampler.Sample.Samples.getDim(), python.uq.dists.J.J.getDim(), python.uq.dists.NatafDist.NatafDist.getDim(), python.uq.sampler.Sample.Sample.getDim(), python.uq.dists.LibAGFDist.LibAGFDist.getDim(), python.uq.manager.ASGCUQManager.ASGCUQManager.getDim(), python.uq.parameters.ParameterSet.ParameterSet.getDim(), python.data.DataContainer.DataContainer.getDim(), and python.uq.uq_setting.UQSetting.UQSetting.getDim().

Referenced by python.uq.dists.SGDEdist.SGDEdist.__str__(), python.uq.dists.KDEDist.KDEDist.getBandwidths(), python.uq.uq_setting.UQSetting.UQSetting.getDim(), and python.uq.uq_setting.UQSetting.UQSetting.toDataMatrix().

getPostprocessorStats()

def python.uq.uq_setting.UQSetting.UQSetting.getPostprocessorStats

(

self

)

Get post-processor results
@return: dictionary [<parameter>] -> [<qoi>][...]
containing the post-processor results

References python.uq.uq_setting.UQSetting.UQSetting.__stats_postprocessor.

Referenced by python.uq.uq_setting.UQSetting.UQSetting.run().

getPreprocessorStats()

def python.uq.uq_setting.UQSetting.UQSetting.getPreprocessorStats

(

self

)

Get the pre-processor results

@return: dictionary [<unit parameter>] -> [<paramter>]
containing the pre-processor results

References python.uq.uq_setting.UQSetting.UQSetting.__stats_preprocessor.

getPreprocessorStatsReverse()

def python.uq.uq_setting.UQSetting.UQSetting.getPreprocessorStatsReverse

(

self

)

Get the reversed pre-processor results
@return: dictionary [<parameter>] -> [<unit-parameter>]
of reversed pre-processor stats

References python.uq.uq_setting.UQSetting.UQSetting.__stats_preprocessor_reverse.

getResult()

def python.uq.uq_setting.UQSetting.UQSetting.getResult	(		self,
			sample,
			ts = [0],
			qoi = '_'
	)

get the result for one given sample
@param sample: Sample
@param ts: list of numerics
@param qoi: string
@result: numpy array with the scalar results per time step

References python.uq.uq_setting.UQSetting.UQSetting.__stats_postprocessor, python.uq.uq_setting.UQSetting.UQSetting.__stats_preprocessor, python.uq.analysis.asgc.ASGCKnowledge.ASGCKnowledge.getAvailableQoI(), python.uq.uq_setting.UQSetting.UQSetting.getAvailableQoI(), python.uq.uq_setting.UQSpecification.UQSpecification.getInterpolationFunction(), python.uq.uq_setting.UQSetting.UQSetting.getTimeSetting(), python.uq.uq_setting.UQSpecification.UQSpecification.hasInterpolationFunction(), python.uq.uq_setting.UQBuilder.UQBuilder.reachesSteadyState(), and python.uq.uq_setting.UQSpecification.UQSpecification.reachesSteadyState().

Referenced by python.uq.uq_setting.UQSetting.UQSetting.getTimeDependentResults().

getResults()

def python.uq.uq_setting.UQSetting.UQSetting.getResults	(		self,
			qoi = "_",
			sampleType = UQSampleType.RAW
	)

Collects the simulation results assuming that ts = [0].
If just a selection of parameters is needed, one
can specify it using the ps parameter.
@param sampleType:
@return: dictionary {0: {<Sample>: value}}

References python.uq.uq_setting.UQSetting.UQSetting.__stats_postprocessor, python.uq.uq_setting.UQSetting.UQSetting.__stats_preprocessor, python.uq.uq_setting.UQSetting.UQSetting.__stats_preprocessor_reverse, and python.uq.uq_setting.UQSetting.UQSetting.__stats_samples.

getSamplesStats()

def python.uq.uq_setting.UQSetting.UQSetting.getSamplesStats

(

self

)

References python.uq.uq_setting.UQSetting.UQSetting.__stats_samples.

getSimulationStats()

def python.uq.uq_setting.UQSetting.UQSetting.getSimulationStats

(

self

)

Get the simulation results
@return: dictionary [<paramter>] -> simulation result

References python.uq.uq_setting.UQSetting.UQSetting.__stats_simulation.

Referenced by python.uq.uq_setting.UQSetting.UQSetting.run().

getSize()

def python.uq.uq_setting.UQSetting.UQSetting.getSize	(		self,
			item = "postprocessor"
	)

@oaram item: string identifying the stage
@return: int number of simulation results

References python.uq.uq_setting.UQSetting.UQSetting.__stats_postprocessor, python.uq.uq_setting.UQSetting.UQSetting.__stats_preprocessor, python.uq.uq_setting.UQSetting.UQSetting.__stats_samples, and python.uq.uq_setting.UQSetting.UQSetting.__stats_simulation.

Referenced by python.uq.uq_setting.UQSetting.UQSetting.convert(), python.uq.uq_setting.UQSetting.UQSetting.getTimeDependentResults(), python.uq.uq_setting.UQSetting.UQSetting.runSamples(), and python.uq.uq_setting.UQSetting.UQSetting.runSamples_withoutDistribution().

getSpecification()

def python.uq.uq_setting.UQSetting.UQSetting.getSpecification

(

self

)

@return: The UQSpecification object

References python.uq.analysis.asgc.ASGCDescriptor.ASGCDescriptor.__specification, python.uq.learner.builder.RegressorSpecificationDescriptor.RegressorSpecificationDescriptor.__specification, python.uq.uq_setting.UQBuilder.UQBuilder.__specification, python.uq.uq_setting.UQSetting.UQSetting.__specification, python.uq.learner.builder.SimulationLearnerBuilder.SimulationLearnerDescriptor.__specification, and python.learner.LearnerBuilder.LearnerBuilder.SpecificationDescriptor.__specification.

getTimeDependentResults()

def python.uq.uq_setting.UQSetting.UQSetting.getTimeDependentResults	(		self,
			ts,
			qoi = '_',
			ps = None,
			sampleType = UQSampleType.RAW
	)

Collects the simulation results for the given time steps and a certain
quantity of interest. If just a selection of parameters is needed, one
can specify it using the ps parameter.
@param ts: list of time steps
@param ps: Samples, selection of parameters
@param qoi: quantity of interest
@param ps: list of samples to be loaded

@return: dictionary {<time step>: {<Sample>: value}}

References python.uq.uq_setting.UQSetting.UQSetting.__dictResults, python.uq.uq_setting.UQSetting.UQSetting.__stats_postprocessor, python.uq.uq_setting.UQSetting.UQSetting.__stats_preprocessor, python.uq.uq_setting.UQSetting.UQSetting.__stats_preprocessor_reverse, python.uq.uq_setting.UQSetting.UQSetting.__stats_samples, python.uq.learner.SimulationLearner.SimulationLearner._verbose, python.uq.analysis.Analysis.Analysis._verbose, python.uq.uq_setting.UQSetting.UQSetting._verbose, python.uq.analysis.asgc.anova.hdmrAnalytic.HDMRAnalytic._verbose, python.uq.analysis.asgc.ASGCKnowledge.ASGCKnowledge.getAvailableQoI(), python.uq.uq_setting.UQSetting.UQSetting.getAvailableQoI(), sgpp::combigrid::CombigridOperation.getResult(), sgpp::combigrid::CombigridTensorOperation.getResult(), sgpp::combigrid::CombigridMultiOperation.getResult(), python.uq.uq_setting.UQSetting.UQSetting.getResult(), python.uq.refinement.AdmissibleSet.AdmissibleSetGenerator.getSize(), python.uq.transformation.Transformation.Transformation.getSize(), python.uq.transformation.RosenblattTransformation.RosenblattTransformation.getSize(), python.uq.transformation.LinearTransformation.LinearTransformation.getSize(), python.uq.transformation.JointTransformation.JointTransformation.getSize(), python.uq.learner.Interpolant.Interpolant.getSize(), python.uq.sampler.asgc.ASGCSampler.ASGCSampler.getSize(), sgpp::base::HashGridStorage.getSize(), sgpp::base::DataVector.getSize(), sgpp::base::DataVectorSP.getSize(), python.data.DataContainer.DataContainer.getSize(), sgpp::base::DataMatrixSP.getSize(), sgpp::base::DataMatrix.getSize(), sgpp::base::Grid.getSize(), and python.uq.uq_setting.UQSetting.UQSetting.getSize().

Referenced by python.uq.uq_setting.UQSetting.UQSetting.hasResult(), and python.uq.uq_setting.UQSetting.UQSetting.toDataMatrix().

getTimeSetting()

def python.uq.uq_setting.UQSetting.UQSetting.getTimeSetting	(		self,
			q = None
	)

Get time setting consisting of 't0', 'tn', and 'dt'
@return: dictionary containing the time setting for the simulation

References python.uq.uq_setting.UQSetting.UQSetting.__stats_postprocessor, python.uq.uq_setting.UQSpecification.UQSpecification.getEndTime(), python.uq.uq_setting.UQSpecification.UQSpecification.getStartTime(), and python.uq.uq_setting.UQSpecification.UQSpecification.getTimeStep().

Referenced by python.uq.uq_setting.UQSetting.UQSetting.getResult(), and python.uq.uq_setting.UQSetting.UQSetting.hasTimeSetting().

getVerbose()

def python.uq.uq_setting.UQSetting.UQSetting.getVerbose

(

self

)

@return: verbosity level

References python.uq.learner.SimulationLearner.SimulationLearner._verbose, python.uq.analysis.Analysis.Analysis._verbose, python.uq.uq_setting.UQSetting.UQSetting._verbose, and python.uq.analysis.asgc.anova.hdmrAnalytic.HDMRAnalytic._verbose.

hasResult()

def python.uq.uq_setting.UQSetting.UQSetting.hasResult	(		self,
			sample
	)

References python.uq.uq_setting.UQSetting.UQSetting.__stats_postprocessor, python.uq.uq_setting.UQSetting.UQSetting.__stats_preprocessor, python.uq.uq_setting.UQSetting.UQSetting.__stats_simulation, and python.uq.uq_setting.UQSetting.UQSetting.getTimeDependentResults().

hasTimeSetting()

def python.uq.uq_setting.UQSetting.UQSetting.hasTimeSetting

(

self

)

@return: bool defining whether there is a specified time setting or not

References python.uq.uq_setting.UQSetting.UQSetting.getTimeSetting().

loadfile()

def python.uq.uq_setting.UQSetting.UQSetting.loadfile	(		self,
			filename
	)

References sgpp::combigrid.join(), and python.uq.uq_setting.UQSetting.UQSetting.mergeStats().

Referenced by python.uq.uq_setting.UQSetting.UQSetting.loadResults().

loadResults()

def python.uq.uq_setting.UQSetting.UQSetting.loadResults

(

self

)

Load Results from files, if necessary
and merge them with this uq setting

References sgpp::combigrid::InternalTreeStorageNode< T >.children, python.uq.uq_setting.UQSetting.UQSetting.children, python.uq.uq_setting.UQSetting.UQSetting.files, python.uq.uq_setting.samplingresult.Samplingresult.loadfile(), python.uq.uq_setting.UQSetting.UQSetting.loadfile(), and python.uq.uq_setting.UQSetting.UQSetting.waitForResults().

Referenced by python.uq.uq_setting.UQSettingManager.UQSettingManager.getResults(), and python.uq.uq_setting.UQSetting.UQSetting.runSamples().

merge()

def python.uq.uq_setting.UQSetting.UQSetting.merge	(		self,
			newSetting
	)

Merges this UQSetting with the one in newSetting
@param newSetting: UQSetting to be merged

References python.uq.uq_setting.UQSetting.UQSetting.__stats_postprocessor, python.uq.uq_setting.UQSetting.UQSetting.__stats_preprocessor, python.uq.uq_setting.UQSetting.UQSetting.__stats_preprocessor_reverse, python.uq.uq_setting.UQSetting.UQSetting.__stats_samples, python.uq.uq_setting.UQSetting.UQSetting.__stats_simulation, python.uq.uq_setting.UQSpecification.UQSpecification.getEndTime(), python.uq.uq_setting.UQSpecification.UQSpecification.getStartTime(), python.uq.uq_setting.UQSpecification.UQSpecification.getTimeStep(), python.uq.uq_setting.UQSpecification.UQSpecification.setEndTime(), python.uq.uq_setting.UQSpecification.UQSpecification.setStartTime(), and python.uq.uq_setting.UQSpecification.UQSpecification.setTimeStep().

mergeStats()

def python.uq.uq_setting.UQSetting.UQSetting.mergeStats	(		self,
			newSetting
	)

Merge statistics in this setting and some other.
@param newSetting: UQSetting to be merged

References python.uq.uq_setting.UQSetting.UQSetting.__stats_postprocessor, python.uq.uq_setting.UQSetting.UQSetting.__stats_preprocessor, python.uq.uq_setting.UQSetting.UQSetting.__stats_preprocessor_reverse, python.uq.uq_setting.UQSetting.UQSetting.__stats_samples, python.uq.uq_setting.UQSetting.UQSetting.__stats_simulation, and python.uq.uq_setting.UQSetting.UQSetting.lastid.

Referenced by python.uq.uq_setting.UQSetting.UQSetting.loadfile().

remove()

def python.uq.uq_setting.UQSetting.UQSetting.remove	(		self,
			sample
	)

References python.uq.uq_setting.UQSetting.UQSetting.__stats_postprocessor, python.uq.uq_setting.UQSetting.UQSetting.__stats_preprocessor, python.uq.uq_setting.UQSetting.UQSetting.__stats_preprocessor_reverse, python.uq.uq_setting.UQSetting.UQSetting.__stats_samples, and python.uq.uq_setting.UQSetting.UQSetting.__stats_simulation.

Referenced by python.uq.uq_setting.UQSetting.UQSetting.cleanUp().

run()

def python.uq.uq_setting.UQSetting.UQSetting.run	(		self,
			sample,
			writeToFile = False,
			args,
			kws
	)

Trigger the pipeline from
 1) Transformation p \in [0, 1]^d -> \Gamma*
 2) Pre-processing
 3) Simulation run
 4) Post-processing
@param p: tuple input parameter in [0, 1]^d
@return: simulation results

References python.uq.uq_setting.UQSetting.UQSetting.__eval(), python.uq.uq_setting.UQSetting.UQSetting.__postprocessing(), python.uq.uq_setting.UQSetting.UQSetting.__preprocessing(), python.uq.uq_setting.UQSetting.UQSetting.getPostprocessorStats(), python.uq.uq_setting.UQSetting.UQSetting.getSimulationStats(), sgpp::base::ConfigurationParameters.writeToFile(), python.uq.analysis.asgc.ASGCKnowledge.ASGCKnowledge.writeToFile(), and python.uq.uq_setting.UQSetting.UQSetting.writeToFile().

Referenced by python.uq.uq_setting.UQSetting.UQSetting.runSamples_withoutDistribution().

runPostprocessor()

def python.uq.uq_setting.UQSetting.UQSetting.runPostprocessor

(

self

)

Run the post-processing for all available simulation results.

References python.uq.uq_setting.UQSetting.UQSetting.__postprocessing(), python.uq.uq_setting.UQSetting.UQSetting.__stats_postprocessor, and python.uq.uq_setting.UQSetting.UQSetting.__stats_simulation.

runSamples()

def python.uq.uq_setting.UQSetting.UQSetting.runSamples	(		self,
			samples,
			dist = False,
			args,
			kws
	)

References python.uq.uq_setting.UQSetting.UQSetting.__stats_samples, python.uq.refinement.AdmissibleSet.AdmissibleSetGenerator.getSize(), python.uq.transformation.Transformation.Transformation.getSize(), python.uq.transformation.RosenblattTransformation.RosenblattTransformation.getSize(), python.uq.transformation.LinearTransformation.LinearTransformation.getSize(), python.uq.transformation.JointTransformation.JointTransformation.getSize(), python.uq.learner.Interpolant.Interpolant.getSize(), python.uq.sampler.asgc.ASGCSampler.ASGCSampler.getSize(), sgpp::base::HashGridStorage.getSize(), sgpp::base::DataVector.getSize(), sgpp::base::DataVectorSP.getSize(), python.data.DataContainer.DataContainer.getSize(), sgpp::base::DataMatrixSP.getSize(), sgpp::base::DataMatrix.getSize(), sgpp::base::Grid.getSize(), python.uq.uq_setting.UQSetting.UQSetting.getSize(), python.uq.uq_setting.UQSetting.UQSetting.loadResults(), python.uq.uq_setting.UQSetting.UQSetting.runSamples_dist(), python.uq.uq_setting.UQSetting.UQSetting.runSamples_withoutDistribution(), and python.uq.uq_setting.UQSetting.UQSetting.waitForResults().

runSamples_dist()

def python.uq.uq_setting.UQSetting.UQSetting.runSamples_dist	(		self,
			samples,
			starti = 0,
			args,
			kws
	)

Performs run() for the given samples.
Parallelizes automatically, so use this if possible.
Sampling will take place in the background, use waitForResults()
at the end.

References python.uq.uq_setting.UQSetting.UQSetting.__filesuffix, python.uq.uq_setting.UQSetting.UQSetting.__nextId(), sgpp::combigrid::InternalTreeStorageNode< T >.children, python.uq.uq_setting.UQSetting.UQSetting.children, python.uq.uq_setting.UQSetting.UQSetting.expectedsamplecount, python.uq.uq_setting.UQSetting.UQSetting.files, python.data.DataSpecification.DataSpecification.getFilename(), python.uq.uq_setting.UQSpecification.UQSpecification.getFilename(), python.uq.uq_setting.UQSetting.UQSetting.parallelprocesses, and python.uq.uq_setting.UQSetting.UQSetting.runSamples_dist().

Referenced by python.uq.uq_setting.UQSetting.UQSetting.runSamples(), and python.uq.uq_setting.UQSetting.UQSetting.runSamples_dist().

runSamples_withoutDistribution()

def python.uq.uq_setting.UQSetting.UQSetting.runSamples_withoutDistribution	(		self,
			samples,
			args,
			kws
	)

Run for multiple samples
@param samples: list of samples

References python.uq.learner.SimulationLearner.SimulationLearner._verbose, python.uq.analysis.Analysis.Analysis._verbose, python.uq.uq_setting.UQSetting.UQSetting._verbose, python.uq.analysis.asgc.anova.hdmrAnalytic.HDMRAnalytic._verbose, python.uq.uq_setting.UQSpecification.UQSpecification.getSaveAfterEachRun(), python.uq.refinement.AdmissibleSet.AdmissibleSetGenerator.getSize(), python.uq.transformation.Transformation.Transformation.getSize(), python.uq.transformation.RosenblattTransformation.RosenblattTransformation.getSize(), python.uq.transformation.LinearTransformation.LinearTransformation.getSize(), python.uq.transformation.JointTransformation.JointTransformation.getSize(), python.uq.learner.Interpolant.Interpolant.getSize(), python.uq.sampler.asgc.ASGCSampler.ASGCSampler.getSize(), sgpp::base::HashGridStorage.getSize(), sgpp::base::DataVector.getSize(), sgpp::base::DataVectorSP.getSize(), python.data.DataContainer.DataContainer.getSize(), sgpp::base::DataMatrixSP.getSize(), sgpp::base::DataMatrix.getSize(), sgpp::base::Grid.getSize(), python.uq.uq_setting.UQSetting.UQSetting.getSize(), python.controller.TerminalController.TerminalController.run(), and python.uq.uq_setting.UQSetting.UQSetting.run().

Referenced by python.uq.uq_setting.UQSetting.UQSetting.runSamples().

runSimulations()

def python.uq.uq_setting.UQSetting.UQSetting.runSimulations

(

self

)

Run the simulations for all available pre-processor stats

References python.uq.uq_setting.UQSetting.UQSetting.__eval(), python.uq.uq_setting.UQSetting.UQSetting.__stats_preprocessor, and python.uq.uq_setting.UQSetting.UQSetting.__stats_simulation.

sanityCheck()

def python.uq.uq_setting.UQSetting.UQSetting.sanityCheck

(

self

)

Check for consistency of the UQ setting.

References python.uq.uq_setting.UQSetting.UQSetting.__stats_postprocessor, python.uq.uq_setting.UQSetting.UQSetting.__stats_preprocessor, python.uq.uq_setting.UQSetting.UQSetting.__stats_preprocessor_reverse, and python.uq.uq_setting.UQSetting.UQSetting.__stats_simulation.

setLastId()

def python.uq.uq_setting.UQSetting.UQSetting.setLastId	(		self,
			lastid
	)

References python.uq.uq_setting.UQSetting.UQSetting.lastid.

setMemento()

def python.uq.uq_setting.UQSetting.UQSetting.setMemento	(		self,
			memento
	)

Restores the state which is saved in the given memento
@param memento: the memento object

References python.uq.transformation.Transformation.Transformation.fromJson(), python.uq.estimators.SparseGridEstimationStrategy.SparseGridEstimationStrategy.fromJson(), python.uq.dists.CorrBeta.CorrBeta.fromJson(), python.uq.dists.TLognormal.TLognormal.fromJson(), python.uq.parameters.Parameter.Parameter.fromJson(), python.uq.transformation.RosenblattTransformation.RosenblattTransformation.fromJson(), python.uq.transformation.LinearTransformation.LinearTransformation.fromJson(), python.uq.dists.Uniform.Uniform.fromJson(), python.uq.dists.Corr.Corr.fromJson(), python.uq.dists.Beta.Beta.fromJson(), python.uq.dists.MultivariateNormal.MultivariateNormal.fromJson(), python.uq.sampler.asgc.ASGCSamplerStopPolicy.ASGCSamplerStopPolicy.fromJson(), python.uq.dists.Lognormal.Lognormal.fromJson(), python.uq.transformation.JointTransformation.JointTransformation.fromJson(), python.uq.dists.DataDist.DataDist.fromJson(), python.uq.dists.TNormal.TNormal.fromJson(), python.uq.dists.Normal.Normal.fromJson(), python.learner.solver.CGSolver.CGSolver.fromJson(), python.learner.TrainingStopPolicy.TrainingStopPolicy.fromJson(), python.uq.dists.KDEDist.KDEDist.fromJson(), python.learner.TrainingSpecification.TrainingSpecification.fromJson(), python.uq.sampler.asgc.ASGCSampler.ASGCSampler.fromJson(), python.uq.dists.NatafDist.NatafDist.fromJson(), python.uq.dists.J.J.fromJson(), python.uq.dists.Dist.Dist.fromJson(), python.uq.analysis.asgc.ASGCKnowledge.ASGCKnowledge.fromJson(), python.uq.sampler.Sample.Sample.fromJson(), python.uq.learner.Learner.Learner.fromJson(), python.uq.dists.SGDEdist.SGDEdist.fromJson(), python.data.DataContainer.DataContainer.fromJson(), python.learner.Learner.Learner.fromJson(), python.uq.parameters.ParameterSet.ParameterSet.fromJson(), and python.uq.uq_setting.UQSetting.UQSetting.fromJson().

setPostprocessorStats()

def python.uq.uq_setting.UQSetting.UQSetting.setPostprocessorStats	(		self,
			stats
	)

Set post-processor results
@param stats: dictionary

References python.uq.uq_setting.UQSetting.UQSetting.__stats_postprocessor.

setPreprocessorStats()

def python.uq.uq_setting.UQSetting.UQSetting.setPreprocessorStats	(		self,
			stats
	)

Set pre-processor stats
@param stats: dictionary

References python.uq.uq_setting.UQSetting.UQSetting.__stats_preprocessor.

setPreprocessorStatsReverse()

def python.uq.uq_setting.UQSetting.UQSetting.setPreprocessorStatsReverse	(		self,
			stats
	)

Set reversed pre-processor stats
@param stats: dictionary

References python.uq.uq_setting.UQSetting.UQSetting.__stats_preprocessor_reverse.

setSamplesStats()

def python.uq.uq_setting.UQSetting.UQSetting.setSamplesStats	(		self,
			value
	)

References python.uq.uq_setting.UQSetting.UQSetting.__stats_samples.

setSimulationStats()

def python.uq.uq_setting.UQSetting.UQSetting.setSimulationStats	(		self,
			stats
	)

Set simulation results
@param stats: dictionary

References python.uq.uq_setting.UQSetting.UQSetting.__stats_simulation.

setSpecification()

def python.uq.uq_setting.UQSetting.UQSetting.setSpecification	(		self,
			specification
	)

Set the specification
@param specification: UQSpecification object

References python.uq.analysis.asgc.ASGCDescriptor.ASGCDescriptor.__specification, python.uq.learner.builder.RegressorSpecificationDescriptor.RegressorSpecificationDescriptor.__specification, python.uq.uq_setting.UQBuilder.UQBuilder.__specification, python.uq.uq_setting.UQSetting.UQSetting.__specification, python.uq.learner.builder.SimulationLearnerBuilder.SimulationLearnerDescriptor.__specification, and python.learner.LearnerBuilder.LearnerBuilder.SpecificationDescriptor.__specification.

setVerbose()

def python.uq.uq_setting.UQSetting.UQSetting.setVerbose	(		self,
			verbose
	)

Set verbose level
@param verbose: bool

References python.uq.learner.SimulationLearner.SimulationLearner._verbose, python.uq.analysis.Analysis.Analysis._verbose, python.uq.uq_setting.UQSetting.UQSetting._verbose, and python.uq.analysis.asgc.anova.hdmrAnalytic.HDMRAnalytic._verbose.

split()

def python.uq.uq_setting.UQSetting.UQSetting.split	(		self,
			n = 500
	)

Split the UQ setting in two disjunct parts
@param n: number of elements of the new UQ setting

References python.uq.analysis.asgc.ASGCDescriptor.ASGCDescriptor.__specification, python.uq.learner.builder.RegressorSpecificationDescriptor.RegressorSpecificationDescriptor.__specification, python.uq.uq_setting.UQBuilder.UQBuilder.__specification, python.uq.uq_setting.UQSetting.UQSetting.__specification, python.uq.learner.builder.SimulationLearnerBuilder.SimulationLearnerDescriptor.__specification, python.learner.LearnerBuilder.LearnerBuilder.SpecificationDescriptor.__specification, python.uq.uq_setting.UQSetting.UQSetting.__stats_postprocessor, python.uq.uq_setting.UQSetting.UQSetting.__stats_preprocessor, python.uq.uq_setting.UQSetting.UQSetting.__stats_preprocessor_reverse, python.uq.uq_setting.UQSetting.UQSetting.__stats_simulation, python.uq.learner.SimulationLearner.SimulationLearner._verbose, python.uq.analysis.Analysis.Analysis._verbose, python.uq.uq_setting.UQSetting.UQSetting._verbose, and python.uq.analysis.asgc.anova.hdmrAnalytic.HDMRAnalytic._verbose.

toDataMatrix()

def python.uq.uq_setting.UQSetting.UQSetting.toDataMatrix	(		self,
			ts = [0],
			qoi = '_',
			dtype = SampleType.ACTIVEUNIT,
			sampleType = UQSampleType.RAW,
			args,
			kws
	)

Write simulation results to file
@param ts: numeric time steps
@param qoi: string quantity of interest

References python.uq.uq_setting.UQSetting.UQSetting.getDim(), and python.uq.uq_setting.UQSetting.UQSetting.getTimeDependentResults().

Referenced by python.uq.uq_setting.UQSetting.UQSetting.toJson().

toJson()

def python.uq.uq_setting.UQSetting.UQSetting.toJson

(

self

)

@return: string representing the object

References python.uq.uq_setting.UQSetting.UQSetting.toDataMatrix().

Referenced by python.uq.uq_setting.UQSetting.UQSetting.__str__(), and python.uq.uq_setting.UQSetting.UQSetting.createMemento().

waitForResults()

def python.uq.uq_setting.UQSetting.UQSetting.waitForResults

(

self

)

Wait for all forked workers to finish working,
then load all result files into one SamplingResult.

References sgpp::combigrid::InternalTreeStorageNode< T >.children, python.uq.uq_setting.UQSetting.UQSetting.children, python.uq.uq_setting.UQSetting.UQSetting.files, sgpp::base::ConfigurationParameters.writeToFile(), python.uq.analysis.asgc.ASGCKnowledge.ASGCKnowledge.writeToFile(), and python.uq.uq_setting.UQSetting.UQSetting.writeToFile().

Referenced by python.uq.uq_setting.UQSettingManager.UQSettingManager.getResults(), python.uq.uq_setting.UQSettingManager.UQSettingManager.loadResults(), python.uq.uq_setting.UQSetting.UQSetting.loadResults(), python.uq.uq_setting.UQSettingManager.UQSettingManager.run_distinct_paths(), python.uq.uq_setting.UQSettingManager.UQSettingManager.run_sensitivity(), and python.uq.uq_setting.UQSetting.UQSetting.runSamples().

writeToFile()

def python.uq.uq_setting.UQSetting.UQSetting.writeToFile	(		self,
			filename = None
	)

References python.uq.learner.SimulationLearner.SimulationLearner._verbose, python.uq.analysis.Analysis.Analysis._verbose, python.uq.uq_setting.UQSetting.UQSetting._verbose, python.uq.analysis.asgc.anova.hdmrAnalytic.HDMRAnalytic._verbose, python.learner.LearnedKnowledge.LearnedKnowledge.createMemento(), python.uq.sampler.asgc.ASGCSampler.ASGCSampler.createMemento(), python.uq.analysis.asgc.ASGCKnowledge.ASGCKnowledge.createMemento(), python.uq.learner.Learner.Learner.createMemento(), python.learner.Learner.Learner.createMemento(), python.uq.uq_setting.UQSetting.UQSetting.createMemento(), python.data.DataSpecification.DataSpecification.getFilename(), and python.uq.uq_setting.UQSpecification.UQSpecification.getFilename().

Referenced by python.uq.uq_setting.UQSetting.UQSetting.run(), and python.uq.uq_setting.UQSetting.UQSetting.waitForResults().

Member Data Documentation

children

python.uq.uq_setting.UQSetting.UQSetting.children

Referenced by python.uq.uq_setting.UQSettingManager.UQSettingManager.getResults(), python.uq.uq_setting.UQSettingManager.UQSettingManager.loadResults(), python.uq.uq_setting.UQSetting.UQSetting.loadResults(), python.uq.uq_setting.UQSettingManager.UQSettingManager.run_sampleList(), python.uq.uq_setting.UQSetting.UQSetting.runSamples_dist(), python.uq.uq_setting.UQSettingManager.UQSettingManager.waitForResults(), and python.uq.uq_setting.UQSetting.UQSetting.waitForResults().

expectedsamplecount

python.uq.uq_setting.UQSetting.UQSetting.expectedsamplecount

Referenced by python.uq.uq_setting.UQSettingManager.UQSettingManager.run_sampleList(), python.uq.uq_setting.UQSetting.UQSetting.runSamples_dist(), and python.uq.uq_setting.UQSettingManager.UQSettingManager.setExpectedSampleCount().

files

python.uq.uq_setting.UQSetting.UQSetting.files

Referenced by python.uq.uq_setting.UQSettingManager.UQSettingManager.loadResults(), python.uq.uq_setting.UQSetting.UQSetting.loadResults(), python.uq.uq_setting.UQSettingManager.UQSettingManager.run_sampleList(), python.uq.uq_setting.UQSetting.UQSetting.runSamples_dist(), python.uq.uq_setting.UQSettingManager.UQSettingManager.waitForResults(), and python.uq.uq_setting.UQSetting.UQSetting.waitForResults().

lastid

python.uq.uq_setting.UQSetting.UQSetting.lastid

Referenced by python.uq.uq_setting.UQSetting.UQSetting.mergeStats(), and python.uq.uq_setting.UQSetting.UQSetting.setLastId().

parallelprocesses

python.uq.uq_setting.UQSetting.UQSetting.parallelprocesses

Referenced by python.uq.uq_setting.UQSettingManager.UQSettingManager.run_sampleList(), and python.uq.uq_setting.UQSetting.UQSetting.runSamples_dist().

---

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

• datadriven/python/uq/uq_setting/UQSetting.py