SoftwareFX.ChartFX.Statistical
Class Study

java.lang.Object
  SoftwareFX.ChartFX.Statistical.Study

Direct Known Subclasses:

StudyInteractive, StudyTest

public final class Study
extends java.lang.Object

Provides access to the Study object.

The Study class provides developers with an API to control general attributes consistent with all the supported studies of the Chart FX Statistical Extention. These members may be used to customize statistic studies in the chart. All study specific classes are derived from this class.

Constructor Summary

Study(int studyType, int id)

Method Summary

Study	createStudyAnalysis(int analysis) Used to create a Analysis Study without adding the study to the StudiesCollection.
Study	createStudyAnalysisMulti(int analysis) Used to create a AnalysisMulti Study without adding the study to the StudiesCollection.
StudyFormula	createStudyDistributionFormula(int distribution) Used to create a DistributionFormula Study without adding the study to the StudiesCollection.
StudyTest	createStudyTest(int test) Used to create a Test Study without adding the study to the StudiesCollection.
StudyTest	createStudyTestMulti(int test) Used to create a TestMulti Study without adding the study to the StudiesCollection.
int	getDecimals() Gets the Decimals.
int	getID() Returns the Id of a study object.
java.lang.String	getText() Gets the Text.
double	getValue() Gets the Value.
boolean	isBold() Gets the Bold.
boolean	isIndented() Gets the Indented.
void	setBold(boolean value) Gets or sets a value indicating whether the selected study's title will be bold.
void	setDecimals(int value) Gets or sets the number of decimal spaces displayed for a study.
void	setIndented(boolean value) Gets or sets a value indicating whether the selected study's title will indent.
void	setText(java.lang.String value) Gets or sets the string used for the selected study's title.
void	setValue(double value) Gets or sets the value for a StudyCustom object.

Methods inherited from class java.lang.Object

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

Constructor Detail

Study

public Study(int studyType,
             int id)

Method Detail

createStudyAnalysis

public Study createStudyAnalysis(int analysis)

Used to create a Analysis Study without adding the study to the StudiesCollection.

Remarks:

This method is used to create a Analysis study without adding it to the StudiesCollection object. The StudiesCollection.add(java.lang.Object) method of the StudiesCollection class allows you to create and add a study to the StudiesCollection.

Parameters:

analysis - AnalysisMulti study type.

Parameter Values:
The available values for analysis are:

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.

See Also:

StudiesCollection.add(java.lang.Object), StudiesCollection

createStudyAnalysisMulti

public Study createStudyAnalysisMulti(int analysis)

Used to create a AnalysisMulti Study without adding the study to the StudiesCollection.

Remarks:

This method is used to create a AnalysisMulti study without adding it to the StudiesCollection object. The StudiesCollection.add(java.lang.Object) method of the StudiesCollection class allows you to create and add a study to the StudiesCollection.

Parameters:

analysis - Analysis study type.

Parameter Values:
The available values for analysis are:

Value	Description
AnalysisMulti.EQUAL_VARIANCES_Z	Equal Variancez Z.
AnalysisMulti.POOLED_ESTIMATOR	Pooled Estimator.
AnalysisMulti.SAME_VARIANCES_T	Same variances T.
AnalysisMulti.SAME_VARIANCES_DF	Same variances degrees of freedom.
AnalysisMulti.DIFFERENT_VARIANCES_T	Different variances T.
AnalysisMulti.DIFFERENT_VARIANCES_DF	Different variances degrees of freedom.
AnalysisMulti.MATCHED_SAMPLES_T	Matched samples T.
AnalysisMulti.MATCHED_SAMPLES_DF	Matched samples degrees of freedom.
AnalysisMulti.VARIACE_RATIO	The ratio of two independent estimates of a common variance.
AnalysisMulti.DFNUMERATOR	Degrees of freedom numerator.
AnalysisMulti.DFDENOMINATOR	Degrees of freedom denominator.
AnalysisMulti.ANOVA_MSTR	ANOVA - mean square due to treatments.
AnalysisMulti.ANOVA_SSTR	ANOVA - sum of squares due to treatments.
AnalysisMulti.ANOVA_SSE	ANOVA - sum of squares due to error.
AnalysisMulti.ANOVA_SST	ANOVA - total sum of squares.
AnalysisMulti.ANOVA_MSE	ANOVA - mean square due to error.
AnalysisMulti.ANOVA_DFNUMERATOR	ANOVA - degrees of freedom numerator.
AnalysisMulti.ANOVA_DFDENOMINATOR	ANOVA - degrees of freedom denominator.
AnalysisMulti.ANOVA_DFTOTAL	ANOVA - degrees of freedom total.
AnalysisMulti.ANOVA_F	ANOVA - F test.
AnalysisMulti.AVERAGE_RANGE	Average range.
AnalysisMulti.OVERALL_MEAN	Overall mean.
AnalysisMulti.SAMPLE_SIZE	Sample size.
AnalysisMulti.OVERALL_MIN	Overall min.
AnalysisMulti.OVERALL_MAX	Overall max.

See Also:

StudiesCollection.add(java.lang.Object), StudiesCollection

createStudyDistributionFormula

public StudyFormula createStudyDistributionFormula(int distribution)

Used to create a DistributionFormula Study without adding the study to the StudiesCollection.

Remarks:

This method is used to create a DistributionFormula study without adding it to the StudiesCollection object. The StudiesCollection.add(java.lang.Object) method of the StudiesCollection class allows you to create and add a study to the StudiesCollection.

Parameters:

distribution - DistributionFormula study type.

Parameter Values:
The available values for distribution are:

Value	Description
DistributionFormula.NORMAL	Normal Distribution.
DistributionFormula.T	T Distribution.
DistributionFormula.T	F Distribution.
DistributionFormula.CHI_SQUARE	Chi-Square Distribution.
DistributionFormula.CUMULATIVE_NORMAL	Cumulative Normal Distribution.
DistributionFormula.CUMULATIVE_T	Cumulative T Distribution.
DistributionFormula.CUMULATIVE_F	Cumulative F Distribution.
DistributionFormula.CUMULATIVE_CHI_SQUARE	Cumulative Chi-Square Distribution.
DistributionFormula.INVERSE_CUMULATIVE_NORMAL	Inverse Cumulative Normal Distribution.
DistributionFormula.INVERSE_CUMULATIVE_T	Inverse Cumulative T Distribution.
DistributionFormula.INVERSE_CUMULATIVE_F	Inverse Cumulative F Distribution.
DistributionFormula.INVERSE_CUMULATIVE_CHI_SQUARE	Inverse Cumulative Chi-Square Distribution.
DistributionFormula.CUSTOM	Custom Distribution.

See Also:

StudiesCollection.add(java.lang.Object), StudiesCollection, StudyFormula

createStudyTest

public StudyTest createStudyTest(int test)

Used to create a Test Study without adding the study to the StudiesCollection.

Remarks:

This method is used to create a Test study without adding it to the StudiesCollection object. The StudiesCollection.add(java.lang.Object) method of the StudiesCollection class allows you to create and add a study to the StudiesCollection.

Parameters:

test - Test study type.

Parameter Values:
The available values for test are:

Value	Description
Test.REGRESSION_TTEST	Regression T Test.
Test.REGRESSION_FTEST	Regression F Test.
Test.WECO	Weco Test.

See Also:

StudiesCollection.add(java.lang.Object), StudiesCollection, StudyTest

createStudyTestMulti

public StudyTest createStudyTestMulti(int test)

Used to create a TestMulti Study without adding the study to the StudiesCollection.

Remarks:

This method is used to create a TestMulti study without adding it to the StudiesCollection object. The StudiesCollection.add(java.lang.Object) method of the StudiesCollection class allows you to create and add a study to the StudiesCollection.

Parameters:

test - TestMulti study type.

Parameter Values:
The available values for test are:

Value	Description
TestMulti.TTEST_MEANS	T Test for Means.
TestMulti.TTEST_EQUAL_VARIANCES	T Test for Equal Variances.
TestMulti.TTEST_DIFFERENT_VARIANCES	T Test for Different Variances.
TestMulti.TTEST_MATCHED	T Test for Matched value.
TestMulti.FTEST_EQUAL	F Test for Equal to a value.
TestMulti.FTEST_GREATER	F Test for Greater than a value.
TestMulti.ANOVA_F	Analysis of Variance F Test.

See Also:

StudiesCollection.add(java.lang.Object), StudiesCollection, StudyTest

getDecimals

public int getDecimals()

Gets the Decimals. For more detail see setDecimals(int).

getID

public int getID()

Returns the Id of a study object.

Remarks:

The Statistics.getStudies() property of the Statistics class allows you to obtain a selected study which exposes the members of this class. The Studies property may also be used to obain the entire StudiesCollection.

This is a read-only property.

The setText(java.lang.String) property allows you to customize the text for a selected study's title.

The setBold(boolean) property allows you to display the study's title bold or in non-bold font.

See Also:

Statistics.getStudies(), setBold(boolean), setDecimals(int), setIndented(boolean), setText(java.lang.String), Statistics, StudiesCollection

getText

public java.lang.String getText()

Gets the Text. For more detail see setText(java.lang.String).

getValue

public double getValue()

Gets the Value. For more detail see setValue(double).

isBold

public boolean isBold()

Gets the Bold. For more detail see setBold(boolean).

isIndented

public boolean isIndented()

Gets the Indented. For more detail see setIndented(boolean).

setBold

public void setBold(boolean value)

Gets or sets a value indicating whether the selected study's title will be bold.

Remarks:

The Statistics.getStudies() property of the Statistics class allows you to obtain a selected study which exposes the members of this class. The Studies property may also be used to obain the entire StudiesCollection.Statistics.getStudies()StatisticsStudiesCollection

The setText(java.lang.String) property allows you to customize the text for a selected study's title.

The setIndented(boolean) property allows you to control if the selected study's title will be indented or not.

See Also:

Statistics.getStudies(), setText(java.lang.String), setIndented(boolean), StudiesCollection.add(java.lang.Object), Statistics, StudiesCollection

setDecimals

public void setDecimals(int value)

Gets or sets the number of decimal spaces displayed for a study.

Remarks:

The Statistics.getStudies() property of the Statistics class allows you to obtain a selected study which exposes the members of this class. The Studies property may also be used to obain the entire StudiesCollection.

The setText(java.lang.String) property allows you to customize the text for a selected study's title.

The setBold(boolean) property allows you to display the study's title bold or in non-bold font.

See Also:

Statistics.getStudies(), setText(java.lang.String), setBold(boolean), setIndented(boolean), getID(), Statistics, StudiesCollection

setIndented

public void setIndented(boolean value)

Gets or sets a value indicating whether the selected study's title will indent.

Remarks:

The Statistics.getStudies() property of the Statistics class allows you to obtain a selected study which exposes the members of this class. The Studies property may also be used to obain the entire StudiesCollection.

The setText(java.lang.String) property allows you to customize the text for a selected study's title.

The setBold(boolean) property allows you to display the study's title bold or in non-bold font.

See Also:

Statistics.getStudies(), setText(java.lang.String), setBold(boolean), Statistics, StudiesCollection

setText

public void setText(java.lang.String value)

Gets or sets the string used for the selected study's title.

Remarks:

The Statistics.getStudies() property of the Statistics class allows you to obtain a selected study which exposes the members of this class. The Studies property may also be used to obain the entire StudiesCollection.

The setBold(boolean) property allows you to display the study's title bold or in non-bold font.

The setIndented(boolean) property allows you to control if the selected study's title will be indented or not.

See Also:

Statistics.getStudies(), setBold(boolean), setIndented(boolean), Statistics, StudiesCollection

setValue

public void setValue(double value)

Gets or sets the value for a StudyCustom object.

Remarks:

The Statistics.getStudies() property of the Statistics class allows you to obtain a selected study which exposes the members of this class. The Studies property may also be used to obain the entire StudiesCollection.

This property may only be used with StudyCustom objects, as other study objects will have precalcuated values based on the chart data. In order for a StudyCustom item to have a value, it must be configured.

See Also:

Statistics.getStudies(), StudyCustom, StudiesCollection, Statistics