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

EMAN::TestImageSquarecube Class Reference

Replace a source image as a square or cube depends on 2D or 3D of the source image. More...

#include <processor.h>

Inheritance diagram for EMAN::TestImageSquarecube:

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

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

ProcessorNEW ()

Static Public Attributes

const string NAME = "testimage.squarecube"

Detailed Description

Replace a source image as a square or cube depends on 2D or 3D of the source image.

Parameters:
edge_length edge length of the square or cube
axis specify a major axis for asymmetric features
odd_edge edge length for the asymmetric axis
fill answer 'yes' or 'no' to specify if it's filled or hollow, default filled

Definition at line 6106 of file processor.h.


Member Function Documentation

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

06117                 {
06118                         return "Replace a source image as a square or cube depends on 2D or 3D of the source image";
06119                 }

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

06112                 {
06113                         return NAME;
06114                 }

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

References EMAN::TypeDict::put().

06127                 {
06128                         TypeDict d;
06129                         d.put("edge_length", EMObject::FLOAT, "edge length of the square or cube, unit: pixel");
06130                         d.put("axis", EMObject::STRING, "specify a major axis for asymmetric features");
06131                         d.put("odd_edge", EMObject::FLOAT, "edge length for the asymmetric axis");
06132                         d.put("fill", EMObject::INT, "Flag indicating if image is filled, default filled, 1 for filled, 0 for blank");
06133                         return d;
06134                 }

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

Definition at line 6121 of file processor.h.

06122                 {
06123                         return new TestImageSquarecube();
06124                 }

void TestImageSquarecube::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 7374 of file processor.cpp.

References EMAN::EMData::get_data(), InvalidValueException, nx, ny, EMAN::TestImageProcessor::preprocess(), and EMAN::EMData::update().

07375 {
07376         preprocess(image);
07377 
07378         float edge_length = params["edge_length"];
07379         string axis = (const char*)params["axis"];
07380         float odd_edge = params["odd_edge"];
07381         int fill = (int)params["fill"];
07382 
07383         float *dat = image->get_data();
07384         float x2, y2, z2; //this coordinates of this pixel from center
07385         float xEdge, yEdge, zEdge; //half of edge length for this cube
07386         if(axis == ""){
07387                 xEdge = edge_length/2.0f;
07388                 yEdge = edge_length/2.0f;
07389                 zEdge = edge_length/2.0f;
07390         }
07391         else if(axis == "x"){
07392                 xEdge = odd_edge/2.0f;
07393                 yEdge = edge_length/2.0f;
07394                 zEdge = edge_length/2.0f;
07395         }
07396         else if(axis == "y"){
07397                 xEdge = edge_length/2.0f;
07398                 yEdge = odd_edge/2.0f;
07399                 zEdge = edge_length/2.0f;
07400         }
07401         else if(axis == "z"){
07402                 if( nz == 1 ){
07403                         throw InvalidValueException(0, "This is a 2D image, no asymmetric feature for z axis");
07404                 }
07405                 xEdge = edge_length/2.0f;
07406                 yEdge = edge_length/2.0f;
07407                 zEdge = odd_edge/2.0f;
07408         }
07409         else{
07410                 throw InvalidValueException(0, "please specify a valid axis for asymmetric features");
07411         }
07412         for (int k = 0; k < nz; ++k) {
07413                 for (int j = 0; j < ny; ++j) {
07414                         for (int i = 0; i < nx; ++i, ++dat) {
07415                                 x2 = (float)fabs((float)i - nx/2);
07416                                 y2 = (float)fabs((float)j - ny/2);
07417                                 z2 = (float)fabs((float)k - nz/2);
07418                                 if( x2<=xEdge && y2<=yEdge && z2<=zEdge ) {
07419                                         if( !fill) {
07420                                                 *dat = 0;
07421                                         }
07422                                         else {
07423                                                 *dat = 1;
07424                                         }
07425                                 }
07426                                 else {
07427                                         if( !fill ) {
07428                                                 *dat = 1;
07429                                         }
07430                                         else {
07431                                                 *dat = 0;
07432                                         }
07433                                 }
07434                         }
07435                 }
07436         }
07437 
07438         image->update();
07439 }


Member Data Documentation

const string TestImageSquarecube::NAME = "testimage.squarecube" [static]
 

Definition at line 198 of file processor.cpp.


The documentation for this class was generated from the following files:
Generated on Thu Dec 9 13:48:23 2010 for EMAN2 by  doxygen 1.3.9.1