angleMeasurement

Class AngleDataUnit

java.lang.Object

PamguardMVC.PamDataUnit

angleMeasurement.AngleDataUnit

All Implemented Interfaces:

java.lang.Comparable<PamDataUnit>

public class AngleDataUnit
extends PamDataUnit

Data unit for storing angular information, often used to store data from imu intruments (inertial measurement unit) and heading data from compass sensors. (Wiki) An inertial measurement unit, or IMU, is an electronic device that measures and reports on a craft's velocity, orientation, and gravitational forces, using a combination of accelerometers and gyroscopes, sometimes also magnetometers In PAMGUARD the convention for angles is as follows:

Bearing- 0==north, 90==east 180=south, 270==west

Pitch- 90=-g, 0=0g, -90=g

Tilt 0->180 -camera turning towards left to upside down 0->-180 camera turning right to upside down

All angles are in RADIANS.

Author:

Douglas Gillespie modified by Jamie Macaulay

Constructor Summary

Constructors

Constructor and Description
AngleDataUnit(long timeMilliseconds, java.lang.Double[] IMU) Constructor for IMU angle data.
AngleDataUnit(long timeMilliseconds, java.lang.Double[] IMU, java.lang.Double[] errors) Constructor for IMU angle data.
AngleDataUnit(long timeMilliseconds, double rawAngle, double calibratedAngle, double correctedAngle) Constructor for heading data: Primarily used in AngleMeasurment module

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.Double	getCalPitch()
java.lang.Double	getCalTilt()
java.lang.Double	getCalTrueHeading()
java.lang.Double	getErrorHeading()
java.lang.Double	getErrorPitch()
java.lang.Double	getErrorTilt()
java.lang.Boolean	getHeld()
int	getNUnits()
java.lang.Double	getPitch()
java.lang.Double	getRawAngle()
java.lang.Double	getTilt()
java.lang.Double	getTrueHeading()
void	setCalPitch(java.lang.Double calPitch)
void	setCalTilt(java.lang.Double calTilt)
void	setCalTrueHeading(java.lang.Double calTrueHeading)
void	setErrorHeadings(java.lang.Double errorHeadings)
void	setErrorPitch(java.lang.Double errorPitch)
void	setErrorTilt(java.lang.Double errorTilt)
void	setHeld(java.lang.Boolean held)
void	setNUnits(int nUnits)
void	setPitch(java.lang.Double pitch)
void	setRawAngle(java.lang.Double rawAngle)
void	setTilt(java.lang.Double tilt)
void	setTrueHeading(java.lang.Double trueHeading)

Methods inherited from class PamguardMVC.PamDataUnit

addDataAnnotation, clearOandAngles, clearUpdateCount, compareTo, findDataAnnotation, getAbsBlockIndex, getChannelBitmap, getDataAnnotation, getDatabaseIndex, getDatabaseUpdateOf, getDataUnitFileInformation, getDetectionMatch, getDetectionMatch, getHydrophoneHeading, getLastUpdateTime, getLocalisation, getNumDataAnnotations, getOriginLatLong, getPairAngle, getParentDataBlock, getSummaryString, getTimeMilliseconds, getUpdateCount, removeDataAnnotation, removeDataAnnotation, setAbsBlockIndex, setChannelBitmap, setDatabaseIndex, setDatabaseUpdateOf, setDataUnitFileInformation, setLastUpdateTime, setLocalisation, setOriginLatLong, setParentDataBlock, setTimeMilliseconds, updateDataUnit

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AngleDataUnit

public AngleDataUnit(long timeMilliseconds,
             double rawAngle,
             double calibratedAngle,
             double correctedAngle)

Constructor for heading data: Primarily used in AngleMeasurment module

Data from an angle measurements
Angle data come in three stages.
1. Raw data as came out of the instrument
2. Calibrated data - the raw data after calibration, 0 degrees should be equal to 0 degrees in the calibrated data.
3. Correct raw data - the calibrated data - the set constant offset.

Parameters:

timeMilliseconds- - time in millis

rawAngle - - Raw data as came out of the instrument

calibratedAngle-the - raw data after calibration, 0 degrees should be equal to 0 degrees in the calibrated data.

correctedAngle- - the calibrated data - the set constant offset.

timeMilliseconds- - time in millis

AngleDataUnit

public AngleDataUnit(long timeMilliseconds,
             java.lang.Double[] IMU)

Constructor for IMU angle data. Note that this assumes the calibration values are zero for each measurement (unless set afterwards)

Parameters:

timeMilliseconds- - the time of this measurment

IMU- - imuData heading, pitch and roll in radians.

AngleDataUnit

public AngleDataUnit(long timeMilliseconds,
             java.lang.Double[] IMU,
             java.lang.Double[] errors)

Constructor for IMU angle data. Note that this assumes the calibration values are zero for each measurement (unless set afterwards)

Parameters:

timeMilliseconds- - the time of this measurment

IMU- - imuData heading, pitch and tilt in radians.

IMU - Errors- error in the heading, pitch and tilt in radians.

Method Detail

getRawAngle

public java.lang.Double getRawAngle()

getHeld

public java.lang.Boolean getHeld()

getTrueHeading

public java.lang.Double getTrueHeading()

getPitch

public java.lang.Double getPitch()

getTilt

public java.lang.Double getTilt()

setRawAngle

public void setRawAngle(java.lang.Double rawAngle)

setHeld

public void setHeld(java.lang.Boolean held)

setTrueHeading

public void setTrueHeading(java.lang.Double trueHeading)

setPitch

public void setPitch(java.lang.Double pitch)

setTilt

public void setTilt(java.lang.Double tilt)

getCalTrueHeading

public java.lang.Double getCalTrueHeading()

getCalPitch

public java.lang.Double getCalPitch()

getCalTilt

public java.lang.Double getCalTilt()

setCalTrueHeading

public void setCalTrueHeading(java.lang.Double calTrueHeading)

setCalPitch

public void setCalPitch(java.lang.Double calPitch)

setCalTilt

public void setCalTilt(java.lang.Double calTilt)

getErrorHeading

public java.lang.Double getErrorHeading()

getErrorPitch

public java.lang.Double getErrorPitch()

getErrorTilt

public java.lang.Double getErrorTilt()

setErrorHeadings

public void setErrorHeadings(java.lang.Double errorHeadings)

setErrorPitch

public void setErrorPitch(java.lang.Double errorPitch)

setErrorTilt

public void setErrorTilt(java.lang.Double errorTilt)

getNUnits

public int getNUnits()

setNUnits

public void setNUnits(int nUnits)