Parameters

In this section, we describe the parameters used to configure the building creation process. These parameters can be specified via command-line arguments or configuration files.

1. Command-line Parameters

The following command-line parameters can be used:

  • --i: This parameter allows the user to provide a GIS JSON file containing descriptions of multiple buildings ( more details about GIS JSON file ).

  • --si: This parameter allows the user to provide a configuration JSON file describing the parameters required to create a building using a DAT file as input.

  • --d: This parameter allows the display of test results, the progress of the application, and the writing of intermediate files.

  • --r: This parameter allows the user to automatically add roofs to the buildings.

  • --u: This parameter allows the user to change the merging process to a union process. Union will lose every Marker except for buildindId

  • --volume: This parameter allows the user to perform a volume meshing of the resulting surface mesh,
    the volume meshing is performed on every building at the same time so if there is too many buildings or too complex, execution time can increase a lot.

2. config Json Parameters Descriptions

parameters are contained in a json file, every parameter is used to define the building

2.1. poly_file:

  • Description: Path to the file containing polygon data. This parameter is mandatory.

  • Type: string

  • Example: "rectangle.dat"

  • Usage: This file contains the basic geometric information of the building in the form of polygons, more details about the polygon file.

2.2. weight_file:

  • Description: Path to the file containing weight data.

  • Type: string

  • Example: "rectangle_weight.dat"

  • Usage: This file includes the weight data associated with each point of the polygon inputted, used for the roof Straight Skeleton extrusion, more details about the weight file.

2.3. height:

  • Description: height of the whole building, default value is 3.0.

  • Type: float

  • Example: 3.0

2.4. roof_height

  • Description: Height of the roof, default value is 0 (height stay as resulted by straight skeleton extrusion )

  • Type: float

  • Example: 1.0

2.5. wall_thickness

  • Description: Thickness of the building walls, default value is 0.

  • Type: float

  • Example: 0.1

2.6. Example

Here is an example of a config.json, polygon and weight file with every parameters:

config_create_building.json rectangle.dat rectangle_weight.dat 
{
    "poly_file":"rectangle.dat",
    "weight_file":"rectangle_weight.dat",
    "height":9,
    "roof_height":1,
    "wall_thickness":0.1
}
json
 
4
0 4 0
0 0 0
8 0 0
8 4 0
txt
 
1
10000
1
10000
txt

Next: Multiple Building Class Presentation



Back to main page