map_addhmb

Syntax

map_addhmb --help
map_addhmb [-vb] [-old] [-old_aacgm] [-cnt count] [-vel vmin] [-ex exlist]
[mapname]
map_addhmb -t [-vb] [-old] [-cnt count] [-vel vmin] [-ex exlist] [mapname]
map_addhmb -lf latname [-vb] [-old] [mapname]
map_addhmb -lat latmin [-vb] [-old] [mapname]

Synopsis

Calculates the position of the Heppner Maynard Boundary and adds it to a cnvmap format file.

Options

`--help`	print the help message and exit.
`--version`	print the RST version number and exit.
`-vb`	verbose. Log information to the console.
`-old`	the input file is a `map` format file.
`-old_aacgm`	uses the older AACGM software and coefficients. The default
	is to use AACGM-v2.
`-cnt count`	set the number of scatter points to get a match to be count.
`-vel vmin`	set the minimum velocity to vmin.
`-wdt wmin`	set the minimum spectral width to wmin.
`-ex exlist`	exclude data from the stations listed in exlist, which is a
	comma separated list of radar station numbers.
`mapname`	filename of the `cnvmap` format file. If this is omitted, the file will
	be read from standard input.
`-t`	instead of adding the calculated boundary to the map file,
	write the record time and the calculated location as ASCII text to standard
	output.
`-lf latname`	do not calculate the boundary, instead read it from the ASCII
	text file latname.
`-lat latmin`	do not calculate the boundary, instead set the lower latitude
	boundary to latmin degrees.
`-nodef`	do not use the default latmin if no data is available (ie use latmin from the statistical model).

Description

Adds a Heppner-Maynard boundary to a convection map file, or generates a data file containing the latitudes of the boundary at magnetic local midnight for each record in the file.

The file is written to standard output.

The default operation is to calculate a possible position of the Heppner-Maynard boundary from the line-of-sight velocity data in the convection map file. The two options "-vel" and "-cnt" adjust the algorithm. A boundary determination is made for each record in the map file. This is median filtered using the previous and subsequent records to reduce rapid fluctuations in the boundary. The median filtered boundary determination is then used to generate zero velocity model vectors that are added to the map file to constrain the convection pattern. The location of the boundary is also stored.

If the "-lat" option is specified, the location of the boundary is fixed so that at magnetic local midnight it has a latitude of latmin.

The "-lf" option will read the latitude of the boundary at magnetic local midnight from the plain text file latfile. Any lines in the file beginning the character "#" are treated as comments and ignored. Any other lines are expected to contain a time followed by two latitudes of the boundary at magnetic local midnight:

year month day hour minut second median actual

The two values correspond to a filtered and actual value of the latitude. Only the filtered value, median, is used to select the boundary for the map file. The boundary will be fixed at this value starting at the time specified and will only change if a subsequent entry in the boundary files alters it.

The "-t" option will generate a text file containing the latitude of the boundary at magnetic local midnight for each record in the map file. Each line of the output file contains the date and time of the start of the record followed by the median filtered boundary determination and the actual boundary determination of the record:

year month day hour minut second median actual

Examples

map_addhmb -vb -old 19980410.map > 19980410.hmb.map

Locate the Heppner-Maynard boundary for the map file "19980410.map". The output is written to the file "19980410.hmb.map" and status is logged to standard error.

map_addhmb -old -lat 64 19970415.map > 19970415.hmb.map

Add vectors to the map file "19970415.map" for a Heppner-Maynard boundary that crosses 64 degrees at magnetic local midnight. The output is written to the file "19970415.hmb.map".

map_addhmb -old -lf lat.dat 19990830.map > 19980830.hmb.map

Add vectors to the map file "19990830.map" taking latitudes for the Heppner-Maynard boundary from the file "lat.dat". The output is written to the file "19990830.map"

map_addhmb -old -t -vel 150 -cnt 4 20000410.map > lat.dat

Generate a list of latitudes from the map file "20000410.map". Set the minimum velocity magnitude to 150 m/s and the minimum number of points to 4. The output is written to "lat.dat".