Debrief NG User Documentation

Ian Mayo

Autumn 2015

Revision History
Revision 2.86th October 2015IM
Update images to new look & feel
Revision 2.74th June 2015IM
Natural Earth, dynamic annotations, new Symbology
Revision 2.622nd May 2014IM
Include SATC, plus updates to reflect GitHub hosting
Revision 2.510th June 2012IM
Include Charting, plus Exercise Planning
Revision 2.41st June 2011IM
Full document update/tidying. Update to DocBook 5.0
Revision 2.31st December 2010IM
Add guidance for right-click integration, worm in the hole
Revision 2.21st July 2009IM
Update for single-sided reconstruction
Revision 2.11st July 2007IM
Polish final Debrief NG content
Revision 2.01st March 2006IM
Start transition to Debrief NG
Revision 1.710th July 2004IM
Include track-shifting
Revision 1.610th March 2003IM
Update to Debrief 2003 functionality
Revision 1.510th Nov 2002IM
Add ETOPO-2 data support
Revision 1.410th July 2002IM
D2002 post-beta revisions, including starting with higher memory allocation
Revision 1.37th May 2002IM
Update to reflect Debrief 2002
Revision 1.213th February 2002IM
Bought up to date with new features (per-fix colouring, cascade/tile, x-y plot tracking bar)
Revision 1.125th October 2001IM
Acknowledged Debrief users added, together with extended Welcome/History
Revision 1.08th October 2001IM
Initial version, following collation of existing HTML pages to DocBook format, together with full review by SMTAC OA.

Contact details

Should you wish to learn more about Debrief please make contact the Project Manager:

Debrief Project Manager. 


            Mr Ian Mayo
            Deep Blue C Technology Ltd
            Fareham
            HANTS
            UK
            e-mail: ian@DeepBlueC.com
          


Acknowledgements

Third Party Libraries. Debrief uses a licensed copy of the WMFWriter library from Piet Jonas (http://piet.jonas.com/WMFWriter/WMFWriter.html ).

Open Source Libraries. Debrief also uses these Open Source libraries:

License.  Debrief is an Open Source application, offering a set of benefits (Section 2.2, “The Switch to Open Source”)

            
/*
 *    Debrief - the Open Source Maritime Analysis Application
 *    http://debrief.info
 *
 *    (C) 2000-2015, Deep Blue C Technology Ltd
 *
 *    This library is free software; you can redistribute it and/or
 *    modify it under the terms of the Eclipse Public License v1.0
 *    (http://www.eclipse.org/legal/epl-v10.html)
 *
 *    This library is distributed in the hope that it will be useful,
 *    but WITHOUT ANY WARRANTY; without even the implied warranty of
 *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. 
 */
            
          

Introduction
1. Welcome
2. History
2.1. Prehistory
2.2. The Switch to Open Source
2.3. Debrief 2001 onwards
3. Debrief users
4. Document conventions
Getting started
1. First steps
1.1. Before Installing Debrief
1.1.1. Obtaining Debrief
1.1.2. Where to get help on Debrief
1.1.3. Debrief on CD-Rom
1.2. Performing installation
1.3. Configuring reference data
1.4. Start Debrief
1.4.1. Opening the application
1.4.2. A Debrief Walkthrough
1.4.3. Navigating around Debrief
1.4.4. Loading your first plot
1.5. Importing track data
1.5.1. Introduction to Replay files
1.5.2. The Debrief file format
1.5.3. Importing data
1.5.4. Import modes
Using Debrief
2. Moving around the view
2.1. Introduction
2.2. Mouse mode buttons
2.3. Click buttons
2.4. Chart Overview
2.5. Undo
2.6. Formatting the plot
3. Manipulating track data
3.1. Property editing
3.1.1. Edit track
3.1.2. Set label, symbol and arrow display intervals
3.1.3. Track shifting
3.2. Adding chart features
3.2.1. Chart features toolbar
3.2.2. Scale
3.2.3. Time Display (Absolute)
3.2.4. Time Display (Relative)
3.2.5. Grid
3.2.6. Local Grid
3.2.7. Coastline
3.2.8. ETOPO gridded bathy
3.2.9. Chart Library
3.2.10. Vectored data
3.2.11. Natural Earth
3.3. Adding drawing features
3.3.1. Label
3.3.2. Ellipse
3.3.3. Polygon
3.3.4. Rectangle, Circle, Line, Arc
3.3.5. General
3.4. Layer management
3.4.1. Outline View
3.4.2. Cut/Copy and Paste
3.5. Saving and re-opening plots
3.5.1. Save
3.5.2. Adding more data to a plot
3.6. Grooming track data
3.6.1. Introduction
3.6.2. Resampling track and sensor data
3.6.3. Splitting track sections
3.6.4. Joining track sections
3.6.5. Combining track sections
3.6.6. Generating infill segments
3.6.7. Removing Jumps
3.7. Using the Grid Editor
3.7.1. Introduction
3.7.2. Use of Grid Editor
4. Analysing Data
4.1. Assigning tracks as primary and secondary
4.1.1. Tote area
4.1.2. Assigning tracks
4.1.3. Notes
4.2. Controlling time
4.2.1. The Time Controller
4.2.2. Display modes
4.2.3. Plotting modes
4.2.4. Highlight modes
4.2.5. Time display
4.2.6. Time slider
4.2.7. Bookmarking
4.2.8. Manipulating according to time period
4.2.9. VCR controls
4.2.10. Other time operations
4.3. Measuring range and bearing
4.3.1.
4.3.2. Earth Model
4.4. Show time-related variables
4.4.1. Time-Variable Plot Tracker-Bar
4.4.2. Analysing time-zero data in time-variable plot
5. Exporting Data
5.1. Exporting images
5.1.1.
6. Symbol sets
6.1.
6.1.1. Use in labels
6.1.2. Use in tracks
7. External datasets
7.1. Natural Earth data
7.1.1.
7.1.2. Using Natural Earth
7.2. VPF data
7.2.1. Introduction
7.2.2. Introduction to VMAP Level 0
7.2.3. Obtaining VPF data
7.2.4. Storing VPF data
7.2.5. Configuring Debrief to read VPF data
7.2.6. Thank heavens for Open Source
7.3. Viewing VPF data
7.3.1. Introduction
7.3.2. Creating VPF layers
7.3.3. Storing VPF settings
7.3.4. VPF best practice
7.4. Configuring VPF defaults
7.4.1. The problem
7.4.2. The solution
7.4.3. How to do it - 1
7.4.4. How to do it - 2
7.4.5. How to do it - 3
7.4.6. At last!
7.5. ETOPO Data
7.5.1. Configuring Debrief to read ETOPO data
7.5.2. Background to ETOPO data
8. Exercise planning
8.1. Introduction
8.2. Creating tracks
8.3. Manipulating tracks
8.4. XY plots of planning tracks
9. Viewing narratives
9.1. Introduction to narrative data
9.1.1. Introduction
9.1.2. Preparing the data
9.1.3. Loading the data
9.1.4. Viewing the data
10. Using chart backdrops
10.1. Introduction
10.1.1. File types
10.2. Loading data
11. Analysing sensor data
11.1. Getting your data in
11.1.1. Introduction
11.1.2. Viewing Sensor Data Time Period
11.1.3. Worm in the hole
11.1.4. Sensor offset lengths editor
11.1.5. Preparing Sensor Data
11.1.6. Relative Data
11.2. Analysing your data
11.2.1. Introduction
11.2.2. Managing high volumes of sensor data
11.2.3. View plot of sensor range to target
11.2.4. Managing ambiguous data
11.2.5. Exploiting doppler calculations
11.2.6. Multi tonal frequency analysis
11.2.7. Multipath analysis
12. Management of TMA and TUA solutions
12.1. TUA data
12.1.1. Introduction
12.1.2. Loading TUA data in bulk
12.1.3. Loading small amounts of TUA data
12.1.4. Relative data
12.1.5. Analysing TUA data
12.2. TMA Management
12.2.1. Introduction
12.2.2. Generating track segments
12.2.3. Dragging tracks
12.2.4. Combining tracks
12.3. Semi-Automated TMA generation
12.3.1. Bearings Only TMA
12.3.2. Glossary
12.3.3. Overview of SATC
12.3.4. User Interface
13. Support for DIS Protocol
13.1. Introduction
13.2. Configuring DIS
13.2.1. Network configuration
13.2.2. Configuring the launch of an external simulator
13.2.3. Giving Debrief an identity
13.2.4. Filtering DIS traffic
13.3. Monitoring a DIS simulation
13.3.1. Running a local simulator
13.3.2. Interacting with a DIS simulation
13.3.3. Other settings
13.3.4. Logging DIS messages
13.3.5. Performance graph
13.4. DIS Tips & Tricks
13.4.1. Specifying format parameters in advance
13.4.2. Running Debrief's DIS simulator
13.4.3. Track the simulator using the Console
Maintainer's Guide
14. Participating in Debrief development
14.1. Debrief online
14.2. Keeping up to date
14.2.1. Twitter
14.2.2. Email
14.3. Debrief at the Maritime Warfare Centre
14.3.1. Installing Debrief
14.3.2. Keeping your Debrief installation up to date
14.4. Debrief across the Internet
14.4.1. Installing Debrief
14.4.2. Keeping your Debrief installation up to date
14.5. Providing feedback
14.5.1. Reporting bugs
14.5.2. Requesting new features
15. Debrief maintainer's guide
15.1. Installation guidance
15.1.1. System requirements
15.1.2. Implementing 'open with' support for DebriefNG
15.1.3. Directory structure
15.1.4. Multi-user Debrief installation
15.1.5. Centralised software updates
15.1.6. Starting the program
15.1.7. Use of English locale
15.2. Fault-diagnosis instructions
15.2.1. How-to
15.3. Storing Chart Folios
15.4. Debrief properties
15.4.1. Introduction
Reference Guide
16. Debrief file formats
16.1. Replay file format
16.1.1. Track data
16.1.2. Symbology attributes
16.1.3. Annotation Data Intro
16.1.4. Core Elements
16.1.5. Towed Array Extensions
16.1.6. Dynamic Elements
16.1.7. Dynamic Track Annotations
16.1.8. Formatting helpers
16.2. Debrief file format
16.2.1. Introduction
16.2.2. Adoption of XML
16.3. KML file format
16.3.1. Introduction to KML file format
16.3.2. LineString KML files
16.3.3. MultiGeometry KML files
16.4. Flat file format
16.4.1. Introduction to Flat file (SAM) format
16.4.2. Schema for Flat file format
16.5. Multipath analysis datafiles
16.5.1. Introduction
16.5.2. SVP file
16.5.3. Time delays file
16.6. S2087 Track files
16.6.1. Introduction
16.6.2. File format
17. GeoTools in Debrief
17.1. Introduction
18. Debrief algorithms
18.1. Range/Bearing calculations within Debrief
18.1.1. LEGACY - The Rhumb-Line formulae
18.1.2. LEGACY - Short-distance sailing
18.2. Worm in the hole algorithm
18.2.1. Overview
18.2.2. Example
18.2.3. Algorithm
18.3. Other Debrief algorithms
18.3.1. Frequency algorithms
18.4. Remove Jumps
18.4.1. Background
18.4.2. Algorithm
18.5. Contouring algorithm
18.5.1. Introduction
18.5.2. CONREC
18.5.3. Algorithm
18.5.4. Example
18.5.5. Subroutine
18.5.6. Example
18.5.7. Note
19. Semi Automated Track Construction (SATC)
19.1. High-Level SATC Concepts
19.1.1. Strategy
19.1.2. Process
19.1.3. Data Concepts
19.1.4. Algorithms
19.1.5. Examples of contributions
19.2. Optimisation Strategies
19.2.1. Brute Force
19.2.2. Simulated Annealing
19.2.3. Genetic Algortihm
19.3. Solution Generator based on Genetic Algorithm
19.3.1. Definitions
19.3.2. Structure
19.3.3. Candidate Factory
19.3.4. Chromosome selection strategy
19.3.5. Genetic operators
19.3.6. Fitness function
19.3.7. Island attributes
20. System Documentation for DIS integration
20.1. Introduction
20.1.1. DIS Standard
20.1.2. Adding support for further DIS message types
20.2. Command line options
20.3. Messages supported
20.4. Other DIS specifics
Debrief Glossary
1. Introduction
Glossary
Index