Control Files

Control files are text based files located in the root folder of a SURE project. Their function is to store the parameter values to be used in a project.

This means that the project parametrization can be changed using control files in two distinct ways:

  • By directly editing the default control files  (warning)  ATTENTION (warning);
  • By creating your own custom control files :
    • Backup original files and attribute the same name to the custom ones;
    • attribute custom names to your customized control files and call them using the CLI flag --controlfile on each individual module (ex: ModuleTrueOrtho.exe  --controlfile "PATH/TO/OUR/CUSTOM/CONTROL/FILE.txt" )

We only recommend this scenario for advanced users.

In order to understand the control files, what they do and how to create them, please read the information bellow:


The structure of these files is as follows:

$ModuleName_Begin

      # Description 1 of parameter controller #

      $KeyOne = value

      # Description 2 of parameter controller #

      $KeyTwo = value

      # Description 3 of parameter controller #

      $KeyThree = value

      ...

$ModuleName_End

Where:

  • $ModuleName: It's the name of the module to which the control file refers to. The name of the module should be written in UpperCamelCase convention. $ModuleName is followed by the text _Begin and _End at the beggining and at the end of the file, respectivelly. There are some exceptions regarding the $ModuleName naming convention in some control files. Find the correct $ModuleName for each control file in the table bellow;
  • "#":  Everything beetween these symbols will be ignored, which means these are treated as comments. In this case, it represents a description of the control key. If you are creating your own custom control file, these comments are not necessary;
  • $Key: A Key is the name of the parameter to which a value needs to be attributed, written in UpperCameCase convention. Key is followed by the desired value.

There are 12 control files in total. Each one of these is responsible to control a specific step of the workflow. In the list bellow, you will be able to know specific information about each file:

Control fileModule controlledDescription
controlBootstrap.txtneeded by all moduesThis file is the core controller. Here the core parameters of a project are defined. All other control files will relly not only on the parameters defined here, but also on the name and location of this control file.
controlArea.txtneeded by all modulesThis file contains automatic/manual area specification (region of interest), the path to the area shape file (in case one was specified), as well as the tile size for all tiled outputs.
controlInit.txtAnalysisThis file states the initial parameters values that will be used as an approximate initial value for the analysis stage.
controlInvalidate.txtAnalysis / Dense CloudThis file states all the necessary parameter values that will be used  to choose the candidate stereopairs and to build the models during the analysis stage.
controlRect.txtAnalysis / Dense CloudThis file states all the necessary parameter values that will be used build the rectified the images based on the values from the orientation file. This will happen during the analysis stage.
controlSGM.txtAnalysis / Dense CloudThis file states all the necessary parameter values that will be used to find matching points between the images during the analysis stage.
controlTriang.txtAnalysis / Dense CloudThis file states all the necessary parameter values that will be used to generate the dense point cloud from Dense Image Matching.
controlDsm.txtDSMThis file states all the necessary parameter values needed to generate the DSM from the interpolation of the Dense Point Cloud when running the DSM Module.
controlTrueOrtho.txtTrue OrthoThis file states all the necessary parameter values needed to generate theTrue Orthophoto, when running the TrueOrtho module.
controlDsmMesh.txtDSM MeshThis file states all the necessary parameters needed to generate the DSM Mesh (2.5D Mesh) when running the DsmMesh Module.
controlFusion.txtCloud FilterThis file states all the necessary parameter values needed to filter the dense point cloud when running the Cloud Filter Module.
control3DMesh.txt3D MeshThis file states all the necessary parameter values needed to generate the 3D Mesh when running the 3D Mesh Module.
controlMeshTexturing.txtMesh TexturingThis file states all the necessary parameter values needed to generate the Mesh textures, both for 2.5D and 3D Meshes when running the MeshTexturing module.