R/read.digital.surf.file.R

In npetraco/x3pr: Read/Write functionality for X3P surface metrology format

#--------------------------------------------
#' @title Read in a Digital Surf file.
#'
#' @description Read in a Digital Surf file. Just specify the path to the
#' .sur file.
#' 
#' @details This function calls \code{read.digital.surf.header} and \code{read.digital.surf.profiles}.
#'
#' @param file.path
#' 
#' @return a matrix.
#' 
#' @references http://open-gps.sourceforge.net/
#'
#' @examples
#' file.path <- system.file("extdata", "glock.sur", package="x3pr")
#' glock.sur.info <- read.digital.surf.file(file.path)
#' glock.sur.info[[1]]
#--------------------------------------------
read.digital.surf.file<-function(file.path) {
  
  ptr<-file(file.path, "rb") #Open up a connection to the .sur file
  header.info<-read.digital.surf.header(ptr)
  surface.matrix<-read.digital.surf.profiles(ptr,header.info)
  close(ptr)
  
  all.file.info<-c(list(NULL),list(NULL))
  names(all.file.info)<-c("Surface Info","Surface")
  all.file.info[[1]]<-header.info
  all.file.info[[2]]<-surface.matrix
  
  return(all.file.info)
  
}