albarji/proxTV

View on GitHub
src/condat_fast_tv.h

Summary

Maintainability
Test Coverage
/*
 #  File            : condat_fast_tv.c
 #
 #  Version            : proxTV 1.0, Dec. 18, 2012
 #
 #  Author            : Laurent Condat, PhD, CNRS research fellow in France.
 #                    Minor modifications by Alvaro Barbero.
 #
 #  Description     : This file contains an implementation in the C language
 #                      of algorithms described in the research paper:
 #
 #                       L. Condat, "A Direct Algorithm for 1D Total Variation
 #                      Denoising", preprint hal-00675043, Feb. 2012.
 #
 #                      This implementation comes with no warranty: due to the
 #                      limited number of tests performed, there may remain
 #                      bugs. In case the functions would not do what they are
 #                      supposed to do, please email the author (contact info
 #                      to be found on the web).
 #
 #                      If you use this code or parts of it for any purpose,
 #                      the author asks you to cite the paper above or, in
 #                      that event, its published version. Please email him if
 #                      the proposed algorithms were useful for one of your
 #                      projects, or for any comment or suggestion.
 #
 #  Usage rights    : Copyright Laurent Condat.
 #                      This file is distributed under the terms of the CeCILL
 #                      licence (compatible with the GNU GPL), which can be
 #                      found at the URL "http://www.cecill.info".
 #
 #  This software is governed by the CeCILL license under French law and
 #  abiding by the rules of distribution of free software. You can  use,
 #  modify and or redistribute the software under the terms of the CeCILL
 #  license as circulated by CEA, CNRS and INRIA at the following URL :
 #  "http://www.cecill.info".
 #
 #  As a counterpart to the access to the source code and rights to copy,
 #  modify and redistribute granted by the license, users are provided only
 #  with a limited warranty  and the software's author,  the holder of the
 #  economic rights,  and the successive licensors  have only  limited
 #  liability.
 #
 #  In this respect, the user's attention is drawn to the risks associated
 #  with loading,  using,  modifying and/or developing or reproducing the
 #  software by the user in light of its specific status of free software,
 #  that may mean  that it is complicated to manipulate,  and  that  also
 #  therefore means  that it is reserved for developers  and  experienced
 #  professionals having in-depth computer knowledge. Users are therefore
 #  encouraged to load and test the software's suitability as regards their
 #  requirements in conditions enabling the security of their systems and/or
 #  data to be ensured and,  more generally, to use and operate it in the
 #  same conditions as regards security.
 #
 #  The fact that you are presently reading this means that you have had
 #  knowledge of the CeCILL license and that you accept its terms.
*/
#ifndef _CONDAT_FAST_TV_H
#define _CONDAT_FAST_TV_H

#include <math.h>
#include <stdio.h>
#include <stdlib.h>


/*
This function implements the 1D total variation denoising
algorithm described in the paper referenced above.
If output=input, the process is performed in place. Else,
the values of input are left unchanged.
lambda must be nonnegative. lambda=0 is admissible and
yields output[k]=input[k] for all k.
If width<=0, nothing is done.
*/

extern "C" {

void TV1D_denoise(double* input, double* output, const int width, const double lambda);
void TV1D_denoise_tautstring(double* input, double* output, int width, const double lambda);

}

#endif