EMAN2
Public Member Functions | Static Public Member Functions | Static Public Attributes | Private Attributes
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().

{
}
XYZReconstructor::~XYZReconstructor ( )

Definition at line 42 of file reconstructor_template.cpp.

{
}

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.

{
        return image;
}
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.

                {
                        return "XYZ Description";
                }
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.

                {
                        return NAME;
                }
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().

                {
                        TypeDict d;
                          d.put("size", EMObject::INT);
                          d.put("padratio", EMObject::FLOAT);
                          d.put("snr", EMObject::FLOATARRAY);
                          return d;
                }
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.

{
        return 0;
}
static Reconstructor* EMAN::XYZReconstructor::NEW ( ) [inline, static]

Definition at line 75 of file reconstructor_template.h.

References XYZReconstructor().

                {
                        return new XYZReconstructor();
                }
void XYZReconstructor::setup ( ) [virtual]

initialize the reconstructor

Implements EMAN::Reconstructor.

Definition at line 46 of file reconstructor_template.cpp.

{
        
}

Member Data Documentation

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().

Definition at line 101 of file reconstructor_template.h.

Definition at line 102 of file reconstructor_template.h.

Definition at line 103 of file reconstructor_template.h.


The documentation for this class was generated from the following files: