Skip to content

Module fordead.steps.step5_export_results

Functions

export_results

def export_results(
    data_directory,
    start_date='2015-06-23',
    end_date='2030-01-02',
    frequency='M',
    multiple_files=False,
    conf_threshold_list=None,
    conf_classes_list=None
)

Writes results in the chosen period, form and using chosen frequency.
See details here : https://fordead.gitlab.io/fordead_package/docs/user_guides/english/05_export_results/


Parameters
----------
data_directory : str
    Path of the output directory
start_date : str
    Start date for exporting results (format : 'YYYY-MM-DD')
end_date : str
    End date for exporting results (format : 'YYYY-MM-DD')
frequency : str
    Frequency used to aggregate results, if value is 'sentinel', then periods correspond to the period between sentinel dates used in the detection, or it can be the frequency as used in pandas.date_range. e.g. 'M' (monthly), '3M' (three months), '15D' (fifteen days)
multiple_files : bool
    If True, one shapefile is exported for each period containing the areas in dieback at the end of the period. Else, a single shapefile is exported containing diebackd areas associated with the period of dieback
conf_threshold_list : list
    List of thresholds used as bins to discretize the confidence index into several classes
conf_classes_list : list
    List of classes names, if conf_threshold_list has n values, conf_classes_list must have n+1 values

Returns
-------