Commit 81dc96d3 authored by remi cresson's avatar remi cresson
Browse files

DOC: update markdown

parent 767f72f5
...@@ -28,16 +28,15 @@ The implemented pipeline is described in [Leroux et al](https://doi.org/10.1016/ ...@@ -28,16 +28,15 @@ The implemented pipeline is described in [Leroux et al](https://doi.org/10.1016/
TimeSeriesIndexTrend is an OTBApplication. TimeSeriesIndexTrend is an OTBApplication.
``` ```
This is the TimeSeriesIndexTrend (TimeSeriesIndexTrend) application, version 6.2.0 This is the TimeSeriesIndexTrend (TimeSeriesIndexTrend) application, version 6.4.0
Compute the trend of the vegetation index time series Compute the trend of the vegetation index time series
Parameters: Parameters:
-progress <boolean> Report progress
-help <string list> Display long help (empty list), or help for given parameters keys
MISSING -ndvits <string list> Input NDVI time series images (mandatory) MISSING -ndvits <string list> Input NDVI time series images (mandatory)
MISSING -ndvidates <string> Input NDVI time series dates ASCII file (Must be YYYYMMDD format) (mandatory) MISSING -ndvidates <string> Input NDVI time series dates ASCII file (Must be YYYYMMDD format) (mandatory)
MISSING -rainfts <string list> Input rainfall time series images (mandatory) -rainfts <string list> Input rainfall time series images (optional, off by default)
MISSING -rainfdates <string> Input rainfall time series dates ASCII file (Must be YYYYMMDD format) (mandatory) -rainfdates <string> Input rainfall time series dates ASCII file (Must be YYYYMMDD format) (optional, off by default)
-ndvi <group> NDVI Time series
-ndvi.reduce <string> Method to reduce time series [cumul/max/amplitude] (mandatory, default value is cumul) -ndvi.reduce <string> Method to reduce time series [cumul/max/amplitude] (mandatory, default value is cumul)
-ndvi.reduce.cumul.day1 <int32> Day 1 (mandatory, default value is 1) -ndvi.reduce.cumul.day1 <int32> Day 1 (mandatory, default value is 1)
-ndvi.reduce.cumul.day2 <int32> Day 2 (mandatory, default value is 31) -ndvi.reduce.cumul.day2 <int32> Day 2 (mandatory, default value is 31)
...@@ -45,19 +44,30 @@ MISSING -rainfdates <string> Input rainfall time series da ...@@ -45,19 +44,30 @@ MISSING -rainfdates <string> Input rainfall time series da
-ndvi.reduce.cumul.month2 <int32> Month 2 (mandatory, default value is 10) -ndvi.reduce.cumul.month2 <int32> Month 2 (mandatory, default value is 10)
-ndvitrend <string> [pixel] Output image for NDVI trend (Contains [slope, pvalue, correlation]) [pixel=uint8/uint16/int16/uint32/int32/float/double] (default value is float) (optional, off by default) -ndvitrend <string> [pixel] Output image for NDVI trend (Contains [slope, pvalue, correlation]) [pixel=uint8/uint16/int16/uint32/int32/float/double] (default value is float) (optional, off by default)
-ndvilabel <string> [pixel] Output image for NDVI label [pixel=uint8/uint16/int16/uint32/int32/float/double] (default value is uint8) (optional, off by default) -ndvilabel <string> [pixel] Output image for NDVI label [pixel=uint8/uint16/int16/uint32/int32/float/double] (default value is uint8) (optional, off by default)
-rain <group> Rainfall Time series
-rain.reduce <string> Method to reduce time series [cumul] (mandatory, default value is cumul) -rain.reduce <string> Method to reduce time series [cumul] (mandatory, default value is cumul)
-rain.reduce.cumul.day1 <int32> Day 1 (mandatory, default value is 1) -rain.reduce.cumul.day1 <int32> Day 1 (optional, on by default, default value is 1)
-rain.reduce.cumul.day2 <int32> Day 2 (mandatory, default value is 31) -rain.reduce.cumul.day2 <int32> Day 2 (optional, on by default, default value is 31)
-rain.reduce.cumul.month1 <int32> Month 1 (mandatory, default value is 6) -rain.reduce.cumul.month1 <int32> Month 1 (optional, on by default, default value is 6)
-rain.reduce.cumul.month2 <int32> Month 2 (mandatory, default value is 10) -rain.reduce.cumul.month2 <int32> Month 2 (optional, on by default, default value is 10)
-residues <string> [pixel] Output image for NDVI residues [pixel=uint8/uint16/int16/uint32/int32/float/double] (default value is float) (optional, off by default) -residues <string> [pixel] Output image for NDVI residues [pixel=uint8/uint16/int16/uint32/int32/float/double] (default value is float) (optional, off by default)
-restrend <string> [pixel] Output image for NDVI residues trend [pixel=uint8/uint16/int16/uint32/int32/float/double] (default value is float) (optional, off by default) -restrend <string> [pixel] Output image for NDVI residues trend [pixel=uint8/uint16/int16/uint32/int32/float/double] (default value is float) (optional, off by default)
-reslabel <string> [pixel] Output image for NDVI residues trend labels [pixel=uint8/uint16/int16/uint32/int32/float/double] (default value is uint8) (optional, off by default) -reslabel <string> [pixel] Output image for NDVI residues trend labels [pixel=uint8/uint16/int16/uint32/int32/float/double] (default value is uint8) (optional, off by default)
MISSING -factorslabel <string> [pixel] Output image for factors labels [pixel=uint8/uint16/int16/uint32/int32/float/double] (default value is uint8) (mandatory) -factorslabel <string> [pixel] Output image for factors labels [pixel=uint8/uint16/int16/uint32/int32/float/double] (default value is uint8) (optional, off by default)
-ndvicumul <string> [pixel] Output image for ndvi year cumul [pixel=uint8/uint16/int16/uint32/int32/float/double] (default value is float) (optional, off by default)
-rainfcumul <string> [pixel] Output image for rainfall year cumul [pixel=uint8/uint16/int16/uint32/int32/float/double] (default value is float) (optional, off by default)
-pearsoncoef <string> [pixel] Output image for pearson coef [pixel=uint8/uint16/int16/uint32/int32/float/double] (default value is float) (optional, off by default)
-ram <int32> Available RAM (Mb) (optional, off by default, default value is 128) -ram <int32> Available RAM (Mb) (optional, off by default, default value is 128)
-inxml <string> Load otb application from xml file (optional, off by default) -inxml <string> Load otb application from xml file (optional, off by default)
-progress <boolean> Report progress
-help <string list> Display long help (empty list), or help for given parameters keys
Use -help param1 [... paramN] to see detailed documentation of those parameters. Use -help param1 [... paramN] to see detailed documentation of those parameters.
Examples:
None
``` ```
TimeSeriesIndexTrend can be used as any OTB application (gui, command line, python, c++, ...). TimeSeriesIndexTrend can be used as any OTB application (gui, command line, python, c++, ...).
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment