MODIS/man/runGdal.Rd

% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/runGdal.R
\name{runGdal}
\alias{runGdal}
\title{Process MODIS HDF with GDAL}
\usage{
runGdal(product, collection = NULL, begin = NULL, end = NULL,
  extent = NULL, tileH = NULL, tileV = NULL, SDSstring = NULL,
  job = NULL, checkIntegrity = TRUE, forceDownload = TRUE,
  overwrite = FALSE, ...)
}
\arguments{
\item{product}{\code{character}, see \code{\link{getProduct}}.}

\item{collection}{\code{character} or \code{integer}, see 
\code{\link{getCollection}}.}

\item{begin}{\code{character}. Begin date of MODIS time series, see 
\code{\link{transDate}} for formatting.}

\item{end}{Same for end date.}

\item{extent}{Extent information, defaults to \code{'global'}. See
\code{\link{getTile}}.}

\item{tileH}{\code{numeric} or \code{character}. Horizontal tile number, 
see \code{\link{getTile}}.}

\item{tileV}{\code{numeric} or \code{character}. Vertical tile number(s), 
see \code{tileH}.}

\item{SDSstring}{\code{character}, see \code{\link{getSds}}.}

\item{job}{\code{character}. Name of the current job for the creation of the 
output folder. If not specified, it is created in 'PRODUCT.COLLECTION_DATETIME'.}

\item{checkIntegrity}{\code{logical}, see \code{\link{getHdf}}.}

\item{forceDownload}{\code{logical}, see \code{\link{getHdf}}.}

\item{overwrite}{\code{logical}, defaults to \code{FALSE}. Determines 
whether or not to overwrite existing SDS output files.}

\item{...}{Additional arguments passed to \code{MODIS:::combineOptions()} (eg
'wait'), see also \code{\link{MODISoptions}}.}
}
\value{
A \code{list} of the same length as 'product'. Each product slot holds a 
sub-\code{list} of processed dates which, for each time step, include the 
corresponding output files as \code{character} objects.
}
\description{
Downloads MODIS grid data from archive (FTP or local) and processes the 
files.
}
\details{
\describe{
\tabular{rll}{
  \tab \code{outProj}\tab CRS/ prj4 or EPSG code of output, any format supported by gdal see examples.\cr \tab \tab Default is 'asIn' (no warping). See \code{?MODISoptions}.\cr
  \tab \code{pixelSize}\tab Numeric single value. Output pixel size in target reference system unit.\cr \tab \tab Default is 'asIn'. See \code{?MODISoptions}.\cr
  \tab \code{resamplingType}\tab Character. Default is 'near', can be one of: 'bilinear', 'cubic', 'cubicspline', 'lanczos'.\cr \tab \tab See \code{?MODISoptions}.\cr
  \tab \code{blockSize}\tab integer. Default \code{NULL} that means the stripe size is set by GDAL.\cr \tab \tab Basically it is the "-co BLOCKYSIZE=" parameter. See: http://www.gdal.org/frmt_gtiff.html\cr
  \tab \code{compression}\tab logical. Default is \code{TRUE}, compress data with the lossless LZW compression with "predictor=2".\cr \tab \tab See: \url{http://www.gdal.org/frmt_gtiff.html}\cr
  \tab \code{dataFormat}\tab Data output format, see \code{getOption("MODIS_gdalOutDriver")} column 'name'.\cr
  \tab \code{localArcPath}\tab Character.  See \code{?MODISoptions}. Local path to look for and/or to download MODIS files.\cr
  \tab \code{outDirPath}\tab Character.  See \code{?MODISoptions}. Root directory where to write \code{job} folder.\cr
}
}

\code{\link{runGdal}} uses a lot of \strong{MODIS} package functions, see in 
section Arguments and Methods the respective '?function' for details and 
inputs.\cr
If \code{extent} is a \code{Raster*} object, the output has exactly the same 
extent, pixel size, and projection.\cr
If \code{extent} is a \strong{sp} object (i.e., polygon shapefile), the 
output has exactly the same extent and projection.\cr
If \code{tileH} and \code{tileV} are used (instead of \code{extent}) to 
define the area of interest, and \code{outProj} and \code{pixelSize} are 
\code{'asIn'}, the result is only converted from multilayer-HDF to 
\code{dataFormat}, default "GeoTiff" (\code{\link{MODISoptions}}).\cr
}
\note{
You need to have a GDAL installed on your system!\cr
\url{http://www.gdal.org/gdal_utilities.html}\cr\cr
On Unix-alkes, install 'gdal-bin' (i.e. Ubuntu: 'sudo apt-get install gdal-bin')\cr
On Windows, you need to install GDAL through OSGeo4W 
(\url{http://trac.osgeo.org/osgeo4w/}) or FWTools 
(\url{http://fwtools.maptools.org/}) since the standard GDAL does not support 
HDF4 format.
}
\examples{
\dontrun{
# LST in Austria
runGdal( product="MOD11A1", extent="austria", begin="2010001", end="2010005", SDSstring="101")

# LST with interactiv area selection
runGdal( product="MOD11A1", begin="2010001", end="2010005", SDSstring="101")

### outProj examples
# LST of Austria warped to UTM 34N (the three different possibilites to specify "outProj")
# to find am EPSG or prj4 you may use: prj <- make_EPSG() See  
runGdal( job="LSTaustria", product="MOD11A1", extent="Austria", begin="2010001", end="2010005",
         SDSstring="101", outProj="EPSG:32634")

runGdal( job="LSTaustria", product="MOD11A1", extent="Austria", begin="2010001", end="2010005",
         SDSstring="101", outProj="32634")

runGdal( job="LSTaustria", product="MOD11A1", extent="Austria", begin="2010001", end="2010005",
         SDSstring="101", outProj="+proj=utm +zone=34 +ellps=WGS84 +datum=WGS84 +units=m +no_defs")

### resamplingType examples
runGdal( job="LSTaustria", product="MOD11A1", extent="Austria", begin="2010001", end="2010005",
         SDSstring="1", resamplingType="lanczos", outProj="32634", pixelSize=100)

### processing entire tiles and keeping Sinusoidal projection
# This corresponds to a format conversion (eos-hdf04 to Geotiff) and 
# layer extraction (multi-layer to single layer)
runGdal( job="LSTaustria", product="MOD11A1", tileH=18:19,tileV=4, begin="2010001", end="2010005",
         SDSstring="1", outProj="asIn")

}

}
\seealso{
\code{\link{getHdf}}, \code{\link{runMrt}}.
}
\author{
Matteo Mattiuzzi, Florian Detsch
}