getSds.Rd 1.1 KB

12345678910111213141516171819202122232425262728293031323334353637383940
  1. % Generated by roxygen2: do not edit by hand
  2. % Please edit documentation in R/getSds.R
  3. \name{getSds}
  4. \alias{getSds}
  5. \title{List SDS Layers in an .HDF File}
  6. \usage{
  7. getSds(HdfName, SDSstring = NULL, method = "gdal")
  8. }
  9. \arguments{
  10. \item{HdfName}{\code{character}. (Absolute) filename from which to extract
  11. SDS names.}
  12. \item{SDSstring}{\code{character}, see Value.}
  13. \item{method}{\code{character}, defaults to \code{"gdal"}. Caution: on
  14. Windows, the default 'GDAL' installation doesn't support HDF4 files. Install
  15. 'FWTools' or use \code{method = "mrt"} instead.}
  16. }
  17. \value{
  18. A \code{list} or \code{character}. If \code{SDSstring} is provided, the
  19. function reports extracted SDS and a formatted SDSsting (e.g., "11101"). If
  20. not provided, the SDS names in \code{HdfName} are returned. Consult the MRT
  21. manual for details.
  22. }
  23. \description{
  24. This function lists the names of all scientific datasets (SDS) contained in a
  25. specified MODIS grid HDF file.
  26. }
  27. \examples{
  28. \dontrun{
  29. getSds(HdfName="XXX.hdf")
  30. getSds(HdfName="/path/XXX.hdf",method="gdal") # require GDAL (FWTools on Windows)
  31. getSds(HdfName="/path/XXX.hdf",method="mrt") # require MRTool
  32. }
  33. }
  34. \author{
  35. Matteo Mattiuzzi
  36. }