Optional input

Here we provide an overview of all optional/ non essential settings that the user can provide to FIAT. These are listed in the table () below.

Table 1: Settings.toml input (required and optional fields)
Field Type Default
[global]
loglevel string INFO
type string flood
[global.srs]
value string EPSG:4326
prefer_global bool false
[global.grid]
prefer string exposure
[hazard]
resampling_method int 0
return_periods list -
[hazard.settings]
srs string -
subset string -
var_as_band boolean false
[exposure]
types list [‘damage’]
[exposure.csv.settings]
index string object_id
[exposure.geom.settings]
index string object_id
srs string -
[exposure.grid]
resampling_method int 0
[exposure.grid.settings]
srs string -
var_as_band boolean false
[vulnerability]
step_size float 0.01
[vulnerability.settings]
index string ‘water depth’

[global]

  • crs: Global projection for the model and the output. If not defined, the default crs for the model output is the same as the hazard map.

  • loglevel: Set the loglevel of the fiat logger from the settings file. Choose from ‘DEBUG’, ‘INFO’, ‘WARNING’, ‘ERROR’ or ‘DEAD’.

  • type: Type of hazard. Should be the same name as the file containing the functions (e.g. ‘flood’ -> fiat.methods.flood)

[global.srs]

  • value: Global projection for the model and the output. If not defined, the default projection is set to WGS84.

  • prefer_global: Whether to prefer the global projection or one defined by the hazard data. By default false, i.e. prefer the hazard projection.

[global.grid]

  • prefer: Whether to spatially prefer exposure data or hazard data. The other will be warped when they are not equal. Chose ‘exposure’ or ‘hazard’.

[hazard]

  • resampling_method: Method used during resampling/ reprojecting. Default is 0, i.e. nearest neighbour. For more info, see this page

  • return_periods: Return periods for hazard calculation when they cannot be inferred from the data itself.

[hazard.settings]

  • srs: Projection of the hazard data if it cannot be inferred from the dataset itself.

  • subset: Select a specific subdataset by supplying it’s ID (name) here.

  • var_as_band: Whether or not to read the subdatasets as classic raster band.

Note

The entry var_as_band is only applicable to netCDF files.

[exposure]

  • types: Types of exposure. This could be monetary damages (‘damage’), affected people (‘affected’) etc.

[exposure.csv.settings]

  • index: Set the index column of the csv file. In case of the exposure csv, if no entry is provided then FIAT will default to ‘object_id’.

[exposure.geom.settings]

  • index: Set the index column of the geom file(s). In case nothing is provided, the default value ‘object_id’ is used.

  • srs: Projection of the exposure geometry data if it cannot be inferred from the dataset itself.

[exposure.grid]

  • resampling_method: Method used during resampling/ reprojecting. Default is 0, i.e. nearest neighbour. For more info, see this page

[exposure.grid.settings]

  • srs: Projection of the gridded exposure data if it cannot be inferred from the dataset itself.

  • var_as_band: Whether or not to read the subdatasets as classic raster band.

Note

The entry var_as_band is only applicable to netCDF files.

[vulnerability]

  • step_size: The internal step size of the vulnerability data. The supplied data is interpolated or averaged depending on the minimal step size of the supplied dataset.

[vulnerability.settings]

  • index: Set the index column of the csv file. In case of the vulnerability csv, if no entry is provided then FIAT will default to ‘water depth’.
Back to top