XML Template Overview

The following page presents you the different ways of managing and using XML templates generated out of a XMP map.

Description

A XML template file contains information that has been saved out of the current opened XMP map state. These information can then be applied to another XMP map in the viewer as presets or to a future xmp generated in Speos.

It contains different information:
  • the map information
  • the display options
  • the VLC information
  • the measures information
There are two ways of saving information in a XML template. Each way has its own purpose.

Export Template

When exporting a template using Export Template, you manually save the template with the different aforementioned information. Manually saving the template means that you define the save folder and the template name.

You can then:
  • use the template as input of a Speos sensor to apply the measures saved to the future xmp to be generated out of the sensor, and the sensor properties (dimensions, display properties, sensor type).
  • import the template in the viewer to apply the information to a loaded XMP map as presets.

Save Display Option as default and Load Display default

With Save Display Option as default, you save the same information as Export Template in a dedicated XML template file.

With Load Display default, you apply in one click the display options saved with the Save Display Option as default command.

The goal is to facilitate the process of display option configuration to avoid setting them each time you need to.

Example: when working on a series of results of the same type, from the same project, you can easily set the same display properties to your results, which will avoid you setting manually the properties for each result.

XML Template Load Mechanism by Version

  • In version 2024 R2, you need to click Load Display default on each new XMP generated, each time you want to apply the display options.
  • As of version 2025 R1, a new mechanism prevents you from needing to click Load Display default each time. Indeed, if you have previously saved the display options as default, then the template is automatically applied to the new XMP generated. This is only true if no XML template has been defined in the Sensor definition, and if the XMP type is the same as the XMP used to saved the display options as default.

For more details about the load mechanism, refer to the section In Speos below.

Save Display Option as default

With Save Display Option as default, you save the same information as Export Template in a dedicated XML template file. However, unlike Export Template, you do not need to manually create the XML template file. The viewer automatically creates the XML template file in the %appdata% folder and names it according to the XMP map from which it has been saved.

The file naming follows a strict pattern which depends on the loaded XMP map characteristics.



Load Display default

With Load Display default, you apply in one click the display options saved with the Save Display Option as default command, without having to manually import the XML file.

  • With Load Display default, only the display options are applied to the XMP map loaded.

    CAUTION: Load Display default is different from the Apply display options command of Import Template. Indeed, if you apply the display options using Import Template, you will also apply VLC information to the XMP map.
    CAUTION: Load Display default is different from the Apply measures command of Import Template. Indeed, if you apply the measures using Import Template, you will also apply areas, measures and rules to the XMP map.

  • You can only use Load Display default for same type of XMP maps.

    Example: you can load the Colorimetric_irradiance.xml template for a colorimetric irradiance XMP map, but you cannot load a Spectral_irradiance.xml template.

The display options that are saved and loaded are:

  • The Regulation options

    These options are available only for Intensity maps in Virtual Photometric Lab.

  • The Overlap Grid option

    This option is available only for Intensity maps in Virtual Photometric Lab.

  • The Visibility option

    This option is available only for Intensity maps in Virtual Photometric Lab.

  • The Photometric units and Radiometric units options

    These options are available only for Colorimetric and Spectral maps in Virtual Photometric Lab.

  • The options From source looking at sensor and From sensor looking at source

    These options are available only for Intensity maps in Virtual Photometric Lab.

  • The Level tool information

    The Level tool is only available in Virtual Photometric Lab.

  • The Color mode

    The Color mode is only available in Virtual Photometric Lab.

  • The right-click menu options:
    • Show rule
    • Ruler parameters
    • Show axis on cross
    • Snap cross to grid
    • Show tooltip
    • Color around the map
    • Fill shape
    • Show primary grid
    • Show secondary grid
    • Grid Parameters
    • Show flux
    • Show minimum
    • Show maximum
  • The XMP Filtering options
  • The Grid view in simulation report option (Measure tool)
  • The column selection and display in the Measure tool

In Speos

The following section explains in details the automatic XML template load mechanism.



For clarity purpose in this section:
  • XML templates that are used as input in the XMP Template section of a sensor definition in Speos are labeled Local XML file.
  • XML templates that are saved in the %appdata% folder and not used as input in the XMP Template section are labeled Global XML file.

Principles



  • If you input a Local XML file in the definition of the sensor with Display properties from file activated, the display options of the sensor definition are deactivated (greyed) and the sensor inherits the display properties from the Local XML file for the 3D view and the XMP result.

  • In case a XML template in the %appdata% folder exists (Global XML file):

    1. When you run a simulation,
    2. If [a XML template has been saved using the Save display option as default] AND [the XMP map to be generated share the same type with the Global XML file] AND [no Local XML file is input in the definition of the sensor]
    3. Then, the Global XML file is automatically applied to the XMP map to be generated.

    This way, you do not have to apply the Global XML file in Virtual Photometric Lab or Virtual Human Vision Lab using the option Load Display default, because the display options from the Global XML file are already applied.

    Important: Display options of the sensor definition are accessible but are only applied in the 3D view. They do not overwrite the display properties from the Global XML file applied to the XMP result.

Compatibility

Only the LiDAR sensor is not compatible with the behavior. You will need to input manually the XML template in the XMP Template section of the LiDAR sensor.