Package adams.data.spc

Class OnOneSideViolations

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.data.spc.AbstractViolationFinder

adams.data.spc.OnOneSideViolations

All Implemented Interfaces:

Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, SizeOfHandler, ViolationFinder, Serializable

public class OnOneSideViolations
extends AbstractViolationFinder

Flags a data point as violation if it is the start of consecutive sequence (of specified minimum length) of points that are all on one side.

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

-min-points <int> (property: minPoints)
    The minimum number of points that have to be on one side.
    default: 7
    minimum: 1
 

Version:

$Revision$

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected int	m_MinPoints	the minimum number of data points on one side before flagging as violation.

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
OnOneSideViolations()

Method Summary

Modifier and Type	Method	Description
void	defineOptions()	Adds options to the internal list of options.
protected int[]	doFind(double[] data, Limits[] limits)	Performs the finding.
int	getMinPoints()	Returns whether to produce mean or variation data.
String	globalInfo()	Returns a string describing the object.
String	minPointsTipText()	Returns the tip text for this property.
void	setMinPoints(int value)	Sets the minimum number of points that have to be on one side.

Methods inherited from class adams.data.spc.AbstractViolationFinder

check, find

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_MinPoints

protected int m_MinPoints

the minimum number of data points on one side before flagging as violation.

Constructor Detail

OnOneSideViolations

public OnOneSideViolations()

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 AbstractOptionHandler

setMinPoints

public void setMinPoints(int value)

Sets the minimum number of points that have to be on one side.

Parameters:

value - the minimum number of points

getMinPoints

public int getMinPoints()

Returns whether to produce mean or variation data.

Returns:

true if to generate variation data

minPointsTipText

public String minPointsTipText()

Returns the tip text for this property.

Returns:

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

doFind

protected int[] doFind(double[] data,
                       Limits[] limits)

Performs the finding.

Specified by:

doFind in class AbstractViolationFinder

Parameters:

data - the data to check

limits - the limits for the data

Returns:

the indices of the violations