I2Classification ################# .. _i2_classification.Landsat5_old: Landsat5_old ************ .. list-table:: :widths: auto :header-rows: 1 * - Name - Default Value - Description - Type - Mandatory - Name .. _i2_classification.Landsat5_old.additional_features: * - additional_features - - OTB's bandmath expressions, separated by comma. - str - False - additional_features .. _i2_classification.Landsat5_old.end_date: * - :ref:`end_date ` - - The last date of interpolated image time series : YYYYMMDD format. - str - False - :ref:`end_date ` .. _i2_classification.Landsat5_old.keep_bands: * - :ref:`keep_bands ` - ['B1', 'B2', 'B3', 'B4', 'B5', 'B6', 'B7'] - The list of spectral bands used for classification. - list - False - :ref:`keep_bands ` .. _i2_classification.Landsat5_old.start_date: * - :ref:`start_date ` - - The first date of interpolated image time series : YYYYMMDD format. - str - False - :ref:`start_date ` .. _i2_classification.Landsat5_old.temporal_resolution: * - temporal_resolution - 10 - The temporal gap between two interpolations. - int - False - temporal_resolution .. _i2_classification.Landsat5_old.write_reproject_resampled_input_dates_stack: * - write_reproject_resampled_input_dates_stack - True - Flag to write resampled stack image for each date. - bool - False - write_reproject_resampled_input_dates_stack Notes ===== .. _desc_i2_classification.Landsat5_old.end_date: :ref:`end_date ` --------------------------------------------------------- WARNING ------- For this parameter to be taken into account, the auto_date variable in the sensors_data_interpolation section must also be set to `False`: .. code-block:: python sensors_data_interpolation : { 'auto_date':False, } .. _desc_i2_classification.Landsat5_old.keep_bands: :ref:`keep_bands ` ------------------------------------------------------------- WARNING ------- For this parameter to be taken into account, the extract_bands variable in the iota2_feature_extraction section must also be set to `True`: .. code-block:: python iota2_feature_extraction : { 'extract_bands':True, } .. _desc_i2_classification.Landsat5_old.start_date: :ref:`start_date ` ------------------------------------------------------------- WARNING ------- For this parameter to be taken into account, the auto_date variable in the sensors_data_interpolation section must also be set to `False`: .. code-block:: python sensors_data_interpolation : { 'auto_date':False, } .. _i2_classification.Landsat8: Landsat8 ******** .. list-table:: :widths: auto :header-rows: 1 * - Name - Default Value - Description - Type - Mandatory - Name .. _i2_classification.Landsat8.additional_features: * - additional_features - - OTB's bandmath expressions, separated by comma. - str - False - additional_features .. _i2_classification.Landsat8.end_date: * - :ref:`end_date ` - - The last date of interpolated image time series : YYYYMMDD format. - str - False - :ref:`end_date ` .. _i2_classification.Landsat8.keep_bands: * - :ref:`keep_bands ` - ['B1', 'B2', 'B3', 'B4', 'B5', 'B6', 'B7'] - The list of spectral bands used for classification. - list - False - :ref:`keep_bands ` .. _i2_classification.Landsat8.start_date: * - :ref:`start_date ` - - The first date of interpolated image time series : YYYYMMDD format. - str - False - :ref:`start_date ` .. _i2_classification.Landsat8.temporal_resolution: * - temporal_resolution - 16 - The temporal gap between two interpolations. - int - False - temporal_resolution .. _i2_classification.Landsat8.write_reproject_resampled_input_dates_stack: * - write_reproject_resampled_input_dates_stack - True - Flag to write resampled stack image for each date. - bool - False - write_reproject_resampled_input_dates_stack Notes ===== .. _desc_i2_classification.Landsat8.end_date: :ref:`end_date ` ----------------------------------------------------- WARNING ------- For this parameter to be taken into account, the auto_date variable in the sensors_data_interpolation section must also be set to `False`: .. code-block:: python sensors_data_interpolation : { 'auto_date':False, } .. _desc_i2_classification.Landsat8.keep_bands: :ref:`keep_bands ` --------------------------------------------------------- WARNING ------- For this parameter to be taken into account, the extract_bands variable in the iota2_feature_extraction section must also be set to `True`: .. code-block:: python iota2_feature_extraction : { 'extract_bands':True, } .. _desc_i2_classification.Landsat8.start_date: :ref:`start_date ` --------------------------------------------------------- WARNING ------- For this parameter to be taken into account, the auto_date variable in the sensors_data_interpolation section must also be set to `False`: .. code-block:: python sensors_data_interpolation : { 'auto_date':False, } .. _i2_classification.Landsat8_old: Landsat8_old ************ .. list-table:: :widths: auto :header-rows: 1 * - Name - Default Value - Description - Type - Mandatory - Name .. _i2_classification.Landsat8_old.additional_features: * - additional_features - - OTB's bandmath expressions, separated by comma. - str - False - additional_features .. _i2_classification.Landsat8_old.end_date: * - :ref:`end_date ` - - The last date of interpolated image time series : YYYYMMDD format. - str - False - :ref:`end_date ` .. _i2_classification.Landsat8_old.keep_bands: * - :ref:`keep_bands ` - ['B1', 'B2', 'B3', 'B4', 'B5', 'B6', 'B7'] - The list of spectral bands used for classification. - list - False - :ref:`keep_bands ` .. _i2_classification.Landsat8_old.start_date: * - :ref:`start_date ` - - The first date of interpolated image time series : YYYYMMDD format. - str - False - :ref:`start_date ` .. _i2_classification.Landsat8_old.temporal_resolution: * - temporal_resolution - 10 - The temporal gap between two interpolations. - int - False - temporal_resolution .. _i2_classification.Landsat8_old.write_reproject_resampled_input_dates_stack: * - write_reproject_resampled_input_dates_stack - True - Flag to write resampled stack image for each date. - bool - False - write_reproject_resampled_input_dates_stack Notes ===== .. _desc_i2_classification.Landsat8_old.end_date: :ref:`end_date ` --------------------------------------------------------- WARNING ------- For this parameter to be taken into account, the auto_date variable in the sensors_data_interpolation section must also be set to `False`: .. code-block:: python sensors_data_interpolation : { 'auto_date':False, } .. _desc_i2_classification.Landsat8_old.keep_bands: :ref:`keep_bands ` ------------------------------------------------------------- WARNING ------- For this parameter to be taken into account, the extract_bands variable in the iota2_feature_extraction section must also be set to `True`: .. code-block:: python iota2_feature_extraction : { 'extract_bands':True, } .. _desc_i2_classification.Landsat8_old.start_date: :ref:`start_date ` ------------------------------------------------------------- WARNING ------- For this parameter to be taken into account, the auto_date variable in the sensors_data_interpolation section must also be set to `False`: .. code-block:: python sensors_data_interpolation : { 'auto_date':False, } .. _i2_classification.Landsat8_usgs: Landsat8_usgs ************* .. list-table:: :widths: auto :header-rows: 1 * - Name - Default Value - Description - Type - Mandatory - Name .. _i2_classification.Landsat8_usgs.additional_features: * - additional_features - - OTB's bandmath expressions, separated by comma. - str - False - additional_features .. _i2_classification.Landsat8_usgs.end_date: * - :ref:`end_date ` - - The last date of interpolated image time series : YYYYMMDD format. - str - False - :ref:`end_date ` .. _i2_classification.Landsat8_usgs.keep_bands: * - :ref:`keep_bands ` - ['B1', 'B2', 'B3', 'B4', 'B5', 'B6', 'B7', 'B8', 'B9', 'B10'] - The list of spectral bands used for classification. - list - False - :ref:`keep_bands ` .. _i2_classification.Landsat8_usgs.start_date: * - :ref:`start_date ` - - The first date of interpolated image time series : YYYYMMDD format. - str - False - :ref:`start_date ` .. _i2_classification.Landsat8_usgs.temporal_resolution: * - temporal_resolution - 16 - The temporal gap between two interpolations. - int - False - temporal_resolution .. _i2_classification.Landsat8_usgs.write_reproject_resampled_input_dates_stack: * - write_reproject_resampled_input_dates_stack - True - Flag to write resampled stack image for each date. - bool - False - write_reproject_resampled_input_dates_stack Notes ===== .. _desc_i2_classification.Landsat8_usgs.end_date: :ref:`end_date ` ---------------------------------------------------------- WARNING ------- For this parameter to be taken into account, the auto_date variable in the sensors_data_interpolation section must also be set to `False`: .. code-block:: python sensors_data_interpolation : { 'auto_date':False, } .. _desc_i2_classification.Landsat8_usgs.keep_bands: :ref:`keep_bands ` -------------------------------------------------------------- WARNING ------- For this parameter to be taken into account, the extract_bands variable in the iota2_feature_extraction section must also be set to `True`: .. code-block:: python iota2_feature_extraction : { 'extract_bands':True, } .. _desc_i2_classification.Landsat8_usgs.start_date: :ref:`start_date ` -------------------------------------------------------------- WARNING ------- For this parameter to be taken into account, the auto_date variable in the sensors_data_interpolation section must also be set to `False`: .. code-block:: python sensors_data_interpolation : { 'auto_date':False, } .. _i2_classification.Landsat8_usgs_infrared: Landsat8_usgs_infrared ********************** .. list-table:: :widths: auto :header-rows: 1 * - Name - Default Value - Description - Type - Mandatory - Name .. _i2_classification.Landsat8_usgs_infrared.additional_features: * - additional_features - - OTB's bandmath expressions, separated by comma. - str - False - additional_features .. _i2_classification.Landsat8_usgs_infrared.enable_sensor_gapfilling: * - enable_sensor_gapfilling - False - Enable or disable gapfilling for landsat 8 and 9 IR data. - bool - False - enable_sensor_gapfilling .. _i2_classification.Landsat8_usgs_infrared.end_date: * - :ref:`end_date ` - - The last date of interpolated image time series : YYYYMMDD format. - str - False - :ref:`end_date ` .. _i2_classification.Landsat8_usgs_infrared.keep_bands: * - :ref:`keep_bands ` - ['B10', 'B11'] - The list of spectral bands used for classification. - list - False - :ref:`keep_bands ` .. _i2_classification.Landsat8_usgs_infrared.start_date: * - :ref:`start_date ` - - The first date of interpolated image time series : YYYYMMDD format. - str - False - :ref:`start_date ` .. _i2_classification.Landsat8_usgs_infrared.temporal_resolution: * - temporal_resolution - 16 - The temporal gap between two interpolations. - int - False - temporal_resolution .. _i2_classification.Landsat8_usgs_infrared.write_reproject_resampled_input_dates_stack: * - write_reproject_resampled_input_dates_stack - True - Flag to write resampled stack image for each date. - bool - False - write_reproject_resampled_input_dates_stack Notes ===== .. _desc_i2_classification.Landsat8_usgs_infrared.end_date: :ref:`end_date ` ------------------------------------------------------------------- WARNING ------- For this parameter to be taken into account, the auto_date variable in the sensors_data_interpolation section must also be set to `False`: .. code-block:: python sensors_data_interpolation : { 'auto_date':False, } .. _desc_i2_classification.Landsat8_usgs_infrared.keep_bands: :ref:`keep_bands ` ----------------------------------------------------------------------- WARNING ------- For this parameter to be taken into account, the extract_bands variable in the iota2_feature_extraction section must also be set to `True`: .. code-block:: python iota2_feature_extraction : { 'extract_bands':True, } .. _desc_i2_classification.Landsat8_usgs_infrared.start_date: :ref:`start_date ` ----------------------------------------------------------------------- WARNING ------- For this parameter to be taken into account, the auto_date variable in the sensors_data_interpolation section must also be set to `False`: .. code-block:: python sensors_data_interpolation : { 'auto_date':False, } .. _i2_classification.Landsat8_usgs_optical: Landsat8_usgs_optical ********************* .. list-table:: :widths: auto :header-rows: 1 * - Name - Default Value - Description - Type - Mandatory - Name .. _i2_classification.Landsat8_usgs_optical.additional_features: * - additional_features - - OTB's bandmath expressions, separated by comma. - str - False - additional_features .. _i2_classification.Landsat8_usgs_optical.enable_sensor_gapfilling: * - enable_sensor_gapfilling - True - Enable or disable gapfilling for landsat 8 and 9 optical data. - bool - False - enable_sensor_gapfilling .. _i2_classification.Landsat8_usgs_optical.end_date: * - :ref:`end_date ` - - The last date of interpolated image time series : YYYYMMDD format. - str - False - :ref:`end_date ` .. _i2_classification.Landsat8_usgs_optical.keep_bands: * - :ref:`keep_bands ` - ['B1', 'B2', 'B3', 'B4', 'B5', 'B6', 'B7'] - The list of spectral bands used for classification. - list - False - :ref:`keep_bands ` .. _i2_classification.Landsat8_usgs_optical.start_date: * - :ref:`start_date ` - - The first date of interpolated image time series : YYYYMMDD format. - str - False - :ref:`start_date ` .. _i2_classification.Landsat8_usgs_optical.temporal_resolution: * - temporal_resolution - 16 - The temporal gap between two interpolations. - int - False - temporal_resolution .. _i2_classification.Landsat8_usgs_optical.write_reproject_resampled_input_dates_stack: * - 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 Notes ===== .. _desc_i2_classification.Landsat8_usgs_optical.end_date: :ref:`end_date ` ------------------------------------------------------------------ WARNING ------- For this parameter to be taken into account, the auto_date variable in the sensors_data_interpolation section must also be set to `False`: .. code-block:: python sensors_data_interpolation : { 'auto_date':False, } .. _desc_i2_classification.Landsat8_usgs_optical.keep_bands: :ref:`keep_bands ` ---------------------------------------------------------------------- WARNING ------- For this parameter to be taken into account, the extract_bands variable in the iota2_feature_extraction section must also be set to `True`: .. code-block:: python iota2_feature_extraction : { 'extract_bands':True, } .. _desc_i2_classification.Landsat8_usgs_optical.start_date: :ref:`start_date ` ---------------------------------------------------------------------- WARNING ------- For this parameter to be taken into account, the auto_date variable in the sensors_data_interpolation section must also be set to `False`: .. code-block:: python sensors_data_interpolation : { 'auto_date':False, } .. _i2_classification.Landsat8_usgs_thermal: Landsat8_usgs_thermal ********************* .. list-table:: :widths: auto :header-rows: 1 * - Name - Default Value - Description - Type - Mandatory - Name .. _i2_classification.Landsat8_usgs_thermal.additional_features: * - additional_features - - OTB's bandmath expressions, separated by comma. - str - False - additional_features .. _i2_classification.Landsat8_usgs_thermal.enable_sensor_gapfilling: * - enable_sensor_gapfilling - False - Enable or disable gapfilling for landsat 8 and 9 thermal data.(temperature and emissivity) - bool - False - enable_sensor_gapfilling .. _i2_classification.Landsat8_usgs_thermal.end_date: * - :ref:`end_date ` - - The last date of interpolated image time series : YYYYMMDD format. - str - False - :ref:`end_date ` .. _i2_classification.Landsat8_usgs_thermal.keep_bands: * - :ref:`keep_bands ` - ['B10', 'EMIS'] - The list of spectral bands used for classification. - list - False - :ref:`keep_bands ` .. _i2_classification.Landsat8_usgs_thermal.start_date: * - :ref:`start_date ` - - The first date of interpolated image time series : YYYYMMDD format. - str - False - :ref:`start_date ` .. _i2_classification.Landsat8_usgs_thermal.temporal_resolution: * - temporal_resolution - 16 - The temporal gap between two interpolations. - int - False - temporal_resolution .. _i2_classification.Landsat8_usgs_thermal.write_reproject_resampled_input_dates_stack: * - write_reproject_resampled_input_dates_stack - True - Flag to write resampled stack image for each date. - bool - False - write_reproject_resampled_input_dates_stack Notes ===== .. _desc_i2_classification.Landsat8_usgs_thermal.end_date: :ref:`end_date ` ------------------------------------------------------------------ WARNING ------- For this parameter to be taken into account, the auto_date variable in the sensors_data_interpolation section must also be set to `False`: .. code-block:: python sensors_data_interpolation : { 'auto_date':False, } .. _desc_i2_classification.Landsat8_usgs_thermal.keep_bands: :ref:`keep_bands ` ---------------------------------------------------------------------- WARNING ------- For this parameter to be taken into account, the extract_bands variable in the iota2_feature_extraction section must also be set to `True`: .. code-block:: python iota2_feature_extraction : { 'extract_bands':True, } .. _desc_i2_classification.Landsat8_usgs_thermal.start_date: :ref:`start_date ` ---------------------------------------------------------------------- WARNING ------- For this parameter to be taken into account, the auto_date variable in the sensors_data_interpolation section must also be set to `False`: .. code-block:: python sensors_data_interpolation : { 'auto_date':False, } .. _i2_classification.Sentinel_2: Sentinel_2 ********** .. list-table:: :widths: auto :header-rows: 1 * - Name - Default Value - Description - Type - Mandatory - Name .. _i2_classification.Sentinel_2.additional_features: * - additional_features - - OTB's bandmath expressions, separated by comma. - str - False - additional_features .. _i2_classification.Sentinel_2.end_date: * - :ref:`end_date ` - - The last date of interpolated image time series : YYYYMMDD format. - str - False - :ref:`end_date ` .. _i2_classification.Sentinel_2.keep_bands: * - :ref:`keep_bands ` - ['B1', 'B2', 'B3', 'B4', 'B5', 'B6', 'B7'] - The list of spectral bands used for classification. - list - False - :ref:`keep_bands ` .. _i2_classification.Sentinel_2.start_date: * - :ref:`start_date ` - - The first date of interpolated image time series : YYYYMMDD format. - str - False - :ref:`start_date ` .. _i2_classification.Sentinel_2.temporal_resolution: * - temporal_resolution - 10 - The temporal gap between two interpolations. - int - False - temporal_resolution .. _i2_classification.Sentinel_2.write_reproject_resampled_input_dates_stack: * - write_reproject_resampled_input_dates_stack - True - Flag to write resampled stack image for each date. - bool - False - write_reproject_resampled_input_dates_stack Notes ===== .. _desc_i2_classification.Sentinel_2.end_date: :ref:`end_date ` ------------------------------------------------------- WARNING ------- For this parameter to be taken into account, the auto_date variable in the sensors_data_interpolation section must also be set to `False`: .. code-block:: python sensors_data_interpolation : { 'auto_date':False, } .. _desc_i2_classification.Sentinel_2.keep_bands: :ref:`keep_bands ` ----------------------------------------------------------- WARNING ------- For this parameter to be taken into account, the extract_bands variable in the iota2_feature_extraction section must also be set to `True`: .. code-block:: python iota2_feature_extraction : { 'extract_bands':True, } .. _desc_i2_classification.Sentinel_2.start_date: :ref:`start_date ` ----------------------------------------------------------- WARNING ------- For this parameter to be taken into account, the auto_date variable in the sensors_data_interpolation section must also be set to `False`: .. code-block:: python sensors_data_interpolation : { 'auto_date':False, } .. _i2_classification.Sentinel_2_L3A: Sentinel_2_L3A ************** .. list-table:: :widths: auto :header-rows: 1 * - Name - Default Value - Description - Type - Mandatory - Name .. _i2_classification.Sentinel_2_L3A.additional_features: * - additional_features - - OTB's bandmath expressions, separated by comma. - str - False - additional_features .. _i2_classification.Sentinel_2_L3A.end_date: * - :ref:`end_date ` - - The last date of interpolated image time series : YYYYMMDD format. - str - False - :ref:`end_date ` .. _i2_classification.Sentinel_2_L3A.keep_bands: * - :ref:`keep_bands ` - ['B1', 'B2', 'B3', 'B4', 'B5', 'B6', 'B7'] - The list of spectral bands used for classification. - list - False - :ref:`keep_bands ` .. _i2_classification.Sentinel_2_L3A.start_date: * - :ref:`start_date ` - - The first date of interpolated image time series : YYYYMMDD format. - str - False - :ref:`start_date ` .. _i2_classification.Sentinel_2_L3A.temporal_resolution: * - temporal_resolution - 10 - The temporal gap between two interpolations. - int - False - temporal_resolution .. _i2_classification.Sentinel_2_L3A.write_reproject_resampled_input_dates_stack: * - write_reproject_resampled_input_dates_stack - True - Flag to write resampled stack image for each date. - bool - False - write_reproject_resampled_input_dates_stack Notes ===== .. _desc_i2_classification.Sentinel_2_L3A.end_date: :ref:`end_date ` ----------------------------------------------------------- WARNING ------- For this parameter to be taken into account, the auto_date variable in the sensors_data_interpolation section must also be set to `False`: .. code-block:: python sensors_data_interpolation : { 'auto_date':False, } .. _desc_i2_classification.Sentinel_2_L3A.keep_bands: :ref:`keep_bands ` --------------------------------------------------------------- WARNING ------- For this parameter to be taken into account, the extract_bands variable in the iota2_feature_extraction section must also be set to `True`: .. code-block:: python iota2_feature_extraction : { 'extract_bands':True, } .. _desc_i2_classification.Sentinel_2_L3A.start_date: :ref:`start_date ` --------------------------------------------------------------- WARNING ------- For this parameter to be taken into account, the auto_date variable in the sensors_data_interpolation section must also be set to `False`: .. code-block:: python sensors_data_interpolation : { 'auto_date':False, } .. _i2_classification.Sentinel_2_S2C: Sentinel_2_S2C ************** .. list-table:: :widths: auto :header-rows: 1 * - Name - Default Value - Description - Type - Mandatory - Name .. _i2_classification.Sentinel_2_S2C.additional_features: * - additional_features - - OTB's bandmath expressions, separated by comma. - str - False - additional_features .. _i2_classification.Sentinel_2_S2C.end_date: * - :ref:`end_date ` - - The last date of interpolated image time series : YYYYMMDD format. - str - False - :ref:`end_date ` .. _i2_classification.Sentinel_2_S2C.keep_bands: * - :ref:`keep_bands ` - ['B1', 'B2', 'B3', 'B4', 'B5', 'B6', 'B7'] - The list of spectral bands used for classification. - list - False - :ref:`keep_bands ` .. _i2_classification.Sentinel_2_S2C.start_date: * - :ref:`start_date ` - - The first date of interpolated image time series : YYYYMMDD format. - str - False - :ref:`start_date ` .. _i2_classification.Sentinel_2_S2C.temporal_resolution: * - temporal_resolution - 10 - The temporal gap between two interpolations. - int - False - temporal_resolution .. _i2_classification.Sentinel_2_S2C.write_reproject_resampled_input_dates_stack: * - write_reproject_resampled_input_dates_stack - True - Flag to write resampled stack image for each date. - bool - False - write_reproject_resampled_input_dates_stack Notes ===== .. _desc_i2_classification.Sentinel_2_S2C.end_date: :ref:`end_date ` ----------------------------------------------------------- WARNING ------- For this parameter to be taken into account, the auto_date variable in the sensors_data_interpolation section must also be set to `False`: .. code-block:: python sensors_data_interpolation : { 'auto_date':False, } .. _desc_i2_classification.Sentinel_2_S2C.keep_bands: :ref:`keep_bands ` --------------------------------------------------------------- WARNING ------- For this parameter to be taken into account, the extract_bands variable in the iota2_feature_extraction section must also be set to `True`: .. code-block:: python iota2_feature_extraction : { 'extract_bands':True, } .. _desc_i2_classification.Sentinel_2_S2C.start_date: :ref:`start_date ` --------------------------------------------------------------- WARNING ------- For this parameter to be taken into account, the auto_date variable in the sensors_data_interpolation section must also be set to `False`: .. code-block:: python sensors_data_interpolation : { 'auto_date':False, } .. _i2_classification.arg_classification: arg_classification ****************** .. list-table:: :widths: auto :header-rows: 1 * - Name - Default Value - Description - Type - Mandatory - Name .. _i2_classification.arg_classification.boundary_comparison_mode: * - :ref:`boundary_comparison_mode ` - False - Enable classification comparison - bool - False - :ref:`boundary_comparison_mode ` .. _i2_classification.arg_classification.boundary_exterior_buffer_size: * - :ref:`boundary_exterior_buffer_size ` - 0 - Buffer size outside the region. - int - False - :ref:`boundary_exterior_buffer_size ` .. _i2_classification.arg_classification.boundary_fusion_epsilon: * - :ref:`boundary_fusion_epsilon ` - 0.0 - Threshold to avoid weights equals to zero - float - False - :ref:`boundary_fusion_epsilon ` .. _i2_classification.arg_classification.boundary_interior_buffer_size: * - :ref:`boundary_interior_buffer_size ` - 0 - Buffer size inside the region - int - False - :ref:`boundary_interior_buffer_size ` .. _i2_classification.arg_classification.classif_mode: * - :ref:`classif_mode ` - separate - 'separate' or 'fusion' - str - False - :ref:`classif_mode ` .. _i2_classification.arg_classification.dempstershafer_mob: * - :ref:`dempstershafer_mob ` - precision - Choose the dempster shafer mass of belief estimation method. - str - False - :ref:`dempstershafer_mob ` .. _i2_classification.arg_classification.enable_boundary_fusion: * - :ref:`enable_boundary_fusion ` - False - Enable the boundary fusion. - bool - False - :ref:`enable_boundary_fusion ` .. _i2_classification.arg_classification.enable_probability_map: * - :ref:`enable_probability_map ` - False - Produce the probability map. - bool - False - :ref:`enable_probability_map ` .. _i2_classification.arg_classification.fusion_options: * - fusion_options - -nodatalabel 0 -method majorityvoting - OTB FusionOfClassification options for voting method involved if classif_mode is set to 'fusion'. - str - False - fusion_options .. _i2_classification.arg_classification.fusionofclassification_all_samples_validation: * - :ref:`fusionofclassification_all_samples_validation ` - False - Enable the use of all reference data to validate the classification merge. - bool - False - :ref:`fusionofclassification_all_samples_validation ` .. _i2_classification.arg_classification.generate_final_probability_map: * - :ref:`generate_final_probability_map ` - False - Enable the mosaicing of probabilities maps. - bool - False - :ref:`generate_final_probability_map ` .. _i2_classification.arg_classification.keep_runs_results: * - :ref:`keep_runs_results ` - True - If in fusion mode, two final reports can be provided. One for each seed, and one for the classification fusion. - bool - False - :ref:`keep_runs_results ` .. _i2_classification.arg_classification.merge_final_classifications: * - merge_final_classifications - False - Enable the fusion of classifications mode, merging all run in a unique result. - bool - False - merge_final_classifications .. _i2_classification.arg_classification.merge_final_classifications_indecidedlabel: * - merge_final_classifications_indecidedlabel - 255 - Indicate the label for indecision case during fusion. - int - False - merge_final_classifications_indecidedlabel .. _i2_classification.arg_classification.merge_final_classifications_method: * - merge_final_classifications_method - majorityvoting - Indicate the fusion of classification method: 'majorityvoting' or 'dempstershafer.' - str - False - merge_final_classifications_method .. _i2_classification.arg_classification.merge_final_classifications_ratio: * - merge_final_classifications_ratio - 0.1 - Percentage of samples to use in order to evaluate the fusion raster. - float - False - merge_final_classifications_ratio .. _i2_classification.arg_classification.no_label_management: * - no_label_management - maxConfidence - Method for choosing a label in case of fusion. - str - False - no_label_management Notes ===== .. _desc_i2_classification.arg_classification.boundary_comparison_mode: :ref:`boundary_comparison_mode ` ----------------------------------------------------------------------------------------------- If enabled, it will produce two maps. The boundary regions will be analysed to measure the method improvements. .. _desc_i2_classification.arg_classification.boundary_exterior_buffer_size: :ref:`boundary_exterior_buffer_size ` --------------------------------------------------------------------------------------------------------- This value can be different from the interior buffer. The unit is in meters. The value is divided by the resolution to estimate the distance in pixels. .. _desc_i2_classification.arg_classification.boundary_fusion_epsilon: :ref:`boundary_fusion_epsilon ` --------------------------------------------------------------------------------------------- If the region shape contains the buffer, operations are not bijective. In this condition, several weights can be set to 0. This lead to 0 area in the final map (holes). The weights maps are stored as uint16. The threshold should be higher enough to be different to zero, once multiplied by 1000. .. _desc_i2_classification.arg_classification.boundary_interior_buffer_size: :ref:`boundary_interior_buffer_size ` --------------------------------------------------------------------------------------------------------- This value can be different from the exterior buffer. The unit is in meters. The value is divided by the resolution to estimate the distance in pixels. .. _desc_i2_classification.arg_classification.classif_mode: :ref:`classif_mode ` ----------------------------------------------------------------------- If 'fusion' : too huge models will be divided into smaller ones and will classify the same pixels. The threshold between small/big models is defined by the parameter 'mode_outside_regionsplit'. .. _desc_i2_classification.arg_classification.dempstershafer_mob: :ref:`dempstershafer_mob ` ----------------------------------------------------------------------------------- Two kind of indexes can be used: * Global: `accuracy` or `kappa`. * Per class: `precision` or `recall`. .. _desc_i2_classification.arg_classification.enable_boundary_fusion: :ref:`enable_boundary_fusion ` ------------------------------------------------------------------------------------------- If enabled probabilities are used to fuse maps between regions. .. _desc_i2_classification.arg_classification.enable_probability_map: :ref:`enable_probability_map ` ------------------------------------------------------------------------------------------- A probability map is a image with N bands , where N is the number of classes in the nomenclature file. The bands are sorted in ascending order, more information :doc:`here `. .. _desc_i2_classification.arg_classification.fusionofclassification_all_samples_validation: :ref:`fusionofclassification_all_samples_validation ` ----------------------------------------------------------------------------------------------------------------------------------------- If the fusion mode is enabled, enable the use of all reference data samples for validation. .. _desc_i2_classification.arg_classification.generate_final_probability_map: :ref:`generate_final_probability_map ` ----------------------------------------------------------------------------------------------------------- This operation can produce heavy maps. If you don't need it over the whole area in one image, disable this option. .. _desc_i2_classification.arg_classification.keep_runs_results: :ref:`keep_runs_results ` --------------------------------------------------------------------------------- If in fusion mode, two final reports can be provided. One for each seed, and one for the classification fusion. .. _i2_classification.arg_train: arg_train ********* .. list-table:: :widths: auto :header-rows: 1 * - Name - Default Value - Description - Type - Mandatory - Name .. _i2_classification.arg_train.classifier: * - classifier - None - OTB classification algorithm. - str - False - classifier .. _i2_classification.arg_train.deep_learning_parameters: * - deep_learning_parameters - {} - Deep learning parameter description is available :doc:`here `. - dict - False - deep_learning_parameters .. _i2_classification.arg_train.features: * - :ref:`features ` - ['NDVI', 'NDWI', 'Brightness'] - List of additional features computed. - list - False - :ref:`features ` .. _i2_classification.arg_train.features_from_raw_dates: * - :ref:`features_from_raw_dates ` - False - Learn model from raw sensor's date (no interpolations). - bool - False - :ref:`features_from_raw_dates ` .. _i2_classification.arg_train.force_standard_labels: * - :ref:`force_standard_labels ` - False - Standardize labels for feature extraction. - bool - False - :ref:`force_standard_labels ` .. _i2_classification.arg_train.learning_samples_extension: * - :ref:`learning_samples_extension ` - sqlite - Learning samples file extension, possible values are 'sqlite' and 'csv'. - str - False - :ref:`learning_samples_extension ` .. _i2_classification.arg_train.mode_outside_regionsplit: * - :ref:`mode_outside_regionsplit ` - 0.1 - Set the threshold to split huge model. - float - False - :ref:`mode_outside_regionsplit ` .. _i2_classification.arg_train.otb_classifier_options: * - :ref:`otb_classifier_options ` - None - OTB option for classifier.If None, the OTB default values are used. - dict - False - :ref:`otb_classifier_options ` .. _i2_classification.arg_train.random_seed: * - :ref:`random_seed ` - None - Fix the random seed for random split of reference data. - int - False - :ref:`random_seed ` .. _i2_classification.arg_train.ratio: * - ratio - 0.5 - Should be between 0.0 and 1.0 and represents the proportion of the dataset to include in the train split. - float - False - ratio .. _i2_classification.arg_train.runs: * - :ref:`runs ` - 1 - Number of independent runs processed. - int - False - :ref:`runs ` .. _i2_classification.arg_train.sample_augmentation: * - :ref:`sample_augmentation ` - {'activate': False, 'bins': 10} - OTB parameters for sample augmentation. - dict - False - :ref:`sample_augmentation ` .. _i2_classification.arg_train.sample_management: * - :ref:`sample_management ` - None - Absolute path to a CSV file containing samples transfer strategies. - str - False - :ref:`sample_management ` .. _i2_classification.arg_train.sample_selection: * - :ref:`sample_selection ` - {'sampler': 'random', 'strategy': 'all'} - OTB parameters for sampling the validation set. - dict - False - :ref:`sample_selection ` .. _i2_classification.arg_train.sample_validation: * - :ref:`sample_validation ` - {'sampler': 'random', 'strategy': 'all'} - OTB parameters for sampling the validation set. - dict - False - :ref:`sample_validation ` .. _i2_classification.arg_train.sampling_validation: * - sampling_validation - False - Enable sampling validation. - bool - False - sampling_validation .. _i2_classification.arg_train.split_ground_truth: * - :ref:`split_ground_truth ` - True - Enable the split of reference data. - bool - False - :ref:`split_ground_truth ` .. _i2_classification.arg_train.validity_threshold: * - validity_threshold - 1 - Threshold above which a training pixel is considered valid. - int - False - validity_threshold Notes ===== .. _desc_i2_classification.arg_train.features: :ref:`features ` ------------------------------------------------------ This parameter enables the computation of the three indices if available for the sensor used. There is no choice for using only one of them. .. _desc_i2_classification.arg_train.features_from_raw_dates: :ref:`features_from_raw_dates ` ------------------------------------------------------------------------------------ If True, during the learning and classification step, each pixel will receive a vector of values of the size of the number of all dates detected. As the pixels were not all acquired on the same dates, the vector will contains NaNs on the unacquired dates. .. _desc_i2_classification.arg_train.force_standard_labels: :ref:`force_standard_labels ` -------------------------------------------------------------------------------- The chain labels each feature by the sensors name, the spectral band or index and the date. If activated this parameter use the OTB default value (`value_X`). .. _desc_i2_classification.arg_train.learning_samples_extension: :ref:`learning_samples_extension ` ------------------------------------------------------------------------------------------ Default value is 'sqlite' (faster). If the number of features is greater than 2000, it should be set to 'csv' as sqlite file doesn't accept more than 2000 columns. .. _desc_i2_classification.arg_train.mode_outside_regionsplit: :ref:`mode_outside_regionsplit ` -------------------------------------------------------------------------------------- This parameter is available if regionPath is used and arg_train.classif_mode is set to fusion. It represents the maximum size covered by a region. If the regions are larger than this threshold, then N models are built by randomly selecting features inside the region. .. _desc_i2_classification.arg_train.otb_classifier_options: :ref:`otb_classifier_options ` ---------------------------------------------------------------------------------- This parameter is a dictionary which accepts all OTB application parameters. To know the exhaustive parameters list use `otbcli_TrainVectorClassifier` in a terminal or look at the OTB documentation. .. _desc_i2_classification.arg_train.random_seed: :ref:`random_seed ` ------------------------------------------------------------ Fix the random seed used for random split of reference data. If set, the results must be the same for a given classifier. .. _desc_i2_classification.arg_train.runs: :ref:`runs ` ---------------------------------------------- Number of independent runs processed. Each run has its own learning samples. Must be an integer greater than 0. .. _desc_i2_classification.arg_train.sample_augmentation: :ref:`sample_augmentation ` ---------------------------------------------------------------------------- In supervised classification the balance between class samples is important. There are many ways to manage class balancing in iota2, using :ref:`desc_i2_classification.arg_train.sample_selection` or the classifier's options to limit the number of samples by class. An other approach is to generate synthetic samples. It is the purpose of this functionality, which is called sample augmentation'. .. code-block:: python {'activate':False} Example ------- .. code-block:: python sample_augmentation : { 'target_models' : ['1', '2'], 'strategy' : 'jitter', 'strategy.jitter.stdfactor' : 10, 'strategy.smote.neighbors' : 5, 'samples.strategy' : 'balance', 'activate' : True } iota2 implements an interface to the OTB `SampleAugmentation `_ application. There are three methods to generate samples : replicate, jitter and smote. The documentation :doc:`here ` explains the difference between these approaches. ``samples.strategy`` specifies how many samples must be created. There are 3 different strategies: - minNumber To set the minimum number of samples by class required. - balance Balance all classes with the same number of samples as the majority one. - byClass Augment only some of the classes Parameters related to ``minNumber`` and ``byClass`` strategies are: - samples.strategy.minNumber Minimum number of samples. - samples.strategy.byClass Path to a CSV file containing in first column the class's abel and in the second column the minimum number of samples required. In the above example, classes of models '1' and '2' will be augmented to the most represented class in the corresponding model using the jitter method. To perform sample augmentation for regression problems, we return to a configuration similar to classification. For that purpose we create fake classes using the ``bins`` parameter. The ``bins`` parameter can be an integer in which case the interval of values of the target output variable is divided into ``bins`` sub-intervals of equal width, and each sample gets a fake a class corresponding to the number of the interval in which its label fell. ``bins`` can also be a list of ascending values used as interval boundaries to assign to the classes. .. _desc_i2_classification.arg_train.sample_management: :ref:`sample_management ` ------------------------------------------------------------------------ The CSV must contain a row per transfer: .. code-block:: python >>> cat /absolute/path/myRules.csv 1,2,4,2 Meaning: +--------+-------------+------------+----------+ | source | destination | class name | quantity | +========+=============+============+==========+ | 1 | 2 | 4 | 2 | +--------+-------------+------------+----------+ Currently, setting the 'random_seed' parameter has no effect on this workflow. .. _desc_i2_classification.arg_train.sample_selection: :ref:`sample_selection ` ---------------------------------------------------------------------- This field parameters the strategy of polygon sampling. It directly refers to options of OTB’s SampleSelection application. Example ------- .. code-block:: python "sample_selection": { "sampler": "random", "strategy": "percent", "strategy.percent.p": 0.2, "per_models": [ { "target_model": "4", "sampler": "periodic" } ] } In the example above, all polygons will be sampled with the 20% ratio. But the polygons which belong to the model 4 will be periodically sampled, instead of the ransom sampling used for other polygons. Notice than ``per_models`` key contains a list of strategies. Then we can imagine the following : .. code-block:: python "sample_selection": { "sampler": "random", "strategy": "percent", "strategy.percent.p": 0.2, "per_models": [ { "target_model": "4", "sampler": "periodic" }, { "target_model": "1", "sampler": "random", "strategy": "byclass", "strategy.byclass.in": "/path/to/myCSV.csv" } ] } Where the first column of /path/to/myCSV.csv is class label (integer), second one is the required samples number (integer). .. _desc_i2_classification.arg_train.sample_validation: :ref:`sample_validation ` ------------------------------------------------------------------------ This field parameters the strategy of polygon sampling. It directly refers to options of OTB’s SampleSelection application. Example ------- .. code-block:: python "sample_selection": { "sampler": "random", "strategy": "percent", "strategy.percent.p": 0.2, "per_models": [ { "target_model": "4", "sampler": "periodic" } ] } In the example above, all polygons will be sampled with the 20% ratio. But the polygons which belong to the model 4 will be periodically sampled, instead of the ransom sampling used for other polygons. Notice than ``per_models`` key contains a list of strategies. Then we can imagine the following : .. code-block:: python "sample_selection": { "sampler": "random", "strategy": "percent", "strategy.percent.p": 0.2, "per_models": [ { "target_model": "4", "sampler": "periodic" }, { "target_model": "1", "sampler": "random", "strategy": "byclass", "strategy.byclass.in": "/path/to/myCSV.csv" } ] } Where the first column of /path/to/myCSV.csv is class label (integer), second one is the required samples number (integer). .. _desc_i2_classification.arg_train.split_ground_truth: :ref:`split_ground_truth ` -------------------------------------------------------------------------- If set to False, the chain uses all polygons for both training and validation. .. _i2_classification.builders: builders ******** .. list-table:: :widths: auto :header-rows: 1 * - Name - Default Value - Description - Type - Mandatory - Name .. _i2_classification.builders.builders_class_name: * - :ref:`builders_class_name ` - ['I2Classification'] - The name of the class defining the builder. - list - False - :ref:`builders_class_name ` .. _i2_classification.builders.builders_paths: * - :ref:`builders_paths ` - /path/to/iota2/sources - The path to user builders. - str - False - :ref:`builders_paths ` Notes ===== .. _desc_i2_classification.builders.builders_class_name: :ref:`builders_class_name ` --------------------------------------------------------------------------- Available builders are : 'I2Classification', 'I2FeaturesMap' and 'I2Obia'. .. _desc_i2_classification.builders.builders_paths: :ref:`builders_paths ` ----------------------------------------------------------------- If not indicated, the iota2 source directory is used: \*/iota2/sequence_builders/. .. _i2_classification.chain: chain ***** .. list-table:: :widths: auto :header-rows: 1 * - Name - Default Value - Description - Type - Mandatory - Name .. _i2_classification.chain.check_inputs: * - :ref:`check_inputs ` - True - Enable the inputs verification - bool - False - :ref:`check_inputs ` .. _i2_classification.chain.cloud_threshold: * - :ref:`cloud_threshold ` - 0 - Threshold to consider that a pixel is valid. - int - False - :ref:`cloud_threshold ` .. _i2_classification.chain.color_table: * - color_table - None - Absolute path to the file that links the classes and their colours. - str - True - color_table .. _i2_classification.chain.compression_algorithm: * - compression_algorithm - ZSTD - Set the gdal compression algorithm to use: NONE, LZW, ZSTD (default).All rasters written with OTB will be compressed with the chosen algorithm. - str - False - compression_algorithm .. _i2_classification.chain.compression_predictor: * - :ref:`compression_predictor ` - 2 - Set the predictor for LZW and ZSTD compression: 1 (no predictor), 2 (horizontal differencing, default). - int - False - :ref:`compression_predictor ` .. _i2_classification.chain.data_field: * - :ref:`data_field ` - None - Field name indicating classes labels in `ground_truth` - str - True - :ref:`data_field ` .. _i2_classification.chain.first_step: * - first_step - None - The step group name indicating where the chain starts. - str - False - first_step .. _i2_classification.chain.ground_truth: * - ground_truth - None - Absolute path to reference data. - str - True - ground_truth .. _i2_classification.chain.l5_path_old: * - l5_path_old - None - Absolute path to Landsat-5 images coming from old THEIA format (D*H*). - str - False - l5_path_old .. _i2_classification.chain.l8_path: * - l8_path - None - Absolute path to Landsat-8 images comingfrom new tiled THEIA data. - str - False - l8_path .. _i2_classification.chain.l8_path_old: * - l8_path_old - None - Absolute path to Landsat-8 images coming from old THEIA format (D*H*). - str - False - l8_path_old .. _i2_classification.chain.l8_usgs_infrared_path: * - l8_usgs_infrared_path - None - Absolute path to :doc:`Landsat-8 images coming from USGS data `. - str - False - l8_usgs_infrared_path .. _i2_classification.chain.l8_usgs_optical_path: * - l8_usgs_optical_path - None - Absolute path to :doc:`Landsat-8 images coming from USGS data `. - str - False - l8_usgs_optical_path .. _i2_classification.chain.l8_usgs_path: * - l8_usgs_path - None - Absolute path to :doc:`Landsat-8 images coming from USGS data `. - str - False - l8_usgs_path .. _i2_classification.chain.l8_usgs_thermal_path: * - l8_usgs_thermal_path - None - Absolute path to :doc:`Landsat-8 images coming from USGS data `. - str - False - l8_usgs_thermal_path .. _i2_classification.chain.last_step: * - last_step - None - The step group name indicating where the chain ends. - str - False - last_step .. _i2_classification.chain.list_tile: * - list_tile - None - List of tiles to process, separated by space. - str - True - list_tile .. _i2_classification.chain.logger_level: * - logger_level - INFO - Set the logger level: NOTSET, DEBUG, INFO, WARNING, ERROR, CRITICAL. - str - False - logger_level .. _i2_classification.chain.minimum_required_dates: * - minimum_required_dates - 2 - Required minimum number of available dates for each sensor. - int - False - minimum_required_dates .. _i2_classification.chain.nomenclature_path: * - nomenclature_path - None - Absolute path to the nomenclature description file. - str - True - nomenclature_path .. _i2_classification.chain.output_path: * - :ref:`output_path ` - None - Absolute path to the output directory - str - True - :ref:`output_path ` .. _i2_classification.chain.output_statistics: * - output_statistics - True - output_statistics - bool - False - output_statistics .. _i2_classification.chain.proj: * - proj - None - The projection wanted. Format EPSG:XXXX is mandatory. - str - True - proj .. _i2_classification.chain.region_field: * - :ref:`region_field ` - region - The column name for region indicator in`region_path` file. - str - False - :ref:`region_field ` .. _i2_classification.chain.region_path: * - region_path - None - Absolute path to a region vector file. - str - False - region_path .. _i2_classification.chain.remove_output_path: * - :ref:`remove_output_path ` - True - Before the launch of iota2, remove the content of `output_path`. - bool - False - :ref:`remove_output_path ` .. _i2_classification.chain.s1_path: * - s1_path - None - Absolute path to Sentinel-1 configuration file. - str - False - s1_path .. _i2_classification.chain.s2_l3a_output_path: * - s2_l3a_output_path - None - Absolute path to store preprocessed data in a dedicated directory. - str - False - s2_l3a_output_path .. _i2_classification.chain.s2_l3a_path: * - s2_l3a_path - None - Absolute path to Sentinel-2 L3A images (THEIA format). - str - False - s2_l3a_path .. _i2_classification.chain.s2_output_path: * - s2_output_path - None - Absolute path to store preprocessed data in a dedicated directory. - str - False - s2_output_path .. _i2_classification.chain.s2_path: * - s2_path - None - Absolute path to Sentinel-2 images (THEIA format). - str - False - s2_path .. _i2_classification.chain.s2_s2c_output_path: * - s2_s2c_output_path - None - Absolute path to store preprocessed data in a dedicated directory. - str - False - s2_s2c_output_path .. _i2_classification.chain.s2_s2c_path: * - s2_s2c_path - None - Absolute path to Sentinel-2 images (Sen2Cor format). - str - False - s2_s2c_path .. _i2_classification.chain.spatial_resolution: * - :ref:`spatial_resolution ` - [] - Output spatial resolution. - list or scalar - False - :ref:`spatial_resolution ` .. _i2_classification.chain.user_feat_path: * - :ref:`user_feat_path ` - None - Absolute path to the user's features path. - str - False - :ref:`user_feat_path ` Notes ===== .. _desc_i2_classification.chain.check_inputs: :ref:`check_inputs ` ---------------------------------------------------------- Enable the inputs verification. It can take a lot of time for large datasets. Check if region intersects reference data for instance. .. _desc_i2_classification.chain.cloud_threshold: :ref:`cloud_threshold ` ---------------------------------------------------------------- Indicates the threshold for a polygon to be used for learning. It uses the validity count, which is incremented if a cloud, a cloud shadow or a saturated pixel is detected. .. _desc_i2_classification.chain.compression_predictor: :ref:`compression_predictor ` ---------------------------------------------------------------------------- It has been noted that in some cases, once the features are written to disk, the raster file may be empty. If this is the case, please change the predictor to 1 or 3. .. _desc_i2_classification.chain.data_field: :ref:`data_field ` ------------------------------------------------------ All the labels values must be different from 0. It is recommended to use a continuous range of values but it is not mandatory. Keep in mind that the final product type is detected according to the maximum label value. Try to keep values between 1 and 255 to avoid heavy products. .. _desc_i2_classification.chain.output_path: :ref:`output_path ` -------------------------------------------------------- Absolute path to the output directory. It is recommended to have one directory per run of the chain. .. _desc_i2_classification.chain.region_field: :ref:`region_field ` ---------------------------------------------------------- This column in the database must contain a string which can be converted into integers. For instance '1_2' does not match this condition. It is mandatory that the region identifiers are > 0. .. _desc_i2_classification.chain.remove_output_path: :ref:`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. .. _desc_i2_classification.chain.spatial_resolution: :ref:`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. .. _desc_i2_classification.chain.user_feat_path: :ref:`user_feat_path ` -------------------------------------------------------------- Absolute path to the user's features path. They must be stored by tiles. .. _i2_classification.external_features: external_features ***************** .. list-table:: :widths: auto :header-rows: 1 * - Name - Default Value - Description - Type - Mandatory - Name .. _i2_classification.external_features.concat_mode: * - :ref:`concat_mode ` - True - Enable the use of all features. - bool - False - :ref:`concat_mode ` .. _i2_classification.external_features.exogeneous_data: * - :ref:`exogeneous_data ` - None - Path to a Geotiff file containing additional data to be used in external features. - str - False - :ref:`exogeneous_data ` .. _i2_classification.external_features.external_features_flag: * - external_features_flag - False - Enable the external features mode. - bool - False - external_features_flag .. _i2_classification.external_features.functions: * - :ref:`functions ` - None - Functions list to be used to compute features. - str/list - False - :ref:`functions ` .. _i2_classification.external_features.module: * - module - /path/to/iota2/sources - Absolute path for user source code. - str - False - module .. _i2_classification.external_features.no_data_value: * - no_data_value - -10000 - Value considered as no_data in features map mosaic ('I2FeaturesMap' builder name). - int - False - no_data_value .. _i2_classification.external_features.output_name: * - output_name - None - Temporary chunks are written using this name as prefix. - str - False - output_name Notes ===== .. _desc_i2_classification.external_features.concat_mode: :ref:`concat_mode ` -------------------------------------------------------------------- If disabled, only external features are used in the whole processing. .. _desc_i2_classification.external_features.exogeneous_data: :ref:`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=. .. _desc_i2_classification.external_features.functions: :ref:`functions ` ---------------------------------------------------------------- Can be a string of space-separated function names. Can be a list of either strings of function name or lists of one function name and one argument mapping. .. _i2_classification.iota2_feature_extraction: iota2_feature_extraction ************************ .. list-table:: :widths: auto :header-rows: 1 * - Name - Default Value - Description - Type - Mandatory - Name .. _i2_classification.iota2_feature_extraction.acor_feat: * - :ref:`acor_feat ` - False - Apply atmospherically corrected features - bool - False - :ref:`acor_feat ` .. _i2_classification.iota2_feature_extraction.copy_input: * - copy_input - True - Use spectral bands as features. - bool - False - copy_input .. _i2_classification.iota2_feature_extraction.extract_bands: * - extract_bands - False - - bool - False - extract_bands .. _i2_classification.iota2_feature_extraction.keep_duplicates: * - keep_duplicates - True - Using 'rel_refl' can generate duplicated features (ie: NDVI). Set to False remove these duplicated features. - bool - False - keep_duplicates .. _i2_classification.iota2_feature_extraction.rel_refl: * - rel_refl - False - Compute relative reflectances by the red band. - bool - False - rel_refl Notes ===== .. _desc_i2_classification.iota2_feature_extraction.acor_feat: :ref:`acor_feat ` ----------------------------------------------------------------------- Apply atmospherically corrected features as explained at : http://www.cesbio.ups-tlse.fr/multitemp/?p=12746. .. _i2_classification.pretrained_model: pretrained_model **************** .. list-table:: :widths: auto :header-rows: 1 * - Name - Default Value - Description - Type - Mandatory - Name .. _i2_classification.pretrained_model.boundary_buffer: * - boundary_buffer - None - List of boundary buffer size - list - False - boundary_buffer .. _i2_classification.pretrained_model.function: * - :ref:`function ` - None - Predict function name. - str - False - :ref:`function ` .. _i2_classification.pretrained_model.mode: * - :ref:`mode ` - None - Algorithm nature (classification or regression). - str - False - :ref:`mode ` .. _i2_classification.pretrained_model.model: * - :ref:`model ` - None - Serialized object containing the model. - str - False - :ref:`model ` .. _i2_classification.pretrained_model.module: * - :ref:`module ` - /path/to/iota2/sources - Absolute path to the python module. - str - False - :ref:`module ` Notes ===== .. _desc_i2_classification.pretrained_model.function: :ref:`function ` ------------------------------------------------------------- This function must have the imposed signature. It does not accept any others parameters. All model dedicated parameters must be stored alongside the model. .. _desc_i2_classification.pretrained_model.mode: :ref:`mode ` ----------------------------------------------------- The python module must contains the predict function. It must handle all the potential dependencies and imports related to the correct model instantiation. .. _desc_i2_classification.pretrained_model.model: :ref:`model ` ------------------------------------------------------- In the configuration file, the mandatory keys $REGION and $SEED must be present as they are replaced by iota2. In case of only one region, the region value is set to 1. Look at the documentation about the model constraints. .. _desc_i2_classification.pretrained_model.module: :ref:`module ` --------------------------------------------------------- The python module must contain the predict function. It must handle all the potential dependencies and imports related to the correct model instantiation. .. _i2_classification.python_data_managing: python_data_managing ******************** .. list-table:: :widths: auto :header-rows: 1 * - Name - Default Value - Description - Type - Mandatory - Name .. _i2_classification.python_data_managing.chunk_size_mode: * - chunk_size_mode - split_number - The chunk split mode, currently the choice is 'split_number'. - str - False - chunk_size_mode .. _i2_classification.python_data_managing.chunk_size_x: * - chunk_size_x - 50 - Number of columns for one chunk. - int - False - chunk_size_x .. _i2_classification.python_data_managing.chunk_size_y: * - chunk_size_y - 50 - Number of rows for one chunk. - int - False - chunk_size_y .. _i2_classification.python_data_managing.data_mode_access: * - :ref:`data_mode_access ` - gapfilled - Choose which data can be accessed in custom features. - str - False - :ref:`data_mode_access ` .. _i2_classification.python_data_managing.fill_missing_dates: * - :ref:`fill_missing_dates ` - False - Fill raw data with no data if dates are missing. - bool - False - :ref:`fill_missing_dates ` .. _i2_classification.python_data_managing.max_nn_inference_size: * - :ref:`max_nn_inference_size ` - None - Maximum batch inference size. - int - False - :ref:`max_nn_inference_size ` .. _i2_classification.python_data_managing.number_of_chunks: * - number_of_chunks - 50 - The expected number of chunks. - int - False - number_of_chunks .. _i2_classification.python_data_managing.padding_size_x: * - padding_size_x - 0 - The padding for chunk. - int - False - padding_size_x .. _i2_classification.python_data_managing.padding_size_y: * - padding_size_y - 0 - The padding for chunk. - int - False - padding_size_y Notes ===== .. _desc_i2_classification.python_data_managing.data_mode_access: :ref:`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. .. note:: Data are spatially resampled, these parameters concern only temporal interpolation. .. _desc_i2_classification.python_data_managing.fill_missing_dates: :ref:`fill_missing_dates ` ------------------------------------------------------------------------------------- If raw data access is enabled, this option considers all unique dates for all tiles and identifies 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 values: 0 for valid data, 1 for cloudy or saturated pixels, 2 for a missing date. .. _desc_i2_classification.python_data_managing.max_nn_inference_size: :ref:`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. .. _i2_classification.scikit_models_parameters: scikit_models_parameters ************************ .. list-table:: :widths: auto :header-rows: 1 * - Name - Default Value - Description - Type - Mandatory - Name .. _i2_classification.scikit_models_parameters.cross_validation_folds: * - cross_validation_folds - 5 - The number of k-folds. - int - False - cross_validation_folds .. _i2_classification.scikit_models_parameters.cross_validation_grouped: * - cross_validation_grouped - False - - bool - False - cross_validation_grouped .. _i2_classification.scikit_models_parameters.cross_validation_parameters: * - cross_validation_parameters - {} - - dict - False - cross_validation_parameters .. _i2_classification.scikit_models_parameters.keyword_arguments: * - :ref:`keyword_arguments ` - {} - Keyword arguments to be passed to model. - dict - False - :ref:`keyword_arguments ` .. _i2_classification.scikit_models_parameters.model_type: * - :ref:`model_type ` - None - Machine learning algorithm's name. - str - False - :ref:`model_type ` .. _i2_classification.scikit_models_parameters.standardization: * - standardization - True - - bool - False - standardization Notes ===== .. _desc_i2_classification.scikit_models_parameters.keyword_arguments: :ref:`keyword_arguments ` --------------------------------------------------------------------------------------- Keyword arguments to be passed to model. .. _desc_i2_classification.scikit_models_parameters.model_type: :ref:`model_type ` ------------------------------------------------------------------------- Models coming from scikit-learn are used if scikit_models_parameters.model_type is different from None. More information about how to use scikit-learn is available at iota2 and scikit-learn `documentation `_. .. _i2_classification.sensors_data_interpolation: sensors_data_interpolation ************************** .. list-table:: :widths: auto :header-rows: 1 * - Name - Default Value - Description - Type - Mandatory - Name .. _i2_classification.sensors_data_interpolation.auto_date: * - :ref:`auto_date ` - True - Enable the use of `start_date` and `end_date` - bool - False - :ref:`auto_date ` .. _i2_classification.sensors_data_interpolation.use_additional_features: * - use_additional_features - False - Enable the use of additional features. - bool - False - use_additional_features .. _i2_classification.sensors_data_interpolation.use_gapfilling: * - use_gapfilling - True - Enable the use of gapfilling (clouds/temporal interpolation). - bool - False - use_gapfilling .. _i2_classification.sensors_data_interpolation.write_outputs: * - :ref:`write_outputs ` - False - Write temporary files. - bool - False - :ref:`write_outputs ` Notes ===== .. _desc_i2_classification.sensors_data_interpolation.auto_date: :ref:`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. .. _desc_i2_classification.sensors_data_interpolation.write_outputs: :ref:`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. .. _i2_classification.slurm: slurm ***** .. list-table:: :widths: auto :header-rows: 1 * - Name - Default Value - Description - Type - Mandatory - Name .. _i2_classification.slurm.account: * - :ref:`account ` - None - Feed the sbatch parameter 'account'. - str - False - :ref:`account ` Notes ===== .. _desc_i2_classification.slurm.account: :ref:`account ` ------------------------------------------------ The section 'slurm' is only available once the `Slurm `_ orchestrator is involved in jobs submission. .. _i2_classification.task_retry_limits: task_retry_limits ***************** .. list-table:: :widths: auto :header-rows: 1 * - Name - Default Value - Description - Type - Mandatory - Name .. _i2_classification.task_retry_limits.allowed_retry: * - allowed_retry - 0 - Allow dask to retry a failed job N times. - int - False - allowed_retry .. _i2_classification.task_retry_limits.maximum_cpu: * - :ref:`maximum_cpu ` - 4 - The maximum number of CPU available. - int - False - :ref:`maximum_cpu ` .. _i2_classification.task_retry_limits.maximum_ram: * - :ref:`maximum_ram ` - 16.0 - The maximum amount of RAM available (gB). - float - False - :ref:`maximum_ram ` Notes ===== .. _desc_i2_classification.task_retry_limits.maximum_cpu: :ref:`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 reached. .. _desc_i2_classification.task_retry_limits.maximum_ram: :ref:`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 reached. .. _i2_classification.userFeat: userFeat ******** .. list-table:: :widths: auto :header-rows: 1 * - Name - Default Value - Description - Type - Mandatory - Name .. _i2_classification.userFeat.arbo: * - arbo - /* - Input folder hierarchy. - str - False - arbo .. _i2_classification.userFeat.patterns: * - patterns - ALT,ASP,SLP - Key name to detect the input images. - str - False - patterns