Package PamDetection

Interface DetectionMatchModel

public interface DetectionMatchModel

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    canLocalise(PamDataUnit pamDetection)
    Check to see if a detection can be localised as part of this detection match
    ArrayList<PamDataUnit>
    findDetectionGroup()
    Gets a list of all detections to be used in the localisation.
    ArrayList<TDArrayList<Double>>
    getGroupTimeDelays(int[] channels)
    To group detections run through every detection on the primary hydrophone.
    int
    getNMatchDetections(int[] channels)
    Gets the channel bitmap of hydrophones which contain at least one detection to be used for localisation .
    int
    getNPossibilities(int[] channels)
    Quickly calculate the number of possible time delay possibilities there will be for this localisation.

  • Method Details

    • findDetectionGroup

      ArrayList<PamDataUnit> findDetectionGroup()
      Gets a list of all detections to be used in the localisation. Usually this will be a list of detections which fall within the time windows of each hydrophone element, with respect to a primary detection. .
      Returns:
      a list of detections to be used in localisation in no particular order.

    • getGroupTimeDelays

      ArrayList<TDArrayList<Double>> getGroupTimeDelays(int[] channels)
      To group detections run through every detection on the primary hydrophone. Use the absolute distance of each hydrophone element from the primary hydrophone to create a time window before and after the primary detection. All detections located within the time window of each hydrophone possibly correspond to the primary detection. Work out all the possible combination of detections and the corresponding time delays.
      Parameters:
      channels - includes detections on these channels only for the calculation.
      Returns:
      a set of time delays. Each ArrayList represents a set of time delays between ALL hydrophones using the indexM1 and indexM2 rules. Multiple combinations are then added to ArrayListinvalid input: '<'ArrayList> and returned by this function;

    • getNMatchDetections

      int getNMatchDetections(int[] channels)
      Gets the channel bitmap of hydrophones which contain at least one detection to be used for localisation . Note: this is not the same number of possible time delay possibilities. For any detection, if there is more than one detection that might correpsond to the primary detection on any channel, then there is more than one combination of time delays. However, although there might be more than one detection on a channel, there also may be a channel with no possible corresponding detections at all. In this case, depending on the number of channels without a detection, there will be set number of null time delays. This equivalent to simply removing a hydrophone from the array.
      Parameters:
      channels - : includes detections on these channels only for the calculation.
      Returns:
      bitmap of channels which have a corresponding detection.

    • getNPossibilities

      int getNPossibilities(int[] channels)
      Quickly calculate the number of possible time delay possibilities there will be for this localisation. Remember to include flags,e.g. the number of possibilities for only event clicks
      Parameters:
      channels - includes detections on these channels only for the calculation.
      Returns:
      the number of time delay possibilities.

    • canLocalise

      boolean canLocalise(PamDataUnit pamDetection)
      Check to see if a detection can be localised as part of this detection match