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

EMAN::Projector Class Reference

Projector class defines a method to generate 2D projections from a 3D model. More...

#include <projector.h>

Inheritance diagram for EMAN::Projector:

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

Collaboration graph
[legend]
List of all members.

Public Member Functions

virtual ~Projector ()
virtual EMDataproject3d (EMData *image) const =0
 Project an 3D image into a 2D image.
virtual EMDatabackproject3d (EMData *image) const =0
 Back-project a 2D image into a 3D image.
virtual string get_name () const =0
 Get the projector's name.
virtual string get_desc () const =0
virtual Dict get_params () const
 Get the projector parameters in a key/value dictionary.
void set_params (const Dict &new_params)
 Set the projector parameters using a key/value dictionary.
virtual TypeDict get_param_types () const
 Get processor parameter information in a dictionary.

Protected Attributes

Dict params

Detailed Description

Projector class defines a method to generate 2D projections from a 3D model.

Projector class is the base class for all projectors. Each specific projector has a unique name and should be called through the name.

All Projector classes in EMAN are managed by a Factory pattern. So each Projector class must define:

Typical usage of Projectors:

Definition at line 81 of file projector.h.


Constructor & Destructor Documentation

virtual EMAN::Projector::~Projector  )  [inline, virtual]
 

Definition at line 84 of file projector.h.

00085                 {
00086                 }


Member Function Documentation

virtual EMData* EMAN::Projector::backproject3d EMData image  )  const [pure virtual]
 

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

Returns:
A 3D image from the backprojection.

Implemented in EMAN::XYZProjector, EMAN::GaussFFTProjector, EMAN::FourierGriddingProjector, EMAN::PawelProjector, EMAN::MaxValProjector, EMAN::StandardProjector, and EMAN::ChaoProjector.

Referenced by EMAN::EMData::backproject().

virtual string EMAN::Projector::get_desc  )  const [pure virtual]
 

Implemented in EMAN::XYZProjector, EMAN::GaussFFTProjector, EMAN::FourierGriddingProjector, EMAN::PawelProjector, EMAN::MaxValProjector, EMAN::StandardProjector, and EMAN::ChaoProjector.

virtual string EMAN::Projector::get_name  )  const [pure virtual]
 

Get the projector's name.

Each projector is indentified by unique name.

Returns:
The projector's name.

Implemented in EMAN::XYZProjector, EMAN::GaussFFTProjector, EMAN::FourierGriddingProjector, EMAN::PawelProjector, EMAN::MaxValProjector, EMAN::StandardProjector, and EMAN::ChaoProjector.

virtual TypeDict EMAN::Projector::get_param_types  )  const [inline, virtual]
 

Get processor parameter information in a dictionary.

Each parameter has one record in the dictionary. Each record contains its name, data-type, and description.

Returns:
A dictionary containing the parameter info.

Reimplemented in EMAN::XYZProjector, EMAN::GaussFFTProjector, EMAN::FourierGriddingProjector, EMAN::PawelProjector, EMAN::MaxValProjector, EMAN::StandardProjector, and EMAN::ChaoProjector.

Definition at line 125 of file projector.h.

00126                 {
00127                         TypeDict d;
00128                         return d;
00129                 }

virtual Dict EMAN::Projector::get_params  )  const [inline, virtual]
 

Get the projector parameters in a key/value dictionary.

return A key/value pair dictionary containing the parameters.

Definition at line 110 of file projector.h.

00111                 {
00112                         return params;
00113                 }

virtual EMData* EMAN::Projector::project3d EMData image  )  const [pure virtual]
 

Project an 3D image into a 2D image.

Returns:
A 2D image from the projection.

Implemented in EMAN::XYZProjector, EMAN::GaussFFTProjector, EMAN::FourierGriddingProjector, EMAN::PawelProjector, EMAN::MaxValProjector, EMAN::StandardProjector, and EMAN::ChaoProjector.

Referenced by EMAN::EMData::project().

void EMAN::Projector::set_params const Dict new_params  )  [inline]
 

Set the projector parameters using a key/value dictionary.

Reimplemented in EMAN::GaussFFTProjector.

Definition at line 115 of file projector.h.

00116                 {
00117                         params = new_params;
00118                 }


Member Data Documentation

Dict EMAN::Projector::params [protected]
 

Definition at line 132 of file projector.h.


The documentation for this class was generated from the following file:
Generated on Tue Jun 11 13:49:19 2013 for EMAN2 by  doxygen 1.3.9.1