EMAN::XYZReconstructor Class Reference

XYZReconstructor is a reconstructor template for defining new reconstructors. More...

#include <reconstructor_template.h>

Inheritance diagram for EMAN::XYZReconstructor:

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

Collaboration graph
[legend]
List of all members.

Public Member Functions

 XYZReconstructor ()
 ~XYZReconstructor ()
void setup ()
 initialize the reconstructor
int insert_slice (const EMData *const slice, const Transform &euler, const float weight)
 insert each image slice to the reconstructor.
EMDatafinish (bool doift)
 finish reconstruction and return the complete model.
string get_name () const
 Get the unique name of this class (especially for factory based instantiation access).
string get_desc () const
 Get a clear, concise description of this class.
TypeDict get_param_types () const
 Add your reconstructor parameter names and types in get_param_types().

Static Public Member Functions

static ReconstructorNEW ()

Static Public Attributes

static const string NAME = "xyz"

Private Attributes

EMDataimage
int nx
int ny
int nz

Detailed Description

XYZReconstructor is a reconstructor template for defining new reconstructors.

Please add your own code at the proper place.

1) Replace all 'XYZ' with your new reconstructor name. 2) Define the reconstructor parameter names and types in get_param_types(). 3) Implement the reconstructor in setup(), insert_slice(), and finish();

Definition at line 47 of file reconstructor_template.h.


Constructor & Destructor Documentation

XYZReconstructor::XYZReconstructor (  ) 

Definition at line 38 of file reconstructor_template.cpp.

Referenced by NEW().

00039 {
00040 }

XYZReconstructor::~XYZReconstructor (  ) 

Definition at line 42 of file reconstructor_template.cpp.

00043 {
00044 }


Member Function Documentation

EMData * XYZReconstructor::finish ( bool  doift  )  [virtual]

finish reconstruction and return the complete model.

Reimplemented from EMAN::Reconstructor.

Definition at line 56 of file reconstructor_template.cpp.

References image.

00057 {
00058         return image;
00059 }

string EMAN::XYZReconstructor::get_desc (  )  const [inline, virtual]

Get a clear, concise description of this class.

Returns:
a clear, concise description of this class

Implements EMAN::FactoryBase.

Definition at line 70 of file reconstructor_template.h.

00071                 {
00072                         return "XYZ Description";
00073                 }

string EMAN::XYZReconstructor::get_name (  )  const [inline, virtual]

Get the unique name of this class (especially for factory based instantiation access).

Returns:
the unique name of this class

Implements EMAN::FactoryBase.

Definition at line 66 of file reconstructor_template.h.

References NAME.

00067                 {
00068                         return NAME;
00069                 }

TypeDict EMAN::XYZReconstructor::get_param_types (  )  const [inline, virtual]

Add your reconstructor parameter names and types in get_param_types().

For available parameter types, please refer class EMObject.

As an example, XYZReconstructor has 3 parameters: int size; float patratio; vector<float> snr;

Implements EMAN::FactoryBase.

Definition at line 89 of file reconstructor_template.h.

References EMAN::EMObject::FLOAT, EMAN::EMObject::FLOATARRAY, EMAN::EMObject::INT, and EMAN::TypeDict::put().

00090                 {
00091                         TypeDict d;
00092                           d.put("size", EMObject::INT);
00093                           d.put("padratio", EMObject::FLOAT);
00094                           d.put("snr", EMObject::FLOATARRAY);
00095                           return d;
00096                 }

int XYZReconstructor::insert_slice ( const EMData *const   slice,
const Transform euler,
const float  weight 
) [virtual]

insert each image slice to the reconstructor.

You may call this function multiple times.

Reimplemented from EMAN::Reconstructor.

Definition at line 51 of file reconstructor_template.cpp.

00052 {
00053         return 0;
00054 }

static Reconstructor* EMAN::XYZReconstructor::NEW (  )  [inline, static]

Definition at line 75 of file reconstructor_template.h.

References XYZReconstructor().

00076                 {
00077                         return new XYZReconstructor();
00078                 }

void XYZReconstructor::setup (  )  [virtual]

initialize the reconstructor

Implements EMAN::Reconstructor.

Definition at line 46 of file reconstructor_template.cpp.

00047 {
00048         
00049 }


Member Data Documentation

EMData* EMAN::XYZReconstructor::image [private]

Definition at line 100 of file reconstructor_template.h.

Referenced by finish().

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

Definition at line 98 of file reconstructor_template.h.

Referenced by get_name().

int EMAN::XYZReconstructor::nx [private]

Definition at line 101 of file reconstructor_template.h.

int EMAN::XYZReconstructor::ny [private]

Definition at line 102 of file reconstructor_template.h.

int EMAN::XYZReconstructor::nz [private]

Definition at line 103 of file reconstructor_template.h.


The documentation for this class was generated from the following files:
Generated on Tue Jun 11 12:43:22 2013 for EMAN2 by  doxygen 1.4.7