EMAN2
Public Member Functions | Static Public Member Functions | Static Public Attributes
EMAN::XYZProjector Class Reference

XYZProjector is an projector template for defining new projectors. More...

#include <projector_template.h>

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

List of all members.

Public Member Functions

EMDataproject3d (EMData *em) const
 Project an 3D image into a 2D image.
EMDatabackproject3d (EMData *em) const
 Back-project a 2D image into a 3D image.
string get_name () const
 Get the projector's name.
string get_desc () const
TypeDict get_param_types () const
 Add your projector parameter names and types in get_param_types().

Static Public Member Functions

static ProjectorNEW ()

Static Public Attributes

static const string NAME = "xyz"

Detailed Description

XYZProjector is an projector template for defining new projectors.

Please add your own code at the proper place.

1) Replace all 'XYZ' with your new projector name. 2) Define the projector parameter names and types in get_param_types(). 3) Implement the projector in XYZProjector::project3d().

Definition at line 48 of file projector_template.h.


Member Function Documentation

EMData * XYZProjector::backproject3d ( EMData image) const [virtual]

Back-project a 2D image into a 3D image.

Returns:
A 3D image from the backprojection.

Implements EMAN::Projector.

Definition at line 43 of file projector_template.cpp.

{
        return 0;
}
string EMAN::XYZProjector::get_desc ( ) const [inline, virtual]

Implements EMAN::Projector.

Definition at line 60 of file projector_template.h.

                {
                        return "XYZ Description";
                }
string EMAN::XYZProjector::get_name ( ) const [inline, virtual]

Get the projector's name.

Each projector is indentified by unique name.

Returns:
The projector's name.

Implements EMAN::Projector.

Definition at line 55 of file projector_template.h.

References NAME.

                {
                        return NAME;
                }
TypeDict EMAN::XYZProjector::get_param_types ( ) const [inline, virtual]

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

For available parameter types, please refer class EMObject.

As an example, XYZProjector has 2 parameters: float param1; int param2;

Reimplemented from EMAN::Projector.

Definition at line 77 of file projector_template.h.

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

                {
                        TypeDict d;
                          d.put("param1", EMObject::FLOAT);
                          d.put("param2", EMObject::INT);
                          return d;
                }
static Projector* EMAN::XYZProjector::NEW ( ) [inline, static]

Definition at line 65 of file projector_template.h.

                {
                        return new XYZProjector();
                }
EMData * XYZProjector::project3d ( EMData image) const [virtual]

Project an 3D image into a 2D image.

Returns:
A 2D image from the projection.

Implements EMAN::Projector.

Definition at line 39 of file projector_template.cpp.

{
        return 0;
}

Member Data Documentation

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

Definition at line 85 of file projector_template.h.

Referenced by get_name().


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