mbcut
Section:  MB-System 5.0  (l)
Updated:  9 August 2001 
Index


 
NAME

mbcut - Removes data in specified regions of a swath
in swath sonar data.

 
VERSION

Version 5.0

 
SYNOPSIS

mbcut [-Akind/mode/min/max -Byr/mo/da/hr/mn/sc 
-Eyr/mo/da/hr/mn/sc 
-Fformat -Iinfile
-Llonflip -Ooutfile -Rwest/east/south/north 
-Sspeed 
-V -H]

 
DESCRIPTION

mbcut removes swath data values that lie in
user-specified ranges of beam numbers, pixel numbers, 
or acrosstrack distances.
Multiple cut ranges can be specified. The "cut" data is 
flagged rather than zeroed whenever possible (some formats
do not support flagging of some data types).
The default input and output streams are stdin and stdout.

 
AUTHORSHIP

David W. Caress (caress@mbari.org)




  Monterey Bay Aquarium Research Institute



Dale N. Chayes (dale@ldeo.columbia.edu)




  Lamont-Doherty Earth Observatory

 
 
OPTIONS


-A


kind/mode/min/max



Sets a range of data to be cut; multiple calls of this option
may be made. The kind value indicates whether the
affected data is bathymetry (kind = 0), amplitude 
(kind = 1), or sidescan (kind = 2).
The mode indicates whether the cut range is specified
in terms of beam/pixel number (mode = 1) or
acrosstrack distance (mode = 2). The min
and max values specify the actual cut range.
-B


yr/mo/da/hr/mn/sc



This option sets the starting time for data allowed in the input data.
The -E option sets the ending time for data. If the 
starting time is before the ending time, then any data
with a time stamp before the starting time or after the
ending time is ignored. If instead the starting time is
after the ending time, then any data between the ending
and starting time will be ignored. This scheme allows time
windowing both inside and outside a specified interval.
Default: yr/mo/da/hr/mn/sc = 1962/2/21/10/30/0.
-E


yr/mo/da/hr/mn/sc



This option sets the ending time for data allowed in the input data.
The -B option sets the starting time for data. If the 
starting time is before the ending time, then any data
with a time stamp before the starting time or after the
ending time is ignored. If instead the starting time is
after the ending time, then any data between the ending
and starting time will be ignored. This scheme allows time
windowing both inside and outside a specified interval.
Default: yr/mo/da/hr/mn/sc = 2062/2/21/10/30/0.
-F


format



Sets the data format used in reading the input from stdin
or from a file. This program uses the MBIO library 
and will read or write any swath sonar
format supported by MBIO. A list of the swath sonar data formats
currently supported by MBIO and their identifier values
is given in the MBIO manual page. Default: format = 11.
-H


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


infile



Sets the input swath sonar data filename. 
This program uses the MBIO library and will read or write any swath sonar
format supported by MBIO. A list of the swath sonar data formats
currently supported by MBIO and their identifier values
is given in the MBIO manual page. Default: infile = "stdin".
-L


lonflip



Sets the range of the longitude values returned.
If lonflip=-1 then the longitude values will be in
the range from -360 to 0 degrees. If lonflip=0 
then the longitude values will be in
the range from -180 to 180 degrees. If lonflip=1 
then the longitude values will be in
the range from 0 to 360 degrees.
Default: lonflip = 0.
-O


outfile



Data file to which the output data will be written. The MBIO
format id used is the same as for the input data. If
no output file is specified, the output will be written to
stdout. Default: outfile = stdout.
-R


west/east/south/north



Sets the longitude and latitude bounds within which swath sonar 
data will be read. Only the data which lies within these bounds will
be copied. 
Default: west=-360, east=360, south=-90, north=90.
-S


speed



Sets the minimum speed in km/hr (5.5 kts ~ 10 km/hr) allowed in 
the input data; pings associated with a smaller ship speed will not be
processed. Default: speed = 0.
-V


Normally, mbcut works "silently" without outputting
anything to the stderr stream.  If the
-V flag is given, then mbcut works in a "verbose" 
mode and outputs the program version being used, the values
of some important control parameters, and 
all error status messages.


 
EXAMPLES

Suppose one has a SeaBeam 2100 data file called test.mb41
which contains bathymetry (121 beams in a 120 degree swath), 
beam amplitude (121 beams coincident with bathymetry),
and sidescan data (2000 pixels, roughly a 150 degree swath).
The specular region of the sidescan swath (the center of the
swath) often causes problems when applying simple filters
to the sidescan. To remove the specular region prior to
the use of mbfilter, use mbcut as follows:

        mbcut -F41 -Itest.mb41 -Otestcut.mb41 -A2/2/-500/500 -V




This will remove one kilometer of data from the center of
the swath.

 
SEE ALSO

mbsystem(l), mbfilter(l)

 
BUGS

No one really likes to throw away data.



 
Index

NAME

VERSION

SYNOPSIS

DESCRIPTION

AUTHORSHIP

OPTIONS

EXAMPLES

SEE ALSO

BUGS

Return to list of MB-System manual pages...

Back to MB-System Home Page...