VRControl

java.lang.Object
- PamController.PamControlledUnit
- - videoRangePanel.VRControl

All Implemented Interfaces:

PamSettings
```
public class VRControl
extends PamControlledUnit
implements PamSettings
```
The videoRange module determines location information based on photographs of objects (photogrammetry). The ideal for determining the location of an animal is to know the heading, pitch, roll, focal length, GPS location and height of a camera along with the height of the tide.
However, not all these parameters are necessarily needed to gain some sort of location information. For example, tilt and pitch, focal length and height can determine the distance to animal without the need for heading information or a GPS location.
There are various ways a user can determine required parameters, either directly from a photograph or external data. The simplest example is using the horizon to determine the pitch and tilt of the camera and manually inputting height data along with a calibration (pixels per degree/rad) value. Users may want to use external IMU data, either in real time or for post processing. Geo-tagged photos are another option.
This module is designed to provide a framework for photogrammetry. The core functionality allows users to open and view photographs/images along with any meta data. VRMethod classes are then used to provide the user interface for determining the l.ocation of an object
VRmethods use a JLayer over the photograph to allow users to select locations, draw lines etc. Each VRMethod has it's own side panel and ribbon panel to allow users to input information and select relevant. The VRMethod is responsible for calculating location information which is passed back to VRControl to be saved as a generic video range data unit.

Generic Information Handled outside VRMethods (these are used by one or more VRMethods but handled solely within a VRMethod class)
GPS location of camera
Calibration Values
Landmark Locations
Tide Information
Imported Maps
External Sensor data
Photo meta data

Author:

Doug Gillespie and Jamie Macaulay

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`DBCOMMENTLENGTH`
`static int`	`HEADING_UPDATE` The heading of the image has been changed (usually manually).
`static int`	`IMAGE_CHANGE` The image has changed
`static int`	`IMAGE_SCALE_CHANGE` The scale of the image has been changed.
`static int`	`IMAGE_TIME_CHANGE` The time of the image has been changed.
`static int`	`METHOD_CHANGED` The vrMethod has changed
`static int`	`NOIMAGE`
`static int`	`PITCH_UPDATE` The pitch of the image has been changed (usually manually)
`static int`	`SETTINGS_CHANGE` Some settings in the vrparams may have changed
`static int`	`TILT_UPDATE` The roll of the image has been changed (usually manually), note: roll is often referred to as tilt.
`VRTabPanelControl`	`vrTabPanelControl` Panel containing all gui components

Constructor Summary

Constructors
Constructor and Description

VRControl(java.lang.String unitName)

Constructors
Constructor and Description
`VRControl(java.lang.String unitName)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`fileButton()` Opens a file browser and loads the selected image/folder.
`java.io.File`	`findNextFile(java.io.File file, ImageFileFilter filefilter, boolean forward)` Find the next file which is approved by the Image file filter in the folder.
`AddCalibrationMethod`	`getCalibrationMethod()` Get the calibration method.
`double`	`getCurrentHeight()` Get the current height of the camera from sea level.
`PamImage`	`getCurrentImage()`
`VRMethod`	`getCurrentMethod()` Get the current vr Method.
`java.util.Date`	`getImageDate()`
`java.lang.String`	`getImageName()`
`long`	`getImageTime()`
`java.lang.String`	`getImageTimeString()`
`IMUListener`	`getIMUListener()`
`LocationManager`	`getLocationManager()`
`MapFileManager`	`getMapFileManager()`
`java.util.ArrayList<VRMeasurement>`	`getMeasuredAnimals()`
`java.util.ArrayList<VRMethod>`	`getMethods()` Get an arraylist of all the vr methods currently available.
`VRHorzMethods`	`getRangeMethods()`
`java.io.Serializable`	`getSettingsReference()`
`long`	`getSettingsVersion()`
`TideManager`	`getTideManager()`
`VRPanel`	`getVRPanel()`
`VRParameters`	`getVRParams()`
`VRProcess`	`getVRProcess()`
`int`	`getVrSubStatus()`
`VRTabPanelControl`	`getVRTabPanel()`
`void`	`loadFile(java.io.File file)` Load an image file
`void`	`newMousePoint(java.awt.Point mousePoint)`
`void`	`notifyModelChanged(int changeType)` General notification when the PAMGAURD model changes.
`void`	`pasteButton()` Pastes an image from the computers clipboard.
`boolean`	`restoreSettings(PamControlledUnitSettings pamControlledUnitSettings)`
`void`	`selectHeight(int heightIndex)` Set the current selected height
`void`	`setCurrentImage(PamImage image)`
`void`	`setImageBrightness(float brightness, float contrast)` Se the image brightness
`void`	`setMeasuredAnimals(java.util.ArrayList<VRMeasurement> measuredAnimals)`
`void`	`setRangeMethods(VRHorzMethods rangeMethods)`
`void`	`settingsButton(javax.swing.JFrame frame, int tab)` Opens the settings dialog and updates the module if new settings are saved.
`void`	`setVRMethod(int method)` Set the current method.
`void`	`update(int updateType)` Updates the VRControl depending on flag and passes update flag to the VRTabPanel (gui) and the VRMethods.

Methods inherited from class PamController.PamControlledUnit
addOfflineTaskGroup, addOtherRelatedMenuItems, addPamProcess, addRelatedMenuItems, addXMLParameter, addXMLParameter, addXMLParameter, addXMLParameter, canClose, canPlayViewerSound, createDetectionMenu, createDisplayMenu, createFileMenu, createHelpMenu, fillXMLElement, flushDataBlockBuffers, getFrameNumber, getGuiFrame, getModuleSummary, getNumOfflineTaskGroups, getNumPamProcesses, getOfflineTaskGroup, getPamController, getPamModuleInfo, getPamProcess, getPamView, getShortUnitType, getSidePanel, getTabClipCopier, getTabPanel, getTabSpecificMenuBar, getToolbarComponent, getUnitName, getUnitType, getVerboseLevel, gotoTab, isViewer, pamClose, pamHasStopped, pamToStart, playViewerSound, removePamProcess, removeUnit, rename, saveViewerData, setFrameNumber, setPamController, setPamModuleInfo, setPamView, setSidePanel, setTabPanel, setupControlledUnit, stopViewerSound, terminalPrint, terminalPrintln, toString

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

Methods inherited from interface PamController.PamSettings
getUnitName, getUnitType

- Field Detail
  - vrTabPanelControl
```
public VRTabPanelControl vrTabPanelControl
```
    Panel containing all gui components
  - SETTINGS_CHANGE
```
public static final int SETTINGS_CHANGE
```
    Some settings in the vrparams may have changed
    
    See Also:
    Constant Field Values
  - IMAGE_CHANGE
```
public static final int IMAGE_CHANGE
```
    The image has changed
    
    See Also:
    Constant Field Values
  - IMAGE_SCALE_CHANGE
```
public static final int IMAGE_SCALE_CHANGE
```
    The scale of the image has been changed.
    
    See Also:
    Constant Field Values
  - IMAGE_TIME_CHANGE
```
public static final int IMAGE_TIME_CHANGE
```
    The time of the image has been changed.
    
    See Also:
    Constant Field Values
  - HEADING_UPDATE
```
public static final int HEADING_UPDATE
```
    The heading of the image has been changed (usually manually).
    
    See Also:
    Constant Field Values
  - PITCH_UPDATE
```
public static final int PITCH_UPDATE
```
    The pitch of the image has been changed (usually manually)
    
    See Also:
    Constant Field Values
  - TILT_UPDATE
```
public static final int TILT_UPDATE
```
    The roll of the image has been changed (usually manually), note: roll is often referred to as tilt.
    
    See Also:
    Constant Field Values
  - METHOD_CHANGED
```
public static final int METHOD_CHANGED
```
    The vrMethod has changed
    
    See Also:
    Constant Field Values
  - NOIMAGE
```
public static final int NOIMAGE
```
    See Also:
    Constant Field Values
  - DBCOMMENTLENGTH
```
public static final int DBCOMMENTLENGTH
```
    See Also:
    Constant Field Values
- Constructor Detail
  - VRControl
```
public VRControl(java.lang.String unitName)
```
- Method Detail
  - getMethods
```
public java.util.ArrayList<VRMethod> getMethods()
```
    Get an arraylist of all the vr methods currently available.
    
    Returns:
  - setVRMethod
```
public void setVRMethod(int method)
```
    Set the current method.
    
    Parameters:
    method- - integer specifying method position in vrMethods ArrayList.
  - getCurrentMethod
```
public VRMethod getCurrentMethod()
```
    Get the current vr Method.
    
    Returns:
  - getCalibrationMethod
```
public AddCalibrationMethod getCalibrationMethod()
```
    Get the calibration method. Some dialogs require this.
    
    Returns:
    the AddCalibration vrmethod
  - settingsButton
```
public void settingsButton(javax.swing.JFrame frame,
                  int tab)
```
    Opens the settings dialog and updates the module if new settings are saved.
    
    Parameters:
    frame -
    tab- - the tab to open the settings dialog on.
  - pasteButton
```
public void pasteButton()
```
    Pastes an image from the computers clipboard.
  - fileButton
```
public void fileButton()
```
    Opens a file browser and loads the selected image/folder. Also, looks at the folder the image is in and determines the number of image files.
  - findNextFile
```
public java.io.File findNextFile(java.io.File file,
                        ImageFileFilter filefilter,
                        boolean forward)
```
    Find the next file which is approved by the Image file filter in the folder. Returns null if no file is found.
    
    Parameters:
    file- - current file selected in the directory. If null the first file in the directory is chosen.
    filefilter -
    forward- - true move forward in the folder, false move backward in the folder.
    
    Returns:
  - selectHeight
```
public void selectHeight(int heightIndex)
```
    Set the current selected height
    
    Parameters:
    heightIndex -
  - getCurrentHeight
```
public double getCurrentHeight()
```
    Get the current height of the camera from sea level. Includes any offset calulated by the tide manager.
    
    Returns:
    the current height oif the camera from sea level- (this is fiorm the current sea level)
  - setImageBrightness
```
public void setImageBrightness(float brightness,
                      float contrast)
```
    Se the image brightness
    
    Parameters:
    brightness -
    contrast -
  - loadFile
```
public void loadFile(java.io.File file)
```
    Load an image file
    
    Parameters:
    file- - image file.
  - getSettingsReference
```
public java.io.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
    
    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
  - update
```
public void update(int updateType)
```
    Updates the VRControl depending on flag and passes update flag to the VRTabPanel (gui) and the VRMethods.
    
    Parameters:
    updateType -
  - 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
  - getVrSubStatus
```
public int getVrSubStatus()
```
  - newMousePoint
```
public void newMousePoint(java.awt.Point mousePoint)
```
  - getImageName
```
public java.lang.String getImageName()
```
  - getImageTimeString
```
public java.lang.String getImageTimeString()
```
  - getMeasuredAnimals
```
public java.util.ArrayList<VRMeasurement> getMeasuredAnimals()
```
  - getVRParams
```
public VRParameters getVRParams()
```
  - getVRPanel
```
public VRPanel getVRPanel()
```
  - getVRProcess
```
public VRProcess getVRProcess()
```
  - setMeasuredAnimals
```
public void setMeasuredAnimals(java.util.ArrayList<VRMeasurement> measuredAnimals)
```
  - getRangeMethods
```
public VRHorzMethods getRangeMethods()
```
  - setRangeMethods
```
public void setRangeMethods(VRHorzMethods rangeMethods)
```
  - getMapFileManager
```
public MapFileManager getMapFileManager()
```
  - getLocationManager
```
public LocationManager getLocationManager()
```
  - getTideManager
```
public TideManager getTideManager()
```
  - setCurrentImage
```
public void setCurrentImage(PamImage image)
```
  - getCurrentImage
```
public PamImage getCurrentImage()
```
  - getVRTabPanel
```
public VRTabPanelControl getVRTabPanel()
```
  - getImageTime
```
public long getImageTime()
```
  - getImageDate
```
public java.util.Date getImageDate()
```
  - getIMUListener
```
public IMUListener getIMUListener()
```

Class VRControl

Field Summary

Constructor Summary

Method Summary

Methods inherited from class PamController.PamControlledUnit

Methods inherited from class java.lang.Object

Methods inherited from interface PamController.PamSettings

Field Detail

vrTabPanelControl

SETTINGS_CHANGE

IMAGE_CHANGE

IMAGE_SCALE_CHANGE

IMAGE_TIME_CHANGE

HEADING_UPDATE

PITCH_UPDATE

TILT_UPDATE

METHOD_CHANGED

NOIMAGE

DBCOMMENTLENGTH

Constructor Detail

VRControl

Method Detail

getMethods

setVRMethod

getCurrentMethod

getCalibrationMethod

settingsButton

pasteButton

fileButton

findNextFile

selectHeight

getCurrentHeight

setImageBrightness

loadFile

getSettingsReference

getSettingsVersion

restoreSettings

update

notifyModelChanged

getVrSubStatus

newMousePoint

getImageName

getImageTimeString

getMeasuredAnimals

getVRParams

getVRPanel

getVRProcess

setMeasuredAnimals

getRangeMethods

setRangeMethods

getMapFileManager

getLocationManager

getTideManager

setCurrentImage

getCurrentImage

getVRTabPanel

getImageTime

getImageDate

getIMUListener