python.uq.uq_setting.samplingresult.Samplingresult Class Reference

Public Member Functions

def __init__ (self, uqsetting)
def getSamplesSorted (self, chunktag=None, first=0, number=None, not_match=None, kwargs)
def listChunks (self, chunk_ref=None, kwargs)
def listQoI (self)
def listTime (self)
def loadfile (self, filename)
def makeIndex (self)
def setQoI (self, qoi)
def setSampleFormat (self, onlyActive=False, unitcube=False, onlyValues=False, raw=False)
def setTag (self, kwargs)
def setTime (self, time)
def tagMatch (self, tag, chunk_ref, not_match=None)

Public Attributes


Constructor & Destructor Documentation

def python.uq.uq_setting.samplingresult.Samplingresult.__init__ (   self,
Create a Samplingresult using data of the given UQSetting. If
a filename or a list of filenames is given, load the UQSetting
from those files.

Member Function Documentation

def python.uq.uq_setting.samplingresult.Samplingresult.getSamplesSorted (   self,
  chunktag = None,
  first = 0,
  number = None,
  not_match = None,
Returns the samples which match the preset parameters and are assigned
to the chunk given by the chunktag. The samples will be ordered as
they are in the chunk.

@param chunktag: denotes the  chunk
@param first: index of the first sample to return
@param number: number of samples to return, None for all
@param not_match: tags matching not_match will be excluded from the result
@param kwargs: same as a dict for chunktag

References python.uq.uq_setting.samplingresult.Samplingresult.onlyActive, python.uq.uq_setting.samplingresult.Samplingresult.onlyValues, python.uq.uq_setting.samplingresult.Samplingresult.post_stats, python.uq.uq_setting.samplingresult.Samplingresult.qoi, python.uq.uq_setting.samplingresult.Samplingresult.raw, python.uq.uq_setting.samplingresult.Samplingresult.sim_stats, python.uq.uq_setting.samplingresult.Samplingresult.tag_stats, python.uq.uq_setting.samplingresult.Samplingresult.tagMatch(), python.uq.uq_setting.samplingresult.Samplingresult.time, and python.uq.uq_setting.samplingresult.Samplingresult.unitcube.

Referenced by python.uq.uq_setting.samplingresult.Samplingresult.tagMatch().

def python.uq.uq_setting.samplingresult.Samplingresult.listChunks (   self,
  chunk_ref = None,
Return the available chunks in the dataset as a list of chunk tags.
Slow and should not be used.
@param chunk_ref: return only those of the given prototype (Values
           the same for all keys in prototype.)
@param kwargs: alternate synty for chunk_ref

References python.uq.uq_setting.samplingresult.Samplingresult.__tagToTuple().

def python.uq.uq_setting.samplingresult.Samplingresult.listQoI (   self)
Return the QoIs found in the dataset as a list
def python.uq.uq_setting.samplingresult.Samplingresult.listTime (   self)
Return the timesteps in the dataset as a list.

References python.uq.uq_setting.samplingresult.Samplingresult.qoi.

def python.uq.uq_setting.samplingresult.Samplingresult.loadfile (   self,
def python.uq.uq_setting.samplingresult.Samplingresult.makeIndex (   self)
Creates an index over the samples by tag. This speeds up searching for
a short chunk in a huge dataset (might be a factor of 100) but this
might not always be the case.

The index stored in the index attribute is a dict of lists of sample
points indexed by "atomic" tags (those reported by listChunks()) which
are flattend into tuples of (key, value) tuples.
def python.uq.uq_setting.samplingresult.Samplingresult.setQoI (   self,
def python.uq.uq_setting.samplingresult.Samplingresult.setSampleFormat (   self,
  onlyActive = False,
  unitcube = False,
  onlyValues = False,
  raw = False 
Specifies the format that getSamplesSorted returns.

@param onlyActive: only add active parameters to the sample parameters TODO: Not implemented
@param unitcube: use unitcube values (implies active subset only) TODO: not implemented
@param onlyValues: do not return sample parameters
@param raw: do not extract QoI values

References python.uq.uq_setting.samplingresult.Samplingresult.onlyActive, python.uq.uq_setting.samplingresult.Samplingresult.onlyValues, python.uq.uq_setting.samplingresult.Samplingresult.raw, and python.uq.uq_setting.samplingresult.Samplingresult.unitcube.

def python.uq.uq_setting.samplingresult.Samplingresult.setTag (   self,
Pre-Select samples with the given tag properties.

References python.uq.uq_setting.samplingresult.Samplingresult.chunk_ref.

def python.uq.uq_setting.samplingresult.Samplingresult.setTime (   self,
Set a specific timestep value to return in getSamplesSorted. Default is None,
in this case all timesteps will be returned as a vector.

References python.uq.uq_setting.samplingresult.Samplingresult.time.

def python.uq.uq_setting.samplingresult.Samplingresult.tagMatch (   self,
  not_match = None 
Check if a tag matches an description.
tag may be given as list of items or dict.
return true if all keys in chuck_ref have the same value in tag.
@return: false otherwise or if tag matches not.

References python.uq.uq_setting.samplingresult.Samplingresult.getSamplesSorted(), and python.uq.uq_setting.samplingresult.Samplingresult.tagMatch().

Referenced by python.uq.uq_setting.samplingresult.Samplingresult.getSamplesSorted(), and python.uq.uq_setting.samplingresult.Samplingresult.tagMatch().

Member Data Documentation


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