Package videoRangePanel

Class RefractionMethod

java.lang.Object
videoRangePanel.VRHorzCalcMethod
videoRangePanel.RoundEarthMethod
videoRangePanel.RefractionMethod
All Implemented Interfaces:
PamSettings, SettingsNameProvider
public class RefractionMethod extends RoundEarthMethod implements PamSettings

  • Constructor Details

    • RefractionMethod

      public RefractionMethod(VRControl vrControl)

  • Method Details

    • getRangeMethodPane

      public SettingsPane<RefractionParameters> getRangeMethodPane()
      Description copied from class: VRHorzCalcMethod
      Get the FX based settings pane for the method
      Overrides:
      getRangeMethodPane in class RoundEarthMethod
      Returns:
      pane for changing settings.

    • getRange

      public double getRange(double height, double angle)
      Description copied from class: VRHorzCalcMethod
      Converts a height and an angle below the horizon to a distance in metres.
      Overrides:
      getRange in class RoundEarthMethod
      Parameters:
      height - platform height (metres)
      angle - angle below the horizon (Radians)
      Returns:
      distance in metres.

    • getHorizonDistance

      public double getHorizonDistance(double height)
      Description copied from class: VRHorzCalcMethod
      Calculate the distance to the horizon from a given height.
      Overrides:
      getHorizonDistance in class RoundEarthMethod
      Parameters:
      height -
      Returns:
      distnace to horizon in metres.

    • getAngle

      public double getAngle(double height, double range)
      Description copied from class: VRHorzCalcMethod
      Converts a range into an angle below the horizon.

      Or returns -1 if the range is beyond the horizon.

      Overrides:
      getAngle in class RoundEarthMethod
      Parameters:
      height - platform height (metres)
      range - range to object.
      Returns:
      angle in Radians.

    • getHorizonAngle

      protected double getHorizonAngle(double height)
      Description copied from class: VRHorzCalcMethod
      Calculate the horizon dip angle from the horizontal
      Overrides:
      getHorizonAngle in class VRHorzCalcMethod
      Parameters:
      height - Platform height
      Returns:
      dip angle in radians.

    • dialogPanel

      public RangeDialogPanel dialogPanel()
      Description copied from class: VRHorzCalcMethod
      Get the swing based pane for the method
      Overrides:
      dialogPanel in class RoundEarthMethod
      Returns:
      pane for changing settings

    • 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

    • 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

    • 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