mcsas.utils.parameter module¶

FitParameter(*args, **kwargs)[source]¶: Warning

function ‘utils.parameter.FitParameter’ undocumented

class FitParameterBase[source]¶

Bases: bases.algorithm.parameter.ParameterBase

Deriving parameters for curve fitting from bases.algorithm.parameter to introduce more specific fit related attributes.

activeRange = functools.partial(<function FitParameterBase.activeRange>, <class 'utils.parameter.FitParameterBase'>)¶

activeVal = functools.partial(<function FitParameterBase.activeVal>, <class 'utils.parameter.FitParameterBase'>)¶

activeValues = functools.partial(<function _makeGetter.<locals>.getter>, <class 'utils.parameter.FitParameterBase'>)¶

displayActiveRange = functools.partial(<function FitParameterBase.displayActiveRange>, <class 'utils.parameter.FitParameterBase'>)¶

hdfStoreAsMember()[source]¶: Warning

method ‘utils.parameter.FitParameterBase.hdfStoreAsMember’ undocumented

histograms = functools.partial(<function _makeGetter.<locals>.getter>, <class 'utils.parameter.FitParameterBase'>)¶

isActive = functools.partial(<function _makeGetter.<locals>.getter>, <class 'utils.parameter.FitParameterBase'>)¶

setActive = functools.partial(<function FitParameterBase.setIsActive>, <class 'utils.parameter.FitParameterBase'>)¶

setActiveRange = functools.partial(<function FitParameterBase.setActiveRange>, <class 'utils.parameter.FitParameterBase'>)¶

setActiveVal = functools.partial(<function FitParameterBase.setActiveVal>, <class 'utils.parameter.FitParameterBase'>)¶

setActiveValues = functools.partial(<function _makeSetter.<locals>.setter>, <class 'utils.parameter.FitParameterBase'>)¶

setDisplayActiveRange = functools.partial(<function FitParameterBase.setDisplayActiveRange>, <class 'utils.parameter.FitParameterBase'>)¶

setHistograms = functools.partial(<function _makeSetter.<locals>.setter>, <class 'utils.parameter.FitParameterBase'>)¶

setIsActive = functools.partial(<function FitParameterBase.setIsActive>, <class 'utils.parameter.FitParameterBase'>)¶

setValueRange = functools.partial(<function FitParameterBase.setValueRange>, <class 'utils.parameter.FitParameterBase'>)¶

class FitParameterBoolean[source]¶: Bases: utils.parameter.FitParameterBase, bases.algorithm.parameter.ParameterBoolean

class FitParameterFloat[source]¶: Bases: utils.parameter.FitParameterNumerical, bases.algorithm.parameter.ParameterFloat

class FitParameterLog[source]¶: Bases: utils.parameter.FitParameterBase, bases.algorithm.parameter.ParameterLog

class FitParameterNumerical[source]¶

Bases: utils.parameter.FitParameterBase, bases.algorithm.parameter.ParameterNumerical

generate(lower=None, upper=None, count=1)[source]¶: Warning

method ‘utils.parameter.FitParameterNumerical.generate’ undocumented

class FitParameterString[source]¶: Bases: utils.parameter.FitParameterBase, bases.algorithm.parameter.ParameterString

class Histogram(param, lower, upper, binCount=50, xscale=None, yweight=None, autoFollow=True)[source]¶

Bases: bases.dataset.dataset.DataSet, bases.dataset.dataset.DisplayMixin

Stores histogram related settings of a parameter. The results too, eventually(?). yes, please. Stores&calculates rangeInfo() results for all available weighting options.

Creates an histogram with default bin count, will be updated later.

autoFollow¶

binCount¶

bins¶

calc(contribs, paramIndex, fractions)[source]¶: Warning

method ‘utils.parameter.Histogram.calc’ undocumented

cdf¶

classmethod displayData()[source]¶: Properties used for UI display.

classmethod displayDataDescr()[source]¶: Descriptive text of fields for UI display.

hdfWrite(hdf)[source]¶: Warning

method ‘utils.parameter.Histogram.hdfWrite’ undocumented

classmethod integralProps()[source]¶: All properties needed to properly serialize and restore this histogram. Same order expected by the constructor.

lower¶

lowerDisplay¶: Lower limit in display units including the unit text.

moments¶

observability¶

param¶

paramName¶

updateRange()[source]¶: Restricts histogram range according to changed parameter range if needed. Checks histogram range against parameter limits.

upper¶

upperDisplay¶: Upper limit in display units including the unit text.

xLowerEdge¶

xMean¶

xWidth¶

xrange¶

xscale¶

static xscaling(index=None)[source]¶: Warning

method ‘utils.parameter.Histogram.xscaling’ undocumented

yweight¶

static yweighting(index=None)[source]¶: Warning

method ‘utils.parameter.Histogram.yweighting’ undocumented

class Histograms[source]¶

Bases: list

Manages a set of user configured histograms for evaluation after monte-carlo run.

append(value)[source]¶: Warning

method ‘utils.parameter.Histograms.append’ undocumented

calc(*args)[source]¶: Warning

method ‘utils.parameter.Histograms.calc’ undocumented

clear()[source]¶: Warning

method ‘utils.parameter.Histograms.clear’ undocumented

hdfWrite(hdf)[source]¶: Warning

method ‘utils.parameter.Histograms.hdfWrite’ undocumented

updateRanges()[source]¶: Updates ranges of all histograms.

class Moments(contribs, paramIndex, valueRange, fraction, algo=None)[source]¶

Bases: object

static fieldNames()[source]¶: Returns the field names in the same order as str()

fields¶: Tuple of member data incl. uncertainty for export.

intensity¶

kurtosis¶

mean¶

skew¶

total¶

varName = '_kurtosis'¶

variance¶

Parameter(*args, **kwargs)¶: Warning

function ‘utils.parameter.Parameter’ undocumented

class VectorResult(vecResult)[source]¶

Bases: object

Stores multiple populations of a single result data vector. Calculates statistics at initialization.

full¶

mean¶

std¶

classproperty(func)¶: Warning

function ‘utils.parameter.classproperty’ undocumented

isActiveFitParam(param)[source]¶: Checks any type of parameter for activeness. Shorter than that below or a try/except clause.

isFitParam(param)[source]¶: Warning

function ‘utils.parameter.isFitParam’ undocumented