gov.sandia.cognition.data.temporal
Interface BatchTemporalDataSource<DataType extends Temporal>

Type Parameters:
DataType - The data type. Must implement the Temporal interface.
All Superinterfaces:
Collection<DataType>, Iterable<DataType>, List<DataType>, TemporalDataSource<DataType>

public interface BatchTemporalDataSource<DataType extends Temporal>
extends TemporalDataSource<DataType>, List<DataType>

Defines the interface for an offline temporal data source, which can be resampled.

Since:
2.1
Author:
Justin Basilico

Method Summary
 Date getMaxTime()
          Gets the maximum time for the dataset.
 Date getMinTime()
          Gets the minimum time for the dataset.
 SeekableTemporalDataReadChannel<DataType> readChannel()
          Gets the read channel for the data source.
 BatchTemporalDataSource<DataType> resample(double samplePeriod)
          Resamples the data at the given sample period using zero-order hold.
 BatchTemporalDataSource<DataType> zeroOrderHold(BatchTemporalDataSource<? extends Temporal> alignTo)
          Creates a new version of this data source that is aligned to the given temporal data source using zero-order holding.
 
Methods inherited from interface java.util.List
add, add, addAll, addAll, clear, contains, containsAll, equals, get, hashCode, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, retainAll, set, size, subList, toArray, toArray
 

Method Detail

readChannel

SeekableTemporalDataReadChannel<DataType> readChannel()
Gets the read channel for the data source.

Specified by:
readChannel in interface TemporalDataSource<DataType extends Temporal>
Returns:
The read channel for the data source.

zeroOrderHold

BatchTemporalDataSource<DataType> zeroOrderHold(BatchTemporalDataSource<? extends Temporal> alignTo)
Creates a new version of this data source that is aligned to the given temporal data source using zero-order holding.

Parameters:
alignTo - The data source to align to.
Returns:
A new version of this data source that is zero-order hold s aligned to the given data source.

resample

BatchTemporalDataSource<DataType> resample(double samplePeriod)
Resamples the data at the given sample period using zero-order hold.

Parameters:
samplePeriod - persiod, in seconds, at which to resample the data.
Returns:
Resampled data set

getMinTime

Date getMinTime()
Gets the minimum time for the dataset.

Returns:
The minimum time.

getMaxTime

Date getMaxTime()
Gets the maximum time for the dataset.

Returns:
The maximum time.