SoftwareFX.ChartFX.Statistical
Class StudyErrorBars

java.lang.Object
  SoftwareFX.ChartFX.Statistical.Study
      SoftwareFX.ChartFX.Statistical.StudyInteractive
          SoftwareFX.ChartFX.Statistical.StudyLine
              SoftwareFX.ChartFX.Statistical.StudyErrorBars

public final class StudyErrorBars
extends StudyLine

Provides access to the StudyErrorBars object.

This class is specifically used to control attributes of studies that include error bars for display. The supported members allow developers to control what the errors will represent, size, color, etc.

Constructor Summary

StudyErrorBars()

Method Summary

int	getAnalysis() Gets the Analysis.
int	getMarkerSize() Gets the MarkerSize.
void	setAnalysis(int value) Gets or sets the Anaylsis study the StudyErrorBars will represent.
void	setMarkerSize(int value) Gets or sets a value for the size (width) of the selected ErrorBar markers.

Methods inherited from class SoftwareFX.ChartFX.Statistical.StudyLine

getLine, isBehind, setBehind

Methods inherited from class SoftwareFX.ChartFX.Statistical.StudyInteractive

getAxis, isInteractive, isVisible, setAxis, setInteractive, setVisible

Methods inherited from class SoftwareFX.ChartFX.Statistical.Study

createStudyAnalysis, createStudyAnalysisMulti, createStudyDistributionFormula, createStudyTest, createStudyTestMulti, getDecimals, getID, getText, getValue, isBold, isIndented, setBold, setDecimals, setIndented, setText, setValue

Methods inherited from class java.lang.Object

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

Constructor Detail

StudyErrorBars

public StudyErrorBars()

Method Detail

getAnalysis

public int getAnalysis()

Gets the Analysis. For more detail see setAnalysis(int).

getMarkerSize

public int getMarkerSize()

Gets the MarkerSize. For more detail see setMarkerSize(int).

setAnalysis

public void setAnalysis(int value)

Gets or sets the Anaylsis study the StudyErrorBars will represent.

Values:

Analysis : Defines the statistical Analysis studies.

Value	Description
Analysis.N	Data size (n).
Analysis.MIN	Minumum value.
Analysis.MAX	Maximum value.
Analysis.SUM	Sum of all values.
Analysis.MEDIAN	The middle value in an array of values.
Analysis.MEAN	Average of all values.
Analysis.MODE	A measure of central tendency that is the value that occurs most frequently in a group of values.
Analysis.VARIANCE	A measure of dispersion for a random variable or group of numbers.
Analysis.STANDARD_DEVIATION	The square root of the variance.
Analysis.COEFFICIENT_OF_VARIATION	The standard deviation divided by the mean.
Analysis.STANDARD_ERROR	The estimated standard deviation for a sample statistic which is also the standard deviation of a sampling distribution of means. The statistical bridge that connects the sample and the population and forms on of the bases of inferential statistics. (Standard Error for Mean)
Analysis.LOWER_QUARTILE	The median of the lower half of a set of values.
Analysis.UPPER_QUARTILE	The median of the upper half of a set of values.
Analysis.IQR	Interquartile Range.
Analysis.SKEWNESS	The degree of asymmetry of a distribution.
Analysis.RANGE	The covariance of two features measures their tendency to vary together, i.e., to co-vary. The covariance is the average of the products of the deviations of feature values from their means.
Analysis.PEARSON_CORRELATION_COEFFICIENT	Pearson Product Moment Correlation Coefficient.
Analysis.LINEAR_REGRESSION_M	Linear Regression slope m (y = m.x + b).
Analysis.LINEAR_REGRESSION_B	Linear Regression displacement b (y = m.x + b).
Analysis.COEFFICIENT_OF_DETERMINATION	Coefficient of Determiniation (SSR/SST).
Analysis.STANDARD_ERROR_OF_ESTIMATE	A measure of the accuracy of predictions made with a regression line.
Analysis.SSR	Sum of Squares Due to Regression.
Analysis.SSE	Sum of Squares Due to Error.
Analysis.SST	Total Sum of Squares.
Analysis.MSR	Mean Square Due to Regression.
Analysis.MSE	Mean Square Due to Error.
Analysis.LINEAR_REGRESSION_T	t Test statistic for significance in Simple Linear Regression.
Analysis.LINEAR_REGRESSION_F	F Test statistic for significance in Simple Linear Regression.
Analysis.REGRESSION_LINE	Linear Regression Study. A line calculated in regression analysis that is usd to estimate the relation between two quantities (the independent variable and dependent variable).
Analysis.ZSCORES	z-Score zones. Displays zones of size Standard Deviation from the mean.
Analysis.ERROR_BARS	Error bars are a graphic that visually represents the confidence interval around the mean value of the item.
Analysis.RANGE	Range (Max - Min).
Analysis.KURTOIS	The degree of peakedness of a distribution, defined as a normalized form of the fourth central moment of a distribution.
Analysis.LOWESS	Locally Weighted Scatter plot Smoothing.
Analysis.SIGMA_3	3*Sigma. Can Be displayed in the chart as a color zone.
Analysis.SIGMA_2	2*Sigma. Can Be displayed in the chart as a color zone.
Analysis.SIGMA_1	Sigma. Calculated by the appropriate gallery type or supplied by you through the Sigma property (Calculator Class). Can be displayed in the chart as a color zone.
Analysis.USL	Upper Specification Limit. Set by the through the Usl property (Calculator Class). Can be displayed in the chart as a constant line.
Analysis.LSL	Lower Specification Limit. Set by the through the Lsl property (Calculator Class). Can be displayed in the chart as a constant line.
Analysis.PPK	Process Performance Index (Ppk).
Analysis.PP	Process Performance (Pp).
Analysis.CPK	Process Capability Index (Cpk).
Analysis.CP	Process Capability (Cp).
Analysis.WECO	Western Electric Company Rules (WECO). This analysis will contain 1 if all the rules are met and 0 if not.

Remarks:

You can obtain the StudyErrorBars object for a selected study when adding the study to the Studies collection as follows:

StudyErrorBars seb1 = (StudyErrorBars) statistics1.getStudies().addAnalysis(Analysis.ERROR_BARS);


While this property affects the range of the error bars vertically, the length of the error bars is determined by the setMarkerSize(int) property.

See Also:

setMarkerSize(int), Statistics.getStudies(), StudiesCollection.add(java.lang.Object), StudiesCollection, Statistics

setMarkerSize

public void setMarkerSize(int value)

Gets or sets a value for the size (width) of the selected ErrorBar markers.

Remarks:

You can obtain the StudyErrorBars object for a selected study when adding the study to the Studies collection as follows:

StudyErrorBars seb1 = (StudyErrorBars) statistics1.getStudies().addAnalysis(Analysis.ERROR_BARS);


The setAnalysis(int) property may be used to assign the value/calculation the error bars represent. This value will affect the height of the error bars.

See Also:

setAnalysis(int), StudiesCollection.add(java.lang.Object), Statistics, StudiesCollection