EMAN::FlipProcessor Class Reference

flip an image around an axis More...

#include <processor.h>

Inheritance diagram for EMAN::FlipProcessor:

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

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 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

static ProcessorNEW ()

Static Public Attributes

static const string NAME = "xform.flip"

Detailed Description

flip an image around an axis

Parameters:
axis 'x', 'y', or 'z' axis. 'x' means horizonal flip; 'y' means vertical flip;

Definition at line 4534 of file processor.h.


Member Function Documentation

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

04557                 {
04558                         return "Mirrors an image along the specified axis, preserving the center. This will introduce a plane of 0's for even box sizes. Use 'xform.mirror' processor to avoid the zero plane, but not preserve the center.";
04559                 }

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

References NAME.

04540                 {
04541                         return NAME;
04542                 }

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

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

04550                 {
04551                         TypeDict d;
04552                         d.put("axis", EMObject::STRING, "'x', 'y', or 'z' axis.");
04553                         return d;
04554                 }

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

Definition at line 4544 of file processor.h.

04545                 {
04546                         return new FlipProcessor();
04547                 }

void FlipProcessor::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 4315 of file processor.cpp.

References ENTERFUNC, EXITFUNC, EMAN::EMData::get_data(), EMAN::EMData::get_xsize(), EMAN::EMData::get_ysize(), EMAN::EMData::get_zsize(), LOGWARN, EMAN::Processor::params, EMAN::EMData::process_inplace(), t, EMAN::EMData::update(), and x.

04316 {
04317         ENTERFUNC;
04318         if (!image) {
04319                 LOGWARN("NULL Image");
04320                 return;
04321         }
04322         string axis = (const char*)params["axis"];
04323         
04324 #ifdef EMAN2_USING_CUDA
04325         if (EMData::usecuda == 1 && image->getcudarwdata()) {
04326                 //cout << "flip processor" << endl;
04327                 float array[12] = {1.0, 0.0, 0.0, 0.0,
04328                                                    0.0, 1.0, 0.0, 0.0,
04329                                                    0.0, 0.0, 1.0, 0.0};
04330                 if (axis == "x" || axis == "X") {               // horizontal flip
04331                         array[0] = -1.0;
04332                 }else if (axis == "y" || axis == "Y") {         // vertical flip
04333                         array[5] = -1.0;
04334                 }
04335                 else if (axis == "z" || axis == "Z") {          // vertical flip
04336                         array[10] = -1.0;
04337                 }
04338                 Transform t(array);
04339                 Dict params("transform",(Transform*)&t);
04340                 image->process_inplace("xform",params);
04341 
04342                 EXITFUNC;
04343                 return;
04344         }
04345 #endif
04346 
04347 
04348         float *d = image->get_data();
04349         int nx = image->get_xsize();
04350         int ny = image->get_ysize();
04351         int nz = image->get_zsize();
04352 
04353         size_t nxy = nx * ny;
04354 
04355 
04356         // Note in all cases the origin is nx/2, ny/2 and nz/2
04357         // This means when flipping even sized dimensions that some pixels are redundant.
04358         // Here redundant pixels are set to zero, however, should this change to something
04359         // like the mean.
04360         if (axis == "x" || axis == "X") {               // Horizontal flip
04361                 int offset = (nx%2 == 0);
04362                 size_t idx1, idx2;
04363                 for(int z = 0; z < nz; ++z) {
04364                         for(int y = 0; y < ny; ++y) {
04365                                 if (offset != 0 ) {
04366                                         idx1 = z*nxy + y*nx;
04367                                         d[idx1] = 0; // Here's where you'd make it the mean
04368                                 }
04369                                 for(int x = offset; x < nx / 2; ++x) {
04370                                         idx1 = z*nxy + y*nx + x;
04371                                         idx2 = z*nxy + y*nx + (nx-x-1+offset);
04372                                         std::swap(d[idx1], d[idx2]);
04373                                 }
04374 
04375                         }
04376                 }
04377         }
04378 
04379         else if (axis == "y" || axis == "Y") {          // vertical flip
04380                 int offset = (ny%2 == 0);
04381                 for(int z=0; z<nz; ++z) {
04382                         if (offset != 0) {
04383                                 std::fill(d+z*nxy,d+(size_t)z*nxy+nx,0); // So if we have change it to the mean it's easy to do so. (instead of using memset)
04384                         }
04385                         for(int y=offset; y<ny/2; ++y) {
04386                                 for(int x=0; x<nx; ++x) {
04387                                         std::swap(d[(size_t)z*nxy + y*nx +x], d[(size_t)z*nxy + (ny -y -1+offset)*nx +x]);
04388                                 }
04389                         }
04390                 }
04391         }
04392         else if (axis == "z" || axis == "Z") {          //z axis flip
04393                 int offset = (nz%2 == 0);
04394                 if (offset != 0) {
04395                         std::fill(d,d+nxy,0);// So if we have change it to the mean it's easy to do so. (instead of using memset)
04396                 }
04397                 size_t idx1, idx2;
04398                 for(int z=offset; z<nz/2; ++z) {
04399                         for(int y=0; y<ny; ++y) {
04400                                 for(int x=0; x<nx; ++x) {
04401                                         idx1 = (size_t)z*nxy + y*nx + x;
04402                                         idx2 = (size_t)(nz-z-1+offset)*nxy + y*nx + x;
04403                                         std::swap(d[idx1], d[idx2]);
04404                                 }
04405                         }
04406                 }
04407         }
04408 
04409         image->update();
04410         EXITFUNC;
04411 }


Member Data Documentation

const string FlipProcessor::NAME = "xform.flip" [static]

Definition at line 4561 of file processor.h.

Referenced by get_name().


The documentation for this class was generated from the following files:
Generated on Thu Nov 17 12:46:38 2011 for EMAN2 by  doxygen 1.4.7