Package beamformer.localiser

Class BeamFormLocaliserControl

java.lang.Object
PamController.PamControlledUnit
beamformer.BeamFormerBaseControl
beamformer.localiser.BeamFormLocaliserControl
All Implemented Interfaces:
PamSettings, SettingsNameProvider
public class BeamFormLocaliserControl extends BeamFormerBaseControl implements PamSettings

  • Field Details

  • Constructor Details

    • BeamFormLocaliserControl

      @Deprecated public BeamFormLocaliserControl(String unitName)
      Deprecated.

  • Method Details

    • removeUnit

      public boolean removeUnit()
      Description copied from class: PamControlledUnit
      Called to remove a unit.
      Overrides:
      removeUnit in class PamControlledUnit
      Returns:
      try (not used)

    • notifyModelChanged

      public void notifyModelChanged(int changeType)
      Description copied from class: PamControlledUnit
      General notification when the PAMGAURD model changes.
      Overrides:
      notifyModelChanged in class PamControlledUnit
      Parameters:
      changeType - type of change

    • getBfLocaliserParams

      public BFLocaliserParams getBfLocaliserParams()
      Returns:
      the bfLocaliserParams

    • createDetectionMenu

      public JMenuItem createDetectionMenu(Frame parentFrame)
      Description copied from class: PamControlledUnit
      Create a JMenu object containing MenuItems associated with PamProcesses
      Overrides:
      createDetectionMenu in class PamControlledUnit
      Parameters:
      parentFrame - The owner frame of the menu
      Returns:
      reference to a JMenu which can be added to an existing menu or menu bar

      Note that if multiple views are to use the same menu, then they should each create a new menu (by setting Create to true) the first time they call this method.

    • showSettingsDialog

      protected void showSettingsDialog(Frame parentFrame)

    • getSettingsReference

      public Serializable getSettingsReference()
      Specified by:
      getSettingsReference in interface PamSettings
      Returns:
      The serialisable object that will be stored

    • getSettingsVersion

      public long getSettingsVersion()
      Specified by:
      getSettingsVersion in interface PamSettings
      Returns:
      An integer version number for the settings

    • restoreSettings

      public boolean restoreSettings(PamControlledUnitSettings pamControlledUnitSettings)
      Specified by:
      restoreSettings in interface PamSettings
      Parameters:
      pamControlledUnitSettings -
      Returns:
      true if successful The object performs final checks (if needed) and then casts the settings data pamcontrolledunitSettings.settings into the correct type and uses as required

    • getBeamFormerParams

      public BeamFormerParams getBeamFormerParams()
      Overrides:
      getBeamFormerParams in class BeamFormerBaseControl
      Returns:
      the beamFormerParams

    • setBeamFormerParams

      public void setBeamFormerParams(BeamFormerParams beamFormerParams)
      Overrides:
      setBeamFormerParams in class BeamFormerBaseControl
      Parameters:
      beamFormerParams - the beamFormerParams to set

    • newTriggerData

      public void newTriggerData(PamDataUnit pamDataUnit)

    • getQueuedDataBlock

      public QueuedDataBlock getQueuedDataBlock()
      Returns:
      the queuedDataBlock

    • beamFormDataUnit

      public boolean beamFormDataUnit(PamDataUnit pamDataUnit)
      Run the beam former within the given time-frequency box.
      Parameters:
      timeRange -
      freqRange -
      markChannels -

    • getBeamLocaliserObservable

      public BeamLocaliserObservable getBeamLocaliserObservable()
      Return an observable which will get updates as beam forming takes place can be used to update graphics, etc.
      Returns:
      the beamLocaliserObservable

    • getBfDetectionMonitor

      public BFDetectionMonitor getBfDetectionMonitor()
      Returns:
      the bfDetectionMonitor

    • getBfAnnotationType

      public BFAnnotationType getBfAnnotationType()
      Returns:
      the bfAnnotationType

    • addDownstreamLocalisationContents

      public void addDownstreamLocalisationContents(int localisationContents)
      This gets called when the output datablock has more localisation content options added to it (e.g. from the crossed bearing localiser). We need to pass this information on to the trigger data source so that it can update it's own list, thereby making itself available to displays, etc.
      Parameters:
      localisationContents -