R/Landsat.R

In RETURN-project/makeDataCube: Prepare raster datasets for upscaling recovery indicators

#' Download Landsat scenes. Several criteria can be set to select scenes of interest: the extent of the study area,
#' the time period of interest, the preferred sensors, tiers and maximum cloud percentage.
#' Only scenes are downloaded that are not in the queue file yet. After download to a temporary folder, these scenes
#'  are compressed to a .tar.gz file, added to the the queue file and the level1 folder.
#'  Finally, the original downloaded files are removed from the temporary folder.
#'
#' @param l1folder level 1 folder
#' @param queuefolder queue folder
#' @param queuefile queue file
#' @param tmpfolder folder with temporary data
#' @param logfile file for logs
#' @param ext extent of the study area of interest, this should be given as a vector containing - in order - xmin, xmax, ymin, ymax in degrees
#' @param starttime start date (given as a vector with year, month, day)
#' @param endtime end date (given as a vector with year, month, day)
#' @param sensors sensors of interest, can be LC08, LE07, LT05, LT04, LM05, LM04
#' @param tiers tiers of interest, T1 and T2 represent Tier 1 and 2, respectively
#' @param cld maximum cloud percentage
#'
#' @return adds Landsat data to Level 1 folder
#' @export
#' @import reticulate
#'
dllLS <- function(l1folder, queuefolder, queuefile, tmpfolder, logfile, ext, starttime, endtime, sensors, tiers, cld){
  # Sync the catalog
  system("pylandsat sync-database") # system("pylandsat sync-database -f")
  # Download tiles that are not in the queue yet
  source_python(system.file("python", "dllLandsat.py", package = "makeDataCube"))
  dllInfo <- dllLandsat(queuefolder, queuefile, tmpfolder, logfile, ext, starttime, endtime, sensors, tiers, cld)
  scenes <- dllInfo[[1]]

  # compress data to .tar.gz file
  for(i in 1:length(scenes)){
    systemf("tar -zcvf %s -C %s .",
            file.path(tmpfolder, paste0(scenes[i],'.tar.gz')),
            file.path(tmpfolder, scenes[i]))
  }

  # add scenes to queue
  systemf("force-level1-landsat %s %s %s mv",
          tmpfolder, file.path(l1folder,'landsat'), file.path(queuefolder,'queue.txt'))

  # remove temporary files and folders
  systemf("rm %s", file.path(tmpfolder,"*.tar.gz"))
  systemf("rm -rd %s", file.path(tmpfolder,"L*"))
  systemf("rm -rd %s", file.path(tmpfolder,"index.csv"))

  return(scenes)
}

#' Process Landsat level 1 data to level 2, generate a vrt
#'
#' @param paramfolder path to the directory with the parameter file
#' @param paramfile name of the parameter file
#' @param l2folder path to the level 2 folder
#' @param dry.run Set to TRUE to just return the command lines (useful for testing and debugging)
#'
#' @return processes level 1 landsat scenes
#' @export
process2L2 <- function(paramfolder, paramfile, l2folder, dry.run = FALSE) {
  # System commands list (useful for debugging and testing)
  cmds <- list()

  # Process data
  cmds[1] <- systemf("force-level2 %s", file.path(paramfolder, paramfile), dry.run = dry.run)
  # Generate vrt
  cmds[2] <- systemf("force-mosaic %s", l2folder, dry.run = dry.run)

  if(dry.run) return(cmds)

  # summarize log files of all scenes
  # LSscenes <- paste0(LSscenes, '.tar.gz.log')
  # checkLSlog(LSscenes, logfolder, Sskiplogfile, Ssuccesslogfile, Smissionlogfile, Sotherlogfile)
}