You are looking the documentation of a development version. The release version is available at master.

i2_features_map

Landsat5_old

Name

Default Value

Description

Type

Mandatory

Name

additional_features

OTB’s bandmath expressions, separated by comma

str

False

additional_features

end_date

The last date of interpolated image time series : YYYYMMDD format

str

False

end_date

keep_bands

[‘B1’, ‘B2’, ‘B3’, ‘B4’, ‘B5’, ‘B6’, ‘B7’]

The list of spectral bands used for classification

list

False

keep_bands

start_date

The first date of interpolated image time series : YYYYMMDD format

str

False

start_date

temporal_resolution

10

The temporal gap between two interpolations

int

False

temporal_resolution

write_reproject_resampled_input_dates_stack

True

flag to write of resampled stack image for each date

bool

False

write_reproject_resampled_input_dates_stack

Landsat8

Name

Default Value

Description

Type

Mandatory

Name

additional_features

OTB’s bandmath expressions, separated by comma

str

False

additional_features

end_date

The last date of interpolated image time series : YYYYMMDD format

str

False

end_date

keep_bands

[‘B1’, ‘B2’, ‘B3’, ‘B4’, ‘B5’, ‘B6’, ‘B7’]

The list of spectral bands used for classification

list

False

keep_bands

start_date

The first date of interpolated image time series : YYYYMMDD format

str

False

start_date

temporal_resolution

16

The temporal gap between two interpolations

int

False

temporal_resolution

write_reproject_resampled_input_dates_stack

True

flag to write of resampled stack image for each date

bool

False

write_reproject_resampled_input_dates_stack

Landsat8_old

Name

Default Value

Description

Type

Mandatory

Name

additional_features

OTB’s bandmath expressions, separated by comma

str

False

additional_features

end_date

The last date of interpolated image time series : YYYYMMDD format

str

False

end_date

keep_bands

[‘B1’, ‘B2’, ‘B3’, ‘B4’, ‘B5’, ‘B6’, ‘B7’]

The list of spectral bands used for classification

list

False

keep_bands

start_date

The first date of interpolated image time series : YYYYMMDD format

str

False

start_date

temporal_resolution

10

The temporal gap between two interpolations

int

False

temporal_resolution

write_reproject_resampled_input_dates_stack

True

flag to write of resampled stack image for each date

bool

False

write_reproject_resampled_input_dates_stack

Sentinel_2

Name

Default Value

Description

Type

Mandatory

Name

additional_features

OTB’s bandmath expressions, separated by comma

str

False

additional_features

end_date

The last date of interpolated image time series : YYYYMMDD format

str

False

end_date

keep_bands

[‘B1’, ‘B2’, ‘B3’, ‘B4’, ‘B5’, ‘B6’, ‘B7’]

The list of spectral bands used for classification

list

False

keep_bands

start_date

The first date of interpolated image time series : YYYYMMDD format

str

False

start_date

temporal_resolution

10

The temporal gap between two interpolations

int

False

temporal_resolution

write_reproject_resampled_input_dates_stack

True

flag to write of resampled stack image for each date

bool

False

write_reproject_resampled_input_dates_stack

Sentinel_2_L3A

Name

Default Value

Description

Type

Mandatory

Name

additional_features

OTB’s bandmath expressions, separated by comma

str

False

additional_features

end_date

The last date of interpolated image time series : YYYYMMDD format

str

False

end_date

keep_bands

[‘B1’, ‘B2’, ‘B3’, ‘B4’, ‘B5’, ‘B6’, ‘B7’]

The list of spectral bands used for classification

list

False

keep_bands

start_date

The first date of interpolated image time series : YYYYMMDD format

str

False

start_date

temporal_resolution

10

The temporal gap between two interpolations

int

False

temporal_resolution

write_reproject_resampled_input_dates_stack

True

flag to write of resampled stack image for each date

bool

False

write_reproject_resampled_input_dates_stack

Sentinel_2_S2C

Name

Default Value

Description

Type

Mandatory

Name

additional_features

OTB’s bandmath expressions, separated by comma

str

False

additional_features

end_date

The last date of interpolated image time series : YYYYMMDD format

str

False

end_date

keep_bands

[‘B1’, ‘B2’, ‘B3’, ‘B4’, ‘B5’, ‘B6’, ‘B7’]

The list of spectral bands used for classification

list

False

keep_bands

start_date

The first date of interpolated image time series : YYYYMMDD format

str

False

start_date

temporal_resolution

10

The temporal gap between two interpolations

int

False

temporal_resolution

write_reproject_resampled_input_dates_stack

True

flag to write of resampled stack image for each date

bool

False

write_reproject_resampled_input_dates_stack

arg_train

Name

Default Value

Description

Type

Mandatory

Name

features

[‘NDVI’, ‘NDWI’, ‘Brightness’]

List of additional features computed

list

False

features

Notes

features

This parameter enable the computation of the three indices if available for the sensor used.There is no choice for using only one of them

builders

Name

Default Value

Description

Type

Mandatory

Name

builders_class_name

[‘i2_classification’]

The name of the class defining the builder

list

False

builders_class_name

builders_paths

/path/to/iota2/sources

The path to user builders

str

False

builders_paths

Notes

builders_class_name

Available builders are : ‘i2_classification’, ‘i2_features_map’, ‘i2_obia’ and ‘i2_vectorization’

builders_paths

If not indicated, the iota2 source directory is used: */iota2/sequence_builders/

chain

Name

Default Value

Description

Type

Mandatory

Name

first_step

None

The step group name indicating where the chain start

str

False

first_step

l5_path_old

None

Absolute path to Landsat-5 images coming from old THEIA format (D*H*)

str

False

l5_path_old

l8_path

None

Absolute path to Landsat-8 images comingfrom new tiled THEIA data

str

False

l8_path

l8_path_old

None

Absolute path to Landsat-8 images coming from old THEIA format (D*H*)

str

False

l8_path_old

last_step

None

The step group name indicating where the chain ends

str

False

last_step

list_tile

None

List of tile to process, separated by space

str

True

list_tile

logger_level

INFO

Set the logger level: NOTSET, DEBUG, INFO, WARNING, ERROR, CRITICAL

str

False

logger_level

minimum_required_dates

2

required minimum number of available dates for each sensor

int

False

minimum_required_dates

output_path

None

Absolute path to the output directory

str

True

output_path

proj

None

The projection wanted. Format EPSG:XXXX is mandatory

str

True

proj

remove_output_path

True

Before the launch of iota2, remove the content of output_path

bool

False

remove_output_path

s1_path

None

Absolute path to Sentinel-1 configuration file

str

False

s1_path

s2_l3a_output_path

None

Absolute path to store preprocessed data in a dedicated directory

str

False

s2_l3a_output_path

s2_l3a_path

None

Absolute path to Sentinel-2 L3A images (THEIA format)

str

False

s2_l3a_path

s2_output_path

None

Absolute path to store preprocessed data in a dedicated directory

str

False

s2_output_path

s2_path

None

Absolute path to Sentinel-2 images (THEIA format)

str

False

s2_path

s2_s2c_output_path

None

Absolute path to store preprocessed data in a dedicated directory

str

False

s2_s2c_output_path

s2_s2c_path

None

Absolute path to Sentinel-2 images (Sen2Cor format)

str

False

s2_s2c_path

spatial_resolution

[]

Output spatial resolution

list or scalar

False

spatial_resolution

user_feat_path

None

Absolute path to the user’s features path

str

False

user_feat_path

Notes

output_path

Absolute path to the output directory.It is recommended to have one directory per run of the chain

remove_output_path

Before the launch of iota2, remove the content of output_path. Only if the first_step is init and the folder name is valid

spatial_resolution

The spatial resolution expected.It can be provided as integer or float,or as a list containing two values for non squared resolution

user_feat_path

Absolute path to the user’s features path. They must be stored by tiles

external_features

Name

Default Value

Description

Type

Mandatory

Name

concat_mode

True

enable the use of all features

bool

False

concat_mode

exogeneous_data

None

Path to a Geotiff file containing additional data to be used in external features

str

False

exogeneous_data

external_features_flag

False

enable the external features mode

bool

False

external_features_flag

functions

None

function list to be used to compute features

str/list

False

functions

module

/path/to/iota2/sources

absolute path for user source code

str

False

module

no_data_value

-10000

value considered as no_data in features map mosaic (‘i2_features_map’ builder name)

int

False

no_data_value

output_name

None

temporary chunks are written using this name as prefix

str

False

output_name

Notes

concat_mode

if disabled, only external features are used in the whole processing

exogeneous_data

If the =exogeneous_data= contains ‘$TILE’, it will be replaced by the tile name being processed.If you want to reproject your data on given tiles, you can use the =split_raster_into_tiles.py= command line tool.

Usage: =split_raster_into_tiles.py –help=.

functions

Can be a string of space-separated function namesCan be a list of either strings of function nameor lists of one function name and one argument mapping

python_data_managing

Name

Default Value

Description

Type

Mandatory

Name

chunk_size_mode

split_number

The chunk split mode, currently the choice is ‘split_number’

str

False

chunk_size_mode

chunk_size_x

50

number of cols for one chunk

int

False

chunk_size_x

chunk_size_y

50

number of rows for one chunk

int

False

chunk_size_y

data_mode_access

gapfilled

choose which data can be accessed in custom features

str

False

data_mode_access

fill_missing_dates

False

fill raw data with no data if dates are missing

bool

False

fill_missing_dates

max_nn_inference_size

None

maximum batch inference size

int

False

max_nn_inference_size

number_of_chunks

50

the expected number of chunks

int

False

number_of_chunks

padding_size_x

0

The padding for chunk

int

False

padding_size_x

padding_size_y

0

The padding for chunk

int

False

padding_size_y

Notes

data_mode_access

Three values are allowed: - gapfilled: give access only the gapfilled data - raw: gives access only the original raw data - both: provides access to both data ..Notes:: Data are spatialy resampled, these parameters concern only temporal interpolation

fill_missing_dates

If raw data access is enabled, this option considers all unique dates for all tiles and identify which dates are missing for each tile. A missing date is filled using a no data constant value.Cloud or saturation are not corrected, but masks are provided Masks contain three value: 0 for valid data, 1 for cloudy or saturated pixels, 2 for a missing date

max_nn_inference_size

Involved if a neural network inference is performed. If not set (None), the inference size will be the same as the one used during the learning stage

sensors_data_interpolation

Name

Default Value

Description

Type

Mandatory

Name

auto_date

True

Enable the use of start_date and end_date

bool

False

auto_date

use_additional_features

False

enable the use of additional features

bool

False

use_additional_features

use_gapfilling

True

enable the use of gapfilling (clouds/temporal interpolation)

bool

False

use_gapfilling

write_outputs

False

write temporary files

bool

False

write_outputs

Notes

auto_date

If True, iota2 will automatically guess the first and the last interpolation date. Else, start_date and end_date of each sensors will be used

write_outputs

Write the time series before and after gapfilling, the mask time series, and also the feature time series. This option required a large amount of free disk space.

task_retry_limits

Name

Default Value

Description

Type

Mandatory

Name

allowed_retry

0

allow dask to retry a failed job N times

int

False

allowed_retry

maximum_cpu

4

the maximum number of CPU available

int

False

maximum_cpu

maximum_ram

16.0

the maximum amount of RAM available. (gB)

float

False

maximum_ram

Notes

maximum_cpu

the amount of cpu will be doubled if the task is killed due to ram overconsumption until maximum_cpu or allowed_retry are reach

maximum_ram

the amount of RAM will be doubled if the task is killed due to ram overconsumption until maximum_ram or allowed_retry are reach

userFeat

Name

Default Value

Description

Type

Mandatory

Name

arbo

/*

input folder hierarchy

str

False

arbo

patterns

ALT,ASP,SLP

key name for detect the input images

str

False

patterns