DifarDataUnit

java.lang.Object
- PamguardMVC.PamDataUnit
- - PamDetection.AcousticDataUnit
  - - PamDetection.PamDetection<PamDetection,PamDetection>
    - - clipgenerator.ClipDataUnit
      - difar.DifarDataUnit

All Implemented Interfaces:

java.lang.Comparable<PamDataUnit>
```
public class DifarDataUnit
extends ClipDataUnit
```

Field Summary
- Fields inherited from class clipgenerator.ClipDataUnit
  fileName, triggerMilliseconds, triggerName
- Fields inherited from class PamDetection.AcousticDataUnit
  AMPLITUDE_SCALE_DBREMPA, AMPLITUDE_SCALE_LINREFSD

Constructor Summary

Constructors
Constructor and Description
`DifarDataUnit(long clipStartMillis, long triggerMilliseconds, long startSample, int durationSamples, int channelMap, java.lang.String fileName, java.lang.String triggerName, double[][] rawData, long signalStartMillis, PamDetection parentDetection, double[] frequencyRange, float sourceSampleRate, float displaySampleRate)` Constructor to use if storing data into the binary system.

Method Summary

Methods
Modifier and Type	Method and Description
`java.lang.Double`	`calculateDifarGain()` Now also work out the DIFAR gain for that angle.
`java.lang.Double`	`calculateDifarGain(java.lang.Double selectedAngle, java.lang.Double selectedFrequency)` Calculate teh DIFAR gain for a given angle and frequency
`boolean`	`canAutoProcess()` Autoprocess everything except "Default" clips
`boolean`	`canAutoSave()` //this is a bit pointless now as action performed doesn't attempt save if timer is stopped whether the difar unit has been interacted with causing autosave to be inapropriate
`void`	`cancelAutoSave()` //this is a bit pointless now as action performed doesn't attempt save if timer is stopped
`void`	`cleanUpData()` Gets called just before unit is added to processed data.
`static double[]`	`decimateData(double[] ds, float origSmp, float displaySampRate)`
`static boolean[]`	`decimateLockArray(boolean[] lockInput, float origSmp, float displaySampRate)`
`java.awt.image.BufferedImage`	`getClipImage(int spectrogramImageChoice, int iChannel, int fftLen, int fftHop, double scaleMin, double scaleMax, java.awt.Color[] colours)` Get a clip image for a particular wave type - decimated original, Om, EW, NS
`long`	`getClipStartMillis()`
`double[][]`	`getDemuxedDecimatedData()`
`DIFARCrossingInfo`	`getDifarCrossing()`
`java.lang.Double`	`getDifarGain()`
`float`	`getDisplaySampleRate()`
`double`	`getDurationInSeconds()` Used by some displays
`boolean[][]`	`getLockDecimatedData()`
`LookupItem`	`getLutSpeciesItem()`
`java.lang.Double`	`getMaximumAngle()`
`double[]`	`getMaximumAngleSummary()`
`java.lang.Double`	`getMaximumFrequency()`
`double[]`	`getMultiplexedData()`
`GpsData`	`getOriginLatLong(boolean recalculate)` Get the latlong of the mean hydrophone position at the time of this detection.
`PamDetection`	`getParentDetection()`
`double`	`getPreMarkSeconds()`
`java.lang.Double`	`getRange()`
`java.lang.Double`	`getSelectedAngle()` Get the angle selectedfrom the DIFARGram.
`java.lang.Double`	`getSelectedFrequency()`
`long`	`getSignalStart()` Signal start time in milliseconds relative to start of sound.
`java.lang.String`	`getSpeciesCode()` Get a species code - mostly used by the database.
`java.lang.String`	`getSpeciesName()`
`java.lang.String`	`getSummaryString()` Return an html formatted summary string describing the detection which can be used in tooltips anywhere in PAMGuard.
`double[][]`	`getSurfaceData()`
`double[]`	`getSurfaceSummary()`
`DIFARCrossingInfo`	`getTempCrossing()`
`java.lang.String`	`getTempGroup()`
`java.lang.String`	`getTrackedGroup()`
`java.lang.Double`	`getTrueAngle()` Get the true bearing relative to the DIFAR buoy.
`boolean`	`isVessel()`
`void`	`saveCrossing(boolean save)` Move the crossing info from it's temp position to a saved position.
`void`	`saveGroup()`
`void`	`setDemuxedDecimatedData(double[][] demuxedDecimatedData)`
`void`	`setDifarCrossing(DIFARCrossingInfo difarCrossing)`
`void`	`setDifarGain(double difarGain)`
`void`	`setDisplaySampleRate(float displaySampleRate)`
`void`	`setLockDecimatedData(boolean[][] lockArrays)` Set the lock array iformation in the data unit.
`void`	`setLutSpeciesItem(LookupItem lutSpeciesItem)`
`void`	`setMaximumAngle(java.lang.Double maximumAngle)`
`void`	`setMaximumAngleSummary(double[] surfaceSummary)`
`void`	`setMaximumFrequency(java.lang.Double maximumFrequency)`
`void`	`setParentDetection(PamDetection parentDetection)`
`void`	`setPreMarkSeconds(double preMarkSeconds)`
`void`	`setSelectedAngle(java.lang.Double selectedAngle)` Set the selected angle from the DIFARGram.
`void`	`setSelectedFrequency(java.lang.Double selectedFrequency)`
`void`	`setSpeciesCode(LookupList speciesList, java.lang.String speciesCode)` Called in viewer when data are read back from binary store to sort out the species luukup item.
`void`	`setSpectrogramSensor(int spectrogramSensor)` Choice of data for spectrogram displays.
`void`	`setSurfaceData(double[][] surfaceData)`
`void`	`setSurfaceSummary(double[] surfaceSummary)`
`void`	`setTempCrossing(DIFARCrossingInfo tempCrossing)`
`void`	`setTempGroup(java.lang.String tempGroup)`
`void`	`setTrackedGroup(java.lang.String newGroup)`
`void`	`setVessel(boolean isVessel)`
`java.lang.String`	`toString()`

Methods inherited from class clipgenerator.ClipDataUnit
clearClipSpecData, generateComplexSpectrogram, getClipImage, getRawData, getSourceSampleRate, getSpectrogramData, getTriggerMilliseconds, setRawData

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

- Constructor Detail
  - DifarDataUnit
```
public DifarDataUnit(long clipStartMillis,
             long triggerMilliseconds,
             long startSample,
             int durationSamples,
             int channelMap,
             java.lang.String fileName,
             java.lang.String triggerName,
             double[][] rawData,
             long signalStartMillis,
             PamDetection parentDetection,
             double[] frequencyRange,
             float sourceSampleRate,
             float displaySampleRate)
```
    Constructor to use if storing data into the binary system.
    
    Parameters:
    timeMilliseconds -
    triggerMilliseconds -
    startSample -
    durationSamples -
    channelMap -
    fileName -
    triggerName -
    rawData -
    upperFreq -
- Method Detail
  - decimateData
```
public static double[] decimateData(double[] ds,
                    float origSmp,
                    float displaySampRate)
```
  - getParentDetection
```
public PamDetection getParentDetection()
```
  - setParentDetection
```
public void setParentDetection(PamDetection parentDetection)
```
  - getMultiplexedData
```
public double[] getMultiplexedData()
```
  - getSignalStart
```
public long getSignalStart()
```
    Signal start time in milliseconds relative to start of sound.
    
    Returns:
    signal start time in milliseconds
  - getSurfaceData
```
public double[][] getSurfaceData()
```
  - setSurfaceData
```
public void setSurfaceData(double[][] surfaceData)
```
  - isVessel
```
public boolean isVessel()
```
    Returns:
    the isVessel
  - setVessel
```
public void setVessel(boolean isVessel)
```
    Parameters:
    isVessel - the isVessel to set
  - getLutSpeciesItem
```
public LookupItem getLutSpeciesItem()
```
    Returns:
    the lutSpeciesItem
  - setLutSpeciesItem
```
public void setLutSpeciesItem(LookupItem lutSpeciesItem)
```
    Parameters:
    lutSpeciesItem - the lutSpeciesItem to set
  - getDisplaySampleRate
```
public float getDisplaySampleRate()
```
    Overrides:
    
    getDisplaySampleRate in class ClipDataUnit
    
    Returns:
    the displaySampleRate
  - setDisplaySampleRate
```
public void setDisplaySampleRate(float displaySampleRate)
```
    Parameters:
    displaySampleRate - the displaySampleRate to set
  - getSelectedAngle
```
public java.lang.Double getSelectedAngle()
```
    Get the angle selectedfrom the DIFARGram. Note that this is the angle relative to the DIFAR buoy and is therefore a MAGNETIC angle. If you want an angle corrected for magnetic deviation, use getTrueAngle();
    
    Returns:
    the selectedAngle
  - getRange
```
public java.lang.Double getRange()
```
  - getTrueAngle
```
public java.lang.Double getTrueAngle()
```
    Get the true bearing relative to the DIFAR buoy. This is the selected angle (see getSelectedAngle() + the local magnetic deviation calulcated from the World Magnetic Model. For map display, this bearing may be further corrected for any offset in the buoy heading in the array manager. If there is no offset in the arraymanager, then return the magnetic bearing since returning null for the trueBearing may cause problems down the line.
    
    Returns:
    true angle (if the buoy is orientated right !)
  - getTrackedGroup
```
public java.lang.String getTrackedGroup()
```
  - setTrackedGroup
```
public void setTrackedGroup(java.lang.String newGroup)
```
  - setSelectedAngle
```
public void setSelectedAngle(java.lang.Double selectedAngle)
```
    Set the selected angle from the DIFARGram. Note that this is the angle relative to the DIFAR buoy and is therefore a MAGNETIC angle.
    
    Parameters:
    selectedAngle - the selectedAngle to set
  - calculateDifarGain
```
public java.lang.Double calculateDifarGain()
```
    Now also work out the DIFAR gain for that angle. This means taking the closest point in the summary line and seeing what it's value is for that angle
    
    Returns:
    gain.
  - calculateDifarGain
```
public java.lang.Double calculateDifarGain(java.lang.Double selectedAngle,
                                  java.lang.Double selectedFrequency)
```
    Calculate teh DIFAR gain for a given angle and frequency
    
    Parameters:
    selectedAngle - angle 0 - 360
    selectedFrequency - Frequency Hz
    
    Returns:
    gain
  - getSelectedFrequency
```
public java.lang.Double getSelectedFrequency()
```
    Returns:
    the selectedFrequency
  - setSelectedFrequency
```
public void setSelectedFrequency(java.lang.Double selectedFrequency)
```
    Parameters:
    selectedFrequency - the selectedFrequency to set
  - getSurfaceSummary
```
public double[] getSurfaceSummary()
```
    Returns:
    the surfaceSummary
  - setSurfaceSummary
```
public void setSurfaceSummary(double[] surfaceSummary)
```
    Parameters:
    surfaceSummary - the surfaceSummary to set
  - getMaximumAngleSummary
```
public double[] getMaximumAngleSummary()
```
    Returns:
    the maximumAngleSummary
  - setMaximumAngleSummary
```
public void setMaximumAngleSummary(double[] surfaceSummary)
```
    Parameters:
    surfaceSummary - the surfaceSummary to set
  - getMaximumAngle
```
public java.lang.Double getMaximumAngle()
```
    Returns:
    the maximumAngle
  - setMaximumAngle
```
public void setMaximumAngle(java.lang.Double maximumAngle)
```
    Parameters:
    maximumAngle - the maximumAngle to set
  - getMaximumFrequency
```
public java.lang.Double getMaximumFrequency()
```
    Returns:
    the maximumFrequency
  - setMaximumFrequency
```
public void setMaximumFrequency(java.lang.Double maximumFrequency)
```
    Parameters:
    maximumFrequency - the maximumFrequency to set
  - setSpectrogramSensor
```
public void setSpectrogramSensor(int spectrogramSensor)
```
    Choice of data for spectrogram displays.
    0 = decimated original data.
    1 = Omni demuxed
    2 = EW demuxed
    3 = NS demuxed
    
    Parameters:
    spectrogramSensor - the spectrogramSensor to set
  - getDemuxedDecimatedData
```
public double[][] getDemuxedDecimatedData()
```
    Returns:
    the demuxedDecimatedData
  - setDemuxedDecimatedData
```
public void setDemuxedDecimatedData(double[][] demuxedDecimatedData)
```
    Parameters:
    demuxedDecimatedData - the demuxedDecimatedData to set
  - getClipImage
```
public java.awt.image.BufferedImage getClipImage(int spectrogramImageChoice,
                                        int iChannel,
                                        int fftLen,
                                        int fftHop,
                                        double scaleMin,
                                        double scaleMax,
                                        java.awt.Color[] colours)
```
    Get a clip image for a particular wave type - decimated original, Om, EW, NS
    
    Parameters:
    spectrogramImageChoice -
    iChannel -
    fftLen -
    fftHop -
    scaleMin -
    scaleMax -
    colours -
    
    Returns:
  - getSpeciesName
```
public java.lang.String getSpeciesName()
```
    Returns:
    null, Vessel or the long name from the lookup
  - getSpeciesCode
```
public java.lang.String getSpeciesCode()
```
    Get a species code - mostly used by the database.
    
    Returns:
    a species code (the shorter bit from the lookup table) TODO: Store species parameters with each data unit
  - setSpeciesCode
```
public void setSpeciesCode(LookupList speciesList,
                  java.lang.String speciesCode)
```
    Called in viewer when data are read back from binary store to sort out the species luukup item.
    
    Parameters:
    speciesList - list of programmed species codes
    speciesCode - data units code or "Vessel"
  - decimateLockArray
```
public static boolean[] decimateLockArray(boolean[] lockInput,
                          float origSmp,
                          float displaySampRate)
```
    Parameters:
    lock_15 -
    sampleRate -
    displaySampleRate2 -
  - getDifarGain
```
public java.lang.Double getDifarGain()
```
    Returns:
    the difarGain
  - setDifarGain
```
public void setDifarGain(double difarGain)
```
    Parameters:
    difarGain - the difarGain to set
  - setLockDecimatedData
```
public void setLockDecimatedData(boolean[][] lockArrays)
```
    Set the lock array iformation in the data unit. This is a 2xn boolean array of the 7.5 and 15kHz locks, decimated to the same freqeuncy as the demuxed audio data.
    
    Parameters:
    lockArrays - TODO: Move all lock related code into the Greeneridge demux
  - getLockDecimatedData
```
public boolean[][] getLockDecimatedData()
```
  - cleanUpData
```
public void cleanUpData()
```
    Gets called just before unit is added to processed data. Some things are no longer needed at this point, so can clean them up.
  - getDurationInSeconds
```
public double getDurationInSeconds()
```
    Used by some displays
    
    Returns:
  - getSummaryString
```
public java.lang.String getSummaryString()
```
    Description copied from class: PamDataUnit
    
    Return an html formatted summary string describing the detection which can be used in tooltips anywhere in PAMGuard.
    
    Overrides:
    
    getSummaryString in class AcousticDataUnit
    
    Returns:
    summary string
  - getPreMarkSeconds
```
public double getPreMarkSeconds()
```
    Returns:
    the Number of seconds added to the sound prior to the specrogram mark or detection.
  - setPreMarkSeconds
```
public void setPreMarkSeconds(double preMarkSeconds)
```
    Parameters:
    the - Number of seconds added to the sound prior to the specrogram mark or detection
  - getClipStartMillis
```
public long getClipStartMillis()
```
    Returns:
    the clipStartMillis. This is the start of the clip - which will generally have been put afew secs before the actual sound.
  - canAutoProcess
```
public boolean canAutoProcess()
```
    Autoprocess everything except "Default" clips
    
    Returns:
  - cancelAutoSave
```
public void cancelAutoSave()
```
    //this is a bit pointless now as action performed doesn't attempt save if timer is stopped
    
    Parameters:
    sets - canAutoSave false
  - canAutoSave
```
public boolean canAutoSave()
```
    //this is a bit pointless now as action performed doesn't attempt save if timer is stopped whether the difar unit has been interacted with causing autosave to be inapropriate
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - saveCrossing
```
public void saveCrossing(boolean save)
```
    Move the crossing info from it's temp position to a saved position. Called just at the point when the difar unit is saved and moved from the queue to the output data block.
    
    Parameters:
    save - - save it, or discard it (also from other units associated with this crossing
  - getDifarCrossing
```
public DIFARCrossingInfo getDifarCrossing()
```
    Returns:
    the crossing point when multiple matching DIFAR bearings are crossed.
  - setDifarCrossing
```
public void setDifarCrossing(DIFARCrossingInfo difarCrossing)
```
    Parameters:
    difarCrossing - the difarCrossing to set
  - getTempCrossing
```
public DIFARCrossingInfo getTempCrossing()
```
    Returns:
    the tempCrossing
  - setTempCrossing
```
public void setTempCrossing(DIFARCrossingInfo tempCrossing)
```
    Parameters:
    tempCrossing - the tempCrossing to set
  - getTempGroup
```
public java.lang.String getTempGroup()
```
    Returns:
    the tempCrossing
  - setTempGroup
```
public void setTempGroup(java.lang.String tempGroup)
```
    Parameters:
    tempCrossing - the tempCrossing to set
  - getOriginLatLong
```
public GpsData getOriginLatLong(boolean recalculate)
```
    Description copied from class: PamDataUnit
    
    Get the latlong of the mean hydrophone position at the time of this detection.
    
    Overrides:
    
    getOriginLatLong in class PamDataUnit
    
    Returns:
    Lat long of detection origin (usually the position of the reference hydrophone at time of detection)
  - saveGroup
```
public void saveGroup()
```

Class DifarDataUnit

Field Summary

Fields inherited from class clipgenerator.ClipDataUnit

Fields inherited from class PamDetection.AcousticDataUnit

Constructor Summary

Method Summary

Methods inherited from class clipgenerator.ClipDataUnit

Methods inherited from class PamDetection.PamDetection

Methods inherited from class PamDetection.AcousticDataUnit

Methods inherited from class PamguardMVC.PamDataUnit

Methods inherited from class java.lang.Object

Constructor Detail

DifarDataUnit

Method Detail

decimateData

getParentDetection

setParentDetection

getMultiplexedData

getSignalStart

getSurfaceData

setSurfaceData

isVessel

setVessel

getLutSpeciesItem

setLutSpeciesItem

getDisplaySampleRate

setDisplaySampleRate

getSelectedAngle

getRange

getTrueAngle

getTrackedGroup

setTrackedGroup

setSelectedAngle

calculateDifarGain

calculateDifarGain

getSelectedFrequency

setSelectedFrequency

getSurfaceSummary

setSurfaceSummary

getMaximumAngleSummary

setMaximumAngleSummary

getMaximumAngle

setMaximumAngle

getMaximumFrequency

setMaximumFrequency

setSpectrogramSensor

getDemuxedDecimatedData

setDemuxedDecimatedData

getClipImage

getSpeciesName

getSpeciesCode

setSpeciesCode

decimateLockArray

getDifarGain

setDifarGain

setLockDecimatedData

getLockDecimatedData

cleanUpData

getDurationInSeconds

getSummaryString

getPreMarkSeconds

setPreMarkSeconds

getClipStartMillis

canAutoProcess

cancelAutoSave

canAutoSave

toString

saveCrossing

getDifarCrossing

setDifarCrossing

getTempCrossing

setTempCrossing

getTempGroup

setTempGroup

getOriginLatLong

saveGroup