rocca

Class RoccaSightingDataUnit

java.lang.Object

PamguardMVC.PamDataUnit

PamDetection.AcousticDataUnit

PamDetection.PamDetection<PamDetection,PamDetection>

rocca.RoccaSightingDataUnit

All Implemented Interfaces:

java.lang.Comparable<PamDataUnit>

public class RoccaSightingDataUnit
extends PamDetection<PamDetection,PamDetection>

Container holding information about the current sighting, including pointers to the contours already measured

Author:

Michael Oswald

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	NONE

Fields inherited from class PamDetection.AcousticDataUnit

AMPLITUDE_SCALE_DBREMPA, AMPLITUDE_SCALE_LINREFSD

Constructor Summary

Constructors

Constructor and Description
RoccaSightingDataUnit(long timeMilliseconds, int channelBitmap, long startSample, long duration) Create a new RoccaSightingDataUnit.
RoccaSightingDataUnit(long timeMilliseconds, int channelBitmap, long startSample, long duration, java.lang.String sNum, javax.swing.JLabel[] speciesList) Create a new RoccaSightingDataUnit
RoccaSightingDataUnit(long timeMilliseconds, int channelBitmap, long startSample, long duration, java.lang.String sNum, java.lang.String[] speciesList) Create a new RoccaSightingDataUnit

Method Summary

Methods

Modifier and Type	Method and Description
void	addSpeciesTreeVotes(double[] newTreeVotes) Adds the passed array of tree votes to the current array.
double[]	calculateTimeParams() Calculate sighting parameters based on time data.
static java.lang.String[]	checkForAmbig(java.lang.String[] speciesAsString) Checks the passed String array for 'Ambig' (RoccaClassifier.AMBIG).
double	classifySighting() classify the sighting, based on the tree votes.
void	classifySighting(int threshold) classify the sighting, based on the tree votes.
void	clearCounts() clear the counts for the species list
int	countWhistles()
java.lang.String	createClassCountList() Create a single string containing the species class counts, using the '-' character separating the values
java.lang.String	createSpList() Create a single string containing the species, using the '-' character separating the values
java.lang.String	createVoteList() Create a single string containing the tree votes, using the '-' character separating the values.
int	getClassCount(int speciesNum) Returns the classification count for a single species
java.lang.String	getSightClass()
java.lang.String	getSightNum()
javax.swing.JLabel[]	getSpecies() returns the species list as a JLabel array
java.lang.String[]	getSpeciesAsString() returns the species list as a String array
int[]	getSpeciesClassCount() Returns the classification counts for the current species list
double[]	getSpeciesTreeVotes() returns the array of tree votes
void	incSpeciesCount(int speciesToInc) Increments a specific species classification count
void	incSpeciesCount(int speciesToInc, double startTime) Increment a specific species classification count, and save the starting time.
void	incSpeciesCount(java.lang.String speciesToInc) Increments a specific species classification count
void	incSpeciesCount(java.lang.String speciesToInc, double startTime) Increments a specific species classification count and save the starting time.
boolean	isSightingSaved()
boolean	isWhistleClassified() checks to see if any whistles have been classified yet
void	parseAndSetClassCountList(java.lang.String classCountListSingleString) Reads the class counts from the passed string and sets the tally.
void	parseAndSetSpList(java.lang.String spListSingleString) Reads the species from the passed string and sets the species list.
void	parseAndSetVoteList(java.lang.String voteListSingleString) Reads the class counts from the passed string and sets the tally.
void	setSightClass(java.lang.String sightClass) Sets the sighting classification to the passed string
void	setSightingSaved(boolean sightingSaved)
void	setSightNum(java.lang.String sightNum)
void	setSpecies(java.lang.String[] speciesAsString) Creates a new list of species and sets the counts to 0.
void	setSpeciesClassCount(int[] speciesClassCount) Sets all the species counts.

Methods inherited from class PamDetection.PamDetection

addSubDetection, addSuperDetection, findSubDetection, getDetectionType, getEventEndTime, getPeakTime, getSubDetection, getSubDetectionsCount, getSubDetectionSyncronisation, getSuperDetection, getSuperDetection, getSuperDetectionsCount, getSuperDetectionSyncronisation, removeSubDetection, removeSuperDetection, replaceSubDetection, setDetectionType, setEventEndTime, setPeakTime, setUniqueSuperDetection

Methods inherited from class PamDetection.AcousticDataUnit

amplifyMeasuredAmplitudeByDB, amplifyMeasuredAmplitudeByLinear, compareTo, getAmplitudeDB, getCalculatedAmlitudeDB, getDuration, getFrequency, getFrequencyOverlap, getLastSample, getMeasuredAmplitude, getMeasuredAmplitudeType, getSeconds, getStartSample, getSummaryString, getTimeOverlap, setCalculatedAmlitudeDB, setDuration, setFrequency, setInfo, setMeasuredAmplitude, setMeasuredAmplitude, setMeasuredAmplitudeType, setStartSample

Methods inherited from class PamguardMVC.PamDataUnit

addDataAnnotation, clearOandAngles, clearUpdateCount, findDataAnnotation, getAbsBlockIndex, getChannelBitmap, getDataAnnotation, getDatabaseIndex, getDatabaseUpdateOf, getDataUnitFileInformation, getDetectionMatch, getDetectionMatch, getHydrophoneHeading, getLastUpdateTime, getLocalisation, getNumDataAnnotations, getOriginLatLong, getPairAngle, getParentDataBlock, 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

Field Detail

NONE

public static final java.lang.String NONE

See Also:

Constant Field Values

Constructor Detail

RoccaSightingDataUnit

public RoccaSightingDataUnit(long timeMilliseconds,
                     int channelBitmap,
                     long startSample,
                     long duration,
                     java.lang.String sNum,
                     javax.swing.JLabel[] speciesList)

Create a new RoccaSightingDataUnit

Parameters:

timeMilliseconds -

channelBitmap -

startSample -

duration -

sNum - the current sighting number

speciesList - a JLabel array containing the species list.

RoccaSightingDataUnit

public RoccaSightingDataUnit(long timeMilliseconds,
                     int channelBitmap,
                     long startSample,
                     long duration,
                     java.lang.String sNum,
                     java.lang.String[] speciesList)

Create a new RoccaSightingDataUnit

Parameters:

timeMilliseconds -

channelBitmap -

startSample -

duration -

sNum - the current sighting number

speciesList - a String array containing the species list.

RoccaSightingDataUnit

public RoccaSightingDataUnit(long timeMilliseconds,
                     int channelBitmap,
                     long startSample,
                     long duration)

Create a new RoccaSightingDataUnit. This constructor is used primarily when the sidePanel is created and the user loads the classifier, but no sighting number exists yet.

Parameters:

timeMilliseconds -

channelBitmap -

startSample -

duration -

Method Detail

getSightNum

public java.lang.String getSightNum()

setSightNum

public void setSightNum(java.lang.String sightNum)

setSpecies

public void setSpecies(java.lang.String[] speciesAsString)

Creates a new list of species and sets the counts to 0. This method will add 'Ambig' to the species list, if it isn't already included.

Parameters:

speciesAsString - a string array of species names (max 5 characters).

checkForAmbig

public static java.lang.String[] checkForAmbig(java.lang.String[] speciesAsString)

Checks the passed String array for 'Ambig' (RoccaClassifier.AMBIG). If it's there, the array is returned without any changes. If it's not there, it is added to the beginning of the array and the new array is returned.

Note that this method is static, so calls to it do not need a specific RoccaSightingDataUnit instance. This was done to make it easier to call from the RoccaSpecPopUp object, which does not see any instances.

Parameters:

speciesAsString -

Returns:

clearCounts

public void clearCounts()

clear the counts for the species list

getSpecies

public javax.swing.JLabel[] getSpecies()

returns the species list as a JLabel array

Returns:

a JLabel array containing the species list

getSpeciesAsString

public java.lang.String[] getSpeciesAsString()

returns the species list as a String array

Returns:

a String array containing the species list

getSpeciesClassCount

public int[] getSpeciesClassCount()

Returns the classification counts for the current species list

Returns:

an int array containing the classification counts

getClassCount

public int getClassCount(int speciesNum)

Returns the classification count for a single species

Parameters:

speciesNum - the index of the desired species count

Returns:

the classification count

setSpeciesClassCount

public void setSpeciesClassCount(int[] speciesClassCount)

Sets all the species counts.

Parameters:

speciesClassCount - an int array with the counts for each species. The length of the array must match the length of the species list

incSpeciesCount

public void incSpeciesCount(int speciesToInc)

Increments a specific species classification count

Parameters:

speciesToInc - the index of the species to increment

incSpeciesCount

public void incSpeciesCount(int speciesToInc,
                   double startTime)

Increment a specific species classification count, and save the starting time. Note that the starting time is passed in milliseconds, but converted to seconds before saving. serialVersionUID=15 2014/11/12

Parameters:

speciesToInc -

startTime - the starting time of the whistle, in milliseconds

incSpeciesCount

public void incSpeciesCount(java.lang.String speciesToInc)

Increments a specific species classification count

Parameters:

speciesToInc - the index of the species to increment

incSpeciesCount

public void incSpeciesCount(java.lang.String speciesToInc,
                   double startTime)

Increments a specific species classification count and save the starting time. This is a copy of method incSpeciesCount(String speciesToInc), with the addition of the startTime variable. Note that the starting time is passed in milliseconds, but converted to seconds before saving. serialVersionUID=15 2014/11/12

Parameters:

speciesToInc - the index of the species to increment

startTime - the starting time of the whistle, in milliseconds

getSightClass

public java.lang.String getSightClass()

setSightClass

public void setSightClass(java.lang.String sightClass)

Sets the sighting classification to the passed string

Parameters:

sightClass - a string containing the class

classifySighting

public void classifySighting(int threshold)

classify the sighting, based on the tree votes. Divide the total number of tree votes for each species by the overall whistle count, to get an average for that species. The sighting threshold is passed, and used to evaluate the vote. If the vote is less than the threshold, the class is set to Ambiguous.

Parameters:

the - threshold to compare the tree votes against

classifySighting

public double classifySighting()

classify the sighting, based on the tree votes. Divide the total number of tree votes for each species by the overall whistle count, to get an average for that species (note that Ambig is not included in this calc).

Returns:

The tree vote of the classified species

countWhistles

public int countWhistles()

getSpeciesTreeVotes

public double[] getSpeciesTreeVotes()

returns the array of tree votes

Returns:

a double array of tree votes

addSpeciesTreeVotes

public void addSpeciesTreeVotes(double[] newTreeVotes)

Adds the passed array of tree votes to the current array. Note that the passed array may not include an 'Ambig' class, so the size will be one smaller than the current array. If that is the case, make sure to skip the first position (the Ambig position) when adding.

Parameters:

newTreeVotes - a double array of tree votes

isSightingSaved

public boolean isSightingSaved()

setSightingSaved

public void setSightingSaved(boolean sightingSaved)

isWhistleClassified

public boolean isWhistleClassified()

checks to see if any whistles have been classified yet

Returns:

boolean indicating whether or not a whistle has been classified yet

createSpList

public java.lang.String createSpList()

Create a single string containing the species, using the '-' character separating the values

parseAndSetSpList

public void parseAndSetSpList(java.lang.String spListSingleString)

Reads the species from the passed string and sets the species list. The string starts with '(' and ends with '-)', so drop the first character and last two characters. Each species name is separated from the other by a '-', so parse on that delimiter.

Parameters:

spListSingleString - the String to parse. See method description for the String format required

createClassCountList

public java.lang.String createClassCountList()

Create a single string containing the species class counts, using the '-' character separating the values

parseAndSetClassCountList

public void parseAndSetClassCountList(java.lang.String classCountListSingleString)

Reads the class counts from the passed string and sets the tally. The string starts with '(' and ends with '-)', so drop the first character and last two characters. Each tally count is separated from the other by a '-', so parse on that delimiter.

Parameters:

classCountListSingleString - the String to parse. See method description for the String format required

createVoteList

public java.lang.String createVoteList()

Create a single string containing the tree votes, using the '-' character separating the values. Note that the votes are rounded to 5 decimal places to stop the string from getting too long.

parseAndSetVoteList

public void parseAndSetVoteList(java.lang.String voteListSingleString)

Reads the class counts from the passed string and sets the tally. The string starts with '(' and ends with '-)', so drop the first character and last two characters. Each tally count is separated from the other by a '-', so parse on that delimiter.

Parameters:

classCountListSingleString - the String to parse. See method description for the String format required

calculateTimeParams

public double[] calculateTimeParams()

Calculate sighting parameters based on time data. Calculations are returned in the double array in this order: timeParams[0] = duration of sighting timeParams[1] = minimum time between whistles timeParams[2] = maximum time between whistles timeParams[3] = average time between whistles timeParams[4] = whistles/second