python.uq.sampler.Sample.Sample Class Reference

Inheritance diagram for python.uq.sampler.Sample.Sample:

Public Member Functions
def	__eq__ (self, sample)
def	__hash__ (self)
def	__init__ (self, params=None, sample=None, dtype=SampleType.ACTIVEPROBABILISTIC)
def	__str__ (self)
def	fromJson (cls, jsonObject)
def	getActiveProbabilistic (self)
def	getActiveUnit (self)
def	getDim (self, dtype=SampleType.ACTIVEUNIT)
def	getExpandedDim (self)
def	getExpandedProbabilistic (self)
def	getExpandedUnit (self)
def	getStochasticDim (self)
def	getValue (self, dtype=SampleType.ACTIVEUNIT)
def	init (self, activeUnit, activeProb, expandedUnit, expandedProb)
def	toJson (self)

Constructor & Destructor Documentation

__init__()

def python.uq.sampler.Sample.Sample.__init__	(		self,
			params = None,
			sample = None,
			dtype = SampleType.ACTIVEPROBABILISTIC
	)

constructor
@param params: ParameterSet
@param sample: numpy array, tuple or list
@param dtype: SampleType

References python.uq.sampler.Sample.Sample.__activeProb, python.uq.sampler.Sample.Sample.__activeUnit, python.uq.sampler.Sample.Sample.__expandedProb, and python.uq.sampler.Sample.Sample.__expandedUnit.

Member Function Documentation

__eq__()

def python.uq.sampler.Sample.Sample.__eq__	(		self,
			sample
	)

__hash__()

def python.uq.sampler.Sample.Sample.__hash__

(

self

)

References python.uq.sampler.Sample.Sample.getExpandedUnit().

__str__()

def python.uq.sampler.Sample.Sample.__str__

(

self

)

References python.uq.sampler.Sample.Sample.getActiveUnit().

fromJson()

def python.uq.sampler.Sample.Sample.fromJson	(		cls,
			jsonObject
	)

Restores the Sample object from the json object
with its attributes.
@param jsonObject: json object
@return: the restored Sample object

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

getActiveProbabilistic()

def python.uq.sampler.Sample.Sample.getActiveProbabilistic

(

self

)

References python.uq.sampler.Sample.Sample.__activeProb.

Referenced by python.uq.sampler.Sample.Sample.getValue().

getActiveUnit()

def python.uq.sampler.Sample.Sample.getActiveUnit

(

self

)

References python.uq.sampler.Sample.Sample.__activeUnit.

Referenced by python.uq.sampler.Sample.Sample.__str__(), and python.uq.sampler.Sample.Sample.getValue().

getDim()

def python.uq.sampler.Sample.Sample.getDim	(		self,
			dtype = SampleType.ACTIVEUNIT
	)

References python.uq.sampler.Sample.Sample.getExpandedDim(), python.uq.sampler.Sample.Sample.getStochasticDim(), and python.uq.parameters.ParameterSet.ParameterSet.getStochasticDim().

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

getExpandedDim()

def python.uq.sampler.Sample.Sample.getExpandedDim

(

self

)

References python.uq.sampler.Sample.Sample.__expandedUnit.

Referenced by python.uq.sampler.Sample.Sample.getDim().

getExpandedProbabilistic()

def python.uq.sampler.Sample.Sample.getExpandedProbabilistic

(

self

)

References python.uq.sampler.Sample.Sample.__expandedProb.

Referenced by python.uq.sampler.Sample.Sample.getValue().

getExpandedUnit()

def python.uq.sampler.Sample.Sample.getExpandedUnit

(

self

)

References python.uq.sampler.Sample.Sample.__expandedUnit.

Referenced by python.uq.sampler.Sample.Sample.__hash__(), and python.uq.sampler.Sample.Sample.getValue().

getStochasticDim()

def python.uq.sampler.Sample.Sample.getStochasticDim

(

self

)

References python.uq.sampler.Sample.Sample.__activeUnit.

Referenced by python.uq.sampler.Sample.Sample.getDim().

getValue()

def python.uq.sampler.Sample.Sample.getValue	(		self,
			dtype = SampleType.ACTIVEUNIT
	)

References python.uq.sampler.Sample.Sample.getActiveProbabilistic(), python.uq.sampler.Sample.Sample.getActiveUnit(), python.uq.sampler.Sample.Sample.getExpandedProbabilistic(), and python.uq.sampler.Sample.Sample.getExpandedUnit().

init()

def python.uq.sampler.Sample.Sample.init	(		self,
			activeUnit,
			activeProb,
			expandedUnit,
			expandedProb
	)

References python.uq.sampler.Sample.Sample.__activeProb, python.uq.sampler.Sample.Sample.__activeUnit, python.uq.sampler.Sample.Sample.__expandedProb, and python.uq.sampler.Sample.Sample.__expandedUnit.

toJson()

def python.uq.sampler.Sample.Sample.toJson

(

self

)

Returns a string that represents the object

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

---

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

• datadriven/python/uq/sampler/Sample.py