DifarParameters

java.lang.Object
- difar.DifarParameters

All Implemented Interfaces:: java.io.Serializable, java.lang.Cloneable

public class DifarParameters
extends java.lang.Object
implements java.io.Serializable, java.lang.Cloneable

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`DifarParameters.DifarDemuxTypes`
`static class`	`DifarParameters.DifarOutputTypes`
`class`	`DifarParameters.DifarTriggerParams`
`static class`	`DifarParameters.FirstOrders`
`static class`	`DifarParameters.SecondOrders`
`class`	`DifarParameters.SpeciesParams`

Field Summary

Fields
Modifier and Type	Field and Description
`boolean`	`amplitudeScaledLineLength` Auto scale line length depending on range
`boolean`	`autoProcess` whether to autoprocess vessel clips(now the only ones that can be)
`boolean`	`autoSaveAngleOnly` when auto saving the difar result either the angle can be saved or the angle and range can be saved if it has range
`boolean`	`autoSaveDResult`
`float`	`autoSaveTime` time afterwhich item has been sitting in difargram to autosave if no user interaction
`static int`	`CALIBRATION_USE_MEAN`
`static int`	`CALIBRATION_USE_MODE` Choices for calibration dialog when user right clicks and / or new data arrive.
`int`	`calibrationChoice`
`static java.lang.String`	`CalibrationClip`
`boolean`	`clearProcessedDataAtStart`
`boolean`	`clearQueueAtStart`
`static java.lang.String`	`Default`
`static java.lang.String`	`DefaultGroup`
`double`	`defaultLength` range in meters to dislpay on map
`DifarParameters.DifarDemuxTypes`	`demuxType`
`java.lang.Integer`	`difarGramDividerPos` vertical divider - possible between difargram and spectrogram
`DifarParameters.FirstOrders`	`firstOrder`
`boolean`	`hideVesselClips`
`java.lang.Integer`	`horizontalDividerPos` used when the DIFARcontainers were joined - no longer
`int`	`keepRawDataTime` keep rawdata in rawdatablock for this amount of time may make this display dependant
`double`	`nominalSourceLevel` Nominal source level used to determine line lengths.
`double`	`nominalSpreading` Nominal spreading nLog(r)
`int`	`numberOfFavouriteWhales` not user configurable for now
`int`	`processedDataKeepTime` natural lifetime for the processed data datablock
`int`	`queuedDataKeepTime` natural lifetime for the queued data datablock-note there is also some control over this withing the clip generator history section of the hiding panel
`java.lang.String`	`rawDataName` name of unit to get raw data from including the frequency bands in which the multiplexed signals are within
`DifarParameters.SecondOrders`	`secondOrder`
`double`	`secondsToPreceed` seconds to prepend to each clip to allow for signal locking of the demux algorithm
`static long`	`serialVersionUID`
`boolean`	`showDifarGramFreqLimits` show detection limits on difargram - edited on right click
`boolean`	`showDifarGramKey` key on difargram - edited on right click
`boolean`	`showDifarGramSummary` summary line - addition of amplitude/angle withing frequency bands on difargram - edited on right click
`boolean`	`showVesselBearings`
`LookupItem`	`Species` species to process a difarclip with.
`boolean`	`timeScaledOpacity`
`long`	`timeToFade` check this compared with map show data time 30 min?
`java.util.ArrayList<DifarParameters.DifarTriggerParams>`	`triggerParams` name of the detector module which can trigger difar clips to be made - eg whistle and moan detector currently limited to one detector
`int`	`vesselClipLength`
`int`	`vesselClipNumber`
`int`	`vesselClipSeparation`
`boolean`	`zoomDifarFrequency`

Constructor Summary

Constructors
Constructor and Description

DifarParameters()

Constructors
Constructor and Description
`DifarParameters()`

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`addSpeciesParams(DifarParameters.SpeciesParams sp, boolean override)` Create a new set of audio clip parameters for a given species
`boolean`	`addTrackedGroup(java.lang.String listItem)`
`boolean`	`addTriggerParams(DifarParameters.DifarTriggerParams tP)` Add a new trigger Parameters to the list.
`void`	`clearAllTriggerParams()` Clear all trigger parameters.
`DifarParameters`	`clone()`
`DifarParameters.SpeciesParams`	`findSpeciesParams(DifarDataUnit difarDataUnit)`
`DifarParameters.SpeciesParams`	`findSpeciesParams(LookupItem lutItem)`
`DifarParameters.SpeciesParams`	`findSpeciesParams(java.lang.String lookupItemName)`
`DifarParameters.DifarTriggerParams`	`findTriggerParams(java.lang.String dataName)` Find the trigger parameters for a specific data stream.
`double`	`getDefaultRange()`
`LookupItem[]`	`getFavSpecies()`
`java.util.ArrayList<java.lang.String>`	`getGroupDefaults()`
`int`	`getNumTriggersEnabled()`
`java.util.ArrayList<DifarParameters.SpeciesParams>`	`getSpeciesDefaults()`
`LookupList`	`getSpeciesList(DifarControl difarControl)`
`java.util.ArrayList<DifarParameters.SpeciesParams>`	`getSpeciesParams()`
`java.util.ArrayList<java.lang.String>`	`getTrackedGroupList()`
`DifarParameters.DifarTriggerParams`	`getTriggerParams(int i)` Get a trigger setting object
`boolean`	`isSingleClickSave()`
`void`	`removeTrackedGroup(java.lang.String listItem)`
`void`	`restoreDefaultSpeciesParams()`
`void`	`setFavSpecies(LookupItem[] favSpecies)`
`void`	`setSingleClickSave(boolean singleClickSave)`
`void`	`setSpeciesList(LookupList speciesList)`
`void`	`setSpeciesParams(java.util.ArrayList<DifarParameters.SpeciesParams> speciesParams)`

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

- Field Detail
  - serialVersionUID
```
public static final long serialVersionUID
```
    See Also:
    Constant Field Values
  - keepRawDataTime
```
public int keepRawDataTime
```
    keep rawdata in rawdatablock for this amount of time may make this display dependant
  - rawDataName
```
public java.lang.String rawDataName
```
    name of unit to get raw data from including the frequency bands in which the multiplexed signals are within
  - queuedDataKeepTime
```
public int queuedDataKeepTime
```
    natural lifetime for the queued data datablock-note there is also some control over this withing the clip generator history section of the hiding panel
  - processedDataKeepTime
```
public int processedDataKeepTime
```
    natural lifetime for the processed data datablock
  - clearQueueAtStart
```
public boolean clearQueueAtStart
```
  - clearProcessedDataAtStart
```
public boolean clearProcessedDataAtStart
```
  - secondsToPreceed
```
public double secondsToPreceed
```
    seconds to prepend to each clip to allow for signal locking of the demux algorithm
  - triggerParams
```
public java.util.ArrayList<DifarParameters.DifarTriggerParams> triggerParams
```
    name of the detector module which can trigger difar clips to be made - eg whistle and moan detector currently limited to one detector
  - CALIBRATION_USE_MODE
```
public static final int CALIBRATION_USE_MODE
```
    Choices for calibration dialog when user right clicks and / or new data arrive.
    
    See Also:
    Constant Field Values
  - CALIBRATION_USE_MEAN
```
public static final int CALIBRATION_USE_MEAN
```
    See Also:
    Constant Field Values
  - calibrationChoice
```
public int calibrationChoice
```
  - difarGramDividerPos
```
public java.lang.Integer difarGramDividerPos
```
    vertical divider - possible between difargram and spectrogram
  - horizontalDividerPos
```
public java.lang.Integer horizontalDividerPos
```
    used when the DIFARcontainers were joined - no longer
  - vesselClipLength
```
public int vesselClipLength
```
  - vesselClipSeparation
```
public int vesselClipSeparation
```
  - vesselClipNumber
```
public int vesselClipNumber
```
  - hideVesselClips
```
public boolean hideVesselClips
```
  - showDifarGramKey
```
public boolean showDifarGramKey
```
    key on difargram - edited on right click
  - showDifarGramSummary
```
public boolean showDifarGramSummary
```
    summary line - addition of amplitude/angle withing frequency bands on difargram - edited on right click
  - showDifarGramFreqLimits
```
public boolean showDifarGramFreqLimits
```
    show detection limits on difargram - edited on right click
  - demuxType
```
public DifarParameters.DifarDemuxTypes demuxType
```
  - Default
```
public static final java.lang.String Default
```
    See Also:
    Constant Field Values
  - CalibrationClip
```
public static final java.lang.String CalibrationClip
```
    See Also:
    Constant Field Values
  - DefaultGroup
```
public static final java.lang.String DefaultGroup
```
    See Also:
    Constant Field Values
  - autoSaveTime
```
public float autoSaveTime
```
    time afterwhich item has been sitting in difargram to autosave if no user interaction
  - autoSaveDResult
```
public boolean autoSaveDResult
```
  - autoSaveAngleOnly
```
public boolean autoSaveAngleOnly
```
    when auto saving the difar result either the angle can be saved or the angle and range can be saved if it has range
  - Species
```
public LookupItem Species
```
    species to process a difarclip with. if null autoprocess dieabled
  - firstOrder
```
public DifarParameters.FirstOrders firstOrder
```
  - secondOrder
```
public DifarParameters.SecondOrders secondOrder
```
  - amplitudeScaledLineLength
```
public boolean amplitudeScaledLineLength
```
    Auto scale line length depending on range
  - nominalSourceLevel
```
public double nominalSourceLevel
```
    Nominal source level used to determine line lengths.
  - nominalSpreading
```
public double nominalSpreading
```
    Nominal spreading nLog(r)
  - defaultLength
```
public double defaultLength
```
    range in meters to dislpay on map
  - timeScaledOpacity
```
public boolean timeScaledOpacity
```
  - timeToFade
```
public long timeToFade
```
    check this compared with map show data time 30 min?
  - showVesselBearings
```
public boolean showVesselBearings
```
  - numberOfFavouriteWhales
```
public int numberOfFavouriteWhales
```
    not user configurable for now
  - autoProcess
```
public boolean autoProcess
```
    whether to autoprocess vessel clips(now the only ones that can be)
  - zoomDifarFrequency
```
public boolean zoomDifarFrequency
```
- Constructor Detail
  - DifarParameters
```
public DifarParameters()
```
- Method Detail
  - getSpeciesDefaults
```
public java.util.ArrayList<DifarParameters.SpeciesParams> getSpeciesDefaults()
```
  - getGroupDefaults
```
public java.util.ArrayList<java.lang.String> getGroupDefaults()
```
  - getFavSpecies
```
public LookupItem[] getFavSpecies()
```
    Returns:
    the favSpecies which will be shown next to each clip
  - setFavSpecies
```
public void setFavSpecies(LookupItem[] favSpecies)
```
    Parameters:
    favSpecies - the favSpecies to set
  - clone
```
public DifarParameters clone()
```
    Overrides:
    
    clone in class java.lang.Object
  - getSpeciesList
```
public LookupList getSpeciesList(DifarControl difarControl)
```
  - setSpeciesList
```
public void setSpeciesList(LookupList speciesList)
```
  - restoreDefaultSpeciesParams
```
public void restoreDefaultSpeciesParams()
```
  - getDefaultRange
```
public double getDefaultRange()
```
  - isSingleClickSave
```
public boolean isSingleClickSave()
```
    Returns:
    the singleClickSave
  - setSingleClickSave
```
public void setSingleClickSave(boolean singleClickSave)
```
    Parameters:
    singleClickSave - the singleClickSave to set
  - getSpeciesParams
```
public java.util.ArrayList<DifarParameters.SpeciesParams> getSpeciesParams()
```
    Returns:
    the speciesParams
  - findSpeciesParams
```
public DifarParameters.SpeciesParams findSpeciesParams(DifarDataUnit difarDataUnit)
```
  - findSpeciesParams
```
public DifarParameters.SpeciesParams findSpeciesParams(LookupItem lutItem)
```
  - findSpeciesParams
```
public DifarParameters.SpeciesParams findSpeciesParams(java.lang.String lookupItemName)
```
  - addSpeciesParams
```
public boolean addSpeciesParams(DifarParameters.SpeciesParams sp,
                       boolean override)
```
    Create a new set of audio clip parameters for a given species
    
    Parameters:
    sp - - Audio parameters (e.g. Sample rate, FFT Lenght, Frequency Limits etc.)
    override - - Set to true to overwrite existing parameters
    
    Returns:
  - setSpeciesParams
```
public void setSpeciesParams(java.util.ArrayList<DifarParameters.SpeciesParams> speciesParams)
```
    Parameters:
    speciesParams - the speciesParams to set
  - getNumTriggersEnabled
```
public int getNumTriggersEnabled()
```
    Returns:
    the number of triggers that are enabled by the DIFAR module.
  - getTriggerParams
```
public DifarParameters.DifarTriggerParams getTriggerParams(int i)
```
    Get a trigger setting object
    
    Parameters:
    i - number of the trigger
    
    Returns:
    the trigger parameters
  - findTriggerParams
```
public DifarParameters.DifarTriggerParams findTriggerParams(java.lang.String dataName)
```
    Find the trigger parameters for a specific data stream.
    
    Parameters:
    dataName - data name for the data block.
    
    Returns:
    Trigger parameters, or null if none active.
  - clearAllTriggerParams
```
public void clearAllTriggerParams()
```
    Clear all trigger parameters.
  - addTriggerParams
```
public boolean addTriggerParams(DifarParameters.DifarTriggerParams tP)
```
    Add a new trigger Parameters to the list.
    
    Parameters:
    tP -
  - addTrackedGroup
```
public boolean addTrackedGroup(java.lang.String listItem)
```
  - removeTrackedGroup
```
public void removeTrackedGroup(java.lang.String listItem)
```
  - getTrackedGroupList
```
public java.util.ArrayList<java.lang.String> getTrackedGroupList()
```

Class DifarParameters

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

serialVersionUID

keepRawDataTime

rawDataName

queuedDataKeepTime

processedDataKeepTime

clearQueueAtStart

clearProcessedDataAtStart

secondsToPreceed

triggerParams

CALIBRATION_USE_MODE

CALIBRATION_USE_MEAN

calibrationChoice

difarGramDividerPos

horizontalDividerPos

vesselClipLength

vesselClipSeparation

vesselClipNumber

hideVesselClips

showDifarGramKey

showDifarGramSummary

showDifarGramFreqLimits

demuxType

Default

CalibrationClip

DefaultGroup

autoSaveTime

autoSaveDResult

autoSaveAngleOnly

Species

firstOrder

secondOrder

amplitudeScaledLineLength

nominalSourceLevel

nominalSpreading

defaultLength

timeScaledOpacity

timeToFade

showVesselBearings

numberOfFavouriteWhales

autoProcess

zoomDifarFrequency

Constructor Detail

DifarParameters

Method Detail

getSpeciesDefaults

getGroupDefaults

getFavSpecies

setFavSpecies

clone

getSpeciesList

setSpeciesList

restoreDefaultSpeciesParams

getDefaultRange

isSingleClickSave

setSingleClickSave

getSpeciesParams

findSpeciesParams

findSpeciesParams

findSpeciesParams

addSpeciesParams

setSpeciesParams

getNumTriggersEnabled

getTriggerParams

findTriggerParams

clearAllTriggerParams

addTriggerParams

addTrackedGroup

removeTrackedGroup

getTrackedGroupList