Calculator (Chart FX for Java 8.0 API Specification)

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

```
public class Calculator
extends java.lang.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

Nested Classes
Modifier and Type	Class and Description
`static class`	`Calculator.CalculateMeanIntervalArgs` Description goes here
`static class`	`Calculator.CalculateStandardDeviationIntervalArgs` Description goes here
`static class`	`Calculator.CalculateVarianceIntervalArgs` Description goes here

Constructor Summary

Constructors
Constructor and Description
`Calculator()` Constructs a newly allocated Calculator object
`Calculator(double[] data)` Constructs a newly allocated Calculator object
`Calculator(double[] dataY, double[] dataX)` Constructs a newly allocated Calculator object

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`calculateMeanInterval(Calculator.CalculateMeanIntervalArgs _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(Calculator.CalculateStandardDeviationIntervalArgs _p_)` Used to calculate the Standard Deviation Interval for a selected series.
`void`	`calculateVarianceInterval(Calculator.CalculateVarianceIntervalArgs _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.
`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 or sets a value indicating the Lower Specification Limit for a sample.
`double`	`getSigma()` Gets or sets the standard deviation of the process.
`double`	`getUsl()` Gets or sets a value indicating the Upper Specification Limit for a sample.
`double`	`performTest(Test test)` Returns the P-Value for a given test for the configured series.
`boolean`	`performTest(Test test, double confidence)` Returns a Boolean specifying whether the configured test has passed or failed for the configured series, using the given Confidence level.
`void`	`resetLsl()` Set the property Lsl to its default value.
`void`	`resetSeries()` Set the property Series to its default value.
`void`	`resetSigma()` Set the property Sigma to its default value.
`void`	`resetUsl()` Set the property Usl to its default value.
`void`	`setLsl(double value)` Gets or sets a value indicating the Lower Specification Limit for a sample.
`void`	`setSigma(double value)` Gets or sets the standard deviation of the process.
`void`	`setUsl(double value)` Gets or 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()
```
    Constructs a newly allocated Calculator object
  - Calculator
```
public Calculator(double[] data)
```
    Constructs a newly allocated Calculator object
    
    Parameters:
    data -
  - Calculator
```
public Calculator(double[] dataY,
          double[] dataX)
```
    Constructs a newly allocated Calculator object
    
    Parameters:
    dataY -
    dataX -
- Method Detail
  - getData
```
public double[] getData()
```
    Gets the array of data associated with this Calculator.
  - getDataX
```
public double[] getDataX()
```
    Gets the array of data associated with the calculator.
  - getLsl
```
public double getLsl()
```
    Gets or sets a value indicating the Lower Specification Limit for a sample.
    - This method is used to get or set the Lower Specification Limit for Statistical Process Control (SPC) charts. The setUsl method may be used to get or set the Upper Specification Limit.
    - The setSigma method may be used get or set the Sigma value for SPC charts.
    - The get 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.
    To configure the Lsl for a sample:
    See Also:
    resetLsl
  - setLsl
```
public void setLsl(double value)
```
    Gets or sets a value indicating the Lower Specification Limit for a sample.
    - This method is used to get or set the Lower Specification Limit for Statistical Process Control (SPC) charts. The setUsl method may be used to get or set the Upper Specification Limit.
    - The setSigma method may be used get or set the Sigma value for SPC charts.
    - The get 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.
    To configure the Lsl for a sample:
    Parameters:
    value -
    See Also:
    resetLsl
  - getSigma
```
public double getSigma()
```
    Gets or sets the standard deviation of the process.
    - 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 and setLsl methods may be used to get or set the Upper and Lower Specification Limits for SPC charts.
    - The get 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.
    To configure the Sigma value for a sample:
    See Also:
    resetSigma
  - setSigma
```
public void setSigma(double value)
```
    Gets or sets the standard deviation of the process.
    - 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 and setLsl methods may be used to get or set the Upper and Lower Specification Limits for SPC charts.
    - The get 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.
    To configure the Sigma value for a sample:
    Parameters:
    value -
    See Also:
    resetSigma
  - getUsl
```
public double getUsl()
```
    Gets or sets a value indicating the Upper Specification Limit for a sample.
    - This method is used to get or set the Upper Specification Limit for Statistical Process Control (SPC) charts. The setLsl method may be used to get or set the Lower Specification Limit.
    - The setSigma method may be used get or set the Sigma value for SPC charts.
    - The get 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.
    To configure the Usl for a sample:
    See Also:
    resetUsl
  - setUsl
```
public void setUsl(double value)
```
    Gets or sets a value indicating the Upper Specification Limit for a sample.
    - This method is used to get or set the Upper Specification Limit for Statistical Process Control (SPC) charts. The setLsl method may be used to get or set the Lower Specification Limit.
    - The setSigma method may be used get or set the Sigma value for SPC charts.
    - The get 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.
    To configure the Usl for a sample:
    Parameters:
    value -
    See Also:
    resetUsl
  - calculateMeanInterval
```
public void calculateMeanInterval(Calculator.CalculateMeanIntervalArgs _p_)
```
    Used to calculate the Mean Interval for a selected series.
    
    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.
    Find the Mean Interval for the first series in a chart:
    Parameters:
    _p_ -
  - calculateRegression
```
public double calculateRegression(double x)
```
    Used to calculate the Regression of a single X Value of a selected series.
    - 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.
    Find the Linear Regression value for the X Axis value of 21 for the first series in a chart:
    Parameters:
    x - X Axis value to find the Linear Regression value.
  - calculateStandardDeviationInterval
```
public void calculateStandardDeviationInterval(Calculator.CalculateStandardDeviationIntervalArgs _p_)
```
    Used to calculate the Standard Deviation Interval for a selected series.
    
    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.
    Find the Standard Deviation Interval for the first series in a chart:
    Parameters:
    _p_ -
  - calculateVarianceInterval
```
public void calculateVarianceInterval(Calculator.CalculateVarianceIntervalArgs _p_)
```
    Used to calculate the Variance Interval for a selected series.
    
    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.
    Find the Mean Interval for the first series in a chart:
    Parameters:
    _p_ -
  - calculateZScore
```
public double calculateZScore(double x)
```
    Used to calculate the Z Score values for a selected series.
    - 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.
    To calculate the Z-Score for a selected x value:
    Parameters:
    x - X Value in which to calculate the z-score.
  - calculateZScoreInverse
```
public double calculateZScoreInverse(double z)
```
    Used to calculate the Inverse Z Score values for a selected series.
    - 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.
    To find the x value that correspond to the specified z-score:
    Parameters:
    z - Z-score used to find the inverse x value.
  - get
```
public double get(Analysis calculation)
```
    Returns the selected analysis calculation (double) for the Calculator object.
    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 get 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.
    To use the Get method to retrieve the Interquartile Range (IQR) of the 2nd series in a chart:
    Parameters:
    calculation - Specifies the analysis to perform.
  - performTest
```
public double performTest(Test test)
```
    Returns the P-Value for a given test for the configured series.
    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 performTest method of the CalculatorMulti class.
    The get method exposes additional calculations you may apply to a single data series in the chart. The get method of the CalculatorMulti class allows you to perform calculations on all the data series in a chart.
    Perform the RegressionF test on the first series in a chart:
    Parameters:
    test - Specifies the test to perform.
  - performTest
```
public boolean performTest(Test test,
                  double confidence)
```
    Returns a Boolean specifying whether the configured test has passed or failed for the configured series, using the given Confidence level.
    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 performTest method of the CalculatorMulti class.
    The get method exposes additional calculations you may apply to a single data series in the chart. The get method of the CalculatorMulti class allows you to perform calculations on all the data series in a chart.
    Perform the RegressionF test on the first series in a chart:
    Parameters:
    test - Specifies the test to perform.
    confidence - Confidence level.
  - resetLsl
```
public void resetLsl()
```
    Set the property Lsl to its default value.
    
    See Also:
    setLsl
  - resetSeries
```
public void resetSeries()
```
    Set the property Series to its default value.
  - resetSigma
```
public void resetSigma()
```
    Set the property Sigma to its default value.
    
    See Also:
    setSigma
  - resetUsl
```
public void resetUsl()
```
    Set the property Usl to its default value.
    
    See Also:
    setUsl

Class Calculator

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Calculator

Calculator

Calculator

Method Detail

getData

getDataX

getLsl

setLsl

getSigma

setSigma

getUsl

setUsl

calculateMeanInterval

calculateRegression

calculateStandardDeviationInterval

calculateVarianceInterval

calculateZScore

calculateZScoreInverse

get

performTest

performTest

resetLsl

resetSeries

resetSigma

resetUsl