R/unitConversion.R

In DVHmetrics: Analyze Dose-Volume Histograms and Check Constraints

## conversion of dose and volume units
getConvFac <-
function(conversion="CGY2GY") {
    conversion <- toupper(removeWS(conversion))

    ## check how the conversion factor is indicated
    idxCGY2GY  <- conversion == c("CGY2GY")
    idxCGY2EVG <- conversion == c("CGY2EV/G")

    idxGY2CGY  <- conversion == c("GY2CGY")
    idxGY2EVG  <- conversion == c("GY2EV/G")

    idxEVG2CGY <- conversion == c("EV/G2CGY")
    idxEVG2GY  <- conversion == c("EV/G2GY")

    idxCGY2CGY <- conversion == c("CGY2CGY")
    idxGY2GY   <- conversion == c("GY2GY")
    idxEVG2EVG <- conversion == c("EV/G2EV/G")

    idxCC2CC   <- conversion == c("CC2CC")

    ## did we catch all requested conversion types?
    idxAll <- idxCGY2GY  | idxCGY2EVG |
              idxGY2CGY  | idxGY2EVG  |
              idxEVG2CGY | idxEVG2GY  |
              idxCGY2CGY | idxGY2GY   | idxEVG2EVG | idxCC2CC

    if(!all(idxAll)) {
        warning(c('Conversion type(s) "', paste(conversion[!idxAll], collapse=", "),
                  '" not found - conversion factor set to NA'))
    }

    convFac <- rep(NA_real_, length(conversion))

    ## conversion factors for dose units
    convFac[idxCGY2GY]  <- 1/100
    convFac[idxCGY2EVG] <- NA_real_

    convFac[idxGY2CGY]  <- 100
    convFac[idxGY2EVG]  <- NA_real_

    convFac[idxEVG2CGY] <- NA_real_
    convFac[idxEVG2GY]  <- NA_real_

    convFac[idxCGY2CGY] <- 1
    convFac[idxGY2GY]   <- 1
    convFac[idxEVG2EVG] <- 1

    convFac[idxCC2CC]   <- 1

    return(convFac)
}

## determine unit from conversion string
getUnits <-
function(x="CGY2GY", first=TRUE) {
    if(!is.character(x)) {
        warning("Unit not recognized - input must have form like CGY2GY")
        return(" ")
    }

    units    <- strsplit(x, "2")         # first and second part of string
    unitLens <- sapply(units, length)    # count parts
    if(!all(unitLens == 2)) {            # check that there are two parts
        warning("Unit not recognized - input must have form like CGY2GY")
        return(NA_character_)
    }

    knownUnits <- c("CGY", "GY", "EV/G", "CC")
    isKnown    <- sapply(units, function(x) { all(x %in% knownUnits) })
    if(!all(isKnown)) {
        warning(c("Unit not recognized - needs to be one of\n",
                  paste(knownUnits, collapse=" ")))
        return("")
    }

    if(first) {
        sapply(units, head, n=1)
    } else {
        sapply(units, tail, n=1)
    }
}