Validation Plan#

The validation plan defines which requirements CityDoctor checks, with which parameters, and which objects are included in the check. It is specified in YAML and passed to CityDoctor with the parameter -config (see Command Line).

In the graphical user interface the same settings are available in the check dialog. A validation plan can be saved from there and loaded again, which is the easiest way to create a valid file.

Example#

For version 3.12.x and later, an example looks like this:

globalParameters:
   numberOfRoundingPlaces: 8
   # in m
   minVertexDistance: 0.0001
   schematronPath: 'checkForSolid.xml' # (1)!
useStreaming: true # (2)!
xmlValidation: false # (3)!
filter: # (4)!
   exclude:
      types:
         - VEGETATION
requirements:
   R_GE_R_TOO_FEW_POINTS:
      enabled: true
   R_GE_R_NOT_CLOSED:
      enabled: true
   R_GE_R_CONSECUTIVE_POINTS_SAME:
      enabled: true
   R_GE_R_SELF_INTERSECTION:
      enabled: true
   R_GE_S_MULTIPLE_CONNECTED_COMPONENTS:
      enabled: true
   R_GE_P_INTERIOR_DISCONNECTED:
      enabled: true
   R_GE_P_INTERSECTING_RINGS:
      enabled: true
   R_GE_P_NON_PLANAR:
      enabled: true
      parameters:
         # one of ("distance", "angle", "both")
         type: distance
         # in m
         distanceTolerance: 0.01
         # in degree
         angleTolerance: 1
   R_GE_P_HOLE_OUTSIDE:
      enabled: true
   R_GE_P_ORIENTATION_RINGS_SAME:
      enabled: true
   R_GE_P_INNER_RINGS_NESTED:
      enabled: true
   R_GE_S_TOO_FEW_POLYGONS:
      enabled: true
   R_GE_S_NOT_CLOSED:
      enabled: true
   R_GE_S_NON_MANIFOLD_EDGE:
      enabled: true
   R_GE_S_POLYGON_WRONG_ORIENTATION:
      enabled: true
   R_GE_S_ALL_POLYGONS_WRONG_ORIENTATION:
      enabled: true
   R_GE_S_NON_MANIFOLD_VERTEX:
      enabled: true
   R_GE_S_SELF_INTERSECTION:
      enabled: true
   R_SE_BS_IS_WALL:
      enabled: false
      parameters:
            lowerAngle: '45'
            upperAngle: '135'
   R_SE_BS_IS_FLOOR:
      enabled: false
   R_SE_BS_GROUND_UNFRAGMENTED:
      enabled: false
   R_SE_BS_IS_GROUND:
      enabled: false
   R_SE_BS_IS_CEILING:
      enabled: false
   R_SE_BS_ROOF_UNFRAGMENTED:
      enabled: false
   R_SE_POLYGON_WITHOUT_SURFACE:
      enabled: false

1. Schematron file for checking attributes. A relative path is resolved against the working directory of CityDoctor. If the file does not exist, the Schematron check is skipped with a warning.
2. The parameter useStreaming is a switch to read a file piece by piece instead of reading the complete file before the check takes place. With this setting also files > 2GB can be checked without large RAM requirements.
3. Validates the CityGML file against the XML schema while reading.
4. Optional. Restricts the check to certain objects, see Filter.

Structure#

The validation plan consists of the following top-level entries:

Other top-level entries are not permitted and cause an error when the file is loaded. Validation plans in the format used before version 3.12 (with the entry checks and check IDs like C_GE_R_TOO_FEW_POINTS) are therefore no longer accepted.

Global parameters#

Requirements#

Each requirement is listed under requirements with its ID. It has the following entries:

Requirements that do not appear in the validation plan are not checked. A validation plan therefore keeps its behavior when new requirements are added in later versions of CityDoctor. Unknown requirement IDs are reported with a warning in the log and ignored.

Some checks depend on other checks (e.g. the solid checks require valid polygons). Such checks are executed automatically when an enabled requirement needs them.

Geometric requirements#

The requirements are described in detail under Geometric Requirements.

For R_GE_P_NON_PLANAR the parameter type selects the test method:

• distance: the distance of every point to the regression plane of the polygon must not exceed distanceTolerance,
• angle: the polygon is triangulated; the normal of each triangle must not deviate by more than angleTolerance from the average normal,
• both: both tests are carried out.

Semantic requirements#

The requirements are described under Semantic Requirements. In the graphical user interface they are disabled by default.

Filter#

With the optional entry filter, objects can be included in or excluded from the check. Filters are applied to top-level features (e.g. buildings, bridges); objects that are filtered out are not checked.

filter:
   include:
      types:
         - BUILDING
         - BRIDGE
      ids:
         - DEBW_0010001aBcD
   exclude:
      ids:
         - DEBW_0010001xYz
         - 'UUID_.*'

The filters are evaluated as follows:

1. If include contains at least one entry, an object is only checked if it matches at least one of the listed types or IDs. Without include all objects are checked.
2. An object that matches an entry under exclude is not checked, even if it is included under include.

Available feature types:

The entries under ids are regular expressions (Java syntax) that must match the complete GML ID of the object; upper and lower case are not distinguished. Examples:

Default configuration#

If no validation plan is given on the command line, CityDoctor uses a default configuration in which all requirements are enabled with their default parameters. Details are described under Command Line.