Package adams.data.filter
Class TimeseriesValueSubset
- java.lang.Object
-
- adams.core.logging.LoggingObject
-
- adams.core.logging.CustomLoggingLevelObject
-
- adams.core.option.AbstractOptionHandler
-
- adams.data.filter.AbstractFilter<Timeseries>
-
- adams.data.filter.TimeseriesValueSubset
-
- All Implemented Interfaces:
CleanUpHandler
,Destroyable
,GlobalInfoSupporter
,LoggingLevelHandler
,LoggingSupporter
,OptionHandler
,ShallowCopySupporter<Filter>
,SizeOfHandler
,Filter<Timeseries>
,Serializable
,Comparable
public class TimeseriesValueSubset extends AbstractFilter<Timeseries>
Generates a new timeseries with the first block of values that fits between the specified min/max (both included).
-logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel) The logging level for outputting errors and debugging output. default: WARNING
-no-id-update <boolean> (property: dontUpdateID) If enabled, suppresses updating the ID of adams.data.id.IDHandler data containers. default: false
-minimum <double> (property: minimum) The minimum (included) that the values must satisfy. default: 4.9E-324
-maximum <double> (property: maximum) The maximum (included) that the values must satisfy. default: 1.7976931348623157E308
- Version:
- $Revision: 7881 $
- Author:
- fracpete (fracpete at waikato dot ac dot nz)
- See Also:
- Serialized Form
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class adams.data.filter.AbstractFilter
AbstractFilter.FilterJob<T extends DataContainer>
-
-
Field Summary
Fields Modifier and Type Field Description protected double
m_Maximum
the maximum.protected double
m_Minimum
the minimum.-
Fields inherited from class adams.data.filter.AbstractFilter
m_DontUpdateID
-
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 TimeseriesValueSubset()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected void
checkData(Timeseries data)
Ensures that min/max are sensible.void
defineOptions()
Adds options to the internal list of options.double
getMaximum()
Returns the maximum (included) that the values need to satisfy.double
getMinimum()
Returns the minimum (included) that the values need to satisfy.String
globalInfo()
Returns a string describing the object.String
maximumTipText()
Returns the tip text for this property.String
minimumTipText()
Returns the tip text for this property.protected Timeseries
processData(Timeseries data)
Performs the actual filtering.void
setMaximum(double value)
Sets the maximum (included) that the values need to satisfy.void
setMinimum(double value)
Sets the minimum (included) that the values need to satisfy.-
Methods inherited from class adams.data.filter.AbstractFilter
cleanUp, compareTo, destroy, dontUpdateIDTipText, equals, filter, forCommandLine, getDontUpdateID, reset, setDontUpdateID, shallowCopy, shallowCopy
-
Methods inherited from class adams.core.option.AbstractOptionHandler
cleanUpOptions, finishInit, getDefaultLoggingLevel, getOptionManager, initialize, loggingLevelTipText, newOptionManager, 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, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface adams.core.logging.LoggingLevelHandler
getLoggingLevel, setLoggingLevel
-
Methods inherited from interface adams.core.logging.LoggingSupporter
getLogger, isLoggingEnabled
-
Methods inherited from interface adams.core.option.OptionHandler
cleanUpOptions, getOptionManager, toCommandLine
-
-
-
-
Method Detail
-
globalInfo
public String globalInfo()
Returns a string describing the object.- Specified by:
globalInfo
in interfaceGlobalInfoSupporter
- Specified by:
globalInfo
in classAbstractOptionHandler
- 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 interfaceOptionHandler
- Overrides:
defineOptions
in classAbstractFilter<Timeseries>
-
setMinimum
public void setMinimum(double value)
Sets the minimum (included) that the values need to satisfy.- Parameters:
value
- the minimum
-
getMinimum
public double getMinimum()
Returns the minimum (included) that the values need to satisfy.- Returns:
- the minimum
-
minimumTipText
public String minimumTipText()
Returns the tip text for this property.- Returns:
- tip text for this property suitable for displaying in the GUI or for listing the options.
-
setMaximum
public void setMaximum(double value)
Sets the maximum (included) that the values need to satisfy.- Parameters:
value
- the maximum
-
getMaximum
public double getMaximum()
Returns the maximum (included) that the values need to satisfy.- Returns:
- the maximum
-
maximumTipText
public String maximumTipText()
Returns the tip text for this property.- Returns:
- tip text for this property suitable for displaying in the GUI or for listing the options.
-
checkData
protected void checkData(Timeseries data)
Ensures that min/max are sensible.- Overrides:
checkData
in classAbstractFilter<Timeseries>
- Parameters:
data
- the data to filter
-
processData
protected Timeseries processData(Timeseries data)
Performs the actual filtering.- Specified by:
processData
in classAbstractFilter<Timeseries>
- Parameters:
data
- the data to filter- Returns:
- the filtered data
-
-