YAML File Code Introduction

The following page quickly introduces you with the YAML file standard to better understand the YAML files to set in the context of the Speos Sensor System Exporter.

If you want to go directly to Speos Sensor System Exporter YAML Files description, refer to YAML Input Parameters File and YAML Sensor Properties File.

Description

YAML is a human-readable data serialization standard that can be used in conjunction with all programming languages and is often used to write configuration files.

Note: For more information, you can refer to the YAML documentation on Fileformat or Circleci websites.

Basically a YAML file contains keys:

Each key can be associated to value(s). A value can be a number, a string, a list of something, or a sub-key.
":" is used as relation between the key and the value.
Comments can be added using #.
Tabulations are used to define the structure.

Example

The following example is based on a YAML file corresponding to the inputs parameters to give to the Speos Sensor System Exporter using the Given files mode.

Given files mode along with All in folder modes correspond to the two modes used to define the input parameters. They are explained in the Working Modes chapter.

Logging Level:      # first key
  File: DEBUG       # first sub-key and associated value
  Console: INFO     # second sub-key and associated value
Mode: Given files   # second key and associated value
Given files:
  Set 0: 
    Exposure maps: /Inputs/Exposure 3000K.xmp
    Sensor: /Inputs/Sensor 3000K.yaml
    Output folder: /Outputs
    Raw export: ['dng']
    Processed export: ['png']   
  Set 1: 
    Exposure maps: /Inputs/Exposure 5000K.xmp
    Sensor: /Inputs/Sensor 5000K.yaml
    Output folder: /Outputs
    Raw export: ['dng']
    Processed export: ['png']
  Set 2: 
    Exposure maps: /Inputs/Exposure 7000K.xmp
    Sensor: /Inputs/Sensor 7000K.yaml
    Output folder: /Outputs
    Raw export: ['dng']
    Processed export: ['png']