Changes

Page history
Update home authored by leprob001's avatar leprob001
Hide whitespace changes
Inline Side-by-side
home.md
View page @ 4d0cd3d7
# Content # Content
This wiki contains all documentation that is created outside of the source code. This includes for example documents about the new file structure using MATLAB packages. This wiki contains all documentation that is created outside of the source code. This includes for example documents about the new file structure using MATLAB packages.
## ARTOA 4 user manual ## ARTOA 4 user manual
Note: This version of ARTOA4 was developed under Matlab 2020a. It seems to work under 2020b. However, it does not work under 2021b (Temperature und Pressure windows show no data). Note: This version of ARTOA4 was developed under Matlab 2020a. It seems to work under 2020b. However, it does not work under 2021b (Temperature und Pressure windows show no data).
### ARTOA 4 main window ### ARTOA 4 main window
1. Page tabs 1. Page tabs
1. [File](./ARTOA4-UserManual/File) 1. [File](./ARTOA4-UserManual/File)
2. [Edit](./ARTOA4-UserManual/Edit) 2. [Edit](./ARTOA4-UserManual/Edit)
3. Show 3. Show
4. Track 4. Track
5. View 5. View
2. Tracking Parameters 2. Tracking Parameters
3. [Combination Control](./ARTOA4-UserManual/SourceSelection) 3. [Combination Control](./ARTOA4-UserManual/SourceSelection)
4. [Offsets](./ARTOA4-UserManual/Offsets) 4. [Offsets](./ARTOA4-UserManual/Offsets)
5. [Offset controls](./ARTOA4-UserManual/Offset%20controls) 5. [Offset controls](./ARTOA4-UserManual/Offset%20controls)
## Known Issues ## Known Issues
1. When having deleted all tracks in the trajectory window, renewed tracking throws an error message. Workaround: Close the trajectory window and retrack from the main window 1. When having deleted all tracks in the trajectory window, renewed tracking throws an error message. Workaround: Close the trajectory window and retrack from the main window
### Time Of Arrival window ### Time Of Arrival window
#### Left hand information panels #### Left hand information panels
* Soundsource colors * Soundsource colors
* TOA histogram * TOA histogram
* Adjust colormap boundaries * Adjust colormap boundaries
* Duplicates * Duplicates
#### Central TOA display #### Central TOA display
* Scatterplot of TOAs. In grey scale (controlled by "Adjust colormap boundaries") for unassigned TOAs, in color (according to "soundsource colors" for TOAs assigned to a certain sound source. * Scatterplot of TOAs. In grey scale (controlled by "Adjust colormap boundaries") for unassigned TOAs, in color (according to "soundsource colors" for TOAs assigned to a certain sound source.
* Message date = ...... * Message date = ......
#### Right hand control buttons #### Right hand control buttons
* Select * Select
* Polygon * Polygon
Allows defining a ploygon by consecutive left-clicks and its closure by a right cklick. Minimum number of corners is 4. All TOA points therein are selected. Allows defining a ploygon by consecutive left-clicks and its closure by a right cklick. Minimum number of corners is 4. All TOA points therein are selected.
* Rectangle by date range * Rectangle by date range
Defines a rectangular selection box limited by Start and End dates in x, and full TOA range in y. All TOA points therein are selected. Start and End dates are entered via popup and are indicated by vertical gray lines. Defines a rectangular selection box limited by Start and End dates in x, and full TOA range in y. All TOA points therein are selected. Start and End dates are entered via popup and are indicated by vertical gray lines.
* Points * Points
* Drop * Drop
* SoundSource * SoundSource
* Apply * Apply
* Apply All Visible * Apply All Visible
* Withdraw * Withdraw
* Withdraw All Visible * Withdraw All Visible
* Rempap * Rempap
* Shift * Shift
* Shift selected * Shift selected
Shifts all selected TOAs (vertically) by the amount of seconds entered. Used, e.g., to correct for undocumented jumps in the floats clock, resulting in jumps in the TOA. Shifts all selected TOAs (vertically) by the amount of seconds entered. Used, e.g., to correct for undocumented jumps in the floats clock, resulting in jumps in the TOA.
* Reset selected * Reset selected
* Reset all * Reset all
## ARTOA4 memory data format specification ## ARTOA4 memory data format specification
The specification defines the structure of the MATLAB variables that are used by ARTOA3. The following formats are available: The specification defines the structure of the MATLAB variables that are used by ARTOA3. The following formats are available:
1. [RFB (.rfb) and SoundSource (.soso) files](./ARTOA4-memory-data-format-specification/RFB-(.rfb)-and-SoundSource-(.soso)-files) 1. [RFB (.rfb) and SoundSource (.soso) files](./ARTOA4-memory-data-format-specification/RFB-(.rfb)-and-SoundSource-(.soso)-files)
2. [Trajectory](./ARTOA4-memory-data-format-specification/Trajectory) 2. [Trajectory](./ARTOA4-memory-data-format-specification/Trajectory)
3. [artoaGui](./ARTOA4-memory-data-format-specification/artoaGui) 3. [artoaGui](./ARTOA4-memory-data-format-specification/artoaGui)
4. [artoaWorkspace](./ARTOA4-memory-data-format-specification/artoaWorkspace) 4. [artoaWorkspace](./ARTOA4-memory-data-format-specification/artoaWorkspace)
5. [ARTOA4 Globals](./ARTOA4-globals/README.md) 5. [ARTOA4 Globals](./ARTOA4-globals)
6. [artoaDataInput](./ARTOA4-memory-data-format-specification/artoaDataInput) 6. [artoaDataInput](./ARTOA4-memory-data-format-specification/artoaDataInput)
7. [toaData](./ARTOA4-memory-data-format-specification/toaData) 7. [toaData](./ARTOA4-memory-data-format-specification/toaData)
## ARTOA4 Algorithms ## ARTOA4 Algorithms
The documentation of the algorithms can be found in the following documents: The documentation of the algorithms can be found in the following documents:
1. [Offset calculations](./ARTOA4-Algorithms/Offset-calculations) 1. [Offset calculations](./ARTOA4-Algorithms/Offset-calculations)
2. [Satfix Toa Calculation](./ARTOA4-Algorithms/Satfix-Toa-Calculation) 2. [Satfix Toa Calculation](./ARTOA4-Algorithms/Satfix-Toa-Calculation)
3. [Soundspeed Selection](./ARTOA4-Algorithms/Soundspeed-Selection) 3. [Soundspeed Selection](./ARTOA4-Algorithms/Soundspeed-Selection)
## ARGO trajectory export ## ARGO trajectory export
artoa4 provides an export to netCDF function. This function is available through the File -> Save -> Argo trajectory file menu entry. artoa4 provides an export to netCDF function. This function is available through the File -> Save -> Argo trajectory file menu entry.
This will generate a netCDF file [based on the argo specification](https://archimer.ifremer.fr/doc/00187/29825/68654.pdf). This will generate a netCDF file [based on the argo specification](https://archimer.ifremer.fr/doc/00187/29825/68654.pdf).
\ No newline at end of file