EMAN2
cmp_template.h
Go to the documentation of this file.
1/*
2 * Author: Steven Ludtke, 04/10/2003 (sludtke@bcm.edu)
3 * Copyright (c) 2000-2006 Baylor College of Medicine
4 *
5 * This software is issued under a joint BSD/GNU license. You may use the
6 * source code in this file under either license. However, note that the
7 * complete EMAN2 and SPARX software packages have some GPL dependencies,
8 * so you are responsible for compliance with the licenses of these packages
9 * if you opt to use BSD licensing. The warranty disclaimer below holds
10 * in either instance.
11 *
12 * This complete copyright notice must be included in any revised version of the
13 * source code. Additional authorship citations may be added, but existing
14 * author citations must be preserved.
15 *
16 * This program is free software; you can redistribute it and/or modify
17 * it under the terms of the GNU General Public License as published by
18 * the Free Software Foundation; either version 2 of the License, or
19 * (at your option) any later version.
20 *
21 * This program is distributed in the hope that it will be useful,
22 * but WITHOUT ANY WARRANTY; without even the implied warranty of
23 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
24 * GNU General Public License for more details.
25 *
26 * You should have received a copy of the GNU General Public License
27 * along with this program; if not, write to the Free Software
28 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
29 *
30 * */
31
32#ifndef eman_cmp_template_h__
33#define eman_cmp_template_h__ 1
34
35#include "emdata.h"
36#include "cmp.h"
37
38namespace EMAN
39{
40
48 class XYZCmp:public Cmp
49 {
50 public:
51 float cmp(EMData * image, EMData * with) const;
52
53 string get_name() const
54 {
55 return NAME;
56 }
57
58 string get_desc() const
59 {
60 return "dot product using the center of the image";
61 }
62
63 static Cmp *NEW()
64 {
65 return new XYZCmp();
66 }
67
78 {
79 TypeDict d;
80 d.put("radius", EMObject::INT);
81 d.put("param2", EMObject::FLOAT);
82 return d;
83 }
84
85 static const string NAME;
86 };
87
90// class CmpFactoryExt
91// {
92// public:
93// CmpFactoryExt()
94// {
95// Factory < Cmp >::add<XYZCmp>();
96// }
97// };
98//
99// static CmpFactoryExt cf_ext;
100
101}
102
103#endif
Cmp class defines image comparison method.
Definition: cmp.h:82
EMData stores an image's data and defines core image processing routines.
Definition: emdata.h:82
TypeDict is a dictionary to store <string, EMObject::ObjectType> pair.
Definition: emobject.h:305
void put(const string &key, EMObject::ObjectType o, const string &desc="")
Definition: emobject.h:330
XYZCmp is a cmp template for defining new cmps.
Definition: cmp_template.h:49
static const string NAME
Definition: cmp_template.h:85
static Cmp * NEW()
Definition: cmp_template.h:63
TypeDict get_param_types() const
Add your cmp parameter names and types in get_param_types().
Definition: cmp_template.h:77
string get_desc() const
Definition: cmp_template.h:58
float cmp(EMData *image, EMData *with) const
To compare 'image' with another image passed in through its parameters.
string get_name() const
Get the Cmp's name.
Definition: cmp_template.h:53
E2Exception class.
Definition: aligner.h:40