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

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_onlyset to 1 only shift by integer, no interpolation

Definition at line 5461 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 5476 of file processor.h.

                        {
                                return "centers the image the center of mass, which is calculated using Fourier phases, ignores old dx, dy.";
                        }
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 5466 of file processor.h.

References NAME.

                        {
                                return NAME;
                        }
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 5481 of file processor.h.

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

                        {
                                TypeDict d;
                                d.put("int_shift_only", EMObject::INT, "set to 1 only shift by integer, no interpolation");
                                return d;
                        }
static Processor* EMAN::PhaseToMassCenterProcessor::NEW ( ) [inline, static]

Definition at line 5471 of file processor.h.

                        {
                                return new PhaseToMassCenterProcessor();
                        }
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:
imageThe image to be processed.

Implements EMAN::Processor.

Definition at line 6090 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(), EMAN::Transform::set_trans(), t, and EMAN::EMData::translate().

{
        if (!image) {
                LOGWARN("NULL Image");
                return;
        }

        int int_shift_only = params.set_default("int_shift_only",1);

        vector<float> pcog = image->phase_cog();

        int dims = image->get_ndim();

        if (int_shift_only) {
                int dx=-int(pcog[0]+0.5f),dy=0,dz=0;
                if ( dims >= 2 ) dy = -int(pcog[1]+0.5);
                if ( dims == 3 ) dz = -int(pcog[2]+0.5);

                Transform t;
                t.set_trans((float)dx,(float)dy,(float)dz);
                if (dims == 3) image->set_attr("xform.align3d",&t);
                else if (dims == 2) image->set_attr("xform.align2d",&t);

                image->translate(dx,dy,dz);
        } else  {
                float dx=-pcog[0],dy=0.0,dz=0.0;
                if ( dims >= 2 ) dy = -pcog[1];
                if ( dims == 3 ) dz = -pcog[2];
                image->translate(dx,dy,dz);

                Transform t;
                t.set_trans(dx,dy,dz);
                if (dims == 3) image->set_attr("xform.align3d",&t);
                else if (dims == 2) image->set_attr("xform.align2d",&t);
        }
}

Member Data Documentation

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

Definition at line 5488 of file processor.h.

Referenced by get_name().


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