From 8ff017872a912b053d3e2065f588a76b4dbd02f0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Vin=C3=ADcius=20Mesquita?= Date: Thu, 20 Jun 2024 23:52:06 -0300 Subject: [PATCH] Update theropoda.md --- docs/theropoda.md | 48 +++++++++++++++++++++++------------------------ 1 file changed, 24 insertions(+), 24 deletions(-) diff --git a/docs/theropoda.md b/docs/theropoda.md index 2b204fbc..4bac44e7 100644 --- a/docs/theropoda.md +++ b/docs/theropoda.md @@ -52,34 +52,34 @@ Builds and writes NDVI time series data for a target vector asset, processing on ### 3.`build_time_series_check` - Checks the consistency of the NDVI time series library and handles errors during processing. - - Parameters: - - `index`: Index of the object being processed. - - `obj`: Object ID for which the time series is being checked. - - `id_field`: Field name representing the ID in the vector asset. - - `outfile`: Output file path where time series data is stored. - - `asset`: Earth Engine vector asset. - - `checker`: A boolean indicating whether to check if the polygon has been processed before (default is False). - - Returns: - - A dictionary containing information about errors and processing time. +Checks the consistency of the NDVI time series library and handles errors during processing. + +#### Parameters +- `index`: Index of the object being processed. +- `obj`: Object ID for which the time series is being checked. +- `id_field`: Field name representing the ID in the vector asset. +- `outfile`: Output file path where time series data is stored. +- `asset`: Earth Engine vector asset. +- `checker`: A boolean indicating whether to check if the polygon has been processed before (default is False). + +#### Returns +- A dictionary containing information about errors and processing time. ### 4.`build_id_list` - Builds and writes a text file containing each Polygon ID used to extract the time series. - - Parameters: - - `asset`: Earth Engine vector asset. - - `id_field`: Field name representing the ID in the vector asset. - - `colab_folder`: Path of the folder where the text file will be saved. +Builds and writes a text file containing each Polygon ID used to extract the time series. + +#### Parameters +- `asset`: Earth Engine vector asset. +- `id_field`: Field name representing the ID in the vector asset. +- `colab_folder`: Path of the folder where the text file will be saved. ### 5.`run` - Manages the overall workflow by catching argument information and initiating the process of extracting NDVI time series data for specified polygonal areas. +Manages the overall workflow by catching argument information and initiating the process of extracting NDVI time series data for specified polygonal areas. - Parameters: - - `asset`: Earth Engine vector asset. - - `id_field`: Field name representing the ID in the vector asset. - - `output_name`: Name of the output file. - - `colab_folder`: Path of the folder where the output file will be saved. +#### Parameters +- `asset`: Earth Engine vector asset. +- `id_field`: Field name representing the ID in the vector asset. +- `output_name`: Name of the output file. +- `colab_folder`: Path of the folder where the output file will be saved.