Grid3D

java.lang.Object

group3dlocaliser.grids.Grid3D

All Implemented Interfaces:: PamSettings, SettingsNameProvider

Direct Known Subclasses:: SphericalGrid

public abstract class Grid3D extends Object implements PamSettings

3D grid for localisation. These will come in many shapes and sizes, Rectangular, spherical, cylindrical, etc.

Author:: dg50

Constructor Summary

Constructors

Constructor

Description

Grid3D(String settingsName)
Method Summary

Modifier and Type

Method

Description

abstract String

getGridName()

abstract PamVector

getNextPoint()

Get the next point in the grid.

abstract int

getTotalPoints()

Get the total number of points in the grid.

String

getUnitName()

String

getUnitType()

abstract void

resetGrid()

Reset the grid so that the next call to getNextPoint will return the first grid point again.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface PamController.PamSettings
getSettingsReference, getSettingsVersion, restoreSettings

Constructor Details
- Grid3D
  
  public Grid3D(String settingsName)
  
  Parameters:
  
  grid3dParams -
Method Details
- getGridName
  
  public abstract String getGridName()
  
  Returns:
  
  A descriptive name for the grid.
- getTotalPoints
  
  public abstract int getTotalPoints()
  
  Get the total number of points in the grid.
  
  Returns:
  
  number of grid points
- resetGrid
  
  public abstract void resetGrid()
  
  Reset the grid so that the next call to getNextPoint will return the first grid point again.
- getNextPoint
  
  public abstract PamVector getNextPoint()
  
  Get the next point in the grid. Will return null when it's complete.
  
  Returns:
  
  next grid point
- getUnitName
  
  public String getUnitName()
  
  Specified by:
  
  getUnitName in interface SettingsNameProvider
  
  Returns:
  
  A Name specific to this instance of the particular class, e.g. Sperm whale detector, Beaked whale detector, etc.
- getUnitType
  
  public String getUnitType()
  
  Specified by:
  
  getUnitType in interface PamSettings
  
  Returns:
  
  A Name specific to the type, e.g. Click detector