Main Page | Modules | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Namespace Members | Class Members | File Members

EMAN::XYZAverager Class Reference

XYZAverager is an averager template for defining new averagers. More...

#include <averager_template.h>

Inheritance diagram for EMAN::XYZAverager:

Inheritance graph
[legend]
Collaboration diagram for EMAN::XYZAverager:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 XYZAverager ()
void add_image (EMData *image)
 To add an image to the Averager.
EMDatafinish ()
 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

AveragerNEW ()

Static Public Attributes

const string NAME = "xyz"

Private Attributes

EMDataresult

Detailed Description

XYZAverager is an averager template for defining new averagers.

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.


Constructor & Destructor Documentation

XYZAverager::XYZAverager  ) 
 

Definition at line 39 of file averager_template.cpp.

00039                          : result(0)
00040 {
00041 }


Member Function Documentation

void XYZAverager::add_image EMData image  )  [virtual]
 

To add an image to the Averager.

This image will be averaged in this function.

Parameters:
image The image to be averaged.

Implements EMAN::Averager.

Definition at line 43 of file averager_template.cpp.

References result.

00044 {
00045         if (!image) {
00046                 return;
00047         }
00048         result = new EMData();
00049 }

EMData * XYZAverager::finish  )  [virtual]
 

Finish up the averaging and return the result.

Returns:
The averaged image.

Implements EMAN::Averager.

Definition at line 52 of file averager_template.cpp.

00053 {
00054         return result;
00055 }

string EMAN::XYZAverager::get_desc  )  const [inline, virtual]
 

Implements EMAN::Averager.

Definition at line 59 of file averager_template.h.

00060                 {
00061                         return "XYZ description";
00062                 }

string EMAN::XYZAverager::get_name  )  const [inline, virtual]
 

Get the Averager's name.

Each Averager is identified by a unique name.

Returns:
The Averager's name.

Implements EMAN::Averager.

Definition at line 54 of file averager_template.h.

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::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                 }

Averager* EMAN::XYZAverager::NEW  )  [inline, static]
 

Definition at line 64 of file averager_template.h.

00065                 {
00066                         return new XYZAverager();
00067                 }


Member Data Documentation

const string XYZAverager::NAME = "xyz" [static]
 

Definition at line 37 of file averager_template.cpp.

EMData* EMAN::XYZAverager::result [private]
 

Reimplemented from EMAN::Averager.

Definition at line 89 of file averager_template.h.

Referenced by add_image().


The documentation for this class was generated from the following files:
Generated on Tue Jun 11 13:48:12 2013 for EMAN2 by  doxygen 1.3.9.1