EMAN2
cmp_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_cmp_template_h__
00033 #define eman_cmp_template_h__ 1
00034 
00035 #include "emdata.h"
00036 #include "cmp.h"
00037 
00038 namespace EMAN
00039 {
00040 
00048         class XYZCmp:public Cmp
00049         {
00050           public:
00051                 float cmp(EMData * image, EMData * with) const;
00052 
00053                 string get_name() const
00054                 {
00055                         return NAME;
00056                 }
00057 
00058                 string get_desc() const
00059                 {
00060                         return "dot product using the center of the image";
00061                 }
00062 
00063                 static Cmp *NEW()
00064                 {
00065                         return new XYZCmp();
00066                 }
00067 
00077                 TypeDict get_param_types() const
00078                 {
00079                         TypeDict d;
00080                           d.put("radius", EMObject::INT);
00081                           d.put("param2", EMObject::FLOAT);
00082                           return d;
00083                 }
00084                 
00085                 static const string NAME;
00086         };
00087 
00090 //      class CmpFactoryExt
00091 //      {
00092 //        public:
00093 //              CmpFactoryExt()
00094 //              {
00095 //                      Factory < Cmp >::add<XYZCmp>();
00096 //              }
00097 //      };
00098 //
00099 //      static CmpFactoryExt cf_ext;
00100 
00101 }
00102 
00103 #endif