runMrt.Rd 3.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687
  1. % Generated by roxygen2: do not edit by hand
  2. % Please edit documentation in R/runMrt.R
  3. \name{runMrt}
  4. \alias{runMrt}
  5. \title{Run MODIS Reprojection Tool with Specified Parameters}
  6. \source{
  7. You can obtain MRT-grid after registration from:
  8. \url{https://lpdaac.usgs.gov/tools/modis_reprojection_tool}.
  9. }
  10. \usage{
  11. runMrt(...)
  12. }
  13. \arguments{
  14. \item{...}{See Details.}
  15. }
  16. \description{
  17. Specifying input parameters, this function gets MODIS grid data from the
  18. archive (HTTP/FTP or local) and processes them with the 'MRT-grid' tool. See
  19. also the 'MRT' manual, available online via
  20. \url{https://lpdaac.usgs.gov/sites/default/files/public/mrt41_usermanual_032811.pdf},
  21. for further information.
  22. }
  23. \details{
  24. \describe{
  25. \tabular{rll}{
  26. \tab \code{product}\tab See \code{\link{getProduct}}.\cr
  27. \tab \code{begin}\tab See \code{\link{transDate}}.\cr
  28. \tab \code{end}\tab See \code{\link{transDate}}.\cr
  29. \tab \code{extent}\tab See \code{\link{getTile}}.\cr
  30. \tab \code{SDSstring}\tab See \code{\link{getSds}}. Default is to extract all
  31. SDS.\cr
  32. \tab \code{job}\tab \code{character}. Name of the current job for the
  33. creation of the output folder. If not specified, it is created in
  34. 'PRODUCT.COLLECTION_DATETIME'\cr
  35. \tab \code{localArcPath}\tab \code{character}. Defaults to
  36. \code{options("MODIS_localArcPath")}. Local path to look for and/or download
  37. MODIS files.\cr
  38. \tab \code{outDirPath}\tab \code{character}. Defaults to
  39. \code{options("MODIS_outDirPath")}. Root directory where to write \code{job}
  40. folder.\cr
  41. \tab \code{dataType}\tab \code{character}, defaults to \code{'GeoTiff'} (see
  42. \code{\link{MODISoptions}}. 'MRT' supports: \code{"raw binary"} (hdr+dat),
  43. \code{"HDF-EOS"} (hdf), and \code{"GeoTiff"} (tif). Any other format
  44. specified through \code{\link{MODISoptions}} or \code{dataType}, is switched
  45. to 'GeoTiff'.\cr
  46. \tab \code{outProj}\tab \code{character}, see 'MRT' manual.\cr
  47. \tab \code{zone}\tab Optional UTM zone number when \code{outProj = "UTM"}. If
  48. not set, it is autodetected. See 'MRT' manual.\cr
  49. \tab \code{projPara}\tab \code{character} in the form "6371007.18 0.00 0.00
  50. ...". For \code{outProj \%in\% c("GEO","SIN")}, it is autodetected. See 'MRT'
  51. manual.\cr
  52. \tab \code{datum}\tab \code{character}, defaults to 'NODATUM'. See 'MRT'
  53. manual.\cr
  54. \tab \code{mosaic}\tab \code{logical}, defaults to \code{TRUE}. Mosaic files
  55. or not? One case for setting \code{mosaic=FALSE} is a too large \code{extent}.
  56. HDF4 file supports max 2GB filesize, if crossed mosaicing process will fail.\cr
  57. \tab \code{anonym}\tab \code{logical}, defaults to \code{TRUE}. If
  58. \code{FALSE}, the job name is added at the end of the root filename.\cr
  59. \tab \code{quiet}\tab \code{logical}, defaults to \code{FALSE}. It is up to
  60. you to switch to 'boring' alias \code{FALSE}. Not fully implemented!\cr
  61. \tab \code{dlmethod}\tab default \code{options("MODIS_dlmethod")}. Argument
  62. passed to \code{\link{download.file}} (see \code{\link{MODISoptions}}).\cr
  63. \tab \code{stubbornness}\tab Default is \code{options("MODIS_stubborness")}. See \code{?MODISoptions}\cr
  64. }
  65. }
  66. }
  67. \examples{
  68. \dontrun{
  69. runMrt( product="MOD11A1", extent="austria", begin="2010001", end="2010002", SDSstring="101",
  70. job="ExampleGEOdelme", outProj="GEO")
  71. runMrt( product="MOD11A1", extent="austria", begin="2010001", end="2010002", SDSstring="101",
  72. job="ExampleSINdelme", outProj="SIN")
  73. runMrt( product="MOD11A1", extent="austria", begin="2010001", end="2010002", SDSstring="101",
  74. job="ExampleUTMdelme", outProj="UTM")
  75. }
  76. }
  77. \seealso{
  78. \code{\link{getHdf}}.
  79. }
  80. \author{
  81. Matteo Mattiuzzi and Forrest Stevens
  82. }