From a84d687a5d5f6067f11601d3f7c2d71a2654aa2f Mon Sep 17 00:00:00 2001 From: Simon Barthelme Date: Wed, 26 Aug 2015 08:22:14 +0200 Subject: [PATCH] Minor updates to doc --- NAMESPACE | 2 +- R/RcppExports.R | 8 +++++++- R/cimg_class.R | 5 +++-- man/FFT.Rd | 2 +- man/add.colour.Rd | 2 +- man/as.cimg.Rd | 2 +- man/as.cimg.array.Rd | 2 +- man/as.cimg.data.frame.Rd | 2 +- man/as.cimg.function.Rd | 2 +- man/as.data.frame.cimg.Rd | 2 +- man/as.raster.cimg.Rd | 2 +- man/at.Rd | 2 +- man/autocrop.Rd | 2 +- man/blur_anisotropic.Rd | 2 +- man/boats.Rd | 2 +- man/boxblur.Rd | 2 +- man/boxblur_xy.Rd | 2 +- man/bucketfill.Rd | 2 +- man/capture.plot.Rd | 2 +- man/center.stencil.Rd | 2 +- man/channels.Rd | 2 +- man/cimg.Rd | 2 +- man/cimg.dimensions.Rd | 2 +- man/cimg.extract.Rd | 2 +- man/cimg2im.Rd | 2 +- man/convolve.Rd | 2 +- man/correlate.Rd | 2 +- man/deriche.Rd | 2 +- man/diffusion_tensors.Rd | 2 +- man/displacement.Rd | 2 +- man/display.Rd | 2 +- man/display_list.Rd | 2 +- man/distance_transform.Rd | 2 +- man/erode.Rd | 2 +- man/extract_patches.Rd | 2 +- man/frames.Rd | 2 +- man/get.locations.Rd | 2 +- man/get.stencil.Rd | 2 +- man/get_gradient.Rd | 2 +- man/get_hessian.Rd | 2 +- man/grayscale.Rd | 2 +- man/haar.Rd | 2 +- man/idply.Rd | 2 +- man/iiply.Rd | 2 +- man/ilply.Rd | 2 +- man/im_split.Rd | 2 +- man/imager.Rd | 7 ++++--- man/imager.colourspaces.Rd | 2 +- man/imager.combine.Rd | 2 +- man/imappend.Rd | 11 +++++++++-- man/imdirac.Rd | 2 +- man/imdraw.Rd | 2 +- man/imfill.Rd | 2 +- man/imgradient.Rd | 2 +- man/imhessian.Rd | 2 +- man/imnoise.Rd | 2 +- man/imrotate.Rd | 2 +- man/imsharpen.Rd | 2 +- man/imshift.Rd | 2 +- man/imsplit.Rd | 2 +- man/imwarp.Rd | 2 +- man/interp.Rd | 2 +- man/isoblur.Rd | 2 +- man/label.Rd | 2 +- man/liply.Rd | 2 +- man/load.image.Rd | 2 +- man/medianblur.Rd | 2 +- man/mirror.Rd | 2 +- man/pad.Rd | 2 +- man/periodic.part.Rd | 2 +- man/permute_axes.Rd | 2 +- man/pixel.grid.Rd | 2 +- man/pixel.index.Rd | 2 +- man/play.Rd | 2 +- man/plot.cimg.Rd | 2 +- man/renorm.Rd | 2 +- man/resize.Rd | 2 +- man/resize_uniform.Rd | 2 +- man/rotate_xy.Rd | 2 +- man/save.image.Rd | 2 +- man/selectSimilar.Rd | 2 +- man/squeeze.Rd | 2 +- man/stencil.cross.Rd | 2 +- man/sub-.cimg.Rd | 2 +- man/subim.Rd | 2 +- man/threshold.Rd | 2 +- man/vanvliet.Rd | 2 +- man/warp.Rd | 2 +- man/watershed.Rd | 2 +- src/utils.cpp | 8 +++++++- 90 files changed, 115 insertions(+), 94 deletions(-) diff --git a/NAMESPACE b/NAMESPACE index 18b086a9..b2f04076 100644 --- a/NAMESPACE +++ b/NAMESPACE @@ -1,4 +1,4 @@ -# Generated by roxygen2 (4.1.1): do not edit by hand +# Generated by roxygen2 (4.1.1.9000): do not edit by hand S3method("[",cimg) S3method(as.array,cimg) diff --git a/R/RcppExports.R b/R/RcppExports.R index 66b61c32..c580b652 100644 --- a/R/RcppExports.R +++ b/R/RcppExports.R @@ -755,9 +755,15 @@ im_split <- function(im, axis, nb = -1L) { #' All images will be concatenated along the x,y,z, or c axis. #' #' @param imlist a list of images (all elements must be of class cimg) -#' @param axis the axis along which to split (for example 'c') +#' @param axis the axis along which to concatenate (for example 'c') #' @seealso imsplit (the reverse operation) #' @export +#' @examples +#' imappend(list(boats,boats),"x") %>% plot +#' imappend(list(boats,boats),"y") %>% plot +#' plyr::rlply(3,imnoise(100,100)) %>% imappend("c") %>% plot +#' boats.gs <- grayscale(boats) +#' plyr::llply(seq(1,5,l=3),function(v) isoblur(boats.gs,v)) %>% imappend("c") %>% plot imappend <- function(imlist, axis) { .Call('imager_imappend', PACKAGE = 'imager', imlist, axis) } diff --git a/R/cimg_class.R b/R/cimg_class.R index 891a63d8..3e84127a 100644 --- a/R/cimg_class.R +++ b/R/cimg_class.R @@ -1,7 +1,8 @@ #' imager: an R library for image processing, based on CImg #' -#' CImg by David Tschumperle is a C++ library for image processing. It provides most common functions for image manipulation and filtering, as well as some advanced algorithms. imager makes these functions accessible from R and adds some basic plotting and subsetting. -#' You should install ImageMagick if you want support for common image formats (png, jpg, etc.) +#' CImg by David Tschumperle is a C++ library for image processing. It provides most common functions for image manipulation and filtering, as well as some advanced algorithms. imager makes these functions accessible from R and adds many utilities for accessing and working with image data from R. +#' You should install ImageMagick if you want support for image formats beyond PNG and JPEG, and ffmpeg if you need to work with videos (in which case you probably also want to take a look at experimental package imagerstreams on github). +#' Package documentation is available at http://dahtah.github.io/imager/. #' @docType package #' @name imager NULL diff --git a/man/FFT.Rd b/man/FFT.Rd index 8df7863f..6e7d8411 100644 --- a/man/FFT.Rd +++ b/man/FFT.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.1.1): do not edit by hand +% Generated by roxygen2 (4.1.1.9000): do not edit by hand % Please edit documentation in R/cimg_class.R \name{FFT} \alias{FFT} diff --git a/man/add.colour.Rd b/man/add.colour.Rd index 4baaacde..75a8a428 100644 --- a/man/add.colour.Rd +++ b/man/add.colour.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.1.1): do not edit by hand +% Generated by roxygen2 (4.1.1.9000): do not edit by hand % Please edit documentation in R/cimg_class.R \name{add.colour} \alias{add.colour} diff --git a/man/as.cimg.Rd b/man/as.cimg.Rd index 6ba01166..f9277612 100644 --- a/man/as.cimg.Rd +++ b/man/as.cimg.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.1.1): do not edit by hand +% Generated by roxygen2 (4.1.1.9000): do not edit by hand % Please edit documentation in R/cimg_class.R \name{as.cimg} \alias{as.cimg} diff --git a/man/as.cimg.array.Rd b/man/as.cimg.array.Rd index 56feef5e..27334258 100644 --- a/man/as.cimg.array.Rd +++ b/man/as.cimg.array.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.1.1): do not edit by hand +% Generated by roxygen2 (4.1.1.9000): do not edit by hand % Please edit documentation in R/cimg_class.R \name{as.cimg.array} \alias{as.cimg.array} diff --git a/man/as.cimg.data.frame.Rd b/man/as.cimg.data.frame.Rd index f3eb29ce..7e98f513 100644 --- a/man/as.cimg.data.frame.Rd +++ b/man/as.cimg.data.frame.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.1.1): do not edit by hand +% Generated by roxygen2 (4.1.1.9000): do not edit by hand % Please edit documentation in R/cimg_class.R \name{as.cimg.data.frame} \alias{as.cimg.data.frame} diff --git a/man/as.cimg.function.Rd b/man/as.cimg.function.Rd index 922e83a4..42573f48 100644 --- a/man/as.cimg.function.Rd +++ b/man/as.cimg.function.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.1.1): do not edit by hand +% Generated by roxygen2 (4.1.1.9000): do not edit by hand % Please edit documentation in R/cimg_class.R \name{as.cimg.function} \alias{as.cimg.function} diff --git a/man/as.data.frame.cimg.Rd b/man/as.data.frame.cimg.Rd index f3006002..6065eeb0 100644 --- a/man/as.data.frame.cimg.Rd +++ b/man/as.data.frame.cimg.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.1.1): do not edit by hand +% Generated by roxygen2 (4.1.1.9000): do not edit by hand % Please edit documentation in R/cimg_class.R \name{as.data.frame.cimg} \alias{as.data.frame.cimg} diff --git a/man/as.raster.cimg.Rd b/man/as.raster.cimg.Rd index fcde8332..f1445a30 100644 --- a/man/as.raster.cimg.Rd +++ b/man/as.raster.cimg.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.1.1): do not edit by hand +% Generated by roxygen2 (4.1.1.9000): do not edit by hand % Please edit documentation in R/cimg_class.R \name{as.raster.cimg} \alias{as.raster.cimg} diff --git a/man/at.Rd b/man/at.Rd index 2f5985a8..b269a857 100644 --- a/man/at.Rd +++ b/man/at.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.1.1): do not edit by hand +% Generated by roxygen2 (4.1.1.9000): do not edit by hand % Please edit documentation in R/cimg_class.R \name{at} \alias{at} diff --git a/man/autocrop.Rd b/man/autocrop.Rd index d1e9b49c..5b0cedca 100644 --- a/man/autocrop.Rd +++ b/man/autocrop.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.1.1): do not edit by hand +% Generated by roxygen2 (4.1.1.9000): do not edit by hand % Please edit documentation in R/RcppExports.R \name{autocrop} \alias{autocrop} diff --git a/man/blur_anisotropic.Rd b/man/blur_anisotropic.Rd index 36523a3b..1f9bab94 100644 --- a/man/blur_anisotropic.Rd +++ b/man/blur_anisotropic.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.1.1): do not edit by hand +% Generated by roxygen2 (4.1.1.9000): do not edit by hand % Please edit documentation in R/RcppExports.R \name{blur_anisotropic} \alias{blur_anisotropic} diff --git a/man/boats.Rd b/man/boats.Rd index b1c60120..26a55cb5 100644 --- a/man/boats.Rd +++ b/man/boats.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.1.1): do not edit by hand +% Generated by roxygen2 (4.1.1.9000): do not edit by hand % Please edit documentation in R/datasets.R \docType{data} \name{boats} diff --git a/man/boxblur.Rd b/man/boxblur.Rd index e84e0e52..964d3372 100644 --- a/man/boxblur.Rd +++ b/man/boxblur.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.1.1): do not edit by hand +% Generated by roxygen2 (4.1.1.9000): do not edit by hand % Please edit documentation in R/RcppExports.R \name{boxblur} \alias{boxblur} diff --git a/man/boxblur_xy.Rd b/man/boxblur_xy.Rd index c8315328..ba084141 100644 --- a/man/boxblur_xy.Rd +++ b/man/boxblur_xy.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.1.1): do not edit by hand +% Generated by roxygen2 (4.1.1.9000): do not edit by hand % Please edit documentation in R/RcppExports.R \name{boxblur_xy} \alias{boxblur_xy} diff --git a/man/bucketfill.Rd b/man/bucketfill.Rd index 9a24478d..85737618 100644 --- a/man/bucketfill.Rd +++ b/man/bucketfill.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.1.1): do not edit by hand +% Generated by roxygen2 (4.1.1.9000): do not edit by hand % Please edit documentation in R/drawing.R \name{bucketfill} \alias{bucketfill} diff --git a/man/capture.plot.Rd b/man/capture.plot.Rd index f437f639..7314c087 100644 --- a/man/capture.plot.Rd +++ b/man/capture.plot.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.1.1): do not edit by hand +% Generated by roxygen2 (4.1.1.9000): do not edit by hand % Please edit documentation in R/cimg_class.R \name{capture.plot} \alias{capture.plot} diff --git a/man/center.stencil.Rd b/man/center.stencil.Rd index 851e64f3..03785857 100644 --- a/man/center.stencil.Rd +++ b/man/center.stencil.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.1.1): do not edit by hand +% Generated by roxygen2 (4.1.1.9000): do not edit by hand % Please edit documentation in R/cimg_class.R \name{center.stencil} \alias{center.stencil} diff --git a/man/channels.Rd b/man/channels.Rd index 58b90eb8..15e5f38b 100644 --- a/man/channels.Rd +++ b/man/channels.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.1.1): do not edit by hand +% Generated by roxygen2 (4.1.1.9000): do not edit by hand % Please edit documentation in R/cimg_class.R \name{channels} \alias{channels} diff --git a/man/cimg.Rd b/man/cimg.Rd index a538922e..4476b95a 100644 --- a/man/cimg.Rd +++ b/man/cimg.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.1.1): do not edit by hand +% Generated by roxygen2 (4.1.1.9000): do not edit by hand % Please edit documentation in R/cimg_class.R \name{cimg} \alias{cimg} diff --git a/man/cimg.dimensions.Rd b/man/cimg.dimensions.Rd index a5935d62..33c8bd9d 100644 --- a/man/cimg.dimensions.Rd +++ b/man/cimg.dimensions.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.1.1): do not edit by hand +% Generated by roxygen2 (4.1.1.9000): do not edit by hand % Please edit documentation in R/cimg_class.R \name{cimg.dimensions} \alias{cimg.dimensions} diff --git a/man/cimg.extract.Rd b/man/cimg.extract.Rd index 85d0ea9e..6911e74a 100644 --- a/man/cimg.extract.Rd +++ b/man/cimg.extract.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.1.1): do not edit by hand +% Generated by roxygen2 (4.1.1.9000): do not edit by hand % Please edit documentation in R/cimg_class.R \name{cimg.extract} \alias{B} diff --git a/man/cimg2im.Rd b/man/cimg2im.Rd index d1f37e7a..e1558593 100644 --- a/man/cimg2im.Rd +++ b/man/cimg2im.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.1.1): do not edit by hand +% Generated by roxygen2 (4.1.1.9000): do not edit by hand % Please edit documentation in R/cimg_class.R \name{cimg2im} \alias{cimg2im} diff --git a/man/convolve.Rd b/man/convolve.Rd index 052a3f45..0ed812cf 100644 --- a/man/convolve.Rd +++ b/man/convolve.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.1.1): do not edit by hand +% Generated by roxygen2 (4.1.1.9000): do not edit by hand % Please edit documentation in R/RcppExports.R \name{convolve} \alias{convolve} diff --git a/man/correlate.Rd b/man/correlate.Rd index 8f6c3783..40a3d0b9 100644 --- a/man/correlate.Rd +++ b/man/correlate.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.1.1): do not edit by hand +% Generated by roxygen2 (4.1.1.9000): do not edit by hand % Please edit documentation in R/RcppExports.R \name{correlate} \alias{correlate} diff --git a/man/deriche.Rd b/man/deriche.Rd index 4ed7f9d5..3fb325d5 100644 --- a/man/deriche.Rd +++ b/man/deriche.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.1.1): do not edit by hand +% Generated by roxygen2 (4.1.1.9000): do not edit by hand % Please edit documentation in R/RcppExports.R \name{deriche} \alias{deriche} diff --git a/man/diffusion_tensors.Rd b/man/diffusion_tensors.Rd index 7a535626..1f289761 100644 --- a/man/diffusion_tensors.Rd +++ b/man/diffusion_tensors.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.1.1): do not edit by hand +% Generated by roxygen2 (4.1.1.9000): do not edit by hand % Please edit documentation in R/RcppExports.R \name{diffusion_tensors} \alias{diffusion_tensors} diff --git a/man/displacement.Rd b/man/displacement.Rd index c9b4b01e..0c6dd469 100644 --- a/man/displacement.Rd +++ b/man/displacement.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.1.1): do not edit by hand +% Generated by roxygen2 (4.1.1.9000): do not edit by hand % Please edit documentation in R/RcppExports.R \name{displacement} \alias{displacement} diff --git a/man/display.Rd b/man/display.Rd index 8f49721c..194fe93d 100644 --- a/man/display.Rd +++ b/man/display.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.1.1): do not edit by hand +% Generated by roxygen2 (4.1.1.9000): do not edit by hand % Please edit documentation in R/RcppExports.R \name{display} \alias{display} diff --git a/man/display_list.Rd b/man/display_list.Rd index 48fff7f0..6e2e7b99 100644 --- a/man/display_list.Rd +++ b/man/display_list.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.1.1): do not edit by hand +% Generated by roxygen2 (4.1.1.9000): do not edit by hand % Please edit documentation in R/RcppExports.R \name{display_list} \alias{display_list} diff --git a/man/distance_transform.Rd b/man/distance_transform.Rd index 9345d02d..01a36b3a 100644 --- a/man/distance_transform.Rd +++ b/man/distance_transform.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.1.1): do not edit by hand +% Generated by roxygen2 (4.1.1.9000): do not edit by hand % Please edit documentation in R/RcppExports.R \name{distance_transform} \alias{distance_transform} diff --git a/man/erode.Rd b/man/erode.Rd index 87b5def9..b2feeb05 100644 --- a/man/erode.Rd +++ b/man/erode.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.1.1): do not edit by hand +% Generated by roxygen2 (4.1.1.9000): do not edit by hand % Please edit documentation in R/RcppExports.R \name{erode} \alias{dilate} diff --git a/man/extract_patches.Rd b/man/extract_patches.Rd index 4b0ebf7c..a9a6c029 100644 --- a/man/extract_patches.Rd +++ b/man/extract_patches.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.1.1): do not edit by hand +% Generated by roxygen2 (4.1.1.9000): do not edit by hand % Please edit documentation in R/RcppExports.R \name{extract_patches} \alias{extract_patches} diff --git a/man/frames.Rd b/man/frames.Rd index b9d31727..b846bf51 100644 --- a/man/frames.Rd +++ b/man/frames.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.1.1): do not edit by hand +% Generated by roxygen2 (4.1.1.9000): do not edit by hand % Please edit documentation in R/cimg_class.R \name{frames} \alias{frames} diff --git a/man/get.locations.Rd b/man/get.locations.Rd index b1478346..80f95cd3 100644 --- a/man/get.locations.Rd +++ b/man/get.locations.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.1.1): do not edit by hand +% Generated by roxygen2 (4.1.1.9000): do not edit by hand % Please edit documentation in R/cimg_class.R \name{get.locations} \alias{get.locations} diff --git a/man/get.stencil.Rd b/man/get.stencil.Rd index 4940b233..5bd0373f 100644 --- a/man/get.stencil.Rd +++ b/man/get.stencil.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.1.1): do not edit by hand +% Generated by roxygen2 (4.1.1.9000): do not edit by hand % Please edit documentation in R/cimg_class.R \name{get.stencil} \alias{get.stencil} diff --git a/man/get_gradient.Rd b/man/get_gradient.Rd index de6efddd..d2395412 100644 --- a/man/get_gradient.Rd +++ b/man/get_gradient.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.1.1): do not edit by hand +% Generated by roxygen2 (4.1.1.9000): do not edit by hand % Please edit documentation in R/RcppExports.R \name{get_gradient} \alias{get_gradient} diff --git a/man/get_hessian.Rd b/man/get_hessian.Rd index 62940ff6..75b383ac 100644 --- a/man/get_hessian.Rd +++ b/man/get_hessian.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.1.1): do not edit by hand +% Generated by roxygen2 (4.1.1.9000): do not edit by hand % Please edit documentation in R/RcppExports.R \name{get_hessian} \alias{get_hessian} diff --git a/man/grayscale.Rd b/man/grayscale.Rd index 2c727506..ceee22b5 100644 --- a/man/grayscale.Rd +++ b/man/grayscale.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.1.1): do not edit by hand +% Generated by roxygen2 (4.1.1.9000): do not edit by hand % Please edit documentation in R/RcppExports.R \name{grayscale} \alias{grayscale} diff --git a/man/haar.Rd b/man/haar.Rd index fd208b9b..c3c27f96 100644 --- a/man/haar.Rd +++ b/man/haar.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.1.1): do not edit by hand +% Generated by roxygen2 (4.1.1.9000): do not edit by hand % Please edit documentation in R/RcppExports.R \name{haar} \alias{haar} diff --git a/man/idply.Rd b/man/idply.Rd index 4f606df8..6ebaa3a4 100644 --- a/man/idply.Rd +++ b/man/idply.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.1.1): do not edit by hand +% Generated by roxygen2 (4.1.1.9000): do not edit by hand % Please edit documentation in R/cimg_class.R \name{idply} \alias{idply} diff --git a/man/iiply.Rd b/man/iiply.Rd index d6b2a982..6112ed00 100644 --- a/man/iiply.Rd +++ b/man/iiply.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.1.1): do not edit by hand +% Generated by roxygen2 (4.1.1.9000): do not edit by hand % Please edit documentation in R/cimg_class.R \name{iiply} \alias{iiply} diff --git a/man/ilply.Rd b/man/ilply.Rd index 33e2f99b..bc0ff4e8 100644 --- a/man/ilply.Rd +++ b/man/ilply.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.1.1): do not edit by hand +% Generated by roxygen2 (4.1.1.9000): do not edit by hand % Please edit documentation in R/cimg_class.R \name{ilply} \alias{ilply} diff --git a/man/im_split.Rd b/man/im_split.Rd index 94463261..ab15ce28 100644 --- a/man/im_split.Rd +++ b/man/im_split.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.1.1): do not edit by hand +% Generated by roxygen2 (4.1.1.9000): do not edit by hand % Please edit documentation in R/RcppExports.R \name{im_split} \alias{im_split} diff --git a/man/imager.Rd b/man/imager.Rd index ae0bf770..b5ce1de4 100644 --- a/man/imager.Rd +++ b/man/imager.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.1.1): do not edit by hand +% Generated by roxygen2 (4.1.1.9000): do not edit by hand % Please edit documentation in R/cimg_class.R \docType{package} \name{imager} @@ -6,7 +6,8 @@ \alias{imager-package} \title{imager: an R library for image processing, based on CImg} \description{ -CImg by David Tschumperle is a C++ library for image processing. It provides most common functions for image manipulation and filtering, as well as some advanced algorithms. imager makes these functions accessible from R and adds some basic plotting and subsetting. -You should install ImageMagick if you want support for common image formats (png, jpg, etc.) +CImg by David Tschumperle is a C++ library for image processing. It provides most common functions for image manipulation and filtering, as well as some advanced algorithms. imager makes these functions accessible from R and adds many utilities for accessing and working with image data from R. +You should install ImageMagick if you want support for image formats beyond PNG and JPEG, and ffmpeg if you need to work with videos (in which case you probably also want to take a look at experimental package imagerstreams on github). +Package documentation is available at http://dahtah.github.io/imager/. } diff --git a/man/imager.colourspaces.Rd b/man/imager.colourspaces.Rd index 7ca45de2..4e268cac 100644 --- a/man/imager.colourspaces.Rd +++ b/man/imager.colourspaces.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.1.1): do not edit by hand +% Generated by roxygen2 (4.1.1.9000): do not edit by hand % Please edit documentation in R/RcppExports.R, R/cimg_class.R \name{RGBtoHSL} \alias{HSItoRGB} diff --git a/man/imager.combine.Rd b/man/imager.combine.Rd index dca8bdca..ae0e20ab 100644 --- a/man/imager.combine.Rd +++ b/man/imager.combine.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.1.1): do not edit by hand +% Generated by roxygen2 (4.1.1.9000): do not edit by hand % Please edit documentation in R/cimg_class.R \name{imager.combine} \alias{add} diff --git a/man/imappend.Rd b/man/imappend.Rd index 38abf12d..3eceae07 100644 --- a/man/imappend.Rd +++ b/man/imappend.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.1.1): do not edit by hand +% Generated by roxygen2 (4.1.1.9000): do not edit by hand % Please edit documentation in R/RcppExports.R \name{imappend} \alias{imappend} @@ -9,11 +9,18 @@ imappend(imlist, axis) \arguments{ \item{imlist}{a list of images (all elements must be of class cimg)} -\item{axis}{the axis along which to split (for example 'c')} +\item{axis}{the axis along which to concatenate (for example 'c')} } \description{ All images will be concatenated along the x,y,z, or c axis. } +\examples{ +imappend(list(boats,boats),"x") \%>\% plot +imappend(list(boats,boats),"y") \%>\% plot +plyr::rlply(3,imnoise(100,100)) \%>\% imappend("c") \%>\% plot +boats.gs <- grayscale(boats) +plyr::llply(seq(1,5,l=3),function(v) isoblur(boats.gs,v)) \%>\% imappend("c") \%>\% plot +} \seealso{ imsplit (the reverse operation) } diff --git a/man/imdirac.Rd b/man/imdirac.Rd index fe383426..2c9923e4 100644 --- a/man/imdirac.Rd +++ b/man/imdirac.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.1.1): do not edit by hand +% Generated by roxygen2 (4.1.1.9000): do not edit by hand % Please edit documentation in R/cimg_class.R \name{imdirac} \alias{imdirac} diff --git a/man/imdraw.Rd b/man/imdraw.Rd index 2879f5a7..c010993f 100644 --- a/man/imdraw.Rd +++ b/man/imdraw.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.1.1): do not edit by hand +% Generated by roxygen2 (4.1.1.9000): do not edit by hand % Please edit documentation in R/cimg_class.R \name{imdraw} \alias{imdraw} diff --git a/man/imfill.Rd b/man/imfill.Rd index c76538e0..a870c7ab 100644 --- a/man/imfill.Rd +++ b/man/imfill.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.1.1): do not edit by hand +% Generated by roxygen2 (4.1.1.9000): do not edit by hand % Please edit documentation in R/cimg_class.R \name{imfill} \alias{imfill} diff --git a/man/imgradient.Rd b/man/imgradient.Rd index 2684e9bd..d6dc5a48 100644 --- a/man/imgradient.Rd +++ b/man/imgradient.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.1.1): do not edit by hand +% Generated by roxygen2 (4.1.1.9000): do not edit by hand % Please edit documentation in R/cimg_class.R \name{imgradient} \alias{imgradient} diff --git a/man/imhessian.Rd b/man/imhessian.Rd index 060f6c9c..bf88cc42 100644 --- a/man/imhessian.Rd +++ b/man/imhessian.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.1.1): do not edit by hand +% Generated by roxygen2 (4.1.1.9000): do not edit by hand % Please edit documentation in R/cimg_class.R \name{imhessian} \alias{imhessian} diff --git a/man/imnoise.Rd b/man/imnoise.Rd index b9e5d57b..26a74adb 100644 --- a/man/imnoise.Rd +++ b/man/imnoise.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.1.1): do not edit by hand +% Generated by roxygen2 (4.1.1.9000): do not edit by hand % Please edit documentation in R/cimg_class.R \name{imnoise} \alias{imnoise} diff --git a/man/imrotate.Rd b/man/imrotate.Rd index 49c0eee5..fd0b62d3 100644 --- a/man/imrotate.Rd +++ b/man/imrotate.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.1.1): do not edit by hand +% Generated by roxygen2 (4.1.1.9000): do not edit by hand % Please edit documentation in R/RcppExports.R \name{imrotate} \alias{imrotate} diff --git a/man/imsharpen.Rd b/man/imsharpen.Rd index 29b49d81..d31c0c04 100644 --- a/man/imsharpen.Rd +++ b/man/imsharpen.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.1.1): do not edit by hand +% Generated by roxygen2 (4.1.1.9000): do not edit by hand % Please edit documentation in R/RcppExports.R \name{imsharpen} \alias{imsharpen} diff --git a/man/imshift.Rd b/man/imshift.Rd index 67d50a38..69db9199 100644 --- a/man/imshift.Rd +++ b/man/imshift.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.1.1): do not edit by hand +% Generated by roxygen2 (4.1.1.9000): do not edit by hand % Please edit documentation in R/RcppExports.R \name{imshift} \alias{imshift} diff --git a/man/imsplit.Rd b/man/imsplit.Rd index ad5894f6..9097e84f 100644 --- a/man/imsplit.Rd +++ b/man/imsplit.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.1.1): do not edit by hand +% Generated by roxygen2 (4.1.1.9000): do not edit by hand % Please edit documentation in R/cimg_class.R \name{imsplit} \alias{imsplit} diff --git a/man/imwarp.Rd b/man/imwarp.Rd index ed3966c5..62ad6708 100644 --- a/man/imwarp.Rd +++ b/man/imwarp.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.1.1): do not edit by hand +% Generated by roxygen2 (4.1.1.9000): do not edit by hand % Please edit documentation in R/cimg_class.R \name{imwarp} \alias{imwarp} diff --git a/man/interp.Rd b/man/interp.Rd index d3da4707..fee45062 100644 --- a/man/interp.Rd +++ b/man/interp.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.1.1): do not edit by hand +% Generated by roxygen2 (4.1.1.9000): do not edit by hand % Please edit documentation in R/interpolation.R \name{interp} \alias{interp} diff --git a/man/isoblur.Rd b/man/isoblur.Rd index 619e73ff..769f2d8c 100644 --- a/man/isoblur.Rd +++ b/man/isoblur.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.1.1): do not edit by hand +% Generated by roxygen2 (4.1.1.9000): do not edit by hand % Please edit documentation in R/RcppExports.R \name{isoblur} \alias{isoblur} diff --git a/man/label.Rd b/man/label.Rd index 981fb0a5..4b9befa6 100644 --- a/man/label.Rd +++ b/man/label.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.1.1): do not edit by hand +% Generated by roxygen2 (4.1.1.9000): do not edit by hand % Please edit documentation in R/RcppExports.R \name{label} \alias{label} diff --git a/man/liply.Rd b/man/liply.Rd index 631e7e1e..3436d914 100644 --- a/man/liply.Rd +++ b/man/liply.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.1.1): do not edit by hand +% Generated by roxygen2 (4.1.1.9000): do not edit by hand % Please edit documentation in R/cimg_class.R \name{liply} \alias{liply} diff --git a/man/load.image.Rd b/man/load.image.Rd index b27aff87..fb28fa84 100644 --- a/man/load.image.Rd +++ b/man/load.image.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.1.1): do not edit by hand +% Generated by roxygen2 (4.1.1.9000): do not edit by hand % Please edit documentation in R/cimg_class.R \name{load.image} \alias{load.image} diff --git a/man/medianblur.Rd b/man/medianblur.Rd index 1d627298..a397ecc3 100644 --- a/man/medianblur.Rd +++ b/man/medianblur.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.1.1): do not edit by hand +% Generated by roxygen2 (4.1.1.9000): do not edit by hand % Please edit documentation in R/RcppExports.R \name{medianblur} \alias{medianblur} diff --git a/man/mirror.Rd b/man/mirror.Rd index 4026c56c..835ee311 100644 --- a/man/mirror.Rd +++ b/man/mirror.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.1.1): do not edit by hand +% Generated by roxygen2 (4.1.1.9000): do not edit by hand % Please edit documentation in R/RcppExports.R \name{mirror} \alias{mirror} diff --git a/man/pad.Rd b/man/pad.Rd index 0340e222..ff8d56da 100644 --- a/man/pad.Rd +++ b/man/pad.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.1.1): do not edit by hand +% Generated by roxygen2 (4.1.1.9000): do not edit by hand % Please edit documentation in R/cimg_class.R \name{pad} \alias{pad} diff --git a/man/periodic.part.Rd b/man/periodic.part.Rd index 4f70c888..d89acf05 100644 --- a/man/periodic.part.Rd +++ b/man/periodic.part.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.1.1): do not edit by hand +% Generated by roxygen2 (4.1.1.9000): do not edit by hand % Please edit documentation in R/cimg_class.R \name{periodic.part} \alias{periodic.part} diff --git a/man/permute_axes.Rd b/man/permute_axes.Rd index 29a55ae7..76d8f05f 100644 --- a/man/permute_axes.Rd +++ b/man/permute_axes.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.1.1): do not edit by hand +% Generated by roxygen2 (4.1.1.9000): do not edit by hand % Please edit documentation in R/RcppExports.R \name{permute_axes} \alias{permute_axes} diff --git a/man/pixel.grid.Rd b/man/pixel.grid.Rd index 9dd9ff18..e972ad99 100644 --- a/man/pixel.grid.Rd +++ b/man/pixel.grid.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.1.1): do not edit by hand +% Generated by roxygen2 (4.1.1.9000): do not edit by hand % Please edit documentation in R/cimg_class.R \name{pixel.grid} \alias{pixel.grid} diff --git a/man/pixel.index.Rd b/man/pixel.index.Rd index 4a204583..ad6ce8f1 100644 --- a/man/pixel.index.Rd +++ b/man/pixel.index.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.1.1): do not edit by hand +% Generated by roxygen2 (4.1.1.9000): do not edit by hand % Please edit documentation in R/cimg_class.R \name{pixel.index} \alias{pixel.index} diff --git a/man/play.Rd b/man/play.Rd index acf0baf1..8436002e 100644 --- a/man/play.Rd +++ b/man/play.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.1.1): do not edit by hand +% Generated by roxygen2 (4.1.1.9000): do not edit by hand % Please edit documentation in R/RcppExports.R \name{play} \alias{play} diff --git a/man/plot.cimg.Rd b/man/plot.cimg.Rd index fdc6c15c..4d90eb8c 100644 --- a/man/plot.cimg.Rd +++ b/man/plot.cimg.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.1.1): do not edit by hand +% Generated by roxygen2 (4.1.1.9000): do not edit by hand % Please edit documentation in R/cimg_class.R \name{plot.cimg} \alias{plot.cimg} diff --git a/man/renorm.Rd b/man/renorm.Rd index 97615357..3e4acc56 100644 --- a/man/renorm.Rd +++ b/man/renorm.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.1.1): do not edit by hand +% Generated by roxygen2 (4.1.1.9000): do not edit by hand % Please edit documentation in R/cimg_class.R \name{renorm} \alias{renorm} diff --git a/man/resize.Rd b/man/resize.Rd index f00a9947..da9a3a80 100644 --- a/man/resize.Rd +++ b/man/resize.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.1.1): do not edit by hand +% Generated by roxygen2 (4.1.1.9000): do not edit by hand % Please edit documentation in R/RcppExports.R \name{resize} \alias{resize} diff --git a/man/resize_uniform.Rd b/man/resize_uniform.Rd index 4ad82928..15611a90 100644 --- a/man/resize_uniform.Rd +++ b/man/resize_uniform.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.1.1): do not edit by hand +% Generated by roxygen2 (4.1.1.9000): do not edit by hand % Please edit documentation in R/RcppExports.R, R/cimg_class.R \name{resize_doubleXY} \alias{imresize} diff --git a/man/rotate_xy.Rd b/man/rotate_xy.Rd index 5c0627ba..12b8e844 100644 --- a/man/rotate_xy.Rd +++ b/man/rotate_xy.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.1.1): do not edit by hand +% Generated by roxygen2 (4.1.1.9000): do not edit by hand % Please edit documentation in R/RcppExports.R \name{rotate_xy} \alias{rotate_xy} diff --git a/man/save.image.Rd b/man/save.image.Rd index f81aa635..644a252b 100644 --- a/man/save.image.Rd +++ b/man/save.image.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.1.1): do not edit by hand +% Generated by roxygen2 (4.1.1.9000): do not edit by hand % Please edit documentation in R/cimg_class.R \name{save.image} \alias{save.image} diff --git a/man/selectSimilar.Rd b/man/selectSimilar.Rd index ae0564cf..b201458e 100644 --- a/man/selectSimilar.Rd +++ b/man/selectSimilar.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.1.1): do not edit by hand +% Generated by roxygen2 (4.1.1.9000): do not edit by hand % Please edit documentation in R/drawing.R \name{selectSimilar} \alias{selectSimilar} diff --git a/man/squeeze.Rd b/man/squeeze.Rd index 3737f81d..50916648 100644 --- a/man/squeeze.Rd +++ b/man/squeeze.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.1.1): do not edit by hand +% Generated by roxygen2 (4.1.1.9000): do not edit by hand % Please edit documentation in R/cimg_class.R \name{squeeze} \alias{squeeze} diff --git a/man/stencil.cross.Rd b/man/stencil.cross.Rd index 01a9c125..94299a15 100644 --- a/man/stencil.cross.Rd +++ b/man/stencil.cross.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.1.1): do not edit by hand +% Generated by roxygen2 (4.1.1.9000): do not edit by hand % Please edit documentation in R/cimg_class.R \name{stencil.cross} \alias{stencil.cross} diff --git a/man/sub-.cimg.Rd b/man/sub-.cimg.Rd index b0b90207..6c25245e 100644 --- a/man/sub-.cimg.Rd +++ b/man/sub-.cimg.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.1.1): do not edit by hand +% Generated by roxygen2 (4.1.1.9000): do not edit by hand % Please edit documentation in R/cimg_class.R \name{[.cimg} \alias{[.cimg} diff --git a/man/subim.Rd b/man/subim.Rd index 99ffbe38..ace773c5 100644 --- a/man/subim.Rd +++ b/man/subim.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.1.1): do not edit by hand +% Generated by roxygen2 (4.1.1.9000): do not edit by hand % Please edit documentation in R/cimg_class.R \name{subim} \alias{subim} diff --git a/man/threshold.Rd b/man/threshold.Rd index 7c097f7f..dab6c52d 100644 --- a/man/threshold.Rd +++ b/man/threshold.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.1.1): do not edit by hand +% Generated by roxygen2 (4.1.1.9000): do not edit by hand % Please edit documentation in R/cimg_class.R \name{threshold} \alias{threshold} diff --git a/man/vanvliet.Rd b/man/vanvliet.Rd index 6d42e327..b98292a5 100644 --- a/man/vanvliet.Rd +++ b/man/vanvliet.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.1.1): do not edit by hand +% Generated by roxygen2 (4.1.1.9000): do not edit by hand % Please edit documentation in R/RcppExports.R \name{vanvliet} \alias{vanvliet} diff --git a/man/warp.Rd b/man/warp.Rd index a716d386..827b3041 100644 --- a/man/warp.Rd +++ b/man/warp.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.1.1): do not edit by hand +% Generated by roxygen2 (4.1.1.9000): do not edit by hand % Please edit documentation in R/RcppExports.R \name{warp} \alias{warp} diff --git a/man/watershed.Rd b/man/watershed.Rd index 6aed8897..e9615adf 100644 --- a/man/watershed.Rd +++ b/man/watershed.Rd @@ -1,4 +1,4 @@ -% Generated by roxygen2 (4.1.1): do not edit by hand +% Generated by roxygen2 (4.1.1.9000): do not edit by hand % Please edit documentation in R/RcppExports.R \name{watershed} \alias{watershed} diff --git a/src/utils.cpp b/src/utils.cpp index 749687aa..9bb55897 100644 --- a/src/utils.cpp +++ b/src/utils.cpp @@ -41,9 +41,15 @@ List im_split(NumericVector im,char axis,int nb=-1) //' All images will be concatenated along the x,y,z, or c axis. //' //' @param imlist a list of images (all elements must be of class cimg) -//' @param axis the axis along which to split (for example 'c') +//' @param axis the axis along which to concatenate (for example 'c') //' @seealso imsplit (the reverse operation) //' @export +//' @examples +//' imappend(list(boats,boats),"x") %>% plot +//' imappend(list(boats,boats),"y") %>% plot +//' plyr::rlply(3,imnoise(100,100)) %>% imappend("c") %>% plot +//' boats.gs <- grayscale(boats) +//' plyr::llply(seq(1,5,l=3),function(v) isoblur(boats.gs,v)) %>% imappend("c") %>% plot // [[Rcpp::export]] NumericVector imappend(List imlist,char axis) {