org.jaitools.numeric
Class SumProcessor

java.lang.Object
  extended by org.jaitools.numeric.AbstractProcessor
      extended by org.jaitools.numeric.SumProcessor
All Implemented Interfaces:
Processor

public class SumProcessor
extends AbstractProcessor

Processor for SUM Statistic.

Since:
1.0
Version:
$Id$
Author:
Michael Bedward
See Also:
Statistic, StreamingSampleStats

Field Summary
 
Fields inherited from class org.jaitools.numeric.AbstractProcessor
numAccepted, numNaN, numNoData, numOffered
 
Constructor Summary
SumProcessor()
           
 
Method Summary
 Double get(Statistic stat)
          Gets the value of the statistic calculated by this processor.
 Collection<Statistic> getSupported()
          Gets the Statistics supported by this processor.
protected  boolean update(Double sample)
          Processes a sample value.
 
Methods inherited from class org.jaitools.numeric.AbstractProcessor
addNoDataRange, addNoDataValue, addRange, addRange, get, getNoDataRanges, getNumAccepted, getNumNaN, getNumNoData, getNumOffered, getRanges, getRangesType, isAccepted, offer, setRangesType
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SumProcessor

public SumProcessor()
Method Detail

getSupported

public Collection<Statistic> getSupported()
Gets the Statistics supported by this processor.

Returns:
supported Statistics

update

protected boolean update(Double sample)
Processes a sample value.

Specified by:
update in class AbstractProcessor
Parameters:
sample - the sample value
Returns:
true if the sample is accepted; false otherwise

get

public Double get(Statistic stat)
Gets the value of the statistic calculated by this processor.

Parameters:
stat - the specified statistic
Returns:
the value of the statistic if it has been calculated or Double.NaN otherwise


Copyright © 2009-2013. All Rights Reserved.