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

EMAN::ApplySymProcessor Class Reference

Applies a symmetry to a 3D model. More...

#include <processor.h>

Inheritance diagram for EMAN::ApplySymProcessor:

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

Collaboration graph
[legend]
List of all members.

Public Member Functions

virtual string get_name () const
 Get the processor's name.
virtual void process_inplace (EMData *image)
 To process an image in-place.
virtual EMDataprocess (const EMData *const image)
 To proccess an image out-of-place.
virtual TypeDict get_param_types () const
 Get processor parameter information in a dictionary.
virtual string get_desc () const
 Get the descrition of this specific processor.

Static Public Member Functions

ProcessorNEW ()

Static Public Attributes

const string NAME = "xform.applysym"

Detailed Description

Applies a symmetry to a 3D model.

The model must be on aligned to its symmetry axis(via align3d or other mechanism)

Author:
Steve Ludtke and John Flanagan
Date:
June 2011
Parameters:
sym A string specifying the symmetry under which to do the alignment

Definition at line 1623 of file processor.h.


Member Function Documentation

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

Get the descrition of this specific processor.

This function must be overwritten by a subclass.

Returns:
The description of this processor.

Implements EMAN::Processor.

Definition at line 1647 of file processor.h.

01648                         {
01649                                 return "Symmetry is applied to the 3D EM object";
01650                         }

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

Get the processor's name.

Each processor is identified by a unique name.

Returns:
The processor's name.

Implements EMAN::Processor.

Definition at line 1626 of file processor.h.

01627                         {
01628                                 return NAME;
01629                         }

virtual TypeDict EMAN::ApplySymProcessor::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 from EMAN::Processor.

Definition at line 1640 of file processor.h.

References EMAN::TypeDict::put().

01641                         {
01642                                 TypeDict d;
01643                                 d.put("sym", EMObject::STRING, "The symmetry under which to do the alignment, Default=c1" );
01644                                 return d;
01645                         }

Processor* EMAN::ApplySymProcessor::NEW  )  [inline, static]
 

Definition at line 1631 of file processor.h.

01632                         {
01633                                 return new ApplySymProcessor();
01634                         }

EMData * ApplySymProcessor::process const EMData *const   image  )  [virtual]
 

To proccess an image out-of-place.

For those processors which can only be processed out-of-place, override this function to give the right behavior.

Parameters:
image The image will be copied, actual process happen on copy of image.
Returns:
the image processing result, may or may not be the same size of the input image

Reimplemented from EMAN::Processor.

Definition at line 887 of file processor.cpp.

References EMAN::Averager::add_image(), EMAN::Averager::finish(), EMAN::Factory< T >::get(), EMAN::Symmetry3D::get_syms(), EMAN::EMData::process(), EMAN::Dict::set_default(), and t.

00888 {
00889         Symmetry3D* sym = Factory<Symmetry3D>::get((string)params.set_default("sym","c1"));
00890         vector<Transform> transforms = sym->get_syms();
00891         
00892         Averager* imgavg = Factory<Averager>::get((string)params.set_default("avger","mean"));
00893         for(vector<Transform>::const_iterator trans_it = transforms.begin(); trans_it != transforms.end(); trans_it++) {
00894                 Transform t = *trans_it;
00895                 EMData* transformed = image->process("xform",Dict("transform",&t));
00896                 imgavg->add_image(transformed);
00897                 delete transformed;
00898         }
00899         return imgavg->finish();
00900 }

void ApplySymProcessor::process_inplace EMData image  )  [virtual]
 

To process an image in-place.

For those processors which can only be processed out-of-place, override this function to just print out some error message to remind user call the out-of-place version.

Parameters:
image The image to be processed.

Implements EMAN::Processor.

Definition at line 902 of file processor.cpp.

00903 {
00904         cout << "Not implemented yet" << endl;
00905 }


Member Data Documentation

const string ApplySymProcessor::NAME = "xform.applysym" [static]
 

Definition at line 89 of file processor.cpp.


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