R/landsat.bands.r

Defines functions ETM_bands TIRS_bands OLI_bands MSS_bands RBV_bands Landsat_bands

Documented in ETM_bands Landsat_bands MSS_bands OLI_bands RBV_bands TIRS_bands

#' Constructor of lists of wavebands matching Landsat imagers
#'
#' Defined according as ranges of wavelengths according to NASA and USGS
#' manuals.
#'
#' @param std a character string "L1"..."L8", for missions, "LandsarRBV",
#'   "LandsatMSS", etc. for imagers.
#'
#' @return a list of wavebands
#' @export
#'
#' @seealso \code{\link[photobiology]{waveband}}
#'
#' @examples
#' Landsat_bands("L1")
#' Landsat_bands("L8")
#' OLI_bands()
#' TIRS_bands()
#'
#' @family lists of unweighted wavebands
#'
Landsat_bands <- function(std = "L8") {
  if (! std %in% c("L1", "L2", "L3", "L4", "L5", "L6", "L7", "L8")) {
    warning("'std' = '", std, "' not implemented.")
    list()
  } else {
    suppressWarnings(
      c(RBV_bands(std),
        MSS_bands(std),
        ETM_bands(std),
        OLI_bands(std),
        TIRS_bands(std))
    )
  }
}

#' @rdname Landsat_bands
#'
#' @export
#'
RBV_bands <- function(std = "LandsatRBV") {
  if (std %in% c("L1", "L2")) {
    std = "LandsatRBV"
  }
  if (std == "LandsatRBV") {
    list(Green(std), Red(std), NIR(std))
  } else if (std == "L3") {
    list(VIS("LandsatRBV"))
  } else {
    warning("'std' = '", std, "' not implemented.")
    list()
  }
}

#' @rdname Landsat_bands
#'
#' @export
#'
MSS_bands <- function(std = "LandsatMSS") {
  if (std %in% c("L1", "L2", "L3", "L4", "L5")) {
    std = "LandsatMSS"
  }
  if (std == "LandsatMSS") {
    list(Green(std), Red(std), NIR(std))
  } else {
    warning("'std' = '", std, "' not implemented.")
    list()
  }
}

#' @rdname Landsat_bands
#'
#' @export
#'
OLI_bands <- function(std = "LandsatOLI") {
  if (std == "L8") {
    std <- "LandsatOLI"
  }
  if (std == "LandsatOLI") {
    list(Purple(std), Blue(std), Green(std), Red(std),
         NIR(std), SWIR1(std), SWIR2(std))
  } else {
    warning("'std' = '", std, "' not implemented.")
    list()
  }
}

#' @rdname Landsat_bands
#'
#' @export
#'
TIRS_bands <- function(std = "LandsatTIRS") {
  if (std == "L8") {
    std <- "LandsatTIRS"
  }
  if (std == "LandsatTIRS") {
    list(TIR1(std), TIR2(std))
  } else {
    warning("'std' = '", std, "' not implemented.")
    list()
  }
}

#' @rdname Landsat_bands
#'
#' @export
#'
ETM_bands <- function(std = "LandsatETM") {
  if (std %in% c("L4", "L5")) {
    std <- "LandsatTM"
  } else if (std %in% c("L6", "L7")) {
    std <- "LandsatETM"
  }

  if (std %in% c("LandsatTM", "LandsatETM")) {
    list(Blue(std), Green(std), Red(std), NIR(std), SWIR1(std), SWIR2(std))
  } else {
    warning("'std' = '", std, "' not implemented.")
    list()
  }
}

Try the photobiologyWavebands package in your browser

Any scripts or data that you put into this service are public.

photobiologyWavebands documentation built on May 29, 2017, 12:03 p.m.