arim.io.native

Load .arim file format

An .arim file is a directory which contains:

• a conf.yaml file (base configuration file)

• a conf.d directory which contains additional configuration files (optional)

• intermediary and final results (optional).

The recommended way to load the configuration is to use load_conf(). The configuration is loaded according to the following pseudo-code:

conf := read(conf.yaml)
For each file in conf.d:
    tmp_conf := read(file)
    conf := merge(conf, tmp_conf)
Return conf

The files are conf.d are read in alphabetical order. If a configuration entry is present in two files, only the entry from the file read the latest will be kept.

conf.yaml format

The ultrasonic data is provided using either:

1. frame.datafile: path to the data file, either absolute or relative to conf.yaml,

2. frame.dataset_name and frame.dataset_item: a dataset name (arim.datasets) and the path of the item to fetch

block_in_contact_from_conf(conf)
block_in_immersion_from_conf(conf)	Load block in immersion (examination object)
examination_object_from_conf(conf)	Load examination object
frame_from_conf(conf[, use_probe_from_conf, ...])	Load a Frame.
grid_from_conf(conf)	Load grid
load_conf(dirname[, filepath_keys])	Load the configuration from a .arim directory
load_conf_file(filename)	Load a single configuration file
load_conf_from_str(stream)	Load a single configuration file from a stream or string formatted in YAML.
material_attenuation_from_conf(mat_att_conf)	Load material attenuation
material_from_conf(conf)	Load material
probe_from_conf(conf[, apply_probe_location])	Load probe