R/dcmdump.R

In muschellij2/dcmtk: Wrapper for 'DICOM' Toolkit ('DCMTK')

#' @rdname dcmdump
#' @title DICOM Dump
#' @description Wrapper of \code{dcmdump} from DCMTK
#'
#' @param file DICOM file name
#' @param ... options passed to \code{\link{dcmtk_cmd}}, other than
#' \code{intern}
#'
#' @return Character vector of information
#' @export
#' @examples
#' if (!have_dcmtk_cmd("dcmdump")) {
#' install_dir = tempdir()
#' options(dcmtk.path = install_dir)
#'   res = try({
#'     install_dcmtk(install_dir = install_dir)
#'   })
#'   if (inherits(res, "try-error")) {
#'     res = FALSE
#'   }
#'   if (!res) {
#'     source_install_dcmtk(install_dir = install_dir)
#'   }
#' }
#' file = system.file("extdata", "example.dcm", package = "dcmtk")
#' dcmdump(file)
dcmdump = function(file,
                   ...) {

  suppressWarnings({
    file = normalizePath(file, winslash = "/")
  })
  hdr = dcmtk_cmd(
    cmd = "dcmdump",
    file = file,
    intern = TRUE,
    ...)
  status = attr(hdr, "status")
  if (!is.null(status)) {
    status = as.numeric(status)
    if (is.na(status) || status > 0) {
      warning("dcmdump gave back non-zero status")
    }
  }
  hdr = enc2utf8(hdr)
  return(hdr)
}

#' @export
#' @note \code{dcmdump_full} uses the
#' \code{frontopts = "-q --print-all --load-short --print-filename"} by
#' default
#' @rdname dcmdump
dcmdump_full = function(file,
                        ...) {
  args = list(...)
  frontopts = args$frontopts
  if (is.null(frontopts)) {
    frontopts = ""
  } else {
    frontopts = paste(frontopts, collapse = " ")
  }
  frontopts = paste("-q --print-all --load-short --print-filename",
                    frontopts)
  args$frontopts = frontopts
  x = do.call("dcmdump", args)
  x = enc2utf8(x)
  return(x)
}