YAML Input Parameters File Template

The following page provides you with the full YAML Input Parameters file template to fill.

The YAML Input Parameters File template can be automatically generated thanks to the Speos Sensor System Exporter:

In the Windows cmd prompt, enter the following command line: "SSSExporter.exe" Generate_Templates

Logging Level:
  File: 'DEBUG'
  Console: 'INFO'
Default Working Folder: /Inputs    # '' if working folder is the same as this file. Else set path to folder that will be use by default to find inputs.
Mode:                              # 'All in folder' or 'Given files'
All in folder:                     # needs to be filled if 'All in folder' mode is chosen
  Input folder:                    # path to input folder  (format: 'c:\folder')
  Output folder:                   # path to output folder 
  Xmp backup folder:               # path to folder where processed xmp can be backup. if not present or '' ==> no backup
  Sensor:                          # sensor filename  (file format: yaml)
  Raw export: []                   # tuple from : 'xmp', 'dng'   (format: ['xmp', 'dng'])
  Electron export: []              # tuple from : 'xmp'
  Noise export: []                 # tuple from : 'xmp' (expressed in number of e-)
  Processed export: []             # tuple from 'jpg', 'png', 'tiff', 'bmp'
Given files:                       # needs to be filled if 'Given files' mode is chosen
  Set 0:                           # first jog
    Exposure maps:                 # 'filename ' (for ldr mode) or tuple of 'filename ' (for hdr mode) (format: 'c:/temp/exposure1.xmp' or ['c:/temp/exposure1.xmp', 'c:/temp/exposure2.xmp', 'c:/temp/exposure3.xmp'])
    Sensor:                        # sensor filename  (file format: yaml) or tuple of filename for hdr mode)
    Output folder:                 # path to output folder 
    Rename:                        # optional string to change result filename
    Raw export:                    # tuple from : 'xmp', 'dng'   (format: ['xmp', 'dng'])
    Electron export: []            # tuple from : 'xmp'
    Noise export: []               # tuple from : 'xmp' (expressed in number of e-)
    Processed export: []           # tuple from  from 'jpg', 'png', 'tiff', 'bmp' and 'hdr' in case of multi exposures (note: tiff as 16bits)
    Save previous: False           # True or False
    HDR:                           #inputs used only in case of HDR mode.
      Min:                         # set min value  [0, 1]
      Multiply Factor:             # set ratio (positive value. 1 ==> no modifications)
      Gamma:                       # set exponent (power)  (positive value. 1 ==> no modifications)
    Add text:                      # possibility to add text on images
      Text 0:                      # first text to add
        Position:                  # position in pixel from top left [i, j] 
        Font:                      #choose in SIMPLEX, PLAIN, DUPLEX, COMPLEX, TRIPLEX, COMPLEX_SMALL, SCRIPT_SIMPLEX, SCRIPT_COMPLEX, FONT_ITALICSIMPLEX
        Scale:                     # size of text (1 by default)
        Color:                     # text color  ([255, 255, 0] by default)
        Thickness:                 # thickness of text (1 by default)
        Line type:                 # ? (2 by default) 
        Text:                      # text to add (string)
      Text 1:                      # second text to add
                                   # idem as first text
  Set 1:                           # second jog
                                   # idem Set 0
  Set 2:                           # third jog
                                   # idem Set 0
Video:
  Filename:                        # video filename (without extension)
  Frame rate:                      # 25, 30, 60 ext.
  Add text:                        # possibility to add text on the complete video
  Text 0:                          # first text to add
    Position:                      # position in pixel from top left [i, j] 
    Font:                          #choose in SIMPLEX, PLAIN, DUPLEX, COMPLEX, TRIPLEX, COMPLEX_SMALL, SCRIPT_SIMPLEX, SCRIPT_COMPLEX, FONT_ITALICSIMPLEX
    Scale:                         # size of text (1 by default)
    Color:                         # text color  ([255, 255, 0] by default)
    Thickness:                     # thickness of text (1 by default)
    Line type:                     # ? (2 by default) 
    Text:                          # text to add (string)
  Text 1:                          # second text to add
                                   # idem as first text