From 6ede8b65d6beff661692f4aaa62a6dbefbdc6735 Mon Sep 17 00:00:00 2001 From: Adriano G Passos Date: Tue, 13 Jun 2017 16:33:27 -0300 Subject: [PATCH] some more documentation fixes --- DESCRIPTION | 4 ++-- man/RED.Rd | 17 +++++++++++------ man/SRI.Rd | 10 ---------- man/cameraman.Rd | 2 +- man/degrade.Rd | 12 ++++++------ man/fft_convolve.Rd | 2 +- man/lenna.Rd | 2 +- man/resample.Rd | 8 ++++---- man/shift.Rd | 2 +- man/transform.Rd | 4 ++-- 10 files changed, 29 insertions(+), 34 deletions(-) delete mode 100644 man/SRI.Rd diff --git a/DESCRIPTION b/DESCRIPTION index 8e983d9..cb8aa55 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -2,8 +2,8 @@ Package: RED Type: Package Title: REgularization by Denoising (RED) Version: 1.0.0 -Author: person("Adriano", "Passos", email="adriano.utfpr@gmail.com", role=c("aut","cre")) -Maintainer: Adriano G Passos, email: adriano.utfpr@gmail.com +Author: person("Adriano", "Passos", email="adriano.utfpr at gmail.com", role=c("aut","cre")) +Maintainer: Adriano G. Passos Description: Regularization by Denoising uses a denoising engine to solve many image reconstruction ill-posed inverse problems. Depends: R (>= 3.4.0), imager License: GPL-3 diff --git a/man/RED.Rd b/man/RED.Rd index e1a48d1..81e7474 100644 --- a/man/RED.Rd +++ b/man/RED.Rd @@ -1,8 +1,11 @@ % Generated by roxygen2: do not edit by hand -% Please edit documentation in R/red.R +% Please edit documentation in R/RED_pkg.R, R/red.R +\docType{package} \name{RED} \alias{RED} -\title{REgularization by Denoising} +\alias{RED-package} +\alias{RED} +\title{RED: Regularization by Denoising} \usage{ RED(y, x0 = NULL, lambda = 1, sigma = 1, functional = "SR", engine = "MF", niter = 50, step = NULL, tol = 0.001, args = NULL) @@ -21,17 +24,19 @@ functional to be used} \item{engine}{character indicating the denoised engine or function with the denoiser engine to be used} -\item{niter}{numeric indicating the maxistepm number of iterations} +\item{niter}{numeric indicating the maximum number of iterations} \item{step}{numeric indicating the step size (if NULL an optimal step size will be used)} -\item{tol}{numeric indicating the stoping criteria. The algorithm will stop -when step < tol. Default = 0.001} +\item{tol}{numeric indicating the stopping criteria. The algorithm will stop +when \code{step < tol}. Default = 0.001} -\item{args}{arguments to be passed implicity to H HT and f} +\item{args}{arguments to be passed implicitly to \code{H} \code{HT} and \code{f}} } \description{ +RED: Regularization by Denoising + REgularization by Denoising } \examples{ diff --git a/man/SRI.Rd b/man/SRI.Rd deleted file mode 100644 index d07de7a..0000000 --- a/man/SRI.Rd +++ /dev/null @@ -1,10 +0,0 @@ -% Generated by roxygen2: do not edit by hand -% Please edit documentation in R/RED_pkg.R -\docType{package} -\name{SRI} -\alias{SRI} -\alias{SRI-package} -\title{SRI: Super-resolution imaging package} -\description{ -Super-resolution imaging (SR) is a class of techniques that enhance the resolution of an imaging system. -} diff --git a/man/cameraman.Rd b/man/cameraman.Rd index 967757a..5e4343d 100644 --- a/man/cameraman.Rd +++ b/man/cameraman.Rd @@ -9,6 +9,6 @@ cameraman } \description{ -This image is usualy used as benchmar in SR problems +This image is usually used as benchmark in SR problems } \keyword{datasets} diff --git a/man/degrade.Rd b/man/degrade.Rd index 3b9f491..40b282d 100644 --- a/man/degrade.Rd +++ b/man/degrade.Rd @@ -8,16 +8,16 @@ degrade(z, L = 1, s = cbind(0, 0), noise = 0, blur = 1, L1 = L, L2 = L) } \arguments{ -\item{z}{a cimg object containing the high resolution image} +\item{z}{a \code{cimg}object containing the high resolution image} -\item{L}{numeric indicating the overal scale change. This param will be -overided by L1 or L2} +\item{L}{numeric indicating the overall scale change. This param will be +override by L1 or L2} \item{s}{numeric \code{p} by \code{2} matrix containing the registration -sameters} +parameters} \item{noise}{numeric indicating the standard deviation of the noise or an -cimg object that will be added to the resampled z} +\code{cimg}object that will be added to the resampled z} \item{blur}{numeric indicating the blur range (for uniform blur) or an cimg object with the blur kernel to be convolved with z if nothing is provided @@ -28,7 +28,7 @@ an default kernel will be used.} \item{L2}{numeric indicating the directional scale change} } \value{ -A degraded cimg object +A degraded \code{cimg}object } \description{ This function degrades a high resolution image into a low resolution image. diff --git a/man/fft_convolve.Rd b/man/fft_convolve.Rd index 21344b6..58d9e2e 100644 --- a/man/fft_convolve.Rd +++ b/man/fft_convolve.Rd @@ -7,7 +7,7 @@ fft_convolve(im, filter, deconvolution = FALSE) } \arguments{ -\item{im, filter}{cimg objects} +\item{im, filter}{\code{cimg} objects} \item{deconvolution}{logical indicating if the deconvolution should be performed} } diff --git a/man/lenna.Rd b/man/lenna.Rd index 5f0dbfb..b8aea19 100644 --- a/man/lenna.Rd +++ b/man/lenna.Rd @@ -3,7 +3,7 @@ \docType{data} \name{lenna} \alias{lenna} -\title{Photograp of Lenna} +\title{Photograph of Lenna} \format{an image of class \code{cimg}} \usage{ lenna diff --git a/man/resample.Rd b/man/resample.Rd index 4e5b759..5dd6ad9 100644 --- a/man/resample.Rd +++ b/man/resample.Rd @@ -7,15 +7,15 @@ resample(im, L = 1, L1 = L, L2 = L) } \arguments{ -\item{im}{cigm obect} +\item{im}{\code{cimg} object} -\item{L}{numeric indicating the overal scale change. This param will be -overided by L1 or L2} +\item{L}{numeric indicating the overall scale change. This param will be +override by L1 or L2} \item{L1, L2}{numeric indicating the directional scale change} } \value{ -A resampled cimg object +A resampled \code{cimg} object } \description{ Resampling of an image diff --git a/man/shift.Rd b/man/shift.Rd index b074430..1b512f4 100644 --- a/man/shift.Rd +++ b/man/shift.Rd @@ -10,7 +10,7 @@ shift(im, s) \item{im}{cimg object} \item{s}{numeric \code{p} by \code{2} matrix containing the registration -sameters} +parameters} } \value{ shifted cimg object diff --git a/man/transform.Rd b/man/transform.Rd index 2e3b479..9606b18 100644 --- a/man/transform.Rd +++ b/man/transform.Rd @@ -7,13 +7,13 @@ transform(im, s) } \arguments{ -\item{im}{cimg object} +\item{im}{\code{cimg} object} \item{s}{numeric \code{1} by \code{3} vector containing the registration sameters} } \value{ -shifted cimg object +shifted \code{cimg} object } \description{ Transform an image