R/inside.reg.bc.R

In geo: Draw and Annotate Maps, Especially Charts of the North Atlantic

#' Determine which bormicon (or gadget) region data belong to.
#' 
#' Determine which bormicon (or approximately gadget) region data belong to.
#' 
#' 
#' @param data Data set with coordinates in components \code{lat, lon}.
#' @param only.sv.1to10 Label only data belonging to areas 1 to 10 (depth < 500
#' m). Default FALSE
#' @param ignore.latlon Use rectangle resolution ???
#' @param ignore.area0 Action for data not belonging to bc-areas, not used???
#' @return Returns original data with area code as an added component
#' \code{area}.
#' @note Needs elaboration, esp. when based on rectangles, merge doc with
#' inside.reg.bc1.
#' @seealso Calls \code{\link{inside.reg.bc1}},
#' \code{\link{Reitur2Svaedi1to10}}, \code{\link{sr2d}}. Data set
#' \code{\link{reg.bc}} with bormicon-area outlines is used.
#' @keywords manip
#' @export inside.reg.bc
inside.reg.bc <-
function(data, only.sv.1to10 = F, ignore.latlon = F, ignore.area0 = T)
{
        if(is.na(match("lat", names(data)))) {
                data$lat <- data$lon <- rep(NA, nrow(data))
        }
        if(!is.na(match("area", names(data)))) {
                print("warning column area exists")
                return(invisible(data))
        }
        n <- nrow(data)
        data$area <- rep(NA, nrow(data))
        index <- !is.na(data$lat) & !is.na(data$lon)
        index1 <- c(1:length(index))
        index1 <- index1[index]
        if(ignore.latlon)
                index1 <- NULL
        if(length(index1) > 0) {
                area <- inside.reg.bc1(data[index1, c("lat", "lon")])$area
                data$area[index1] <- area
        }
        if(is.na(match("reitur", names(data))))
                return(data)
        if(ignore.latlon)
                index1 <- c(1:nrow(data))
        else {
                index <- (is.na(data$lat) | is.na(data$lon)) & !is.na(data$
                        reitur)
                if(ignore.area0)
                        index <- index | (data$area == 0 & !is.na(data$area))
                index1 <- c(1:length(index))
                index1 <- index1[index]
        }
        if(length(index1) > 0) {
                reitdata <- data[index1,  ]
                if(only.sv.1to10) {
                        reitdata$area <- Reitur2Svaedi1to10(reitdata$reitur)
                }
                else {
                        if(is.na(match("smareitur", names(reitdata))))
                                reitdata$smareitur <- rep(0, nrow(reitdata))
                        else reitdata$smareitur[is.na(reitdata$smareitur)] <-
                                        0
                        tmp <- data.frame(sr2d(reitdata$reitur * 10 + reitdata$
                                smareitur))
                        ind <- c(1:nrow(tmp))
                        ind <- ind[!is.na(tmp$lat)]
                        reitdata$area[ind] <- inside.reg.bc1(tmp[ind,  ])$
                                area
                }
                data$area[index1] <- reitdata$area
        }
        return(data)
}