Package difar

Class DifarParameters

java.lang.Object
difar.DifarParameters
All Implemented Interfaces:
Serializable, Cloneable, ManagedParameters
public class DifarParameters extends Object implements Serializable, Cloneable, ManagedParameters
See Also:

  • Field Details

    • serialVersionUID

      public static final long serialVersionUID
      See Also:

    • keepRawDataTime

      public int keepRawDataTime
      keep rawdata in rawdatablock for this amount of time may make this display dependant

    • rawDataName

      public 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 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:

    • CALIBRATION_USE_MEAN

      public static final int CALIBRATION_USE_MEAN
      See Also:

    • calibrationChoice

      public int calibrationChoice

    • difarFreqResponseFilterParams

      public FilterParams difarFreqResponseFilterParams
      Stores paramaters to correct the frequency response for DIFAR buoys

    • PROPLOSS_NONE

      public static final int PROPLOSS_NONE
      Propagation loss is not estimated and the bearing lines for detections are drawn with a fixed, user-specified length
      See Also:

    • PROPLOSS_GEOMETRIC

      public static final int PROPLOSS_GEOMETRIC
      The length of bearing lines is estimated using measured Received levels, RL, and user specified Source Levels (SL) and attentuation coefficient, alpha such that RL = SL-PL Propagation loss, PL, is estimated as PL = alpha*log(range)
      See Also:

    • PROPLOSS_CYLINDRICAL

      public static final int PROPLOSS_CYLINDRICAL
      The length of bearing lines is estimated using measured Received levels, RL, and user specified Source Levels (SL) and surface duct distance, h0 such that RL = SL-PL Propagation loss, PL, is estimated as: PL = 10*log(range) - 10*log(h0);
      See Also:

    • difarGramDividerPos

      public Integer difarGramDividerPos
      vertical divider - possible between difargram and spectrogram

    • horizontalDividerPos

      public Integer horizontalDividerPos
      used when the DIFARcontainers were joined - no longer

    • selectedClassification

      public LookupItem selectedClassification
      Automatically assign user-defined DIFAR classification when clicking on the Spectrogram

    • multiChannelClips

      public boolean multiChannelClips
      Spectrogram marks will generate clips from all channels instead of the one clicked on

    • assignClassification

      public boolean assignClassification
      Spectrogram marks will be assigned the selected classification in sidebar

    • 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 String Default
      See Also:

    • CalibrationClip

      public static final String CalibrationClip
      See Also:

    • DefaultGroup

      public static final String DefaultGroup
      See Also:

    • 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

    • propLossModel

      public int propLossModel
      Model to use for determining the length of a bearing line

    • nominalSourceLevel

      public double nominalSourceLevel
      Nominal source level used to determine line lengths.

    • nominalSpreading

      public double nominalSpreading
      Nominal spreading, alpha: PL = alpha*Log(range);

    • cylindricalStartDistance

      public double cylindricalStartDistance
      Distance travelled in surface duct, h0: 10*log(range) - 10*log(h0);

    • 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?

    • minimumOpacity

      public int minimumOpacity

    • 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

    • useSummaryLine

      public boolean useSummaryLine
      If true use the average the energy across the classification frequency band in the difarGram, before picking the peak. Otherwise use the absolute maximum

    • saveKey

      public String saveKey

    • deleteKey

      public String deleteKey

    • saveWithoutCrossKey

      public String saveWithoutCrossKey

    • nextClassKey

      public String nextClassKey

    • prevClassKey

      public String prevClassKey

    • calibrationGpsSource

      public String calibrationGpsSource

    • loadViewerClips

      public boolean loadViewerClips

    • useMaxSourceLevel

      public boolean useMaxSourceLevel

    • maxSourceLevel

      public double maxSourceLevel

    • bearingLineWidth

      public float bearingLineWidth

    • amplitudeScaledOpacity

      public boolean amplitudeScaledOpacity

  • Constructor Details

    • DifarParameters

      public DifarParameters()

  • Method Details

    • getSpeciesDefaults

      public ArrayList<DifarParameters.SpeciesParams> getSpeciesDefaults()

    • getDefaultFreqResponseFilter

      public FilterParams getDefaultFreqResponseFilter()
      The default Frequency Response Filter used for correction/calibration of the frequency response of military sonobuoys. This default frequency response is flat from 5 Hz to 48 kHz, but most sonobuoys have a non-flat frequency response, so this filter can be adjusted (via the DIFAR parameters Dialog) measurement of absolute sound pressure levels is required.
      Returns:

    • getGroupDefaults

      public ArrayList<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()
      Use the function below to assign default values to newly added parameters, since they will be null when loading older versions of the settings file.
      Overrides:
      clone in class 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 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(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(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(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(String listItem)

    • removeTrackedGroup

      public void removeTrackedGroup(String listItem)

    • getTrackedGroupList

      public ArrayList<String> getTrackedGroupList()

    • getDifarFreqResponseFilterParams

      public FilterParams getDifarFreqResponseFilterParams()

    • getParameterSet

      public PamParameterSet getParameterSet()
      Description copied from interface: ManagedParameters
      Get a set of data that describes all of the parameters in a class
      Specified by:
      getParameterSet in interface ManagedParameters
      Returns:
      description of the parameters in a class.