-.TH SPLAT! 1 "16 September 2007" "KD2BD Software" "KD2BD Software"
+.TH SPLAT! 1 "15 November 2008" "KD2BD Software" "KD2BD Software"
.SH NAME
-splat \- An RF \fBS\fPignal \fBP\fPropagation, \fBL\fPoss, \fBA\fPnd \fBT\fPerrain analysis tool
+splat An RF \fBS\fPignal \fBP\fPropagation, \fBL\fPoss, \fBA\fPnd \fBT\fPerrain analysis tool
.SH SYNOPSIS
splat [-t \fItransmitter_site.qth\fP]
[-r \fIreceiver_site.qth\fP]
[-m \fIearth radius multiplier (float)\fP]
[-f \fIfrequency (MHz) for Fresnel zone calculations (float)\fP]
[-R \fImaximum coverage radius (miles/kilometers) (float)\fP]
-[-dB \fImaximum attenuation contour to display on path loss maps (80-230 dB)\fP]
+[-dB \fIthreshold beyond which contours will not be displayed\fP]
+[-gc \fIground clutter height (feet/meters) (float)\fP]
[-fz \fIFresnel zone clearance percentage (default = 60)\fP]
-[-plo \fIpath_loss_output_file.txt\fP]
-[-pli \fIpath_loss_input_file.txt\fP]
+[-ano \fIalphanumeric output file name\fP]
+[-ani \fIalphanumeric input file name\fP]
[-udt \fIuser_defined_terrain_file.dat\fP]
[-n]
[-N]
[-nf]
+[-dbm]
[-ngs]
[-geo]
[-kml]
+[-gpsav]
[-metric]
.SH DESCRIPTION
\fBSPLAT!\fP is a powerful terrestrial RF propagation and terrain
and Longley-Rice analyses in situations where multiple transmitter or
repeater sites are employed, \fBSPLAT!\fP determines individual and
mutual areas of coverage within the network specified.
-
-Simply typing \fCsplat\fR on the command line will return a summary
-of \fBSPLAT!\fP's command line options:
-\fC
-
- --==[ SPLAT! v1.2.1 Available Options... ]==--
-
- -t txsite(s).qth (max of 4 with -c, max of 30 with -L)
- -r rxsite.qth
- -c plot coverage of TX(s) with an RX antenna at X feet/meters AGL
- -L plot path loss map of TX based on an RX at X feet/meters AGL
- -s filename(s) of city/site file(s) to import (5 max)
- -b filename(s) of cartographic boundary file(s) to import (5 max)
- -p filename of terrain profile graph to plot
- -e filename of terrain elevation graph to plot
- -h filename of terrain height graph to plot
- -H filename of normalized terrain height graph to plot
- -l filename of Longley-Rice graph to plot
- -o filename of topographic map to generate (.ppm)
- -u filename of user-defined terrain file to import
- -d sdf file directory path (overrides path in ~/.splat_path file)
- -m earth radius multiplier
- -n do not plot LOS paths in .ppm maps
- -N do not produce unnecessary site or obstruction reports
- -f frequency for Fresnel zone calculation (MHz)
- -R modify default range for -c or -L (miles/kilometers)
- -db maximum loss contour to display on path loss maps (80-230 dB)
- -nf do not plot Fresnel zones in height plots
- -fz Fresnel zone clearance percentage (default = 60)
- -ngs display greyscale topography as white in .ppm files
- -erp override ERP in .lrp file (Watts)
- -pli filename of path-loss input file
- -plo filename of path-loss output file
- -udt filename of user defined terrain input file
- -kml generate Google Earth (.kml) compatible output
- -geo generate an Xastir .geo georeference file (with .ppm output)
--metric employ metric rather than imperial units for all user I/O
-\fR
.SH INPUT FILES
\fBSPLAT!\fP is a command-line driven application and reads input
data through a number of data files. Some files are mandatory for
successful execution of the program, while others are optional.
-Mandatory files include 3-arc second topography models in the
+Mandatory files include digital elevation topography models in the
form of SPLAT Data Files (SDF files), site location files (QTH
files), and Longley-Rice model parameter files (LRP files).
Optional files include city location files, cartographic boundary
-files, user-defined terrain files, path-loss input files, antenna
+files, user-defined terrain files, path loss input files, antenna
radiation pattern files, and color definition files.
.SH SPLAT DATA FILES
\fBSPLAT!\fP imports topographic data in the form of SPLAT Data Files
(SDFs). These files may be generated from a number of information sources.
In the United States, SPLAT Data Files can be generated through U.S.
-Geological Survey Digital Elevation Models (DEMs) using the \fBusgs2sdf\fP
-utility included with \fBSPLAT!\fP. USGS Digital Elevation Models
-compatible with this utility may be downloaded from:
+Geological Survey Digital Elevation Models (DEMs) using the
+\fBpostdownload\fP and \fBusgs2sdf\fP utilities included with \fBSPLAT!\fP.
+USGS Digital Elevation Models compatible with these utilities may be
+downloaded from:
\fIhttp://edcftp.cr.usgs.gov/pub/data/DEM/250/\fP.
Significantly better resolution and accuracy can be obtained through
-the use of SRTM-3 Version 2 digital elevation models. These models are
-the product of the STS-99 Space Shuttle Radar Topography Mission, and
-are available for most populated regions of the Earth. SPLAT Data Files
-may be generated from SRTM data using the included \fBsrtm2sdf\fP utility.
+the use of SRTM Version 2 digital elevation models, especially when
+supplemented by USGS-derived SDF data. These one-degree by
+one-degree models are the product of the Space Shuttle STS-99
+Radar Topography Mission, and are available for most populated
+regions of the Earth. SPLAT Data Files may be generated from
+3 arc-second SRTM-3 data using the included \fBsrtm2sdf\fP utility.
SRTM-3 Version 2 data may be obtained through anonymous FTP from:
-\fIftp://e0srp01u.ecs.nasa.gov:21/srtm/version2/\fP
+\fIftp://e0srp01u.ecs.nasa.gov:21/srtm/version2/SRTM3/\fP
-The \fBstrm2sdf\fP utility may also be used to convert 3-arc second SRTM
+Note that SRTM filenames refer to the latitude and longitude of the
+southwest corner of the topographic dataset contained within the file.
+Therefore, the region of interest must lie north and east of the latitude
+and longitude provided in the SRTM filename.
+
+The \fBsrtm2sdf\fP utility may also be used to convert 3-arc second SRTM
data in Band Interleaved by Line (.BIL) format for use with \fBSPLAT!\fP.
This data is available via the web at:
\fIhttp://seamless.usgs.gov/website/seamless/\fP
\fBsrtm2sdf\fP's documentation for instructions on downloading .BIL
topographic data through the USGS's Seamless Web Site.
+Even greater resolution and accuracy can be obtained by using 1 arc-second
+SRTM-1 Version 2 topography data. This data is available for the United
+States and its territories and possessions, and may be downloaded from:
+\fIftp://e0srp01u.ecs.nasa.gov:21/srtm/version2/SRTM1/\fP
+
+High resolution SDF files for use with \fBSPLAT! HD\fP may be generated
+from data in this format using the \fBsrtm2sdf-hd\fP utility.
+
Despite the higher accuracy that SRTM data has to offer, some voids
in the data sets exist. When voids are detected, the \fBsrtm2sdf\fP
-utility replaces them with corresponding data found in existing SDF
-files (that were presumably created from earlier USGS data through the
-\fBusgs2sdf\fP utility). If USGS-derived SDF data is not available, voids
-are handled through adjacent pixel averaging, or direct replacement.
+and \fBsrtm2sdf-hd\fP utilities replace them with corresponding data
+found in \fBusgs2sdf\fP generated SDF files. If USGS-derived SDF data
+is not available, voids are handled through adjacent pixel averaging,
+or direct replacement.
-SPLAT Data Files contain integer value topographic elevations (in meters)
+SPLAT Data Files contain integer value topographic elevations in meters
referenced to mean sea level for 1-degree by 1-degree regions of the
-earth with a resolution of 3-arc seconds. SDF files can be read in
-either standard format (\fI.sdf\fP) as generated by the \fBusgs2sdf\fP
-and \fBsrtm2sdf\fP utilities, or in bzip2 compressed format
-(\fI.sdf.bz2\fP). Since uncompressed files can be read slightly
-faster than files that have been compressed, \fBSPLAT!\fP searches for
-needed SDF data in uncompressed format first. If uncompressed data
-cannot be located, \fBSPLAT!\fP then searches for data in bzip2 compressed
-format. If no compressed SDF files can be found for the region requested,
+Earth. SDF files can be read by \fBSPLAT!\fP in either standard format
+(\fI.sdf\fP) as generated directly by the \fBusgs2sdf\fP, \fBsrtm2sdf\fP,
+and \fBsrtm2sdf-hd\fP utilities, or in bzip2 compressed format
+(\fI.sdf.bz2\fP). Since uncompressed files can be read slightly faster
+than files that have been compressed, \fBSPLAT!\fP searches for needed
+SDF data in uncompressed format first. If uncompressed data cannot be
+located, \fBSPLAT!\fP then searches for data in bzip2 compressed format.
+If no compressed SDF files can be found for the region requested,
\fBSPLAT!\fP assumes the region is over water, and will assign an
elevation of sea-level to these areas.
For example, a site location file describing television station WNJT-DT,
Trenton, NJ (\fIwnjt-dt.qth\fP) might read as follows:
\fC
+
WNJT-DT
40.2828
74.6864
990.00
\fR
+
Each transmitter and receiver site analyzed by \fBSPLAT!\fP must be
represented by its own site location (QTH) file.
.SH LONGLEY-RICE PARAMETER (LRP) FILES
Longley-Rice parameter data files are required for \fBSPLAT!\fP to
-determine RF path loss in either point-to-point or area prediction
-mode. Longley-Rice model parameter data is read from files having
-the same base name as the transmitter site QTH file, but with a
-\fI.lrp\fP extension. \fBSPLAT!\fP LRP files share the following
-format (\fIwnjt-dt.lrp\fP):
+determine RF path loss, field strength, or received signal power
+level in either point-to-point or area prediction mode. Longley-Rice
+model parameter data is read from files having the same base name
+as the transmitter site QTH file, but with a \fI.lrp\fP extension.
+\fBSPLAT!\fP LRP files share the following format (\fIwnjt-dt.lrp\fP):
\fC
+
15.000 ; Earth Dielectric Constant (Relative permittivity)
0.005 ; Earth Conductivity (Siemens per meter)
301.000 ; Atmospheric Bending Constant (N-units)
0.90 ; Fraction of time (90% of the time)
46000.0 ; ERP in Watts (optional)
\fR
+
If an LRP file corresponding to the tx_site QTH file cannot
be found, \fBSPLAT!\fP scans the current working directory for
the file "splat.lrp". If this file cannot be found, then default
City : 5 0.001
Poor ground : 4 0.001
\fR
+
Radio climate codes used by \fBSPLAT!\fP are as follows:
\fC
+
1: Equatorial (Congo)
2: Continental Subtropical (Sudan)
3: Maritime Subtropical (West coast of Africa)
6: Maritime Temperate, over land (UK and west coasts of US & EU)
7: Maritime Temperate, over sea
\fR
+
The Continental Temperate climate is common to large land masses in
the temperate zone, such as the United States. For paths shorter than
100 km, there is little difference between Continental and Maritime
studies. If the parameter is omitted, path loss is computed instead.
The ERP provided in the \fI.lrp\fP file can be overridden by using
\fBSPLAT!\fP's \fI-erp\fP command-line switch. If the \fI.lrp\fP file
-contains an ERP parameter and the generation of path-loss rather than
-signal strength contours is desired, the ERP can be assigned to zero
+contains an ERP parameter and the generation of path loss rather than
+field strength contours is desired, the ERP can be assigned to zero
using the \fI-erp\fP switch without having to edit the \fI.lrp\fP file
to accomplish the same result.
.SH CITY LOCATION FILES
For example (\fIcities.dat\fP):
\fC
+
Teaneck, 40.891973, 74.014506
Tenafly, 40.919212, 73.955892
Teterboro, 40.859511, 74.058908
Totowa, 40.906160, 74.223310
Trenton, 40.219922, 74.754665
\fR
+
A total of five separate city data files may be imported at a time,
and there is no limit to the size of these files. \fBSPLAT!\fP reads
city data on a "first come/first served" basis, and plots only those
of \fBSPLAT!\fP's switches may be cascaded in any order on the command
line when invoking the program.
+Simply typing \fCsplat\fR on the command line will return a summary
+of \fBSPLAT!\fP's command line options:
+\fC
+
+ --==[ SPLAT! v1.3.0 Available Options... ]==--
+
+ -t txsite(s).qth (max of 4 with -c, max of 30 with -L)
+ -r rxsite.qth
+ -c plot coverage of TX(s) with an RX antenna at X feet/meters AGL
+ -L plot path loss map of TX based on an RX at X feet/meters AGL
+ -s filename(s) of city/site file(s) to import (5 max)
+ -b filename(s) of cartographic boundary file(s) to import (5 max)
+ -p filename of terrain profile graph to plot
+ -e filename of terrain elevation graph to plot
+ -h filename of terrain height graph to plot
+ -H filename of normalized terrain height graph to plot
+ -l filename of path loss graph to plot
+ -o filename of topographic map to generate (.ppm)
+ -u filename of user-defined terrain file to import
+ -d sdf file directory path (overrides path in ~/.splat_path file)
+ -m earth radius multiplier
+ -n do not plot LOS paths in .ppm maps
+ -N do not produce unnecessary site or obstruction reports
+ -f frequency for Fresnel zone calculation (MHz)
+ -R modify default range for -c or -L (miles/kilometers)
+ -db threshold beyond which contours will not be displayed
+ -nf do not plot Fresnel zones in height plots
+ -fz Fresnel zone clearance percentage (default = 60)
+ -gc ground clutter height (feet/meters)
+ -ngs display greyscale topography as white in .ppm files
+ -erp override ERP in .lrp file (Watts)
+ -ano name of alphanumeric output file
+ -ani name of alphanumeric input file
+ -udt filename of user defined terrain input file
+ -kml generate Google Earth (.kml) compatible output
+ -geo generate an Xastir .geo georeference file (with .ppm output)
+ -dbm plot signal power level contours rather than field strength
+ -gpsav preserve gnuplot temporary working files after SPLAT! execution
+-metric employ metric rather than imperial units for all user I/O
+\fR
+
+The command-line options for \fCsplat\fR and \fCsplat-hd\fR are identical.
+
\fBSPLAT!\fP operates in two distinct modes: \fIpoint-to-point mode\fP,
and \fIarea prediction mode\fP. Either a line-of-sight (LOS) or Longley-Rice
Irregular Terrain (ITM) propagation model may be invoked by the user. True
\fCsplat -t tx_site -r rx_site -l path_loss_profile.png\fR
As before, adding the \fI-metric\fP switch forces the graphs to
-be plotted using metric units of measure.
+be plotted using metric units of measure. The \fI-gpsav\fP switch
+instructs \fBSPLAT!\fP to preserve (rather than delete) the \fBgnuplot\fP
+working files generated during \fBSPLAT!\fP execution, allowing the user
+to edit these files and re-run \fBgnuplot\fP if desired.
When performing a point-to-point analysis, a \fBSPLAT!\fP Path Analysis
Report is generated in the form of a text file with a \fI.txt\fP filename
follows in the colors indicated (along with their corresponding RGB
values in decimal):
\fC
+
site1: Green (0,255,0)
site2: Cyan (0,255,255)
site3: Medium Violet (147,112,219)
site1 + site2 + site3 + site4: Gold2 (238,201,0)
\fR
+
If separate \fI.qth\fP files are generated, each representing a common
site location but a different antenna height, a single topographic map
-illustrating the regional coverage from as many as four separate locations
-on a single tower may be generated by \fBSPLAT!\fP.
-.SH LONGLEY-RICE PATH LOSS ANALYSIS
+illustrating the regional coverage from as many as four separate
+locations on a single tower may be generated by \fBSPLAT!\fP.
+.SH PATH LOSS ANALYSIS
If the \fI-c\fP switch is replaced by a \fI-L\fP switch, a
Longley-Rice path loss map for a transmitter site may be generated:
In this mode, \fBSPLAT!\fP generates a multi-color map illustrating
expected signal levels in areas surrounding the transmitter site. A
legend at the bottom of the map correlates each color with a specific
-path loss range in decibels or signal strength in decibels over one
-microvolt per meter (dBuV/m).
+path loss range in decibels.
-The Longley-Rice analysis range may be modified to a user-specific
-value using the \fI-R\fP switch. The argument must be given in miles
+The \fI-db\fP switch allows a threshold to be set beyond which contours
+will not be plotted on the map. For example, if a path loss beyond -140 dB
+is irrelevant to the survey being conducted, \fBSPLAT!\fP's path loss plot
+can be constrained to the region bounded by the 140 dB attenuation contour
+as follows:
+
+\fCsplat -t wnjt-dt -L 30.0 -s cities.dat -b co34_d00.dat -db 140 -o plot.ppm\fR
+
+The path loss contour threshold may be expressed as either a positive or
+negative quantity.
+
+The path loss analysis range may be modified to a user-specific
+distance using the \fI-R\fP switch. The argument must be given in miles
(or kilometers if the \fI-metric\fP switch is used). If a range wider
than the generated topographic map is specified, \fBSPLAT!\fP will
perform Longley-Rice path loss calculations between all four corners
of the area prediction map.
-The \fI-db\fP switch allows a constraint to be placed on the maximum
-path loss region plotted on the map. A maximum path loss between 80
-and 230 dB may be specified using this switch. For example, if a path
-loss beyond -140 dB is irrelevant to the survey being conducted,
-\fBSPLAT!\fP's path loss plot can be constrained to the region
-bounded by the 140 dB attenuation contour as follows:
-
-\fCsplat -t wnjt-dt -L 30.0 -s cities.dat -b co34_d00.dat -db 140 -o plot.ppm\fR
-
-.SH SIGNAL CONTOUR COLOR DEFINITION PARAMETERS
-The colors used to illustrate signal strength and path loss contours
-in \fBSPLAT!\fP generated coverage maps may be tailored by the user
-by creating or modifying \fBSPLAT!\fP's color definition files.
-\fBSPLAT!\fP color definition files have the same base name as the
-transmitter's \fI.qth\fP file, but carry \fI.lcf\fP and \fI.scf\fP
-extensions.
+The colors used to illustrate contour regions in \fBSPLAT!\fP generated
+coverage maps may be tailored by the user by creating or modifying
+\fBSPLAT!\fP's color definition files. \fBSPLAT!\fP color definition
+files have the same base name as the transmitter's \fI.qth\fP file,
+but carry \fI.lcf\fP, \fI.scf\fP, and \fI.dcf\fP extensions. If the
+necessary file does not exist in the current working when \fBSPLAT!\fP
+is run, a file containing default color definition parameters that
+is suitable for manual editing by the user is written into the current
+directory.
When a regional Longley-Rice analysis is performed and the transmitter's
ERP is not specified or is zero, a \fI.lcf\fP path loss color
read by \fBSPLAT!\fP from the current working directory. If a \fI.lcf\fP
file corresponding to the transmitter site is not found, then a default
file suitable for manual editing by the user is automatically generated
-by \fBSPLAT!\fP. If the transmitter's ERP is specified, then a signal
-strength map is generated and a signal strength color definition file
-(\fI.scf\fP) is read, or generated if one is not available in the current
-working directory.
+by \fBSPLAT!\fP.
-A path-loss color definition file possesses the following structure
+A path loss color definition file possesses the following structure
(\fIwnjt-dt.lcf\fP):
\fC
+
; SPLAT! Auto-generated Path-Loss Color Definition ("wnjt-dt.lcf") File
;
; Format for the parameters held in this file is as follows:
\fR
If the path loss is less than 80 dB, the color Red (RGB = 255, 0, 0) is
-assigned to the region. If the path-loss is greater than or equal to
+assigned to the region. If the path loss is greater than or equal to
80 dB, but less than 90 db, then Dark Orange (255, 128, 0) is assigned
to the region. Orange (255, 165, 0) is assigned to regions having a
path loss greater than or equal to 90 dB, but less than 100 dB, and
so on. Greyscale terrain is displayed beyond the 230 dB path loss
contour.
+.SH FIELD STRENGTH ANALYSIS
+If the transmitter's effective radiated power (ERP) is specified in
+the transmitter's \fI.lrp\fP file, or expressed on the command-line using
+the \fI-erp\fP switch, field strength contours referenced to decibels
+over one microvolt per meter (dBuV/m) rather than path loss are produced:
-\fBSPLAT!\fP signal strength color definition files share a very similar
-structure (\fIwnjt-dt.scf\fP):
+\fCsplat -t wnjt-dt -L 30.0 -erp 46000 -db 30 -o plot.ppm\fR
+
+The \fI-db\fP switch can be used in this mode as before to limit the
+extent to which field strength contours are plotted. When plotting
+field strength contours, however, the argument given is interpreted
+as being expressed in dBuV/m.
+
+\fBSPLAT!\fP field strength color definition files share a very
+similar structure to \fI.lcf\fP files used for plotting path loss:
\fC
+
; SPLAT! Auto-generated Signal Color Definition ("wnjt-dt.scf") File
;
; Format for the parameters held in this file is as follows:
8: 140, 0, 128
\fR
-If the signal strength is greater than or equal to 128 db over 1 microvolt
+If the signal strength is greater than or equal to 128 dB over 1 microvolt
per meter (dBuV/m), the color Red (255, 0, 0) is displayed for the region.
-If the signal strength is greater than or equal to 118 dbuV/m, but less than
-128 dbuV/m, then the color Orange (255, 165, 0) is displayed, and so on.
+If the signal strength is greater than or equal to 118 dBuV/m, but less than
+128 dBuV/m, then the color Orange (255, 165, 0) is displayed, and so on.
Greyscale terrain is displayed for regions with signal strengths less than
8 dBuV/m.
Signal strength contours for some common VHF and UHF broadcasting services
in the United States are as follows:
\fC
+
+
+
+
Analog Television Broadcasting
------------------------------
Channels 2-6: City Grade: >= 74 dBuV/m
Digital Service Contour: 65 dBuV/m
\fR
+.SH RECEIVED POWER LEVEL ANALYSIS
+If the transmitter's effective radiated power (ERP) is specified in
+the transmitter's \fI.lrp\fP file, or expressed on the command-line using
+the \fI-erp\fP switch, and the \fI-dbm\fP switch is invoked, received
+power level contours referenced to decibels over one milliwatt (dBm)
+are produced:
+
+\fCsplat -t wnjt-dt -L 30.0 -erp 46000 -dbm -db -100 -o plot.ppm\fR
+
+The \fI-db\fP switch can be used to limit the extent to which received
+power level contours are plotted. When plotting power level contours,
+the argument given is interpreted as being expressed in dBm.
+
+\fBSPLAT!\fP received power level color definition files share a very
+similar structure to the color definition files described earlier,
+except that the power levels in dBm may be either positive or negative,
+and are limited to a range between +40 dBm and -200 dBm:
+\fC
+
+ ; SPLAT! Auto-generated DBM Signal Level Color Definition ("wnjt-dt.dcf") File
+ ;
+ ; Format for the parameters held in this file is as follows:
+ ;
+ ; dBm: red, green, blue
+ ;
+ ; ...where "dBm" is the received signal power level between +40 dBm
+ ; and -200 dBm, and "red", "green", and "blue" are the corresponding
+ ; RGB color definitions ranging from 0 to 255 for the region specified.
+ ;
+ ; The following parameters may be edited and/or expanded
+ ; for future runs of SPLAT! A total of 32 contour regions
+ ; may be defined in this file.
+ ;
+ ;
+ +0: 255, 0, 0
+ -10: 255, 128, 0
+ -20: 255, 165, 0
+ -30: 255, 206, 0
+ -40: 255, 255, 0
+ -50: 184, 255, 0
+ -60: 0, 255, 0
+ -70: 0, 208, 0
+ -80: 0, 196, 196
+ -90: 0, 148, 255
+ -100: 80, 80, 255
+ -110: 0, 38, 255
+ -120: 142, 63, 255
+ -130: 196, 54, 255
+ -140: 255, 0, 255
+ -150: 255, 194, 204
+\fR
+
.SH ANTENNA RADIATION PATTERN PARAMETERS
Normalized field voltage patterns for a transmitting antenna's horizontal
and vertical planes are imported automatically into \fBSPLAT!\fP when a
-Longley-Rice coverage analysis is performed. Antenna pattern data is
-read from a pair of files having the same base name as the transmitter
-and LRP files, but with \fI.az\fP and \fI.el\fP extensions for azimuth
-and elevation pattern files, respectively. Specifications regarding
-pattern rotation (if any) and mechanical beam tilt and tilt direction
-(if any) are also contained within \fBSPLAT!\fP antenna pattern files.
+path loss, field strength, or received power level coverage analysis is
+performed. Antenna pattern data is read from a pair of files having
+the same base name as the transmitter and LRP files, but with \fI.az\fP
+and \fI.el\fP extensions for azimuth and elevation pattern files,
+respectively. Specifications regarding pattern rotation (if any) and
+mechanical beam tilt and tilt direction (if any) are also contained
+within \fBSPLAT!\fP antenna pattern files.
For example, the first few lines of a \fBSPLAT!\fP azimuth pattern file
might appear as follows (\fIkvea.az\fP):
\fC
+
183.0
0 0.8950590
1 0.8966406
7 0.9047923
8 0.9060051
\fR
+
The first line of the \fI.az\fP file specifies the amount of azimuthal
pattern rotation (measured clockwise in degrees from True North) to be
applied by \fBSPLAT!\fP to the data contained in the \fI.az\fP file.
For example, the first few lines a \fBSPLAT!\fP elevation pattern file
might appear as follows (\fIkvea.el\fP):
\fC
+
1.1 130.0
-10.0 0.172
-9.5 0.109
-6.5 0.109
-6.0 0.185
\fR
+
In this example, the antenna is mechanically tilted downward 1.1 degrees
towards an azimuth of 130.0 degrees.
\fBSPLAT!\fP will interpolate the values provided to determine the
data at the required resolution, although this may result in a loss
in accuracy.
-
-.SH IMPORTING AND EXPORTING REGIONAL PATH LOSS CONTOUR DATA
-Performing a Longley-Rice coverage analysis can be a very time
-consuming process, especially if the analysis is repeated repeatedly
-to discover what effects changes to the antenna radiation patterns
-make to the predicted coverage area.
-
-This process can be expedited by exporting the Longley-Rice
-regional path loss contour data to an output file, modifying the
-path loss data externally to incorporate antenna pattern effects,
-and then importing the modified path loss data back into \fBSPLAT!\fP
-to rapidly produce a revised path loss map.
-
-For example, a path loss output file can be generated by \fBSPLAT!\fP
-for a receive site 30 feet above ground level over a 50 mile radius
-surrounding a transmitter site to a maximum path loss of 140 dB using
-the following syntax:
-
-\fCsplat -t kvea -L 30.0 -R 50.0 -db 140 -plo pathloss.dat\fR
-
-\fBSPLAT!\fP path loss output files often exceed 100 megabytes in size.
-They contain information relating to the boundaries of region they describe
-followed by latitudes (degrees North), longitudes (degrees West), azimuths,
-elevations (to the first obstruction), and path loss figures (dB) for a
-series of specific points that comprise the region surrounding the
-transmitter site. The first few lines of a \fBSPLAT!\fP path loss
-output file take on the following appearance (\fIpathloss.dat\fP):
+.SH EXPORTING AND IMPORTING REGIONAL CONTOUR DATA
+Performing a regional coverage analysis based on a Longley-Rice
+path analysis can be a very time consuming process, especially if
+the analysis is performed repeatedly to discover what effects changes
+to a transmitter's antenna radiation pattern make to the predicted
+coverage area.
+
+This process can be expedited by exporting the contour data produced
+by \fBSPLAT!\fP to an alphanumeric output \fI(.ano)\fP file. The data
+contained in this file can then be modified to incorporate antenna
+pattern effects, and imported back into \fBSPLAT!\fP to quickly
+produce a revised contour map. Depending on the way in which
+\fBSPLAT!\fP is invoked, alphanumeric output files can describe
+regional path loss, signal strength, or received signal power levels.
+
+For example, an alphanumeric output file containing path loss information
+can be generated by \fBSPLAT!\fP for a receive site 30 feet above ground
+level over a 50 mile radius surrounding a transmitter site to a maximum
+path loss of 140 dB (assuming ERP is not specified in the transmitter's
+\fI.lrp \fPfile) using the following syntax:
+
+\fCsplat -t kvea -L 30.0 -R 50.0 -db 140 -ano pathloss.dat\fR
+
+If ERP is specified in the \fI.lrp\fP file or on the command line through
+the \fI-erp\fP switch, the alphanumeric output file will instead contain
+predicted field values in dBuV/m. If the \fI-dBm\fP command line switch
+is used, then the alphanumeric output file will contain receive signal
+power levels in dBm.
+
+\fBSPLAT!\fP alphanumeric output files can exceed many hundreds of
+megabytes in size. They contain information relating to the boundaries
+of the region they describe followed by latitudes (degrees North),
+longitudes (degrees West), azimuths (referenced to True North),
+elevations (to the first obstruction), followed by either path loss
+(in dB), received field strength (in dBuV/m), or received signal
+power level (in dBm) \fBwithout regard to the transmitting antenna's
+radiation pattern\fP.
+
+The first few lines of a \fBSPLAT!\fP alphanumeric output file could
+take on the following appearance (\fIpathloss.dat\fP):
\fC
+
119, 117 ; max_west, min_west
- 35, 33 ; max_north, min_north
- 34.2265434, 118.0631104, 48.171, -37.461, 67.70
- 34.2270355, 118.0624390, 48.262, -26.212, 73.72
- 34.2280197, 118.0611038, 48.269, -14.951, 79.74
- 34.2285156, 118.0604401, 48.207, -11.351, 81.68
- 34.2290077, 118.0597687, 48.240, -10.518, 83.26
- 34.2294998, 118.0591049, 48.225, 23.201, 84.60
- 34.2304878, 118.0577698, 48.213, 15.769, 137.84
- 34.2309799, 118.0570984, 48.234, 15.965, 151.54
- 34.2314720, 118.0564346, 48.224, 16.520, 149.45
- 34.2319679, 118.0557632, 48.223, 15.588, 151.61
- 34.2329521, 118.0544281, 48.230, 13.889, 135.45
- 34.2334442, 118.0537643, 48.223, 11.693, 137.37
- 34.2339401, 118.0530930, 48.222, 14.050, 126.32
- 34.2344322, 118.0524292, 48.216, 16.274, 156.28
- 34.2354164, 118.0510941, 48.222, 15.058, 152.65
- 34.2359123, 118.0504227, 48.221, 16.215, 158.57
- 34.2364044, 118.0497589, 48.216, 15.024, 157.30
- 34.2368965, 118.0490875, 48.225, 17.184, 156.36
+ 35, 34 ; max_north, min_north
+ 34.2265424, 118.0631096, 48.199, -32.747, 67.70
+ 34.2270358, 118.0624421, 48.199, -19.161, 73.72
+ 34.2275292, 118.0617747, 48.199, -13.714, 77.24
+ 34.2280226, 118.0611072, 48.199, -10.508, 79.74
+ 34.2290094, 118.0597723, 48.199, -11.806, 83.26 *
+ 34.2295028, 118.0591048, 48.199, -11.806, 135.47 *
+ 34.2299962, 118.0584373, 48.199, -15.358, 137.06 *
+ 34.2304896, 118.0577698, 48.199, -15.358, 149.87 *
+ 34.2314763, 118.0564348, 48.199, -15.358, 154.16 *
+ 34.2319697, 118.0557673, 48.199, -11.806, 153.42 *
+ 34.2324631, 118.0550997, 48.199, -11.806, 137.63 *
+ 34.2329564, 118.0544322, 48.199, -11.806, 139.23 *
+ 34.2339432, 118.0530971, 48.199, -11.806, 139.75 *
+ 34.2344365, 118.0524295, 48.199, -11.806, 151.01 *
+ 34.2349299, 118.0517620, 48.199, -11.806, 147.71 *
+ 34.2354232, 118.0510944, 48.199, -15.358, 159.49 *
+ 34.2364099, 118.0497592, 48.199, -15.358, 151.67 *
\fR
-It is not uncommon for \fBSPLAT!\fP path loss files to contain as
-many as 3 million or more lines of data. Comments can be placed in
-the file if they are proceeded by a semicolon character. The \fBvim\fP
-text editor has proven capable of editing files of this size.
+
+Comments can be placed in the file if they are proceeded by a semicolon
+character. The \fBvim\fP text editor has proven capable of editing
+files of this size.
Note as was the case in the antenna pattern files, negative elevation
angles refer to upward tilt (above the horizon), while positive angles
elevation to the receiving antenna at the height above ground level
specified using the \fI-L\fP switch \fIif\fP the path between transmitter
and receiver is unobstructed. If the path between the transmitter
-and receiver is obstructed, then the elevation angle to the first
-obstruction is returned by \fBSPLAT!\fP. This is because
-the Longley-Rice model considers the energy reaching a distant point
-over an obstructed path as a derivative of the energy scattered from
-the top of the first obstruction, only. Since energy cannot reach
-the obstructed location directly, the actual elevation angle to that
-point is irrelevant.
+and receiver is obstructed, an asterisk (*) is placed on the end of
+the line, and the elevation angle returned by \fBSPLAT!\fP refers the
+elevation angle to the first obstruction rather than the geographic
+location specified on the line. This is done in response to the fact
+that the Longley-Rice model considers the energy reaching a distant point
+over an obstructed path to be the result of the energy scattered over
+the top of the first obstruction along the path. Since energy cannot
+reach the obstructed location directly, the actual elevation angle to
+the destination over such a path becomes irrelevant.
When modifying \fBSPLAT!\fP path loss files to reflect antenna
-pattern data, \fIonly the last column (path loss)\fP should be amended
+pattern data, \fIonly the last numeric column\fP should be amended
to reflect the antenna's normalized gain at the azimuth and elevation
-angles specified in the file. (At this time, programs and scripts
-capable of performing this operation are left as an exercise for
-the user.)
-
-Modified path loss maps can be imported back into \fBSPLAT!\fP for
-generating revised coverage maps:
-
-\fCsplat -t kvea -pli pathloss.dat -s city.dat -b county.dat -o map.ppm\fR
-
-\fBSPLAT!\fP path loss files can also be used for conducting coverage or
-interference studies outside of \fBSPLAT!\fP.
+angles specified in the file. Programs and scripts capable of
+performing this task are left as an exercise for the user.
+
+Modified alphanumeric output files can be imported back into \fBSPLAT!\fP
+for generating revised coverage maps provided that the ERP and -dBm options
+are used as they were when the alphanumeric output file was originally
+generated:
+
+\fCsplat -t kvea -ani pathloss.dat -s city.dat -b county.dat -o map.ppm\fR
+
+Note that alphanumeric output files generated by \fCsplat\fR cannot
+be used with \fCsplat-hd\fR, or vice-versa due to the resolution
+incompatibility between the two versions of the program. Also, each of
+the three types of alphanumeric output files are incompatible with one
+another, so a file containing path loss data cannot be imported into
+\fBSPLAT!\fR to produce signal strength or received power level contours, etc.
.SH USER-DEFINED TERRAIN INPUT FILES
-A user-defined terrain file is a user-generated text file containing latitudes,
-longitudes, and heights above ground level of specific terrain features believed
-to be of importance to the \fBSPLAT!\fP analysis being conducted, but noticeably
-absent from the SDF files being used. A user-defined terrain file is imported
-into a \fBSPLAT!\fP analysis using the \fI-udt\fP switch:
+A user-defined terrain file is a user-generated text file containing
+latitudes, longitudes, and heights above ground level of specific terrain
+features believed to be of importance to the \fBSPLAT!\fP analysis
+being conducted, but noticeably absent from the SDF files being used.
+A user-defined terrain file is imported into a \fBSPLAT!\fP analysis
+using the \fI-udt\fP switch:
\fC splat -t tx_site -r rx_site -udt udt_file.txt -o map.ppm\fR
A user-defined terrain file has the following appearance and structure:
\fC
+
40.32180556, 74.1325, 100.0 meters
40.321805, 74.1315, 300.0
40.3218055, 74.1305, 100.0 meters
\fR
+
Terrain height is interpreted as being described in feet above ground
level unless followed by the word \fImeters\fP, and is added \fIon top of\fP
the terrain specified in the SDF data for the locations specified. Be
aware that each user-defined terrain feature specified will be interpreted
-as being 3-arc seconds in both latitude and longitude. Features described
-in the user-defined terrain file that overlap previously defined features
-in the file are ignored by \fBSPLAT!\fP.
+as being 3-arc seconds in both latitude and longitude in \fCsplat\fR and
+1 arc-second in latitude and longitude in \fCsplat-hd\fR. Features
+described in the user-defined terrain file that overlap previously
+defined features in the file are ignored by \fBSPLAT!\fP to avoid
+ambiguity.
+.SH GROUND CLUTTER
+The height of ground clutter can be specified using the \fI-gc\fP switch:
+\fC
+
+ splat -t wnjt-dt -r kd2bd -gc 30.0 -H wnjt-dt_path.png
+\fR
+
+The \fI-gc\fP switch as the effect of raising the overall terrain by the
+specified amount in feet (or meters if the \fI-metric\fP switch is invoked),
+except over areas at sea-level and at the transmitting and receiving
+antenna locations. Note that the addition of ground clutter does not
+necessarily modify the Longley-Rice path loss results unless the additional
+clutter height results in a switch in the propagation mode from a less
+obstructed path to a more obstructed path (from Line Of Sight to Single
+Horizon Diffraction Dominant, for example). It does, however, affect
+Fresnel zone clearances and line of sight determinations.
.SH SIMPLE TOPOGRAPHIC MAP GENERATION
In certain situations it may be desirable to generate a topographic map
of a region without plotting coverage areas, line-of-sight paths, or
data is available), then those radials are omitted from the calculation
of average terrain.
-Note that SRTM elevation data, unlike older 3-arc second USGS data,
-extends beyond the borders of the United States. Therefore, HAAT
-results may not be in full compliance with FCC Part 73.313(d)
-in areas along the borders of the United States if the SDF files
-used by \fBSPLAT!\fP are SRTM-derived.
+Note that SRTM-3 elevation data, unlike older USGS data, extends beyond
+the borders of the United States. Therefore, HAAT results may not be
+in full compliance with FCC Part 73.313(d) in areas along the borders
+of the United States if the SDF files used by \fBSPLAT!\fP are SRTM-derived.
When performing point-to-point terrain analysis, \fBSPLAT!\fP determines
the antenna height above average terrain only if enough topographic
more of the eight radials surveyed fall over water, or over regions
for which no SDF data is available, \fBSPLAT!\fP reports \fINo Terrain\fP
for the radial paths affected.
-.SH RESTRICTING THE MAXIMUM SIZE OF AN ANALYSIS REGION
-\fBSPLAT!\fP reads SDF files as needed into a series of memory "pages"
-within the structure of the program. Each "page" holds one SDF file
-representing a one degree by one degree region of terrain.
-A \fI#define MAXPAGES\fP statement in the first several lines of
-\fIsplat.cpp\fP sets the maximum number of "pages" available for holding
-topography data. It also sets the maximum size of the topographic maps
-generated by \fBSPLAT!\fP. MAXPAGES is set to 9 by default. If \fBSPLAT!\fP
-produces a segmentation fault on start-up with this default, it is an indication
-that not enough RAM and/or virtual memory (swap space) is available to
-run \fBSPLAT!\fP with the number of MAXPAGES specified. In situations where
-available memory is low, MAXPAGES may be reduced to 4 with the understanding
-that this will greatly limit the maximum region \fBSPLAT!\fP will be able
-to analyze. If 118 megabytes or more of total memory (swap space plus
-RAM) is available, then MAXPAGES may be increased to 16. This will
-permit operation over a 4-degree by 4-degree region, which is sufficient
-for single antenna heights in excess of 10,000 feet above mean sea
-level, or point-to-point distances of over 1000 miles.
.SH ADDITIONAL INFORMATION
The latest news and information regarding \fBSPLAT!\fP software is
available through the official \fBSPLAT!\fP software web page located
Doug McDonald <\fImcdonald@scs.uiuc.edu\fP>
Original Longley-Rice Model integration
.TP
-Ron Bentley <\fIronbentley@earthlink.net\fP>
+Ron Bentley <\fIronbentley@embarqmail.com\fP>
Fresnel Zone plotting and clearance determination
projects / debian / splat / blobdiff