#include <averager_template.h>
Inheritance diagram for EMAN::XYZAverager:
Public Member Functions | |
XYZAverager () | |
void | add_image (EMData *image) |
To add an image to the Averager. | |
EMData * | finish () |
Finish up the averaging and return the result. | |
string | get_name () const |
Get the Averager's name. | |
string | get_desc () const |
TypeDict | get_param_types () const |
Add your averager parameter names and types in get_param_types(). | |
Static Public Member Functions | |
static Averager * | NEW () |
Static Public Attributes | |
static const string | NAME = "xyz" |
Private Attributes | |
EMData * | result |
Please add your own code at the proper place.
1) Replace all 'XYZ' with your new averager name. 2) Define the averager parameter names and types in get_param_types(). 3) Implement the averager in XYZAverager::align().
Definition at line 47 of file averager_template.h.
XYZAverager::XYZAverager | ( | ) |
Definition at line 39 of file averager_template.cpp.
Referenced by NEW().
00039 : result(0) 00040 { 00041 }
void XYZAverager::add_image | ( | EMData * | image | ) | [virtual] |
To add an image to the Averager.
This image will be averaged in this function.
image | The image to be averaged. |
Implements EMAN::Averager.
Definition at line 43 of file averager_template.cpp.
References result.
EMData * XYZAverager::finish | ( | ) | [virtual] |
Finish up the averaging and return the result.
Implements EMAN::Averager.
Definition at line 52 of file averager_template.cpp.
References result.
00053 { 00054 return result; 00055 }
string EMAN::XYZAverager::get_desc | ( | ) | const [inline, virtual] |
string EMAN::XYZAverager::get_name | ( | ) | const [inline, virtual] |
Get the Averager's name.
Each Averager is identified by a unique name.
Implements EMAN::Averager.
Definition at line 54 of file averager_template.h.
References NAME.
00055 { 00056 return NAME; 00057 }
TypeDict EMAN::XYZAverager::get_param_types | ( | ) | const [inline, virtual] |
Add your averager parameter names and types in get_param_types().
For available parameter types, please refer class EMObject.
As an example, XYZAverager has 3 parameters: EMData *param1; int param2; float param3;
Reimplemented from EMAN::Averager.
Definition at line 78 of file averager_template.h.
References EMAN::EMObject::EMDATA, EMAN::EMObject::FLOAT, EMAN::EMObject::INT, and EMAN::TypeDict::put().
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 }
static Averager* EMAN::XYZAverager::NEW | ( | ) | [inline, static] |
Definition at line 64 of file averager_template.h.
References XYZAverager().
00065 { 00066 return new XYZAverager(); 00067 }
const string XYZAverager::NAME = "xyz" [static] |
EMData* EMAN::XYZAverager::result [private] |
Reimplemented from EMAN::Averager.
Definition at line 89 of file averager_template.h.
Referenced by add_image(), and finish().