Package qa.generator.clusters

Interface QACluster

All Known Implementing Classes:
BeakedWhaleCluster, BlackFishCluster, DolphinClicksCluster, DolphinWhistlesCluster, HFBaleenCluster, LFBaleenCluster, PorpoiseCluster, RightWhaleCluster, SpermWhaleCluster, StandardQACluster
public interface QACluster
A cluster contains all the information required to generate a sound or a sequence of sounds. It consists of a sound generator which creates single sounds and a sequence generator which creates sequences of potentially autocorrelated sounds (e.g. sequences of clicks).
Author:
dg50

  • Method Details

    • getName

      String getName()
      Returns:
      The name of the cluster.

    • getSoundGenerator

      QASoundGenerator getSoundGenerator()
      The sound generator can generate single sounds with the correct phase on each hydrophone
      Returns:
      The sound generator

    • getSequenceGenerator

      QASequenceGenerator getSequenceGenerator()
      The sequence generator can generate the precise times and source amplitudes for a sequence of (possibly) autocorrelated sounds, e.g. click trains, totally random whistles, etc.
      Returns:
      The sequence generator

    • getDepthDistribution

      QADistribution getDepthDistribution()
      The depth distribution for the species cluster. This can be null in which case 0 will be used. Remember that PAMGuard uses height, not depth, however, so that distributions that don't allow negative numbers (gamma) can be used, this will genuinely produce a positive number for a real animal depth and whatever uses this distribution will flip it's sign.
      Depths will be generated independently for each sequence and will be constant within each sequence.
      Returns:
      the depth distribution

    • getVersion

      String getVersion()
      Returns:
      Version number for this sound sequence.

    • getPrimaryDetectorType

      Class getPrimaryDetectorType()
      Get the primary detection type in the form of a class type for a PamDataUnit.
      This will be used to set a default primary detector prior to the user selecting one.
      Returns:
      type of primary detector (generally whistles or clicks).