Package beamformer

Class BeamFormerParams

java.lang.Object
beamformer.BeamFormerParams
All Implemented Interfaces:
Serializable, Cloneable, ManagedParameters
Direct Known Subclasses:
BFLocaliserParams
public class BeamFormerParams extends Object implements Cloneable, Serializable, ManagedParameters
See Also:

  • Field Details

  • Constructor Details

    • BeamFormerParams

      public BeamFormerParams()
      Main constructor

  • Method Details

    • getAlgorithmName

      public String getAlgorithmName(int iGroup)
      Get the algorithm name for the n'th group. this is needed prior to calls to getalgorithmParams(...)
      Parameters:
      iGroup - group index
      Returns:
      algorithm name.

    • addAlgorithmNames

      public void addAlgorithmNames(String name)

    • clearAlgorithmNames

      public void clearAlgorithmNames()

    • clone

      public BeamFormerParams clone()

    • getAlgorithmParms

      public BeamAlgorithmParams getAlgorithmParms(int groupId, int groupChanMap, String algorithmName)
      Get a set of algorithm parameters for an algorithm of a specific name, a specific channel group and a specific channel map
      Parameters:
      groupId - channel group
      groupChanMap - the channel map of the group
      algorithmName - algorithm name
      Returns:
      algorithm params, or null

    • setAlgorithmParams

      public void setAlgorithmParams(String algorithmName, int groupId, int groupChanMap, BeamAlgorithmParams algorithmParams)
      Save a set of algorithm parameters for an algorithm of a specific name, a specific channel group and a specific channel map
      Parameters:
      algorithmName - algorithm name
      groupId - channel group number
      groupChanMap - channel map of the group
      algorithmParams - algorithm parameters.

    • getGroupedSourceParameters

      public GroupedSourceParameters getGroupedSourceParameters()
      Returns:
      the groupedSourceParameters

    • setGroupedSourceParameters

      public void setGroupedSourceParameters(GroupedSourceParameters groupedSourceParameters)
      Parameters:
      groupedSourceParameters - the groupedSourceParameters to set

    • countChannelGroups

      public int countChannelGroups()
      Get the total number of channel groups
      Returns:
      number of groups

    • getGroupChannels

      public int getGroupChannels(int iGroup)
      Get the specific channels associated with a particular group.
      Parameters:
      iGroup - group index (0, 1, 2, 3 whatever the actual group numbers are !)
      Returns:
      bitmap of group channels

    • getDataSource

      public String getDataSource()
      Returns the primary dataSource for the beam former. This can be either raw or fft data or possibly even a detector output or spectrogram mark. Note that the long datablock name is used here.
      Returns:
      the data source

    • setDataSource

      public void setDataSource(String dataSource)
      Set the data source. Note that this should be the long datablock name, not just the data name.
      Parameters:
      dataSource - the dataSource to set

    • getChannelBitmap

      public int getChannelBitmap()
      Return the channel bitmap selected from the Source Pane.
      Returns:
      the channelBitmap

    • setChannelBitmap

      public void setChannelBitmap(int channelBitmap)
      Parameters:
      channelBitmap - the channelBitmap to set

    • getChannelGroups

      public int[] getChannelGroups()
      Returns:
      the channelGroups

    • setChannelGroups

      public void setChannelGroups(int[] channelGroups)
      Parameters:
      channelGroups - the channelGroups to set

    • getGroupingType

      public int getGroupingType()
      Returns:
      the groupingType

    • setGroupingType

      public void setGroupingType(int groupingType)
      Parameters:
      groupingType - the groupingType to set

    • getParameterSet

      public PamParameterSet getParameterSet()
      Get the auto-generated parameter set, and then add in the fields that are not included because they are not public and do not have getters. Note: for each field, we search the current class and (if that fails) the superclass. It's done this way because BeamFormerParams might be used directly (and thus the field would be found in the class) and it also might be used as a superclass to something else (e.g. BFLocaliserParams) in which case the field would only be found in the superclass.
      Specified by:
      getParameterSet in interface ManagedParameters
      Returns:
      description of the parameters in a class.