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 Link icon

    • serialVersionUID Link icon

      public static final long serialVersionUID
      See Also:

    • keepRawDataTime Link icon

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

    • rawDataName Link icon

      public String rawDataName
      name of unit to get raw data from including the frequency bands in which the multiplexed signals are within

    • queuedDataKeepTime Link icon

      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 Link icon

      public int processedDataKeepTime
      natural lifetime for the processed data datablock

    • clearQueueAtStart Link icon

      public boolean clearQueueAtStart

    • clearProcessedDataAtStart Link icon

      public boolean clearProcessedDataAtStart

    • secondsToPreceed Link icon

      public double secondsToPreceed
      seconds to prepend to each clip to allow for signal locking of the demux algorithm

    • triggerParams Link icon

      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 Link icon

      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 Link icon

      public static final int CALIBRATION_USE_MEAN
      See Also:

    • calibrationChoice Link icon

      public int calibrationChoice

    • difarFreqResponseFilterParams Link icon

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

    • PROPLOSS_NONE Link icon

      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 Link icon

      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 Link icon

      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 Link icon

      public Integer difarGramDividerPos
      vertical divider - possible between difargram and spectrogram

    • horizontalDividerPos Link icon

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

    • selectedClassification Link icon

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

    • multiChannelClips Link icon

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

    • assignClassification Link icon

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

    • vesselClipLength Link icon

      public int vesselClipLength

    • vesselClipSeparation Link icon

      public int vesselClipSeparation

    • vesselClipNumber Link icon

      public int vesselClipNumber

    • hideVesselClips Link icon

      public boolean hideVesselClips

    • showDifarGramKey Link icon

      public boolean showDifarGramKey
      key on difargram - edited on right click

    • showDifarGramSummary Link icon

      public boolean showDifarGramSummary
      summary line - addition of amplitude/angle withing frequency bands on difargram - edited on right click

    • showDifarGramFreqLimits Link icon

      public boolean showDifarGramFreqLimits
      show detection limits on difargram - edited on right click

    • demuxType Link icon

      public DifarParameters.DifarDemuxTypes demuxType

    • Default Link icon

      public static final String Default
      See Also:

    • CalibrationClip Link icon

      public static final String CalibrationClip
      See Also:

    • DefaultGroup Link icon

      public static final String DefaultGroup
      See Also:

    • autoSaveTime Link icon

      public float autoSaveTime
      time afterwhich item has been sitting in difargram to autosave if no user interaction

    • autoSaveDResult Link icon

      public boolean autoSaveDResult

    • autoSaveAngleOnly Link icon

      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 Link icon

      public LookupItem Species
      species to process a difarclip with. if null autoprocess dieabled

    • firstOrder Link icon

      public DifarParameters.FirstOrders firstOrder

    • secondOrder Link icon

      public DifarParameters.SecondOrders secondOrder

    • amplitudeScaledLineLength Link icon

      public boolean amplitudeScaledLineLength
      Auto scale line length depending on range

    • propLossModel Link icon

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

    • nominalSourceLevel Link icon

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

    • nominalSpreading Link icon

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

    • cylindricalStartDistance Link icon

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

    • defaultLength Link icon

      public double defaultLength
      range in meters to dislpay on map

    • timeScaledOpacity Link icon

      public boolean timeScaledOpacity

    • timeToFade Link icon

      public long timeToFade
      check this compared with map show data time 30 min?

    • minimumOpacity Link icon

      public int minimumOpacity

    • showVesselBearings Link icon

      public boolean showVesselBearings

    • numberOfFavouriteWhales Link icon

      public int numberOfFavouriteWhales
      not user configurable for now

    • autoProcess Link icon

      public boolean autoProcess
      whether to autoprocess vessel clips(now the only ones that can be)

    • zoomDifarFrequency Link icon

      public boolean zoomDifarFrequency

    • useSummaryLine Link icon

      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 Link icon

      public String saveKey

    • deleteKey Link icon

      public String deleteKey

    • saveWithoutCrossKey Link icon

      public String saveWithoutCrossKey

    • nextClassKey Link icon

      public String nextClassKey

    • prevClassKey Link icon

      public String prevClassKey

    • calibrationGpsSource Link icon

      public String calibrationGpsSource

    • loadViewerClips Link icon

      public boolean loadViewerClips

    • useMaxSourceLevel Link icon

      public boolean useMaxSourceLevel

    • maxSourceLevel Link icon

      public double maxSourceLevel

    • bearingLineWidth Link icon

      public float bearingLineWidth

    • amplitudeScaledOpacity Link icon

      public boolean amplitudeScaledOpacity

  • Constructor Details Link icon

    • DifarParameters Link icon

      public DifarParameters()

  • Method Details Link icon

    • getSpeciesDefaults Link icon

      public ArrayList<DifarParameters.SpeciesParams> getSpeciesDefaults()

    • getDefaultFreqResponseFilter Link icon

      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 Link icon

      public ArrayList<String> getGroupDefaults()

    • getFavSpecies Link icon

      public LookupItem[] getFavSpecies()
      Returns:
      the favSpecies which will be shown next to each clip

    • setFavSpecies Link icon

      public void setFavSpecies(LookupItem[] favSpecies)
      Parameters:
      favSpecies - the favSpecies to set

    • clone Link icon

      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.

    • getSpeciesList Link icon

      public LookupList getSpeciesList(DifarControl difarControl)

    • setSpeciesList Link icon

      public void setSpeciesList(LookupList speciesList)

    • restoreDefaultSpeciesParams Link icon

      public void restoreDefaultSpeciesParams()

    • getDefaultRange Link icon

      public double getDefaultRange()

    • isSingleClickSave Link icon

      public boolean isSingleClickSave()
      Returns:
      the singleClickSave

    • setSingleClickSave Link icon

      public void setSingleClickSave(boolean singleClickSave)
      Parameters:
      singleClickSave - the singleClickSave to set

    • getSpeciesParams Link icon

      public ArrayList<DifarParameters.SpeciesParams> getSpeciesParams()
      Returns:
      the speciesParams

    • findSpeciesParams Link icon

      public DifarParameters.SpeciesParams findSpeciesParams(DifarDataUnit difarDataUnit)

    • findSpeciesParams Link icon

      public DifarParameters.SpeciesParams findSpeciesParams(LookupItem lutItem)

    • findSpeciesParams Link icon

      public DifarParameters.SpeciesParams findSpeciesParams(String lookupItemName)

    • addSpeciesParams Link icon

      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 Link icon

      public void setSpeciesParams(ArrayList<DifarParameters.SpeciesParams> speciesParams)
      Parameters:
      speciesParams - the speciesParams to set

    • getNumTriggersEnabled Link icon

      public int getNumTriggersEnabled()
      Returns:
      the number of triggers that are enabled by the DIFAR module.

    • getTriggerParams Link icon

      public DifarParameters.DifarTriggerParams getTriggerParams(int i)
      Get a trigger setting object
      Parameters:
      i - number of the trigger
      Returns:
      the trigger parameters

    • findTriggerParams Link icon

      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 Link icon

      public void clearAllTriggerParams()
      Clear all trigger parameters.

    • addTriggerParams Link icon

      public boolean addTriggerParams(DifarParameters.DifarTriggerParams tP)
      Add a new trigger Parameters to the list.
      Parameters:
      tP -

    • addTrackedGroup Link icon

      public boolean addTrackedGroup(String listItem)

    • removeTrackedGroup Link icon

      public void removeTrackedGroup(String listItem)

    • getTrackedGroupList Link icon

      public ArrayList<String> getTrackedGroupList()

    • getDifarFreqResponseFilterParams Link icon

      public FilterParams getDifarFreqResponseFilterParams()

    • getParameterSet Link icon

      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.