EMAN::PhaseToMassCenterProcessor Class Reference
[unit test in Python]

ToMassCenterProcessor centers image at center of mass, ignores old dx, dy. More...

#include <processor.h>

Inheritance diagram for EMAN::PhaseToMassCenterProcessor:

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

Collaboration graph
[legend]
List of all members.

Public Member Functions

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

Static Public Member Functions

static ProcessorNEW ()

Static Public Attributes

static const string NAME = "xform.phasecenterofmass"

Detailed Description

ToMassCenterProcessor centers image at center of mass, ignores old dx, dy.

Parameters:
int_shift_only set to 1 only shift by integer, no interpolation

Definition at line 5091 of file processor.h.


Member Function Documentation

virtual string EMAN::PhaseToMassCenterProcessor::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 5106 of file processor.h.

05107                         {
05108                                 return "centers the image the center of mass, which is calculated using Fourier phases, ignores old dx, dy.";
05109                         }

virtual string EMAN::PhaseToMassCenterProcessor::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 5096 of file processor.h.

References NAME.

05097                         {
05098                                 return NAME;
05099                         }

virtual TypeDict EMAN::PhaseToMassCenterProcessor::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 5111 of file processor.h.

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

05112                         {
05113                                 TypeDict d;
05114                                 d.put("int_shift_only", EMObject::INT, "set to 1 only shift by integer, no interpolation");
05115                                 return d;
05116                         }

static Processor* EMAN::PhaseToMassCenterProcessor::NEW (  )  [inline, static]

Definition at line 5101 of file processor.h.

05102                         {
05103                                 return new PhaseToMassCenterProcessor();
05104                         }

void PhaseToMassCenterProcessor::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 5677 of file processor.cpp.

References EMAN::EMData::get_ndim(), LOGWARN, EMAN::Processor::params, EMAN::EMData::phase_cog(), EMAN::EMData::set_attr(), EMAN::Dict::set_default(), t, and EMAN::EMData::translate().

05678 {
05679         if (!image) {
05680                 LOGWARN("NULL Image");
05681                 return;
05682         }
05683 
05684         int int_shift_only = params.set_default("int_shift_only",1);
05685 
05686         vector<float> pcog = image->phase_cog();
05687 
05688         int dims = image->get_ndim();
05689 
05690         if (int_shift_only) {
05691                 int dx=-int(pcog[0]+0.5f),dy=0,dz=0;
05692                 if ( dims >= 2 ) dy = -int(pcog[1]+0.5);
05693                 if ( dims == 3 ) dz = -int(pcog[2]+0.5);
05694 
05695                 Transform t;
05696                 t.set_trans((float)dx,(float)dy,(float)dz);
05697                 if (dims == 3) image->set_attr("xform.align3d",&t);
05698                 else if (dims == 2) image->set_attr("xform.align2d",&t);
05699 
05700                 image->translate(dx,dy,dz);
05701         } else  {
05702                 float dx=-pcog[0],dy=0.0,dz=0.0;
05703                 if ( dims >= 2 ) dy = -pcog[1];
05704                 if ( dims == 3 ) dz = -pcog[2];
05705                 image->translate(dx,dy,dz);
05706 
05707                 Transform t;
05708                 t.set_trans(dx,dy,dz);
05709                 if (dims == 3) image->set_attr("xform.align3d",&t);
05710                 else if (dims == 2) image->set_attr("xform.align2d",&t);
05711         }
05712 }


Member Data Documentation

const string PhaseToMassCenterProcessor::NAME = "xform.phasecenterofmass" [static]

Definition at line 5118 of file processor.h.

Referenced by get_name().


The documentation for this class was generated from the following files:
Generated on Mon Jul 19 12:43:54 2010 for EMAN2 by  doxygen 1.4.7