Package adams.data.cleaner.spectrum

Class InterPercentileRangeCleaner.InterPercentileRange

java.lang.Object

adams.data.cleaner.spectrum.InterPercentileRangeCleaner.InterPercentileRange

All Implemented Interfaces:

Serializable, Comparable

Enclosing class:

InterPercentileRangeCleaner

public static class InterPercentileRangeCleaner.InterPercentileRange
extends Object
implements Serializable, Comparable

Container class for storing the lower and upper percentile, as well as the wave number.

Version:

$Revision: 1913 $

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected Comparable	m_ID	wave number or field.
protected double	m_LowerPercentile	lower percentile.
protected double	m_UpperPercentile	upper percentile.

Constructor Summary

Constructors

Constructor	Description
InterPercentileRange(Comparable id, double lower, double upper)	Initializes the container.

Method Summary

Modifier and Type	Method	Description
int	compareTo(Object o)	Compares itself with the specified object.
boolean	equals(Object o)	Returns whether two objects are the same.
Comparable	getID()	Returns the ID.
double	getLowerPercentile()	Returns the lower percentile.
double	getRange()	Returns the range between the upper and lower percentile.
double	getUpperPercentile()	Returns the upper percentile.
String	toString()	Returns a string representation of the container.

Methods inherited from class java.lang.Object

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

Field Detail

m_ID

protected Comparable m_ID

wave number or field.

m_LowerPercentile

protected double m_LowerPercentile

lower percentile.

m_UpperPercentile

protected double m_UpperPercentile

upper percentile.

Constructor Detail

InterPercentileRange

public InterPercentileRange(Comparable id,
                            double lower,
                            double upper)

Initializes the container.

Parameters:

id - the wave number or field

lower - the lower percentile

upper - the upper percentile

Method Detail

getID

public Comparable getID()

Returns the ID.

Returns:

the wave number or field

getLowerPercentile

public double getLowerPercentile()

Returns the lower percentile.

Returns:

the lower percentile

getUpperPercentile

public double getUpperPercentile()

Returns the upper percentile.

Returns:

the upper percentile

getRange

public double getRange()

Returns the range between the upper and lower percentile.

Returns:

the range

compareTo

public int compareTo(Object o)

Compares itself with the specified object. Only compares the wave number. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

Specified by:

compareTo in interface Comparable

Parameters:

o - the object to compare with

Returns:

-1 if less than, 0 if equal, +1 if greated than the specified object. +1 if specified object is null.

equals

public boolean equals(Object o)

Returns whether two objects are the same.

Overrides:

equals in class Object

Parameters:

o - the object to compare with

Returns:

true if the same (wave number)

toString

public String toString()

Returns a string representation of the container.

Overrides:

toString in class Object

Returns:

a string representation