R/mkMCSST.R

In mdsumner/mdsutils: Miscellaneous tools for sumnerd.

#' ~~function to do ... ~~
#' 
#' ~~ A concise (1-5 lines) description of what the function does. ~~
#' 
#' ~~ If necessary, more details than the description above ~~
#' 
#' @return ~Describe the value returned If it is a LIST, use
#' 
#' ...
#' @returnItem comp1 Description of 'comp1'
#' @returnItem comp2 Description of 'comp2'
#' @note ~~further notes~~
#' @author ~~who you are~~
#' @seealso ~~objects to See Also as \code{\link{help}}, ~~~
#' @references ~put references to the literature/web site here ~
#' @keywords ~kwd1 ~kwd2
#' @examples
#' 
#' ##---- Should be DIRECTLY executable !! ----
#' ##-- ==>  Define data, use random,
#' ##--	or do  help(data=index)  for the standard data sets.
#' 
#' ## The function is currently defined as
#' function() {
#' 
#' 	cdim <- c(2048, 1024)
#' 	csize <- c(360, 180)/cdim
#' 	cc.offset <- c(0, -90) + csize/2
#' 	gt <- GridTopology(cc.offset, csize, cdim)
#' 	sclEquation <- function(x) {
#' 		Slope <- 0.15
#' 		Intercept <- -2.1
#' 		x * Slope  + Intercept
#' 	}
#' 	Validrange <- c(-1.8, 35)
#' 	
#' 	bands <- c("mcsst", "interpolated", "count")
#' 	scaledData <- bands[1:2]
#' 	sdsTemplate <- c("HDF4_GR:UNKNOWN:\"", "\":")
#' 	timeTemplate <- "sn%Y%j"
#' 	p4 <- CRS("+proj=longlat +datum=WGS84 +over")
#' 	bandNumbers <- seq(0, by = 1, length = length(bands))
#' 	list(grid = gt, sclEquation = sclEquation, Validrange = Validrange,
#' 		bands = bands, sdsTemplate = sdsTemplate, timeTemplate = timeTemplate, 
#' 		scaledData = scaledData, p4 = p4, bandNumbers = bandNumbers, upside.down = FALSE)
#' 	
#'   }
#' 
`mkMCSST` <-
function() {

	cdim <- c(2048, 1024)
	csize <- c(360, 180)/cdim
	cc.offset <- c(0, -90) + csize/2
	gt <- GridTopology(cc.offset, csize, cdim)
	sclEquation <- function(x) {
		Slope <- 0.15
		Intercept <- -2.1
		x * Slope  + Intercept
	}
	Validrange <- c(-1.8, 35)
	
	bands <- c("mcsst", "interpolated", "count")
	scaledData <- bands[1:2]
	sdsTemplate <- c("HDF4_GR:UNKNOWN:\"", "\":")
	timeTemplate <- "sn%Y%j"
	p4 <- CRS("+proj=longlat +datum=WGS84 +over")
	bandNumbers <- seq(0, by = 1, length = length(bands))
	list(grid = gt, sclEquation = sclEquation, Validrange = Validrange,
		bands = bands, sdsTemplate = sdsTemplate, timeTemplate = timeTemplate, 
		scaledData = scaledData, p4 = p4, bandNumbers = bandNumbers, upside.down = FALSE)
	
}