PLearn 0.1
LimitedGaussianSmoother.h
Go to the documentation of this file.
00001 // -*- C++ -*-
00002 
00003 // LimitedGaussianSmoother.h
00004 // 
00005 // Copyright (C) 2002 Xavier Saint-Mleux
00006 // 
00007 // Redistribution and use in source and binary forms, with or without
00008 // modification, are permitted provided that the following conditions are met:
00009 // 
00010 //  1. Redistributions of source code must retain the above copyright
00011 //     notice, this list of conditions and the following disclaimer.
00012 // 
00013 //  2. Redistributions in binary form must reproduce the above copyright
00014 //     notice, this list of conditions and the following disclaimer in the
00015 //     documentation and/or other materials provided with the distribution.
00016 // 
00017 //  3. The name of the authors may not be used to endorse or promote
00018 //     products derived from this software without specific prior written
00019 //     permission.
00020 // 
00021 // THIS SOFTWARE IS PROVIDED BY THE AUTHORS ``AS IS'' AND ANY EXPRESS OR
00022 // IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
00023 // OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN
00024 // NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
00025 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
00026 // TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
00027 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
00028 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
00029 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00030 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00031 // 
00032 // This file is part of the PLearn library. For more information on the PLearn
00033 // library, go to the PLearn Web site at www.plearn.org
00034 
00035 /* *******************************************************      
00036  * $Id: LimitedGaussianSmoother.h 3994 2005-08-25 13:35:03Z chapados $ 
00037  ******************************************************* */
00038 
00040 #ifndef LimitedGaussianSmoother_INC
00041 #define LimitedGaussianSmoother_INC
00042 
00043 #include "Smoother.h"
00044 #include <cmath>
00045 
00046 namespace PLearn {
00047 using namespace std;
00048 
00049 
00050 // smoothed_function[k] = sum_{j=max(0,k-window_size)}^{min(l-1,k+window_size)} w_{k,j} source_function[j]
00051 //                        / sum_{j=max(0,k-window_size)}^{min(l-1,k+window_size)} w_{k,j} 
00052 // with w_{k,j} = phi(bin_positions[j+1];mu_k,sigma_k)-phi(bin_positions[j];mu_k,sigma_k)
00053 // where mu_k = 0.5*(bin_positions[k+1]+bin_positions[k]),
00054 //       sigma_k = bin_positions[k+window_size]-bin_positions[k]
00055 // where phi(x;mu,sigma) = cdf of normal(mu,sigma) at x,
00056 // window_size = window_size_wrt_sigma * sigma_bin
00057 
00058 class LimitedGaussianSmoother: public Smoother
00059 {
00060 protected:
00061     // *********************
00062     // * protected options *
00063     // *********************
00064 
00065     real window_size_wrt_sigma, sigma_bin;
00066 
00067     
00068 public:
00069 
00070     typedef Smoother inherited;
00071 
00072     // ************************
00073     // * public build options *
00074     // ************************
00075 
00076     // ### declare public option fields (such as build options) here
00077     // ...
00078 
00079     // ****************
00080     // * Constructors *
00081     // ****************
00082 
00083     // Default constructor, make sure the implementation in the .cc
00084     // initializes all fields to reasonable default values.
00085     LimitedGaussianSmoother();
00086 
00087 
00088     LimitedGaussianSmoother(real window_size_wrt_sigma_, real sigma_bin_);
00089 
00090 
00091     // ******************
00092     // * Object methods *
00093     // ******************
00094 
00095 private: 
00097     // (Please implement in .cc)
00098     void build_();
00099 
00100 protected: 
00102     // (Please implement in .cc)
00103     static void declareOptions(OptionList& ol);
00104 
00105 public:
00106     // simply calls inherited::build() then build_() 
00107     virtual void build();
00108 
00110     virtual void makeDeepCopyFromShallowCopy(CopiesMap& copies);
00111 
00113     PLEARN_DECLARE_OBJECT(LimitedGaussianSmoother);
00114 
00115 
00116     /****
00117      * Smoother methods
00118      */
00119 
00120 public:
00121     virtual real smooth(const Vec& source_function, Vec& smoothed_function, 
00122                         Vec bin_positions = Vec(), Vec dest_bin_positions = Vec()) const;
00123 
00124 
00125 };
00126 
00127 // Declares a few other classes and functions related to this class
00128 DECLARE_OBJECT_PTR(LimitedGaussianSmoother);
00129   
00130 } // end of namespace PLearn
00131 
00132 #endif
00133 
00134 
00135 /*
00136   Local Variables:
00137   mode:c++
00138   c-basic-offset:4
00139   c-file-style:"stroustrup"
00140   c-file-offsets:((innamespace . 0)(inline-open . 0))
00141   indent-tabs-mode:nil
00142   fill-column:79
00143   End:
00144 */
00145 // vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:encoding=utf-8:textwidth=79 :
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines