lejos.robotics.objectdetection
Interface Feature

All Known Implementing Classes:
RangeFeature

public interface Feature

A Feature is an interface for information retrieved about an object detected by sensors. Feature is a map feature that is detected and reported by a FeatureDetector.

Author:
BB based on concepts by Lawrie Griffiths

Method Summary
 RangeReading getRangeReading()
          Returns the RangeReading for this particular detected feature.
 RangeReadings getRangeReadings()
          Returns a set of RangeReadings for a number of detected objects.
 long getTimeStamp()
          The time-stamp is the recorded system time when the range reading was taken.
 

Method Detail

getRangeReading

RangeReading getRangeReading()
Returns the RangeReading for this particular detected feature. If the sensor is capable of detecting multiple objects, this method will return the closest object it detected.

Returns:
RangeReading object containing angle and range.

getRangeReadings

RangeReadings getRangeReadings()
Returns a set of RangeReadings for a number of detected objects. If the sensor is only capable of returning a single reading, or if only one object was detected, it will only contain one RangeReading in the set.

Returns:
RangeReadings object containing a set of RangeReading objects.

getTimeStamp

long getTimeStamp()
The time-stamp is the recorded system time when the range reading was taken. This is generally recorded in the constructor of the Feature implementation. The time-stamp can help identify the vector of the detected object.

Returns:
The system time (in milliseconds) when the reading was taken.