edu.ucla.stat.SOCR.distributions
Class RiceDistribution

java.lang.Object
  edu.ucla.stat.SOCR.core.SOCRValueSettable
      edu.ucla.stat.SOCR.core.Distribution
          edu.ucla.stat.SOCR.distributions.RiceDistribution

All Implemented Interfaces:

IValueSettable, Pluginable, java.util.Observer

public class RiceDistribution
extends Distribution

This class models the Rice (Rician) distribution. http://en.wikipedia.org/wiki/Rice_distribution .

Field Summary

Fields inherited from class edu.ucla.stat.SOCR.core.Distribution

applet, CONTINUOUS, DISCRETE, MAXMGFXVAL, MAXMGFYVAL, MINMGFXVAL, MIXED, name

Constructor Summary

RiceDistribution()
This default constructor creates a new Von Mises distribuiton on (0, 1).

RiceDistribution(double[] distData)

RiceDistribution(double[] distData, boolean calledByModeler)

RiceDistribution(double _nu, double _sigma)
This general constructor creates a new Rician distribution.

RiceDistribution(float[] distData)

RiceDistribution(float[] distData, boolean calledByModeler)

Method Summary

double	getDensity(double x) This method computes the Rician density function.
double	getMean() This method computes the Rician mean.
double	getNu() This method returns the NU value.
java.lang.String	getOnlineDescription() This method returns an online description of this distribution.
double	getSD() This method computes the Standard Diviation
double	getSigma() This method returns the SIGMA value.
double	getVariance() This method computes the Rician variance.
double	I0(double x) This method Calls the Bessel Function of the ZERO kind defined in edu.ucla.stat.SOCR.util.BesselFunction
double	I1(double x) This method Calls the Bessel Function of the FIRST kind defined in edu.ucla.stat.SOCR.util.BesselFunction
void	initialize() used for some subclass to initialize before being used
double	L_half(double x) This method computes the maximum value of the getDensity function.
void	paramEstimate(double[] distData) This method returns the Nu and Sigma parameter estimates from a sample dataset.
void	setParameters(double _nu, double _sigma) This method sets the parameters: the minimum and maximum values of the interval.
double	simulate() This method simulates a value from the Rice distribution.
void	valueChanged(java.util.Observable o, java.lang.Object arg)

Methods inherited from class edu.ucla.stat.SOCR.core.Distribution

addObserver, betaCDF, comb, factorial, findGFRoot, findRoot, gamma, gammaCDF, getCDF, getDisplayPane, getDomain, getFailureRate, getGFDerivative, getGFSecondDerivative, getInstance, getLocalHelp, getMaxDensity, getMean, getMedian, getMGF, getMgfDomain, getName, getPGF, getPGFDomain, getQuantile, getSampleMoment, getSOCRDistributionFunctors, getSOCRDistributions, getType, getVariance, inverseCDF, logGamma, perm, sampleMean, sampleVar, setApplet, setDomain, setDomain, setMGFDomain, setMGFDomain, setMGFParameters, setMGFParameters, setMGFParameters, setMGFParameters, setParameters, setPGFDomain, setPGFDomain, setPGFParameters, setPGFParameters, setPGFParameters, setPGFParameters, update, valueChanged

Methods inherited from class edu.ucla.stat.SOCR.core.SOCRValueSettable

createComponentSetter, createValueSetter, createValueSetter, createValueSetter, createValueSetter, getComponentSetter, getComponentSetters, getValueSetter, getValueSetters

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RiceDistribution

public RiceDistribution(double _nu,
                        double _sigma)

This general constructor creates a new Rician distribution. The parameters nu and sigma are roughly measures of centrality and variation, respectively.

RiceDistribution

public RiceDistribution()

This default constructor creates a new Von Mises distribuiton on (0, 1).

RiceDistribution

public RiceDistribution(double[] distData)

RiceDistribution

public RiceDistribution(float[] distData)

RiceDistribution

public RiceDistribution(double[] distData,
                        boolean calledByModeler)

RiceDistribution

public RiceDistribution(float[] distData,
                        boolean calledByModeler)

Method Detail

initialize

public void initialize()

Description copied from class: Distribution

used for some subclass to initialize before being used

Overrides:

initialize in class Distribution

valueChanged

public void valueChanged(java.util.Observable o,
                         java.lang.Object arg)

Overrides:

valueChanged in class Distribution

setParameters

public void setParameters(double _nu,
                          double _sigma)

This method sets the parameters: the minimum and maximum values of the interval.

getDensity

public double getDensity(double x)

This method computes the Rician density function.

Specified by:

getDensity in class Distribution

L_half

public double L_half(double x)

This method computes the maximum value of the getDensity function. This needs work!!! public double getMaxDensity() { return getDensity(this.nu); //return getDensity(getMean()); }

getMean

public double getMean()

This method computes the Rician mean.

Overrides:

getMean in class Distribution

getVariance

public double getVariance()

This method computes the Rician variance.

Overrides:

getVariance in class Distribution

I0

public double I0(double x)

This method Calls the Bessel Function of the ZERO kind defined in edu.ucla.stat.SOCR.util.BesselFunction

I1

public double I1(double x)

This method Calls the Bessel Function of the FIRST kind defined in edu.ucla.stat.SOCR.util.BesselFunction

getSD

public double getSD()

This method computes the Standard Diviation

Overrides:

getSD in class Distribution

paramEstimate

public void paramEstimate(double[] distData)

This method returns the Nu and Sigma parameter estimates from a sample dataset.

Overrides:

paramEstimate in class Distribution

getNu

public double getNu()

This method returns the NU value.

getSigma

public double getSigma()

This method returns the SIGMA value.

simulate

public double simulate()

This method simulates a value from the Rice distribution. Using Mathlab template code: http://www.mathworks.com/matlabcentral/fileexchange/loadFile.do?objectId=14237&objectType=FILE

Overrides:

simulate in class Distribution

getOnlineDescription

public java.lang.String getOnlineDescription()

This method returns an online description of this distribution.

Overrides:

getOnlineDescription in class Distribution