EMAN2
averager_template.h
Go to the documentation of this file.
00001 /*
00002  * Author: Steven Ludtke, 04/10/2003 (sludtke@bcm.edu)
00003  * Copyright (c) 2000-2006 Baylor College of Medicine
00004  * 
00005  * This software is issued under a joint BSD/GNU license. You may use the
00006  * source code in this file under either license. However, note that the
00007  * complete EMAN2 and SPARX software packages have some GPL dependencies,
00008  * so you are responsible for compliance with the licenses of these packages
00009  * if you opt to use BSD licensing. The warranty disclaimer below holds
00010  * in either instance.
00011  * 
00012  * This complete copyright notice must be included in any revised version of the
00013  * source code. Additional authorship citations may be added, but existing
00014  * author citations must be preserved.
00015  * 
00016  * This program is free software; you can redistribute it and/or modify
00017  * it under the terms of the GNU General Public License as published by
00018  * the Free Software Foundation; either version 2 of the License, or
00019  * (at your option) any later version.
00020  * 
00021  * This program is distributed in the hope that it will be useful,
00022  * but WITHOUT ANY WARRANTY; without even the implied warranty of
00023  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
00024  * GNU General Public License for more details.
00025  * 
00026  * You should have received a copy of the GNU General Public License
00027  * along with this program; if not, write to the Free Software
00028  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
00029  * 
00030  * */
00031 
00032 #ifndef eman_averager_template_h__
00033 #define eman_averager_template_h__ 1
00034 
00035 #include "averager.h"
00036 
00037 namespace EMAN
00038 {
00039 
00047         class XYZAverager:public Averager
00048         {
00049         public:
00050                 XYZAverager();
00051                 void add_image( EMData * image);
00052                 EMData * finish();
00053 
00054                 string get_name() const
00055                 {
00056                         return NAME;
00057                 }
00058 
00059                 string get_desc() const
00060                 {
00061                         return "XYZ description";
00062                 }
00063 
00064                 static Averager *NEW()
00065                 {
00066                         return new XYZAverager();
00067                 }
00068 
00078                 TypeDict get_param_types() const
00079                 {
00080                         TypeDict d;
00081                         d.put("param1", EMObject::EMDATA);
00082                         d.put("param2", EMObject::INT);
00083                         d.put("param3", EMObject::FLOAT);
00084                         return d;
00085                 }
00086                 
00087                 static const string NAME;
00088         private:
00089                 EMData *result;
00090         };
00091 
00094 //      class AveragerFactoryExt
00095 //      {
00096 //      public:
00097 //              AveragerFactoryExt()
00098 //              {
00099 //                      Factory < Averager >::add<XYZAverager>();
00100 //              }
00101 //      };
00102 //
00103 //      static AveragerFactoryExt averager_factory_ext;
00104 }
00105 
00106 #endif