EMAN2
averager_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_averager_template_h__
33#define eman_averager_template_h__ 1
34
35#include "averager.h"
36
37namespace EMAN
38{
39
47 class XYZAverager:public Averager
48 {
49 public:
51 void add_image( EMData * image);
52 EMData * finish();
53
54 string get_name() const
55 {
56 return NAME;
57 }
58
59 string get_desc() const
60 {
61 return "XYZ description";
62 }
63
64 static Averager *NEW()
65 {
66 return new XYZAverager();
67 }
68
79 {
80 TypeDict d;
81 d.put("param1", EMObject::EMDATA);
82 d.put("param2", EMObject::INT);
83 d.put("param3", EMObject::FLOAT);
84 return d;
85 }
86
87 static const string NAME;
88 private:
90 };
91
94// class AveragerFactoryExt
95// {
96// public:
97// AveragerFactoryExt()
98// {
99// Factory < Averager >::add<XYZAverager>();
100// }
101// };
102//
103// static AveragerFactoryExt averager_factory_ext;
104}
105
106#endif
Averager class defines a way to do averaging on a set of images.
Definition: averager.h:93
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
XYZAverager is an averager template for defining new averagers.
string get_name() const
Get the Averager's name.
EMData * finish()
Finish up the averaging and return the result.
static Averager * NEW()
void add_image(EMData *image)
To add an image to the Averager.
string get_desc() const
TypeDict get_param_types() const
Add your averager parameter names and types in get_param_types().
static const string NAME
E2Exception class.
Definition: aligner.h:40