PLearn 0.1
MaxSubsamplingTest.h
Go to the documentation of this file.
00001 // -*- C++ -*-
00002 
00003 // MaxSubsamplingTest.h
00004 //
00005 // Copyright (C) 2007 Pascal Lamblin
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 Lamblin
00036 
00040 #ifndef MaxSubsamplingTest_INC
00041 #define MaxSubsamplingTest_INC
00042 
00043 #include <plearn/misc/PTest.h>
00044 #include <plearn/math/PRandom.h>
00045 #include <plearn_learners/online/MaxSubsampling2DModule.h>
00046 
00047 namespace PLearn {
00048 
00052 class MaxSubsamplingTest : public PTest
00053 {
00054     typedef PTest inherited;
00055 
00056 public:
00057     //#####  Public Build Options  ############################################
00058 
00059     // ### declare public option fields (such as build options) here
00060     // Start your comments with Doxygen-compatible comments such as //!
00061     // ### Typically, a PTest options are used to store the test results.
00062 
00063     int batch_size;
00064     int n_input_images;
00065     int input_images_length;
00066     int input_images_width;
00067     int kernel_length;
00068     int kernel_width;
00069 
00070 public:
00071     //#####  Public Member Functions  #########################################
00072 
00074     // ### Make sure the implementation in the .cc
00075     // ### initializes all fields to reasonable default values.
00076     MaxSubsamplingTest();
00077 
00078     // Your other public member functions go here
00079 
00080 
00081     //#####  PLearn::Object Protocol  #########################################
00082 
00083     // Declares other standard object methods.
00084     // ### If your class is not instantiatable (it has pure virtual methods)
00085     // ### you should replace this by PLEARN_DECLARE_ABSTRACT_OBJECT
00086     PLEARN_DECLARE_OBJECT(MaxSubsamplingTest);
00087 
00088     // Simply calls inherited::build() then build_()
00089     virtual void build();
00090 
00092     // (PLEASE IMPLEMENT IN .cc)
00093     virtual void makeDeepCopyFromShallowCopy(CopiesMap& copies);
00094 
00095     //#####  PLearn::PTest Protocol  ##########################################
00096 
00099     virtual void perform();
00100 
00101 protected:
00102     //#####  Protected Options  ###############################################
00103 
00104     // ### Declare protected option fields (such as learned parameters) here
00105     int output_images_length;
00106     int output_images_width;
00107     int input_images_size;
00108     int output_images_size;
00109     int input_size;
00110     int output_size;
00111 
00112     PP<MaxSubsampling2DModule> max_module;
00113     PP<PRandom> random_gen;
00114 
00115 protected:
00116     //#####  Protected Member Functions  ######################################
00117 
00119     // (PLEASE IMPLEMENT IN .cc)
00120     static void declareOptions(OptionList& ol);
00121 
00122 private:
00123     //#####  Private Member Functions  ########################################
00124 
00126     // (PLEASE IMPLEMENT IN .cc)
00127     void build_();
00128 
00129 private:
00130     //#####  Private Data Members  ############################################
00131 
00132     // The rest of the private stuff goes here
00133 };
00134 
00135 // Declares a few other classes and functions related to this class
00136 DECLARE_OBJECT_PTR(MaxSubsamplingTest);
00137 
00138 } // end of namespace PLearn
00139 
00140 #endif
00141 
00142 
00143 /*
00144   Local Variables:
00145   mode:c++
00146   c-basic-offset:4
00147   c-file-style:"stroustrup"
00148   c-file-offsets:((innamespace . 0)(inline-open . 0))
00149   indent-tabs-mode:nil
00150   fill-column:79
00151   End:
00152 */
00153 // 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