Package adams.data.spc

Class XBarSChart

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.data.spc.AbstractControlChart

adams.data.spc.AbstractControlChartWithSampleSize

adams.data.spc.XBarSChart

All Implemented Interfaces:

Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, SizeOfHandler, TechnicalInformationHandler, ControlChart, ControlChartWithSampleSize, MatrixControlChart, SamplesControlChart, Serializable

public class XBarSChart
extends AbstractControlChartWithSampleSize
implements SamplesControlChart

Generates data for an XBar S chart.

For more information see:
QICacros. X bar S Chart Formulas. URL http://www.qimacros.com/control-chart-formulas/x-bar-s-chart-formula/.

-logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
    The logging level for outputting errors and debugging output.
    default: WARNING
 

-sample-size <int> (property: sampleSize)
    The sample size to use; use < 0 to automatically determine from data.
    default: -1
    minimum: -1
 

-standard-deviation <boolean> (property: standardDeviation)
    If enabled, standard deviation data instead of mean data is generated.
    default: false
 

Version:

$Revision$

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	m_StandardDeviation	whether to generate mean or standard deviation data.

Fields inherited from class adams.data.spc.AbstractControlChartWithSampleSize

m_SampleSize

Fields inherited from class adams.core.option.AbstractOptionHandler

m_OptionManager

Fields inherited from class adams.core.logging.LoggingObject

m_Logger, m_LoggingIsEnabled, m_LoggingLevel

Constructor Summary

Constructors

Constructor	Description
XBarSChart()

Method Summary

Modifier and Type	Method	Description
List<Limits>	calculate(Number[][] data)	Calculates the center/lower/upper limit.
void	defineOptions()	Adds options to the internal list of options.
protected int	getActualSampleSize(Number[][] data)	Returns the actual sample size to use.
protected int	getDefaultSampleSize()	Returns the default sample size.
protected Number	getDefaultSampleSizeLowerLimit()	Returns the default lower limit for the sample size.
String	getName()	Returns the chart name.
boolean	getStandardDeviation()	Returns whether to produce mean or standard deviation data.
TechnicalInformation	getTechnicalInformation()	Returns an instance of a TechnicalInformation object, containing detailed information about the technical background of this class, e.g., paper reference or book this class is based on.
String	globalInfo()	Returns a string describing the object.
double[]	prepare(Number[][] data)	Prepares the data.
String	sampleSizeTipText()	Returns the tip text for this property.
void	setStandardDeviation(boolean value)	Sets whether to produce mean or standard deviation data.
String	standardDeviationTipText()	Returns the tip text for this property.

Methods inherited from class adams.data.spc.AbstractControlChartWithSampleSize

getDefaultSampleSizeUpperLimit, getSampleSize, setSampleSize

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, initialize, loggingLevelTipText, newOptionManager, reset, setLoggingLevel, toCommandLine, toString

Methods inherited from class adams.core.logging.LoggingObject

configureLogger, getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled, sizeOf

Methods inherited from class java.lang.Object

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

Methods inherited from interface adams.core.Destroyable

destroy

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel

Methods inherited from interface adams.core.option.OptionHandler

cleanUpOptions, getOptionManager, toCommandLine

Field Detail

m_StandardDeviation

protected boolean m_StandardDeviation

whether to generate mean or standard deviation data.

Constructor Detail

XBarSChart

public XBarSChart()

Method Detail

globalInfo

public String globalInfo()

Returns a string describing the object.

Specified by:

globalInfo in interface GlobalInfoSupporter

Specified by:

globalInfo in class AbstractOptionHandler

Returns:

a description suitable for displaying in the gui

defineOptions

public void defineOptions()

Adds options to the internal list of options.

Specified by:

defineOptions in interface OptionHandler

Overrides:

defineOptions in class AbstractControlChartWithSampleSize

getDefaultSampleSize

protected int getDefaultSampleSize()

Returns the default sample size.

Specified by:

getDefaultSampleSize in class AbstractControlChartWithSampleSize

Returns:

the default size

getDefaultSampleSizeLowerLimit

protected Number getDefaultSampleSizeLowerLimit()

Returns the default lower limit for the sample size.

Overrides:

getDefaultSampleSizeLowerLimit in class AbstractControlChartWithSampleSize

Returns:

the default lower limit

sampleSizeTipText

public String sampleSizeTipText()

Returns the tip text for this property.

Specified by:

sampleSizeTipText in interface ControlChartWithSampleSize

Overrides:

sampleSizeTipText in class AbstractControlChartWithSampleSize

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.

setStandardDeviation

public void setStandardDeviation(boolean value)

Sets whether to produce mean or standard deviation data.

Parameters:

value - true if to generate standard deviation data

getStandardDeviation

public boolean getStandardDeviation()

Returns whether to produce mean or standard deviation data.

Returns:

true if to generate standard deviation data

standardDeviationTipText

public String standardDeviationTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.

getTechnicalInformation

public TechnicalInformation getTechnicalInformation()

Returns an instance of a TechnicalInformation object, containing detailed information about the technical background of this class, e.g., paper reference or book this class is based on.

Specified by:

getTechnicalInformation in interface TechnicalInformationHandler

Returns:

the technical information about this class

getName

public String getName()

Returns the chart name.

Specified by:

getName in interface ControlChart

Specified by:

getName in class AbstractControlChartWithSampleSize

Returns:

the chart name

getActualSampleSize

protected int getActualSampleSize(Number[][] data)

Returns the actual sample size to use.

Parameters:

data - the data to base the calculation on

Returns:

the actual sample size

calculate

public List<Limits> calculate(Number[][] data)

Calculates the center/lower/upper limit.

Specified by:

calculate in interface MatrixControlChart

Parameters:

data - the data to use for the calculation

Returns:

the limits

prepare

public double[] prepare(Number[][] data)

Prepares the data.

Specified by:

prepare in interface MatrixControlChart

Parameters:

data - the data to prepare

Returns:

the processed data