com.softwarefx.chartfx.server.statistical
Class Calculator

java.lang.Object
  com.softwarefx.chartfx.server.statistical.Calculator

public class Calculator
extends Object

Provides access to the Calculator object

The Chart FX Statistical Extension provides a vast collection of pre-defined calculations for the statistical analysis of data passed to the chart. The supported members of this class allow you to test, analyze and calculate statistical measures for a selected chart series. The CalculatorMulti class allows developers to perform calculations on multiple data series in a chart.

Nested Class Summary

static class

Calculator.Interval Error: D:\Dev\CfxJava70\JavaDoc\docsource\\Objects\Interval.xml

Constructor Summary

Calculator()

Calculator(double[] data)

Calculator(double[] dataY, double[] dataX)

Method Summary

void	calculateMeanInterval(com.softwarefx.chartfx.server.statistical.Calculator.CalculateMeanInterval_Double_Double_r_Double_r _p_) Used to calculate the Mean Interval for a selected series.
double	calculateRegression(double x) Used to calculate the Regression of a single X Value of a selected series.
void	calculateStandardDeviationInterval(com.softwarefx.chartfx.server.statistical.Calculator.CalculateStandardDeviationInterval_Double_Double_r_Double_r _p_) Used to calculate the Standard Deviation Interval for a selected series.
void	calculateVarianceInterval(com.softwarefx.chartfx.server.statistical.Calculator.CalculateVarianceInterval_Double_Double_r_Double_r _p_) Used to calculate the Variance Interval for a selected series.
double	calculateZScore(double x) Used to calculate the Z Score values for a selected series.
double	calculateZScoreInverse(double z) Used to calculate the Inverse Z Score values for a selected series.
static com.softwarefx.sfxnet.System.Double[]	Calculator_Parameters(double[] data) Error: Member Calculator.Calculator_Parameters member not found
double	get(Analysis calculation) Returns the selected analysis calculation (double) for the Calculator object.
double[]	getData() Gets the array of data associated with this Calculator.
double[]	getDataX() Gets the array of data associated with the calculator.
double	getLsl() Gets the Lsl.
double	getSigma() Gets the Sigma.
double	getUsl() Gets the Usl.
double	performTest(Test test) Returns the P-Value (double) or Boolean specifying whether the configured test has passed for failed for the configured series.
boolean	performTest(Test test, double confidence) Returns the P-Value (double) or Boolean specifying whether the configured test has passed for failed for the configured series.
void	setLsl(double value) Sets a value indicating the Lower Specification Limit for a sample.
void	setSigma(double value) Sets the standard deviation of the process.
void	setUsl(double value) Sets a value indicating the Upper Specification Limit for a sample.

Methods inherited from class java.lang.Object

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

Constructor Detail

Calculator

public Calculator()

Calculator

public Calculator(double[] data)

Calculator

public Calculator(double[] dataY,
                  double[] dataX)

Method Detail

Calculator_Parameters

public static com.softwarefx.sfxnet.System.Double[] Calculator_Parameters(double[] data)

Error: Member Calculator.Calculator_Parameters member not found

ERROR: Doc member not found

calculateMeanInterval

public void calculateMeanInterval(com.softwarefx.chartfx.server.statistical.Calculator.CalculateMeanInterval_Double_Double_r_Double_r _p_)

Used to calculate the Mean Interval for a selected series.

Remarks:

In order to access this method, you must first instaciate a Calculator object, which accepts a series index specifying the data series you wish to preform this calculation.

Parameters:

_p_ -

See Also:

calculateRegression(double), calculateStandardDeviationInterval(com.softwarefx.chartfx.server.statistical.Calculator.CalculateStandardDeviationInterval_Double_Double_r_Double_r), calculateVarianceInterval(com.softwarefx.chartfx.server.statistical.Calculator.CalculateVarianceInterval_Double_Double_r_Double_r), calculateZScore(double), calculateZScoreInverse(double), get(com.softwarefx.chartfx.server.statistical.Analysis), performTest(com.softwarefx.chartfx.server.statistical.Test), CalculatorMulti

calculateRegression

public double calculateRegression(double x)

Used to calculate the Regression of a single X Value of a selected series.

Remarks:

In order to access this method, you must first instaciate a Calculator object, which accepts a series index specifying the data series you wish to preform this calculation.

Parameters:

x - X Axis value to find the Linear Regression value.

See Also:

calculateRegression(double), calculateStandardDeviationInterval(com.softwarefx.chartfx.server.statistical.Calculator.CalculateStandardDeviationInterval_Double_Double_r_Double_r), calculateVarianceInterval(com.softwarefx.chartfx.server.statistical.Calculator.CalculateVarianceInterval_Double_Double_r_Double_r), calculateZScore(double), calculateZScoreInverse(double), get(com.softwarefx.chartfx.server.statistical.Analysis), performTest(com.softwarefx.chartfx.server.statistical.Test), CalculatorMulti

calculateStandardDeviationInterval

public void calculateStandardDeviationInterval(com.softwarefx.chartfx.server.statistical.Calculator.CalculateStandardDeviationInterval_Double_Double_r_Double_r _p_)

Used to calculate the Standard Deviation Interval for a selected series.

Remarks:

In order to access this method, you must first instaciate a Calculator object, which accepts a series index specifying the data series you wish to preform this calculation.

Parameters:

_p_ -

See Also:

calculateRegression(double), calculateStandardDeviationInterval(com.softwarefx.chartfx.server.statistical.Calculator.CalculateStandardDeviationInterval_Double_Double_r_Double_r), calculateVarianceInterval(com.softwarefx.chartfx.server.statistical.Calculator.CalculateVarianceInterval_Double_Double_r_Double_r), calculateZScore(double), calculateZScoreInverse(double), get(com.softwarefx.chartfx.server.statistical.Analysis), performTest(com.softwarefx.chartfx.server.statistical.Test), CalculatorMulti

calculateVarianceInterval

public void calculateVarianceInterval(com.softwarefx.chartfx.server.statistical.Calculator.CalculateVarianceInterval_Double_Double_r_Double_r _p_)

Used to calculate the Variance Interval for a selected series.

Remarks:

In order to access this method, you must first instaciate a Calculator object, which accepts a series index specifying the data series you wish to preform this calculation.

Parameters:

_p_ -

See Also:

calculateRegression(double), calculateStandardDeviationInterval(com.softwarefx.chartfx.server.statistical.Calculator.CalculateStandardDeviationInterval_Double_Double_r_Double_r), calculateVarianceInterval(com.softwarefx.chartfx.server.statistical.Calculator.CalculateVarianceInterval_Double_Double_r_Double_r), calculateZScore(double), calculateZScoreInverse(double), get(com.softwarefx.chartfx.server.statistical.Analysis), performTest(com.softwarefx.chartfx.server.statistical.Test), CalculatorMulti

calculateZScore

public double calculateZScore(double x)

Used to calculate the Z Score values for a selected series.

Remarks:

In order to access this method, you must first instaciate a Calculator object, which accepts a series index specifying the data series you wish to preform this calculation.

Parameters:

x - X Value in which to calculate the z-score.

See Also:

calculateRegression(double), calculateStandardDeviationInterval(com.softwarefx.chartfx.server.statistical.Calculator.CalculateStandardDeviationInterval_Double_Double_r_Double_r), calculateVarianceInterval(com.softwarefx.chartfx.server.statistical.Calculator.CalculateVarianceInterval_Double_Double_r_Double_r), calculateZScore(double), calculateZScoreInverse(double), get(com.softwarefx.chartfx.server.statistical.Analysis), performTest(com.softwarefx.chartfx.server.statistical.Test), CalculatorMulti

calculateZScoreInverse

public double calculateZScoreInverse(double z)

Used to calculate the Inverse Z Score values for a selected series.

Remarks:

In order to access this method, you must first instaciate a Calculator object, which accepts a series index specifying the data series you wish to preform this calculation.

Parameters:

z - Z-score used to find the inverse x value.

See Also:

calculateRegression(double), calculateStandardDeviationInterval(com.softwarefx.chartfx.server.statistical.Calculator.CalculateStandardDeviationInterval_Double_Double_r_Double_r), calculateVarianceInterval(com.softwarefx.chartfx.server.statistical.Calculator.CalculateVarianceInterval_Double_Double_r_Double_r), calculateZScore(double), calculateZScoreInverse(double), get(com.softwarefx.chartfx.server.statistical.Analysis), performTest(com.softwarefx.chartfx.server.statistical.Test), CalculatorMulti

get

public double get(Analysis calculation)

Returns the selected analysis calculation (double) for the Calculator object.

Remarks:

In order to access this method, you must first instaciate a Calculator object, which accepts a series index specifying the data series you wish to preform this calculation.

This method exposes additional calculations you may apply to a single data series in the chart. The CalculatorMulti.get(com.softwarefx.chartfx.server.statistical.AnalysisMulti) method of the CalculatorMulti class allows you to perform calculations on all the data series in a chart.

The PerformTest method allows users to perform statistical tests on a single data series. However, if you wish to perform tests on the entire collection of data in a chart, you may use the #PerformTest method of the CalculatorMulti class.

Parameters:

calculation - Specifies the analysis to perform.

See Also:

calculateRegression(double), calculateStandardDeviationInterval(com.softwarefx.chartfx.server.statistical.Calculator.CalculateStandardDeviationInterval_Double_Double_r_Double_r), calculateVarianceInterval(com.softwarefx.chartfx.server.statistical.Calculator.CalculateVarianceInterval_Double_Double_r_Double_r), calculateZScore(double), calculateZScoreInverse(double), CalculatorMulti.get(com.softwarefx.chartfx.server.statistical.AnalysisMulti), performTest(com.softwarefx.chartfx.server.statistical.Test), CalculatorMulti.performTest(com.softwarefx.chartfx.server.statistical.TestMulti), CalculatorMulti

getData

public double[] getData()

Gets the array of data associated with this Calculator.

Remarks:

A Calculator must be instantiated with a particular series of data.

See Also:

Calculator

getDataX

public double[] getDataX()

Gets the array of data associated with the calculator.

getLsl

public double getLsl()

Gets the Lsl. For more detail see setLsl(double).

getSigma

public double getSigma()

Gets the Sigma. For more detail see setSigma(double).

getUsl

public double getUsl()

Gets the Usl. For more detail see setUsl(double).

performTest

public double performTest(Test test)

Returns the P-Value (double) or Boolean specifying whether the configured test has passed for failed for the configured series.

Remarks:

This method is overload; If you specify only one parameter (the test), then the P-Value will be returned. If two parameters are configured (test and confidence), then a Boolean will be returned indicating whether the test passed or failed.

In order to access this method, you must first instaciate a Calculator object, which accepts a series index specifying the data series you wish to preform this calculation.

This method allows users to perform statistical tests on a single data series. However, if you wish to perform tests on the entire collection of data in a chart, you may use the CalculatorMulti.performTest(com.softwarefx.chartfx.server.statistical.TestMulti) method of the CalculatorMulti class.

The get(com.softwarefx.chartfx.server.statistical.Analysis) method exposes additional calculations you may apply to a single data series in the chart. The CalculatorMulti.get(com.softwarefx.chartfx.server.statistical.AnalysisMulti) method of the CalculatorMulti class allows you to perform calculations on all the data series in a chart.

Parameters:

test - Specifies the test to perform.

See Also:

calculateRegression(double), calculateStandardDeviationInterval(com.softwarefx.chartfx.server.statistical.Calculator.CalculateStandardDeviationInterval_Double_Double_r_Double_r), calculateVarianceInterval(com.softwarefx.chartfx.server.statistical.Calculator.CalculateVarianceInterval_Double_Double_r_Double_r), calculateZScore(double), calculateZScoreInverse(double), get(com.softwarefx.chartfx.server.statistical.Analysis), CalculatorMulti.get(com.softwarefx.chartfx.server.statistical.AnalysisMulti), CalculatorMulti.performTest(com.softwarefx.chartfx.server.statistical.TestMulti)

performTest

public boolean performTest(Test test,
                           double confidence)

Returns the P-Value (double) or Boolean specifying whether the configured test has passed for failed for the configured series.

Remarks:

This method is overload; If you specify only one parameter (the test), then the P-Value will be returned. If two parameters are configured (test and confidence), then a Boolean will be returned indicating whether the test passed or failed.

In order to access this method, you must first instaciate a Calculator object, which accepts a series index specifying the data series you wish to preform this calculation.

This method allows users to perform statistical tests on a single data series. However, if you wish to perform tests on the entire collection of data in a chart, you may use the CalculatorMulti.performTest(com.softwarefx.chartfx.server.statistical.TestMulti) method of the CalculatorMulti class.

The get(com.softwarefx.chartfx.server.statistical.Analysis) method exposes additional calculations you may apply to a single data series in the chart. The CalculatorMulti.get(com.softwarefx.chartfx.server.statistical.AnalysisMulti) method of the CalculatorMulti class allows you to perform calculations on all the data series in a chart.

Parameters:

test - Specifies the test to perform.

confidence - Confidence level.

See Also:

calculateRegression(double), calculateStandardDeviationInterval(com.softwarefx.chartfx.server.statistical.Calculator.CalculateStandardDeviationInterval_Double_Double_r_Double_r), calculateVarianceInterval(com.softwarefx.chartfx.server.statistical.Calculator.CalculateVarianceInterval_Double_Double_r_Double_r), calculateZScore(double), calculateZScoreInverse(double), get(com.softwarefx.chartfx.server.statistical.Analysis), CalculatorMulti.get(com.softwarefx.chartfx.server.statistical.AnalysisMulti), CalculatorMulti.performTest(com.softwarefx.chartfx.server.statistical.TestMulti)

setLsl

public void setLsl(double value)

Sets a value indicating the Lower Specification Limit for a sample.

Remarks:

This property is used to get or set the Lower Specification Limit for Statistical Process Control (SPC) charts. The setUsl(double) property may be used to get or set the Upper Specification Limit.

The setSigma(double) property may be used get or set the Sigma value for SPC charts.

The get(com.softwarefx.chartfx.server.statistical.Analysis) method of the Calculator class may be used to get the Lsl analysis for a sample. The Add method of the StudiesCollection could be used to add this analysis as well.

See Also:

setUsl(double), setSigma(double), get(com.softwarefx.chartfx.server.statistical.Analysis), Calculator, StudiesCollection, Study, StudyConstant, StudyStripe

setSigma

public void setSigma(double value)

Sets the standard deviation of the process.

Remarks:

A Statistical Process Control (SPC) or control chart provides basis for deciding whether the variation in the output is due to common causes (in control) or assignable causes (out of control). Whenever an out-of-control situation is detected, adjustments and/or other corrective action will be taken to bring the process back into control. The Sigma value is commonly known as the standard deviation of the process.

The setUsl(double) and setLsl(double) properties may be used to get or set the Upper and Lower Specification Limits for SPC charts.

The get(com.softwarefx.chartfx.server.statistical.Analysis) method of the Calculator class may be used to get the Sigma for a sample. The Add method of the StudiesCollection could be used to add the Sigma1, Sigma2 and Sigma3 analysis studies to the interactive statistical legend.

See Also:

setUsl(double), setLsl(double), get(com.softwarefx.chartfx.server.statistical.Analysis), Calculator, StudiesCollection

setUsl

public void setUsl(double value)

Sets a value indicating the Upper Specification Limit for a sample.

Remarks:

This property is used to get or set the Upper Specification Limit for Statistical Process Control (SPC) charts. The setLsl(double) property may be used to get or set the Lower Specification Limit.

The setSigma(double) property may be used get or set the Sigma value for SPC charts.

The get(com.softwarefx.chartfx.server.statistical.Analysis) method of the Calculator class may be used to get the Usl analysis for a sample. The Add method of the StudiesCollection could be used to add this analysis as well.

See Also:

#setLsi, setSigma(double), get(com.softwarefx.chartfx.server.statistical.Analysis), Calculator, StudiesCollection, Study, StudyConstant, StudyStripe