earthexplorer_search: earthexplorer_search

In espa.tools: Wrappers for the USGS ESPA APIs and Earth Explorer

Description

Searches and orders from Earth Explorer.

Usage

earthexplorer_search(usgs_eros_username, usgs_eros_password, datasetName,
  lowerLeft = NULL, upperRight = NULL, startDate = "1920-01-07",
  endDate = as.character(Sys.Date()), months = "",
  includeUnknownCloudCover = T, minCloudCover = 0, maxCloudCover = 100,
  additionalCriteria = "", sp = NULL, place_order = F, products = "sr",
  format = "gtiff", verbose = F)

Arguments

usgs_eros_username	Character. Your USGS registration username. You can register for an account at https://espa.cr.usgs.gov
usgs_eros_password	Character. Your USGS registration password. WARNING: USING THIS WITH R IS NOT PARTICULARLY SECURE.
datasetName	Character. Used as a filter with wildcards inserted at the beginning and the end of the supplied value. See https://mapbox.github.io/usgs/reference/catalog/hdds.html for a list of valid datasetNames. See Details for additional info.
lowerLeft	List. When used in conjunction with upperRight, creates a bounding box to search spatially. Should be a list of form list(latitude=XX,longitude=XX)
upperRight	List. When used in conjunction with lowerLeft, creates a bounding box to search spatially. Should be a list of form list(latitude=XX,longitude=XX)
startDate	Character. Used to search datasets temporally for possible dataset coverage. ISO 8601 Formatted Date. Time portion is ignored. Default is "1920-01-01".
endDate	Character. Used to search datasets temporally for possible dataset coverage. ISO 8601 Formatted Date. Time portion is ignored.Default is today's date.
months	Numeric. Used to limit results to specific months.
includeUnknownCloudCover	Logical. Used to determine if scenes with unknown cloud cover values should be included in the results. Default is TRUE.
minCloudCover	Numeric. Used to limit results by minimum cloud cover (for supported datasets). Range 0 to 100. Default is 0.
maxCloudCover	Numeric. Used to limit results by maximum cloud cover (for supported datasets). Range 0 to 100. Default is 100.
additionalCriteria	List. Used to filter results based on dataset specific metadata fields. Use datasetFields request to determine available fields and options.
sp	SpatialPolygons. Used to refine the search results based on a polygon rather than a bounding box.
place_order	Logical. If T, the search will be ordered. Usually you want to search and refine first before ordering. Default is F.
products	Character. A vector of products to be ordered. Default is "sr" (surface reflectance).
format	Character. The output file format for an order. Default is "gtiff".
verbose	Logical. Verbose execution? Default=F.

Details

This is meant to be a fully functional command line interface to searching and (optionally) ordering products from Earth Explorer.

We have added some custom datasetNames to make searching a bit easier. If datasetName="LANDSAT_4578", the search will include Landsat 4 TM, Landsat 5 TM, Landset 7 ETM+, and Landsat 8 OLI. This is a good if you want to order a long time series of surface reflectance products. Set products="sr" in that case.

Value

List of search results.

Author(s)

Jonathan A. Greenberg ([e-mail]) (wrapper) and USGS ESPA Developers (API and documentation)

References

https://earthexplorer.usgs.gov

See Also

espa_inventory_search,espa_ordering_order

Examples

## Not run:  
# Search only:
earthexplorer_search(
	usgs_eros_username="myusername",usgs_eros_password="mypassword",
	datasetName="GLS2005",
		"lowerLeft"=list(latitude=75,longitude=-135),
		"upperRight"=list(latitude=90,longitude=-120),
		startDate="2006-01-01",endDate="2007-12-01",
	includeUnknownCloudCover=TRUE,minCloudCover=0,maxCloudCover=100,
	place_order = F,
	verbose=TRUE)

# Search and order:
earthexplorer_search(
	usgs_eros_username="myusername",usgs_eros_password="mypassword",
	datasetName="GLS2005",
		"lowerLeft"=list(latitude=75,longitude=-135),
		"upperRight"=list(latitude=90,longitude=-120),
		startDate="2006-01-01",endDate="2007-12-01",
	includeUnknownCloudCover=TRUE,minCloudCover=0,maxCloudCover=100,
	place_order = T,
		products="sr",
		format="gtiff",
	verbose=TRUE)

## End(Not run)

espa.tools documentation built on May 2, 2019, 5:54 p.m.