R/merge_rgbwt.R

In scattermore: Scatterplots with More Points

# This file is part of scattermore.
#
# Copyright (C) 2022 Mirek Kratochvil <exa.exa@gmail.com>
#               2022-2023 Tereza Kulichova <kulichova.t@gmail.com>
#
# scattermore is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# scattermore is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with scattermore. If not, see <https://www.gnu.org/licenses/>.

#' merge_rgbwt
#'
#' Merge RGBWT matrices.
#'
#' @param fRGBWT_list List of RGBWT arrays. The order of the matrices does not matter (except for negligible floating-point rounding and other robustness errors).
#'
#' @return Merged RGBWT matrix.
#'
#' @export
#' @useDynLib scattermore, .registration=TRUE

merge_rgbwt <- function(fRGBWT_list) {
  if (length(fRGBWT_list) < 1) stop("No input RGBWT given.")
  if (length(fRGBWT_list) == 1) {
    return(fRGBWT_list[[1]])
  }

  fRGBWT_1 <- fRGBWT_list[[1]]
  if (!is.array(fRGBWT_1) || dim(fRGBWT_1)[3] != 5) stop("not supported RGBWT format")

  for (i in 2:length(fRGBWT_list)) {
    fRGBWT_2 <- fRGBWT_list[[i]]

    if (!is.array(fRGBWT_2) || dim(fRGBWT_2)[3] != 5) stop("not supported RGBWT format")
    if ((dim(fRGBWT_1)[1] != dim(fRGBWT_2)[1]) || (dim(fRGBWT_1)[2] != dim(fRGBWT_2)[2])) stop("parameters do not have same dimensions")

    rows <- dim(fRGBWT_1)[1]
    cols <- dim(fRGBWT_1)[2]

    fRGBWT_1[, , 1:4] <- fRGBWT_1[, , 1:4] + fRGBWT_2[, , 1:4]
    fRGBWT_1[, , 5] <- fRGBWT_1[, , 5] * fRGBWT_2[, , 5]
  }

  return(fRGBWT_1)
}