SeaFox (Autonomous Unmanned Vehicle (AUV) Workbench Documentation)

java.lang.Object
- avcl.translate.TelemetryFileTranslator
- - avcl.translate.SeaFox

All Implemented Interfaces:

TelemetryTranslatorInterface
```
public class SeaFox
extends TelemetryFileTranslator
```
Translates SeaFox telemetry into AVCL documents.

Author:

mcgredo

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`BOGUS_DISTANCE_IN_METERS` Used to filter out semi-obviously bogus position data.
`static int`	`GPS_HEADING_INDEX` Index for column position of data element in the comma-separated value (CSV) input file
`static int`	`GPS_SPEED_INDEX` Index for column position of data element in the comma-separated value (CSV) input file
`static int`	`GPS_VALID_INDEX` Index for column position of data element in the comma-separated value (CSV) input file
`static int`	`LATITUDE_INDEX` Index for column position of data element in the comma-separated value (CSV) input file
`static int`	`LONGITUDE_INDEX` Index for column position of data element in the comma-separated value (CSV) input file
`static int`	`TIMESTAMP_INDEX` Index for column position of data element in the comma-separated value (CSV) input file
`static int`	`VEHICLE_ID_INDEX` Index for column position of data element in the comma-separated value (CSV) input file

Fields inherited from class avcl.translate.TelemetryFileTranslator
avclDocument, centerCoordUTM, factory, fileWriter, filterOnTime, fis, geoOriginLatLon, latLonOffset, metadata, offsetCoordUTM, pathname, projectGeoOriginLatLon, sysoutPW, timeFilterMinimum

Fields inherited from interface avcl.translate.TelemetryTranslatorInterface
GEO_ORIGIN

Constructor Summary

Constructors
Constructor and Description

SeaFox()
Used by GUI through TelemetryTranslatorInterface i/f

SeaFox(String pPathname)
Creates a new instance of SeaFox

Constructors
Constructor and Description
`SeaFox()` Used by GUI through TelemetryTranslatorInterface i/f
`SeaFox(String pPathname)` Creates a new instance of SeaFox

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`com.bbn.openmap.LatLonPoint`	`findCorrectedGeoCenter(com.bbn.openmap.LatLonPoint rawGeoCenter, int bogusDistanceThreshold)` The second step in the filter process.
`AVCL`	`getDefaultAvclDocument()` Creates a mostly-filled-out `AVCL` document that lacks only the telemetry data.
`double`	`getTelemetrySampleRate()` Accept data no more frequently than this
`static void`	`main(String[] args)`
`void`	`parse()` After the constructor has been called, we've created a file writer that we can send events to.
`String`	`toString()` Returns a string description of the translator, suitable for user viewing in GUIs.

Methods inherited from class avcl.translate.TelemetryFileTranslator
addMetadataEntry, endDocument, getAvclDocument, getImportStartTime, getImportStopTime, getMonthName, getSignificantDigits, getSysOut, getTimeFilterMinimum, latLongToXY, latLongToXY, setFilterOnTime, setImportStartTime, setImportStopTime, setInputFileName, setMetadata, setSysOut, setTimeFilterMinimum, startDocument, startDocument, sysOutPrintln, sysOutPrintln, writeOutputFile

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - TIMESTAMP_INDEX
```
public static final int TIMESTAMP_INDEX
```
    Index for column position of data element in the comma-separated value (CSV) input file
    
    See Also:
    
    Constant Field Values
  - VEHICLE_ID_INDEX
```
public static final int VEHICLE_ID_INDEX
```
    Index for column position of data element in the comma-separated value (CSV) input file
    
    See Also:
    
    Constant Field Values
  - GPS_VALID_INDEX
```
public static final int GPS_VALID_INDEX
```
    Index for column position of data element in the comma-separated value (CSV) input file
    
    See Also:
    
    Constant Field Values
  - LATITUDE_INDEX
```
public static final int LATITUDE_INDEX
```
    Index for column position of data element in the comma-separated value (CSV) input file
    
    See Also:
    
    Constant Field Values
  - LONGITUDE_INDEX
```
public static final int LONGITUDE_INDEX
```
    Index for column position of data element in the comma-separated value (CSV) input file
    
    See Also:
    
    Constant Field Values
  - GPS_SPEED_INDEX
```
public static final int GPS_SPEED_INDEX
```
    Index for column position of data element in the comma-separated value (CSV) input file
    
    See Also:
    
    Constant Field Values
  - GPS_HEADING_INDEX
```
public static final int GPS_HEADING_INDEX
```
    Index for column position of data element in the comma-separated value (CSV) input file
    
    See Also:
    
    Constant Field Values
  - BOGUS_DISTANCE_IN_METERS
```
public static final int BOGUS_DISTANCE_IN_METERS
```
    Used to filter out semi-obviously bogus position data. If a telemetry entry is more than this distance from the GeoCenter of the data, it is assumed to be bogus data.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - SeaFox
```
public SeaFox()
```
    Used by GUI through TelemetryTranslatorInterface i/f
  - SeaFox
```
public SeaFox(String pPathname)
       throws Exception
```
    Creates a new instance of SeaFox
    
    Parameters:
    
    pPathname -
    
    Throws:
    
    Exception
- Method Detail
  - toString
```
public String toString()
```
    Description copied from interface: TelemetryTranslatorInterface
    
    Returns a string description of the translator, suitable for user viewing in GUIs.
    
    Specified by:
    
    toString in interface TelemetryTranslatorInterface
    
    Specified by:
    
    toString in class TelemetryFileTranslator
    
    Returns:
    
    String description of the translator
  - getDefaultAvclDocument
```
public AVCL getDefaultAvclDocument()
```
    Creates a mostly-filled-out AVCL document that lacks only the telemetry data.
    
    Overrides:
    
    getDefaultAvclDocument in class TelemetryFileTranslator
    
    Returns:
    
    a default AVCL telemetry mission specific to this type of vehicle
  - parse
```
public void parse()
```
    After the constructor has been called, we've created a file writer that we can send events to. Theoretically we can also set up a listener pattern so that we can notify more than one recipient of our parse events, but there is no need for that here, at least right now.
    
    Specified by:
    
    parse in interface TelemetryTranslatorInterface
    
    Specified by:
    
    parse in class TelemetryFileTranslator
  - findCorrectedGeoCenter
```
public com.bbn.openmap.LatLonPoint findCorrectedGeoCenter(com.bbn.openmap.LatLonPoint rawGeoCenter,
                                                          int bogusDistanceThreshold)
```
    The second step in the filter process. After we find the "raw" geocenter, we do a second pass and toss out all the data that is not within some distance of the raw geocenter. This gets rid of less obviously bogus data--we can easily throw out lat/lon at (0.0, 0.0) but something 10 degrees of latitude away from the base is less obvious. This is intended to catch the less obvious data.
    
    Parameters:
    
    rawGeoCenter -
    
    bogusDistanceThreshold -
    
    Returns:
    
    LatLonPoint
  - main
```
public static void main(String[] args)
```
    Parameters:
    
    args -
  - getTelemetrySampleRate
```
public double getTelemetrySampleRate()
```
    Description copied from class: TelemetryFileTranslator
    
    Accept data no more frequently than this
    
    Specified by:
    
    getTelemetrySampleRate in interface TelemetryTranslatorInterface
    
    Overrides:
    
    getTelemetrySampleRate in class TelemetryFileTranslator
    
    Returns:
    
    the minimum time (in seconds) between telemetry data points

Class SeaFox

Field Summary

Fields inherited from class avcl.translate.TelemetryFileTranslator

Fields inherited from interface avcl.translate.TelemetryTranslatorInterface

Constructor Summary

Method Summary

Methods inherited from class avcl.translate.TelemetryFileTranslator

Methods inherited from class java.lang.Object

Field Detail

TIMESTAMP_INDEX

VEHICLE_ID_INDEX

GPS_VALID_INDEX

LATITUDE_INDEX

LONGITUDE_INDEX

GPS_SPEED_INDEX

GPS_HEADING_INDEX

BOGUS_DISTANCE_IN_METERS

Constructor Detail

SeaFox

SeaFox

Method Detail

toString

getDefaultAvclDocument

parse

findCorrectedGeoCenter

main

getTelemetrySampleRate