mbdumpesf
Section:  MB-System 5.0  (1)
Updated:  3 May 2015 
Index


 
NAME

mbdumpesf - Output beam edits from a binary edit save file, either in the binary form or as an ASCII text dump.

 
VERSION

Version 5.0

 
SYNOPSIS

mbdumpesf --input=file
[--output=file --ignore-unflag --ignore-flag
--ignore-filter --ignore-zero --verbose --help]

 
DESCRIPTION

Swath bathymetry data is typically edited either with interactive
tools such as mbedit or automatic filters such as mbclean.
In MB-System, the beam flags are stored in binary "edit save files"
(file suffix ".esf"). The program mbdumpesf reads and outputs esf files. If
no output file is specified, then each of the edit events is written in ASCII text
as a single line to stdout. If an output file is specified with the --output=file
option, then the edit save data will be written to that file in binary form.

The four types of edit events supported by esf files are:




        action=1: flag manually


        action=2: unflag


        action=3: zero - make beam null


        action=4: flag by autofilter




This program can be forced to ignore (exclude from the output) any of the event
types using the options --ignore-unflag, --ignore-flag,
--ignore-filter, and --ignore-zero.

 
MB-SYSTEM AUTHORSHIP

David W. Caress




  Monterey Bay Aquarium Research Institute



Dale N. Chayes




  Center for Coastal and Ocean Mapping




  University of New Hampshire



Christian do Santos Ferreira




  MARUM - Center for Marine Environmental Sciences




  University of Bremen

 
MBDUMPESF OPTIONS


--input=file

"Edit save file" (esf file) from which the edit events will be read.
--output=file

Specifies output esf file. If this option is not used, then the edit
event stream will be output to stdout as a sequence of ASCII text lines.
--ignore-unflag

Causes mbdumpesf to not output any unflag edit events read from
the input.
--ignore-flag

Causes mbdumpesf to not output any flag edit events read from
the input.
--ignore-filter

Causes mbdumpesf to not output any filter edit events read from
the input.
--ignore-zero

Causes mbdumpesf to not output any zero edit events read from
the input.
--verbose

Normally, mbdumpesf outputs one line for each edit event in
the input esf file.  If the
--verbose flag is given, then mbdumpesf also outputs the
total number of each type of edit event at the end of the listing.
--help

This "help" flag causes the program to print out a description
of its operation and then exit immediately.


 
EXAMPLES

Suppose one has edited a swath file 20080422_222636.mb88, resulting
in an esf file named 20080422_222636.mb88.esf. To dump the edit events
as a text stream, use mbdumpesf:




        mbdumpesf -I 20080422_222636.mb88.esf




The output will look something like:







EDITS READ: i:0 time: 947562291.799000 2008/04/22 22:26:36.799000 beam:21 action:1



EDITS READ: i:1 time: 947562291.799000 2008/04/22 22:26:36.799000 beam:22 action:1



EDITS READ: i:2 time: 947562291.799000 2008/04/22 22:26:36.799000 beam:23 action:1



EDITS READ: i:3 time: 947562291.799000 2008/04/22 22:26:36.799000 beam:24 action:1



EDITS READ: i:4 time: 947562291.799000 2008/04/22 22:26:36.799000 beam:25 action:1



EDITS READ: i:5 time: 947562291.799000 2008/04/22 22:26:36.799000 beam:26 action:1



EDITS READ: i:6 time: 947562291.799000 2008/04/22 22:26:36.799000 beam:27 action:1



EDITS READ: i:7 time: 947562291.799000 2008/04/22 22:26:36.799000 beam:28 action:1







Here the large time value is epoch seconds (seconds since 1/1/1970), and the
edit event action values are:




        action=1: flag manually


        action=2: unflag


        action=3: zero - make beam null


        action=4: flag by autofilter


 
SEE ALSO

mbsystem(1), mbedit(1), mbeditviz(1), fBmbclean(1), mbunclean(1)

 
BUGS

Too simple to have any interesting problems.



 
Index

NAME

VERSION

SYNOPSIS

DESCRIPTION

MB-SYSTEM AUTHORSHIP

MBDUMPESF OPTIONS

EXAMPLES

SEE ALSO

BUGS