starvine.uvar.uvd.Uvd Class Reference

Container for univariate data. More...

Inheritance diagram for starvine.uvar.uvd.Uvd:

Public Member Functions
def	__init__ (self, fData=None, dWeights=None, dName=None, bPlanes=None, uvModelName="gauss", args, kwargs)
	Init univariate model distirbution. More...
def	setUVM (self, uvModelName)
	Select target univariate model. More...
def	setName (self, dataName)
def	setWeights (self, dataWeights)
def	setAxialBounds (self, boundingPlanes)
def	setData (self, fieldData, dataWeights, boundingPlanes=None)
	Set the univariate field data and weights. More...
def	fitMLE (self, params0=None)
	fit model to data via maximum likelyhood. More...
def	fitGMM (self)
def	fitMCMC (self)

Public Attributes
	fieldData
	dataWeights
	dataName
	boundingPlanes
	uvmodel

Detailed Description

Container for univariate data.

Constructor & Destructor Documentation

__init__()

def starvine.uvar.uvd.Uvd.__init__	(		self,
			fData = None,
			dWeights = None,
			dName = None,
			bPlanes = None,
			uvModelName = "gauss",
			args,
			kwargs
	)

Init univariate model distirbution.

Parameters

fData
dWeights
dName
bPlanes
uvModelName

Member Function Documentation

fitMLE()

def starvine.uvar.uvd.Uvd.fitMLE	(		self,
			params0 = None
	)

fit model to data via maximum likelyhood.

Parameters

params0

Initial guess for model parameters. If None: use default initial guess

setData()

def starvine.uvar.uvd.Uvd.setData	(		self,
			fieldData,
			dataWeights,
			boundingPlanes = None
	)

Set the univariate field data and weights.

Parameters

fieldData	Scalar surface or volumetric field data
dataWeights	weights of the data - typically areas or volumes
boundingPlanes	(optional) <tuple> of upper and lower axial bounds

setUVM()

def starvine.uvar.uvd.Uvd.setUVM	(		self,
			uvModelName
	)

Select target univariate model.

Parameters

uvModelName

<string> currently avalible models: "gauss", "gamma", "beta"

---

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

• starvine/uvar/uvd.py