Package clickDetector.localisation

Class GeneralGroupLocaliser

java.lang.Object
clickDetector.localisation.GeneralGroupLocaliser
All Implemented Interfaces:
LocalisationAlgorithm, LocalisationAlgorithmInfo, LocaliserModel<PamDataUnit>
Direct Known Subclasses:
ClickGroupLocaliser
public abstract class GeneralGroupLocaliser extends Object implements LocaliserModel<PamDataUnit>, LocalisationAlgorithm, LocalisationAlgorithmInfo

  • Field Details

    • locAlgorithmList

      public transient ArrayList<LocaliserModel> locAlgorithmList
      List of possible localiser (do not serialise)

  • Constructor Details

    • GeneralGroupLocaliser

      public GeneralGroupLocaliser()

  • Method Details

    • getName

      public abstract String getName()
      Description copied from interface: LocaliserModel
      Get the name which describes the localiser.
      Specified by:
      getName in interface LocaliserModel<PamDataUnit>
      Returns:
      the name of the localiser.

    • getClickLocParams

      public abstract ClickLocParams getClickLocParams()

    • generateLocList

      public void generateLocList()
      Generate the list of available localisers.

    • getToolTipText

      public String getToolTipText()
      Specified by:
      getToolTipText in interface LocaliserModel<PamDataUnit>

    • getAlgorithmSettingsPane

      public LocaliserPane<?> getAlgorithmSettingsPane()
      Description copied from interface: LocaliserModel
      Get the settings pane for the localiser. Allows users to change localiser settings.
      Specified by:
      getAlgorithmSettingsPane in interface LocaliserModel<PamDataUnit>
      Returns:
      the settings pane for the localiser.

    • findLocaliserAlgorithm

      public LocaliserModel findLocaliserAlgorithm(String algorithmName)
      Find an algorithm by name
      Parameters:
      algorithmName -
      Returns:

    • hasParams

      public boolean hasParams()
      Description copied from interface: LocaliserModel
      True if the model has parameters to set. If has the localiser has a settings pane it will have parameters. This generally puts an extra button onto a display panel.
      Specified by:
      hasParams in interface LocaliserModel<PamDataUnit>

    • notifyModelProgress

      public void notifyModelProgress(double progress)
      Description copied from interface: LocaliserModel
      This should be called whenever the localiser has finished processing and, if the localisation process is long, then updates progress.
      Specified by:
      notifyModelProgress in interface LocaliserModel<PamDataUnit>

    • runModel

      public GroupLocalisation runModel(PamDataUnit pamDataUnit, DetectionGroupOptions detectionGroupOptions)
      Run the click group localiser.
      Parameters:
      pamDataUnit - - the group detection to localise.
      Returns:
      the best fit GroupLocalisation.

    • resultsFilterOK

      public boolean resultsFilterOK(GroupLocalisation groupLocalisation)
      Filter results before localisation is selected based on AIC value. If the localisation contains multiple ambiguities, then it will pass as long as one of the ambiguous results passes the filter.
      Parameters:
      groupLocalisation - - the localisation result to test.
      Returns:
      true if localisation passes the filter tests.

    • runModel

      public GroupLocalisation runModel(PamDataUnit pamDataUnit, DetectionGroupOptions detectionGroupOptions, boolean addLoc)
      Description copied from interface: LocaliserModel
      Run the localisation model. Once completed the results are added to the AbstractLoclaisation class of the input PamDataUnit. Note that algorithms may run on a separate thread. Once processing has finished the notifyModelFinished function is called with a progress of 1;.
      Specified by:
      runModel in interface LocaliserModel<PamDataUnit>
      Parameters:
      pamDataUnit - the pamDataUnit. This can be a super unit if multiple detections are required.
      addLoc - automatically add the localisation result to the data unit, replacing it's current localisation info.

    • getLocContents

      public LocContents getLocContents()
      Description copied from interface: LocaliserModel
      The type of localisation information the localiser can accept. e.g. bearings, time delays etc. The types are defined in the AbstractLocalisation class.
      Specified by:
      getLocContents in interface LocaliserModel<PamDataUnit>
      Returns:
      integer bitmap of the type of localisation information the localiser can use.

    • getAlgorithmInfo

      public LocalisationAlgorithmInfo getAlgorithmInfo()
      Description copied from interface: LocalisationAlgorithm
      Get information about the localisation algorithm.
      Specified by:
      getAlgorithmInfo in interface LocalisationAlgorithm
      Returns:
      algorithm information.

    • getTethysCreator

      public LocalizationCreator getTethysCreator()
      Description copied from interface: LocalisationAlgorithm
      Get something that can make LocalisationType objects of a form a bit bespoke to the type of localiser. This may be better than having the standard functions in LocalizationBuilder guess what's best.
      Specified by:
      getTethysCreator in interface LocalisationAlgorithm
      Returns:
      can be null in which case standard functions will do the best they can.

    • getLocalisationContents

      public int getLocalisationContents()
      Description copied from interface: LocalisationAlgorithmInfo
      Get the likely content flags for this localiser.
      Specified by:
      getLocalisationContents in interface LocalisationAlgorithmInfo
      Returns:
      localisation flags.
      See Also:

    • getAlgorithmName

      public String getAlgorithmName()
      Description copied from interface: LocalisationAlgorithmInfo
      Get the algorithm name
      Specified by:
      getAlgorithmName in interface LocalisationAlgorithmInfo
      Returns:
      algorithm name

    • getParameters

      public Serializable getParameters()
      Description copied from interface: LocalisationAlgorithmInfo
      Get the algorithm parameters. Something else can turn these into xml for Tethys.
      Specified by:
      getParameters in interface LocalisationAlgorithmInfo
      Returns:
      algorithm parameters object. Might be null;

    • getLocalizationOptionsPanel

      public LocalizationOptionsPanel getLocalizationOptionsPanel(Window parent, LocalizationBuilder locBuilder)
      Description copied from interface: LocalisationAlgorithmInfo
      Get options panel to either build into the export dialog or to show as a separate dialog (in which case export wizard will show a button). Can be null if no options.
      Specified by:
      getLocalizationOptionsPanel in interface LocalisationAlgorithmInfo
      Parameters:
      locBuilder -
      Returns:
      options panel or null if there are no options.