source: src/hist.h @ 97525e4

feature/autosinkfeature/cnnfeature/cnn_orgfeature/constantqfeature/crepefeature/crepe_orgfeature/pitchshiftfeature/pydocstringsfeature/timestretchfix/ffmpeg5pitchshiftsamplertimestretchyinfft+
Last change on this file since 97525e4 was d88ea06, checked in by Paul Brossier <piem@altern.org>, 18 years ago

add some documentation
add some documentation

  • Property mode set to 100644
File size: 1.7 KB
Line 
1/*
2         Copyright (C) 2003 Paul Brossier
3
4         This program is free software; you can redistribute it and/or modify
5         it under the terms of the GNU General Public License as published by
6         the Free Software Foundation; either version 2 of the License, or
7         (at your option) any later version.
8
9         This program is distributed in the hope that it will be useful,
10         but WITHOUT ANY WARRANTY; without even the implied warranty of
11         MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12         GNU General Public License for more details.
13
14         You should have received a copy of the GNU General Public License
15         along with this program; if not, write to the Free Software
16         Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
17         */
18
19/** @file
20 *
21 * Histogram function
22 *
23 * Big hacks to implement an histogram
24 */
25
26#ifndef HIST_H
27#define HIST_H
28
29#ifdef __cplusplus
30extern "C" {
31#endif
32
33/** histogram object */
34typedef struct _aubio_hist_t aubio_hist_t;
35
36/** histogram creation
37 * \param flow minimum input
38 * \param fhig maximum input
39 * \param nelems number of histogram columns
40 * \param channels number of channels
41 */
42aubio_hist_t * new_aubio_hist(smpl_t flow, smpl_t fhig, uint_t nelems, uint_t channels);
43/** histogram deletion */
44void del_aubio_hist(aubio_hist_t *s);
45/** compute the histogram */
46void aubio_hist_do(aubio_hist_t *s, fvec_t * input);
47/** compute the histogram ignoring null elements */
48void aubio_hist_do_notnull(aubio_hist_t *s, fvec_t * input);
49/** compute the mean of the histogram */
50smpl_t aubio_hist_mean(aubio_hist_t *s); 
51/** weight the histogram */
52void aubio_hist_weigth(aubio_hist_t *s); 
53/** compute dynamic histogram for non-null elements */
54void aubio_hist_dyn_notnull (aubio_hist_t *s, fvec_t *input);
55
56#ifdef __cplusplus
57}
58#endif
59
60#endif
Note: See TracBrowser for help on using the repository browser.