Hi fellow wiki editors!

To help newly registered users get more familiar with the wiki (and maybe older users too) there is now a {{Welcome to the wiki}} template. Have a look at it and feel free to add it to new users discussion pages (and perhaps your own).

I have tried to keep the template short, but meaningful. /Johan G

Difference between revisions of "TerraGear Documentation"

From FlightGear wiki
Jump to: navigation, search
(Toolchain)
(Toolchain)
Line 6: Line 6:
 
If you just want see every options/arguments available for each tool you can use this command line in the terragear/bin directory : (only for linux user)
 
If you just want see every options/arguments available for each tool you can use this command line in the terragear/bin directory : (only for linux user)
 
   for file in *; do echo "" && echo "###################################" && echo $file && echo "###################################" && ./$file --help; done
 
   for file in *; do echo "" && echo "###################################" && echo $file && echo "###################################" && ./$file --help; done
 +
or alternatively
 +
  find * -exec bash './{}' '--help' \;
  
 
=== gdalchop ===
 
=== gdalchop ===
  
gdalchop is a too responsible for cropping height data files into SimGear buckets (or tiles).
+
gdalchop is a tool responsible for cropping height data files into SimGear buckets (or tiles).
  
 
Most height data is published in fairly large data files that cover 1 square degree.  For SRTM-1 data, there are 3601 x 3601 data points per file.  For SRTM-3 data, there are 1201 x 1201 data points per file.  SRTM datafiles are named by their southwestern most point.
 
Most height data is published in fairly large data files that cover 1 square degree.  For SRTM-1 data, there are 3601 x 3601 data points per file.  For SRTM-3 data, there are 1201 x 1201 data points per file.  SRTM datafiles are named by their southwestern most point.

Revision as of 14:39, 29 March 2013

There has been a lot of questions relating to scenery generation tools. This page is an attempt to document each of the tools I use. I will also document the design, and what each tool is actually doing.

My hope is to attract more developers to work on the tools to make it easier to create better scenery for FlightGear.

Toolchain

If you just want see every options/arguments available for each tool you can use this command line in the terragear/bin directory : (only for linux user)

 for file in *; do echo "" && echo "###################################" && echo $file && echo "###################################" && ./$file --help; done

or alternatively

 find * -exec bash './{}' '--help' \;

gdalchop

gdalchop is a tool responsible for cropping height data files into SimGear buckets (or tiles).

Most height data is published in fairly large data files that cover 1 square degree. For SRTM-1 data, there are 3601 x 3601 data points per file. For SRTM-3 data, there are 1201 x 1201 data points per file. SRTM datafiles are named by their southwestern most point.

When TerraGear tools need to query elevation data, they do so expecting the data to be located in a standard SimGear folder structure as follows:

Format Example
10 deg x 10 deg folder w070n10
1 degree by 1 degree subfolder w065n17
—— bucket file —— 1891048.arr.gz

gdalchop will create this directory structure in the work folder, and create sgbucket.arr.gz files within.

command options

gdalchop <height data dir> <work dir>

height data dir
This is the directory your height data resides in. (i.e. .hgt files for SRTM)

work_dir
This is where gdalchop will generate the elevation directory structure described above.

notes

  1. remember to use gdalchop on directories, rather than individual files. It handles height data stitching for you. Using individual files will produce data with missing elevation data where stitching could not be performed.


hgtchop (deprecated)

hgtchop is also a too responsible for cropping height data files into SimGear buckets (or tiles). This tool only work with data in the .hgt format (SRTM, viewfinder).

Reasons for using gdalchop:

  • handles heightdata in many more formats
  • is based on gdal, an actively maintained open source GIS library

command options

hgtchop <resolution> <hgt_file> <work_dir>

resolution
Each file created contains ALL of the data points for the simgear tile. For SRTM-1 data, the resultant grid (for tiles near the equator) is 450 x 450 points. For SRTM-3 data, the grid is 150 x 150 points. The resolution parameter tells hgtcop the distance between sampled points. Note that tile width varies with latitude. So 'square' tiles really only exist between 22 degrees N - 22 degrees S. The tile widths are explained here: Tile Index Scheme

hgt_file
The source file. Usually, the source files are 1 degree by 1 degree, and have enough data to create 64 simgear buckets (near the equator).

work_dir
This is where hgt-chop will generate the elevation directory structure described above.

notes

  1. zip files : In TGHgt::open, if the file extension is '.zip', then unzip executable is executed through system(). If the host system doesn't have unzip, then hgtchop will fail. The unzip should be performed via SimGear - Investigation needed


terrafit

terrafit is responsible for taking the raw heightfield data for one bucket, and picking the most important points to generate a triangle mesh. It uses Terra to perform the work. The output is not a triangulation, but rather a list of nodes that can be fed to a triangulation routine. The quality of FlightGear's terrain is directly related to what parameters are fed into terrafit.

command options

terrafit [options] <file | path>

Option Default Description
-m or --minnodes 50 smallest number of nodes to produce. For a mostly flat tile, more nodes are wasteful.
-x or --maxnodes 1000 largest number of nodes to produce.

For a very complex tile, limiting this will reduce the detail of the resulting mesh.

-e or --maxerror 40 While picking points, and we have at least minnodes, but not yet maxnodes, the mesh will be completed

if any of the remaining points maximum elevation error drops below this value.

-f or --force If you have an already fitted work directory, and want to regenerate with different parameters, be sure to use force.

Otherwise, the work directory is checked for updated height data and merged with current data

As you can see, the default parameters are pretty conservative. At most, we will output 1,000 nodes. The input data for SRTM-1 contains 202,500 nodes, so we are only keeping 0.5% of the source data (or for SRTM-3, with 22,500 nodes, we keep ~5% of the source data)

For my experiments, I've increased maxnodes to 20,000, and decreased max error to 10 meters, and didn't see a major frame rate hit).

If you consider the number of nodes added when using detailed landclass, it's unfortunate that the height lookup for these points will be based on such an inaccurate mesh.

ogr-decode

ogrdecode is responsible for decoding landclass and line vector data into terragears internal textured polygon format. It also performs the 'chop' operation, so the output is structured in the same directory format as described in gdalchop. ogr-decode is capable of decoding shapefiles stored on disk, or retrieving the data from a PosGIS database.

command options

ogr-decode [options...] <work dir> <datasource> [<layername>...]

Option Default Description
--line-width 50 for line data, this is the width in meters the generated polygons will be.
--line-width-column none for line data, this optional field can be used to retrieve the width from the database row, under the given column.

If data is present in the row, it overrides the line-width parameter.

--point-width 500 for point data, this is the 'width' of the square generated. Both width and height will be this large.
--point-width-column none for point data, this optional field can be used to retrieve the width from the database row, under the given column.

If data is present in the row, it overrides the point-width parameter.

--area-type Default This string is used to define the type of landclass the generated polygons will be saved under.

In tgconstruct, the landclass priorities file is used to determine the priority of each landclass. higher priorities are 'on top' of lower.
The name given here must match a landclass type in your priorities configuration file.

genapts / genapts850

design

Step 1 : Parse
Step 2 : Clip
Step 3 : Clean
Step 4 : Elevation
Step 5 : Output

fgfs-construct

Related content