Skip to content

Commit

Permalink
changed function in api
Browse files Browse the repository at this point in the history
  • Loading branch information
jdbcode committed Oct 22, 2018
1 parent cdb740e commit a22fad3
Show file tree
Hide file tree
Showing 25 changed files with 1,154 additions and 345 deletions.
2 changes: 1 addition & 1 deletion bookdown/01-introduction.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
**This guide is intended to introduce the basics of running LandTrendr (LT) in Google Earth Engine (GEE).
It describes the LT conceptual framework, what is required to run LT-GEE, how to run it,
what the outputs are, and how they are formatted. It also provides three example scripts,
a series of user interfaces to the LT operations, and a shortcut JavaScript library.**
a series of user interfaces to LT operations, and an API for opinionated, but easy use.**

LandTrendr is set of spectral-temporal segmentation algorithms that are useful
for change detection in a time series of moderate resolution satellite imagery (primarily Landsat)
Expand Down
2 changes: 1 addition & 1 deletion bookdown/03-requirements.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ In the [example scripts](https://emapr.github.io/LT-GEE/example-scripts.html) pr
<a id='importantsteps'></a>**Two really important steps** in image collection building include 1) masking cloud and cloud shadow pixels during annual image compositing and to 2) ensure that the spectral band or index that is
to be segmented is oriented so that vegetation loss is represented by a positive delta. For instance, NBR in its native orientation results in a negative delta when vegetation is lost from one observation to the next. In this case, NBR must be multiplied by -1 before being segmented. Conversely, if Landsat TM band 5 (SWIR) is selected for segmentation, inversion of the spectral values is not required, since natively, vegetation loss is represented by a positive delta.

Note that we provide a couple of shortcut functions to build annual Landsat surface reflectance collections and convert them to a collections formatted for use by LandTrendr. See the `buildSRcollection` and `buildLTcollection` functions in the [Shortcut Functions](./shortcut-functions.html#functions) section.
Note that within the API we provide functions to build annual Landsat surface reflectance collections and convert them to collections formatted for use by LandTrendr. See the `buildSRcollection` and `buildLTcollection` functions in the [API Functions](./api.html#functions) section.

## LT parameters

Expand Down
2 changes: 1 addition & 1 deletion bookdown/04-running.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ LT-GEE is run using the function: `ee.Algorithms.TemporalSegmentation.LandTrendr

In its most most basic form, running LandTrendr in Google Earth Engine requires 6 steps. The following code snippets help illustrate the steps.

*The following snippets are only a demonstration aid. In application, use the provided code [examples](./example-scripts.html) to learn and build from, and take advantage of the [shortcut functions](./shortcut-functions.html) we've put together to build collections and run LandTrendr*
*The following snippets are only a demonstration aid. In application, use the provided code [examples](./example-scripts.html) to learn and build from, and take advantage of the [API functions](./api.html) we've put together to build collections and run LandTrendr*

1. Define starting and ending years of the times series

Expand Down
2 changes: 1 addition & 1 deletion bookdown/06-outputs-handling.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ specifically, this section will walk through:
4. Apply a minimum mapping unit filter to identified disturbance pixels to reduce spatial noise
5. Convert a fitted (FTV) band from an image array to an image with a band per year in the time series

Note that the following code snippets are intended to be a template for learning and building on. We also provide shortcut functions to perform these operations in the [Shortcut Functions](./shortcut-functions.html) section, which greatly simplify these steps.
Note that the following code snippets are intended to be a template for learning and building on. We also provide shortcut functions to perform these operations in the [API Functions](./api.html) section, which greatly simplify these steps.

## Getting segment information

Expand Down
2 changes: 1 addition & 1 deletion bookdown/07-example-scripts.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

Three use case examples are provided, each of them begins with the same process of parameter definition and collection building and then varies on what is done with the results from the LT-GEE call. Keep in mind that these are simple building blocks to learn from. The parameter settings, methods for building collections, and the way we handle outputs in these examples are not intended to be standard protocol. We hope that the GEE community will help us develop better scripts and push what we can learn about our dynamic Earth using the LT-GEE tool.

Note that the majority of the lines included in these scripts for collection building and manipulating outputs can be reduced to a single shortcut function - see them [here](./shortcut-functions.html).
Note that the majority of the lines included in these scripts for collection building and manipulating outputs can be reduced to a single shortcut function - see them [here](./api.html#functions).

## Exploration and parameterization

Expand Down
Loading

0 comments on commit a22fad3

Please sign in to comment.