Update theropoda.md

docs/theropoda.md

@@ -1,61 +1,85 @@
 
 # Theropoda Module
 
-This module includes functionalities related to theropod dinosaurs.
+This module includes functionalities related to `theropoda.py` code.
 
 ## Overview
 
-The `theropoda` module provides classes and functions to handle data and perform analyses related to theropod dinosaurs.
-
-## Classes
-
-### `Theropod`
-
-Represents a theropod dinosaur.
+The `theropoda.py` module provides functions to extract time series information from Sentinel 2 data stored in Earth Engine.
 
 #### Attributes
 
-- `name` (str): The name of the theropod.
-- `length` (float): The length of the theropod in meters.
-- `weight` (float): The weight of the theropod in kilograms.
-- `diet` (str): The diet type of the theropod (e.g., 'carnivore').
-
-#### Methods
-
-- `roar()`: Prints a roar from the theropod.
+- `asset` (str): Choosed Earth Engine vector asset.
+- `id_field` (str): Vector column used as ID (use unique identifiers!).
+- `output_name` (str): Output filename.
 
 #### Example Usage
 
 ```python
-from theropoda import Theropod
 
-t_rex = Theropod(name="Tyrannosaurus Rex", length=12.3, weight=9000, diet="carnivore")
-print(t_rex.name)  # Output: Tyrannosaurus Rex
-t_rex.roar()  # Output: ROAR!!!
+asset	= 'users/vieiramesquita/LAPIG_FieldSamples/lapig_goias_fieldwork_2022_50m'
+id_field = 'ID_POINTS'
+output_name = 'LAPIG_Pasture_S2_NDVI_Monitoring_FieldWork.csv'
 ```
 
 ## Functions
 
-### `find_largest_theropod(theropods)`
+### 1.`getTimeSeries`
 
-Finds the largest theropod in a list.
+  This function is responsible to get the time series of Sentinel 2 data throught Earth Engine. It needs a `geometry` object in the `ee.Feature()` formart and the choosed vector propertie ID as the `id_field`.
+
+  Parameters:
+  - `geometry`: An ee.Feature() object representing the area of interest.
+  - `bestEffort`: A boolean indicating whether to use a larger pixel (10m to 30m) if the polygon area is too big (default is False).
+
+  Returns:
+  - NDVI time series data along with other information for the specified geometry.
 
-#### Parameters
+### 2.`build_time_series`
 
-- `theropods` (list of Theropod): A list of `Theropod` objects.
+Builds and writes NDVI time series data for a target vector asset, processing one polygon at a time.
 
-#### Returns
+Parameters:
+- `index`: Index of the object being processed.
+- `obj`: Object ID for which the time series is being generated.
+- `id_field`: Field name representing the ID in the vector asset.
+- `outfile`: Output file path to write the time series data.
+- `asset`: Earth Engine vector asset.
+- `bestEffort`: A boolean indicating whether to use a larger scale if needed (default is False).
 
-- `Theropod`: The largest theropod in the list.
+Returns:
+- True if processing is successful, None if the polygon area is too small, False if an error occurs during processing and restart the process using the bestEffort approach.
 
-#### Example Usage
+### 3.`build_time_series_check`
 
-```python
-from theropoda import Theropod, find_largest_theropod
+Checks the consistency of the NDVI time series library and handles errors during processing.
 
-t_rex = Theropod(name="Tyrannosaurus Rex", length=12.3, weight=9000, diet="carnivore")
-velociraptor = Theropod(name="Velociraptor", length=2.0, weight=15, diet="carnivore")
+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).
 
-largest = find_largest_theropod([t_rex, velociraptor])
-print(largest.name)  # Output: Tyrannosaurus Rex
-```
+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.
+
+### 5.`run`
+
+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.