PLearn 0.1
SaltPepperNoiseVariable.h
Go to the documentation of this file.
00001 // -*- C++ -*-
00002 
00003 // SaltPepperNoiseVariable.h
00004 //
00005 // Copyright (C) 2009 Pascal Vincent
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 // Authors: Pascal Vincent
00036 
00040 #ifndef SaltPepperNoiseVariable_INC
00041 #define SaltPepperNoiseVariable_INC
00042 
00043 #include <plearn/var/UnaryVariable.h>
00044 #include <plearn/math/PRandom.h>
00045 
00046 namespace PLearn {
00047 using namespace std;
00048 
00061 class SaltPepperNoiseVariable : public UnaryVariable
00062 {
00063     typedef UnaryVariable inherited;
00064 
00065 public:
00066     //#####  Public Build Options  ############################################
00067 
00070     PP<PRandom> random_gen;
00071     real corruption_prob;
00072     real pepper_prob;
00073     real salt_value;
00074     real pepper_value;
00075 
00076 public:
00077     //#####  Public Member Functions  #########################################
00078 
00080     SaltPepperNoiseVariable();
00081 
00082     // ### If your class has parameters, you probably want a constructor that
00083     // ### initializes them
00084     // SaltPepperNoiseVariable(Variable* input, param_type the_parameter, ...);
00085 
00086     // Your other public member functions go here
00087 
00088     //#####  PLearn::Variable methods #########################################
00089     // (PLEASE IMPLEMENT IN .cc)
00090     virtual void recomputeSize(int& l, int& w) const;
00091     virtual void fprop();
00092     virtual void bprop();
00093 
00094     // ### These ones are not always implemented
00095     // virtual void bbprop();
00096     // virtual void symbolicBprop();
00097     // virtual void rfprop();
00098 
00099     //#####  PLearn::Object Protocol  #########################################
00100 
00101     // Declares other standard object methods.
00102     // ### If your class is not instantiatable (it has pure virtual methods)
00103     // ### you should replace this by PLEARN_DECLARE_ABSTRACT_OBJECT
00104     PLEARN_DECLARE_OBJECT(SaltPepperNoiseVariable);
00105 
00106     // Simply calls inherited::build() then build_()
00107     virtual void build();
00108 
00110     // (PLEASE IMPLEMENT IN .cc)
00111     virtual void makeDeepCopyFromShallowCopy(CopiesMap& copies);
00112 
00113 protected:
00114     //#####  Protected Options  ###############################################
00115 
00116     // ### Declare protected option fields (such as learned parameters) here
00117     // ...
00118     
00119     // will contain true where features have been corrupted 
00120     TVec<bool> corrupted;
00121 
00122 protected:
00123     //#####  Protected Member Functions  ######################################
00124 
00126     // (PLEASE IMPLEMENT IN .cc)
00127     static void declareOptions(OptionList& ol);
00128 
00129 private:
00130     //#####  Private Member Functions  ########################################
00131 
00133     // (PLEASE IMPLEMENT IN .cc)
00134     void build_();
00135 
00136 private:
00137     //#####  Private Data Members  ############################################
00138 
00139     // The rest of the private stuff goes here
00140 };
00141 
00142 // Declares a few other classes and functions related to this class
00143 DECLARE_OBJECT_PTR(SaltPepperNoiseVariable);
00144 
00145 // ### Put here a convenient method for building your variable.
00146 // ### e.g., if your class is TotoVariable, with two parameters foo_type foo
00147 // ### and bar_type bar, you could write:
00148 // inline Var toto(Var v, foo_type foo=default_foo, bar_type bar=default_bar)
00149 // { return new TotoVariable(v, foo, bar); }
00150 
00151 } // end of namespace PLearn
00152 
00153 #endif
00154 
00155 
00156 /*
00157   Local Variables:
00158   mode:c++
00159   c-basic-offset:4
00160   c-file-style:"stroustrup"
00161   c-file-offsets:((innamespace . 0)(inline-open . 0))
00162   indent-tabs-mode:nil
00163   fill-column:79
00164   End:
00165 */
00166 // 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