Navigation path

LEft

18-Aug-2017   
Path: FORMATS
  Up Print version Decrease text Increase text Home

To facilitate the intercomparison of the submitted results files, the RAMI file-naming and formatting conventions outlined on this webpage must be adhered to.

RAMI: Direct mode file naming specifications file content specifications
RAMI4PILPS file naming specifications file content specifications


Output file naming convention for the RAMI direct mode up

Two types of output files for each experiment are required. The first one is a report file (ideally one per experiment but sometimes one per canopy architecture is sufficient), containing all the input parameters as well as some run time information (if available) for the experiment(s). The second type of output files are those that contain the measurement results of a particular test case. Specifically,

Report files must follow a <MOD>-<EXP>.rep naming convention, where

  • <MOD> identifies the RT model that was used to perform the simulation and generate the measurement results file
  • <EXP> identifies the experiment(s) that was performed. This tag contains information as to the structural and spectral properties of the test case as well as the ilumination conditions for the simulations. A comprehensive overview of permissible model and experiment identifiers is given below.

An example of the <MOD>-<EXP>.rep filenaming scheme would be "raytran-HET01_DIS_UNI_NIR_50.rep", where the model identifier <MOD> is "raytran" and the experiment identifier <EXP> is "HET01_DIS_UNI_NIR_50". Alternatively, the report file "raytran-HET01_DIS.rep" would summarize the information for all DIScrete HET01 experiments irrespective of the leaf normal distribution, the sectral band and solar zenith angle.

Measurement results files must follow a <MES>_<MOD>-<EXP>.mes naming convention, where:

  • <MES> defines the identification label of the measurement that is contained within the results file
  • <MOD> identifies the RT model that was used to perform the simulation and generate the measurement results file
  • <EXP> identifies the experiment that was performed. This tag contains information as to the structural and spectral properties of the test case as well as the ilumination conditions for the simulations. <EXP> identifies only one specific test case.

An example of the <MES>_<MOD>-<EXP>.mes filenaming scheme would be "brfop_raytran-HET01_DIS_UNI_NIR_50.mes", where the measurement identifier <MES> is "brfop", the model identifier <MOD> is "raytran" and the experiment identifier <EXP> is "HET01_DIS_UNI_NIR_50". A comprehensive overview of permissible measurement, model and experiment identifiers is given below:

List of permissible RAMI measurement identifiers <MES>

# Measurement description for RAMI Measurement identifier Measurement applies to
1 BRF in azimuthal ring (total) brfazim selected test cases
2 BRF in the cross plane (perpendicular to the principal plane) brfop ALL test cases
3 BRF in the cross plane for single-scattered radiation brfop_co_sgl ALL test cases
4 BRF in the cross plane for multiple-scattered (two or more scattering events) radiation brfop_mlt ALL test cases
5 BRF in the cross plane for single-scattered radiation collided by the soil brfop_uc_sgl ALL test cases
6 BRF in the principal plane (total) brfpp ALL test cases
7 BRF in the principal plane for single-scattered radiation brfpp_co_sgl ALL test cases
8 BRF in the principal plane for multiple-scattered (two or more scattering events) radiation brfpp_mlt ALL test cases
9 BRF in the principal plane for single-scattered radiation collided by the soil brfpp_uc_sgl ALL test cases
10 Directional Hemispherical Reflectance (Black Sky Albedo) dhr ALL test cases
11 Isotropic Bihemispherical Reflectance (White Sky Albedo) bhr_iso selected canopies only
12 Total canopy absorption (foliage and wood) fabs_tot ACTUAL CANOPIES only
13 Foliage absorption fabs_fol ALL test cases
14 Total transmission at lower boundary level for direct illumination only ftran_tot_dir ALL test cases
15 Uncollided transmission at lower boundary level for direct illumination only ftran_uc_dir ALL test cases
16 Collided by canopy only transmission at lower boundary level for direct illumination only ftran_coco_dir ALL test cases
17 Total transmission at lower boundary level for diffuse illumination only ftran_tot_iso selected canopies only
18 Uncollided transmission at lower boundary level for diffuse illumination only ftran_uc_iso selected canopies only
19 Collided by canopy only transmission at lower boundary level for diffuse illumination only ftran_coco_iso selected canopies only
20 Vertical profile of total transmission through canopy ftran_tot_vprof ALL test cases
21 Local uncollided transmission at lower boundary for direct illumination from finitesized sun ftran_dir_loc selected test cases
22 Thresholded hemispherical photograph (binary fisheye image) thp ACTUAL CANOPIES only
23 Total waveform LIDAR return signal lidar_tot selected test cases
24 Single collided waveform LIDAR return signal lidar_sgl_co selected test cases
where different background colours relate to different categories of measurements, i.e., #1-11 relate to domain level reflectance quantities, #12-20 relate to domain level absorption and transmission quantities, #21-22 relate to local measurements obtainable from typical in-situ instruments like TRAC or fisheye cameras, and #23-24 relate to the simulation of waveform LIDAR return signals.

RT model identifier tags for RAMI <MOD>

The RT model identifier tag is the 'name' of the model that was used to perform the RT simulations contained within the measurement results file. RT models names should be one single string containing only alphanumeric characters. The names of the RT model that participated in the RAMI activity so far can be found in the appropriate pages of the individual RAMI phases. RT models that remain unchanged between successive RAMI phases keep their <MOD> identifier tags; models that have been upgraded or modified from a previously participating version obtain a numerical ending, e.g., sprint in phase 1 became sprint2 in phase 2 of the RAMI initiative.

List of permissible RAMI experiment identifier <EXP>

Identifier tag
Tag meaning
HOMxx HOMogeneous case, scene number xx
HETxx HETerogeneous case, scene number xx
TUR TURbid medium
DIS DIScrete scatterers
JBS Jaervselja Birch Stand
JPS Jaervselja Pine Stand
OPS Ofenpass Pine Stand
SRF Short Rotation Forest
WCO Wellington Citrus Orchard
WIN WINter scenario
SUM SUMmer scenario
STO STOchastic foliage representation (pseudo-turbid)
UNI UNIform leaf angle distribution function
PLA PLAnophile leaf angle distribution function
ERE EREctophile leaf angle distribution function
EAP two layer canopy with Erectophile layer Above Planophile layer
PAE two layer canopy with Planophile layer Above Erectophile layer
B** spectral Band 01 to 19
RED RED wavelength (650 nm)
NIR Near-InfraRed wavelength (860 nm)
NR1 purist case (conservative scattering)
yy Value of the solar zenith angle in degrees
zzz Value of the solar azimuth angle in degrees

Experiment identifiers are provided on the web pages that describe the individual test cases. They are not listed here because there are too many of them. Experiment identifiers are composed of a variety of identifier tags, describing the structural and spectral properties of the scene (test case), as well as, the illumination conditions for the RT model simulations, among others. An example of an experiment identifier is: HET01_DIS_UNI_NIR_50. The following table shows a selection of identifier tags that are used to make up the experiment identification tag <EXP>:



Output format description for the RAMI direct mode up

Two types of output files for each experiment are required. The first one is a report file for each experiment containing all the input parameters as well as some run time information (if available) for the experiment. The second type of output files are those that contain the measurement results of a particular experiment. Specifically:

Report files must be provided in plain ASCII, but can be structured in any sensible way (preferably clearly), as they are used only to keep linking experiment results with authors and models. In any case report files must contain the following information:

  • Author(s):
    • First and last name
    • Institution
    • Address and mail coordinates
    • E-mail address
  • Experiment:
    • Experiment name or identifier (please be creative, as more than one person may use the same model)
    • Model name (as referred to in the scientific literature)
    • Model description: radiation transfer and scene representation
    • Main bibliographical reference
    • Input data:
      • Illumination conditions (zenith and azimuth angles, as well as inclusion (or not) of diffuse illumination comonent)
      • Choice of leaf normal distribution functions, e.g., Beta function, geometric functions, elliptical functions, etc.
      • Scene architecture implementation (e.g., statistical versus deterministic foliage and tree locations)
      • Implementation of anisotropic spectral properties, e.g., usage of RPV model or re-fitting to other scattering distribution model like that of Hapke, Jacquemoud, etc.
    • Measurement information:
      • angular width of BRF measurement (single direction versus solid angle)
      • location of detectors (infinity versus fixed distance)
      • dimension of detectors (finite-sized, point like, infinity)
      • pointing of detectors (scene center and height, reference plane center and height, etc)
      • RT model specific reasons for not performing a specific measurement
    • Computer Code and run time information (this section is OPTIONAL):
      • Total processing time
      • Compiler name, version and options
      • Machine type and operating system level
      • RAM, CPU clock speed, etc.
      • Computer language of model implementation

Results files contain the results from RT model simulations for a given measurement and experiment (test case). Several different types of results files are possible. These are described in detail on the page describing a given measurement (see links in table with measurement identifiers <MES> above).


Output file naming convention for RAMI4PILPS up

Two types of output files for each experiment are required. The first one is a report file (optional but ideally one per experiment), containing a description of the model, its input parameters for a given RAMI4PILPS run and some run time information (if available). The second type of output files are those that contain the measurement results of a particular experiment. Specifically,

Report files must follow a <MOD>-<EXP>.rep naming convention, where

  • <MOD> identifies the RT model that was used to perform the simulation and generate the measurement results file
  • <EXP> identifies the experiment that was performed. This tag contains information as to the structural and spectral properties of the test case as well as the ilumination conditions for the simulations. A comprehensive overview of permissible model and experiment identifiers is given below.

An example of the <MOD>-<EXP>.rep filenaming scheme would be "raytran-SHR100_SNW_UNI_NIR_27.rep", where the model identifier <MOD> is "raytran" and the experiment identifier <EXP> is "SHR100_SNW_UNI_NIR_27".

Measurement results files must follow a <MES>_<MOD>-<EXP>.mes naming convention, where:

  • <MES> defines the identification label of the measurement that is contained within the results file
  • <MOD> identifies the RT model that was used to perform the simulation and generate the measurement results file
  • <EXP> identifies the experiment that was performed. This tag contains information as to the structural and spectral properties of the test case as well as the ilumination conditions for the simulations.

An example of the <MES>_<MOD>-<EXP>.mes filenaming scheme would be "fref_raytran-GRA100_SNW_UNI_NIR_50.mes", where the measurement identifier <MES> is "fref", the model identifier <MOD> is "raytran" and the experiment identifier <EXP> is "GRA100_SNW_UNI_NIR_50". A comprehensive overview of permissible measurement, model and experiment identifiers is given below:

List of permissible measurement identifiers for RAMI4PILPS<MES>

# Measurement description Measurement identifier
1 Absorption by the canopy (turbid or discrete) fabs
2 Total transmission through the medium at the lower boundary level ftran
3 Reflection from the canopy (spectral albedo) fref

RT model identifier tags for RAMI4PILPS <MOD>

The RT model identifier tag is the 'name' of the model that was used to perform the RT simulations contained within the measurement results file. RT models names should be one single (maximum 10-digit) string containing only alphanumeric characters.

List of permissible RAMI4PILPS experiment identifier <EXP>

Experiment identifiers are provided on the web pages that describe the individual test cases. They are not listed here because there are too many of them. Experiment identifiers are composed of a variety of identifier tags, describing the structural and spectral properties of the scene (test case), as well as, the illumination conditions for the RT model simulations, among others. An example of an experiment identifier is: CLC100_MED_UNI_NIR_50. The following table shows a selection of identifier tags that are used to make up the experiment identification tag <EXP>:

Identifier tag
Tag meaning
SHRxxx SHRublands, scene number xxx
GRAxxx GRAsslands, scene number xxx
OFCxxx Open Forest Canopies, scene number xxx
CFCxxx CLosed Forest Canopies, scene number xxx
SNW SNoW background
MED MEDium bright soil background
UNI UNIform leaf angle distribution function
ERE EREctophile leaf angle distribution function
VIS Visible domain (300 - 700 nm)
NIR Near-InfraRed domain (700 - 1300 nm)
ISO isotropic diffuse illumination
yy Value of the solar zenith angle in degrees


Output format description for RAMI4PILPS up

RAMI4PILPS encourages the submission of two types of files for each experiment. The first one is optional but should be submitted (at least once) to facilitate the comprehension of the functioning of the model used to generate the uploaded results, as well as its limitations and advantages (if known). The second type of output files are those containing the measurement results of each experiment. Specifically:

Report files (are optional) but if provided must be in plain ASCII, but can be structured in any sensible way (preferably clearly), as they are used only to keep linking experiment results with authors and models. Idealy one report file per experiment should be submitted, but the bare minimum would be one report file per category of experiment. As a guideline report files could contain the following information:

  • Author(s):
    • First and last name
    • Institution
    • Address and mail coordinates
    • E-mail address
  • Model:
    • Model name (as referred to in the scientific literature)
    • Model description: radiation transfer and scene representation
    • Main bibliographical reference
    • Overall description of experiment setup
    • Input data:
      • Illumination conditions (zenith and azimuth angles)
      • Scene architecture implementation
      • Scatterer's optical properties
    • output data
      • description on how model was run to generate output
    • Computer Code and run time information:
      • Total processing time
      • Compiler name, version and options
      • Machine type and operating system level
      • RAM, CPU clock speed, etc.
      • Computer language of model implementation

Results files contain the results from RT model simulations for a given measurement and experiment (test case). One single type of results files are prescribed:

Fraction of transmitted, absorbed or reflected radiation (measurements # 1, 2 and 3):

Content Percentage of radiation [%] standard deviation of estimate*
Format real real
*: if not available set to -1.000000.

A real is defined as having 6 digits after the decimal point, e.g., 1.000000.

Example:

The file "fref_<MOD>-<EXP>.mes" contains one line:
26.502224	-1.000000

    Right navigation