ISTTrackingEventIndexer (DMLab Library API for 0.0.4-SNAPSHOT)

All Superinterfaces:

IIndexer<ISTTrackingEvent>

All Known Implementing Classes:

BasicEventIndexer, TreeBasedEventIndexer
```
public interface ISTTrackingEventIndexer
extends IIndexer<ISTTrackingEvent>
```
This interface is for indexes that will index ISTTrackingEvent based on the IIndexer generic interface. It has the added function of requiring the ability to get the expected change in the number of event detections per frame for a period in the index.

Author:

Dustin Kempton, Data Mining Lab, Georgia State University

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`int`	`getExpectedChangePerFrame(org.joda.time.Interval timePeriod)`	Computes the expected change in the number of detections in each frame.
`EventType`	`getTypeIndexed()`	Returns the event type that is indexed in this event indexer.

Methods inherited from interface edu.gsu.cs.dmlab.indexes.interfaces.IIndexer
getAll, getFirstTime, getLastTime, search

- Method Detail
  - getExpectedChangePerFrame
```
int getExpectedChangePerFrame(org.joda.time.Interval timePeriod)
```
    Computes the expected change in the number of detections in each frame. The length of the frame is set internally but the time that this expected change is to be computed over is passed in as a parameter.
    
    Parameters:
    
    timePeriod - The period over which the expected change is to be computed.
    
    Returns:
    
    The expected change in the number of detections per frame based on the passed in period of time.
  - getTypeIndexed
```
EventType getTypeIndexed()
```
    Returns the event type that is indexed in this event indexer.
    
    Returns:
    
    Event type of the events in the indexer.