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

static ProcessorNEW ()

Static Public Attributes

static 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 6319 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 6329 of file processor.h.

06330                 {
06331                         return "Replace a source image as a square or cube depends on 2D or 3D of the source image";
06332                 }

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 6324 of file processor.h.

References NAME.

06325                 {
06326                         return NAME;
06327                 }

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 6339 of file processor.h.

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

06340                 {
06341                         TypeDict d;
06342                         d.put("edge_length", EMObject::FLOAT, "edge length of the square or cube, unit: pixel");
06343                         d.put("axis", EMObject::STRING, "specify a major axis for asymmetric features");
06344                         d.put("odd_edge", EMObject::FLOAT, "edge length for the asymmetric axis");
06345                         d.put("fill", EMObject::INT, "Flag indicating if image is filled, default filled, 1 for filled, 0 for blank");
06346                         return d;
06347                 }

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

Definition at line 6334 of file processor.h.

06335                 {
06336                         return new TestImageSquarecube();
06337                 }

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 7476 of file processor.cpp.

References EMAN::EMData::get_data(), InvalidValueException, EMAN::Processor::params, EMAN::TestImageProcessor::preprocess(), and EMAN::EMData::update().

07477 {
07478         preprocess(image);
07479 
07480         float edge_length = params["edge_length"];
07481         string axis = (const char*)params["axis"];
07482         float odd_edge = params["odd_edge"];
07483         int fill = (int)params["fill"];
07484 
07485         float *dat = image->get_data();
07486         float x2, y2, z2; //this coordinates of this pixel from center
07487         float xEdge, yEdge, zEdge; //half of edge length for this cube
07488         if(axis == ""){
07489                 xEdge = edge_length/2.0f;
07490                 yEdge = edge_length/2.0f;
07491                 zEdge = edge_length/2.0f;
07492         }
07493         else if(axis == "x"){
07494                 xEdge = odd_edge/2.0f;
07495                 yEdge = edge_length/2.0f;
07496                 zEdge = edge_length/2.0f;
07497         }
07498         else if(axis == "y"){
07499                 xEdge = edge_length/2.0f;
07500                 yEdge = odd_edge/2.0f;
07501                 zEdge = edge_length/2.0f;
07502         }
07503         else if(axis == "z"){
07504                 if( nz == 1 ){
07505                         throw InvalidValueException(0, "This is a 2D image, no asymmetric feature for z axis");
07506                 }
07507                 xEdge = edge_length/2.0f;
07508                 yEdge = edge_length/2.0f;
07509                 zEdge = odd_edge/2.0f;
07510         }
07511         else{
07512                 throw InvalidValueException(0, "please specify a valid axis for asymmetric features");
07513         }
07514         for (int k = 0; k < nz; ++k) {
07515                 for (int j = 0; j < ny; ++j) {
07516                         for (int i = 0; i < nx; ++i, ++dat) {
07517                                 x2 = (float)fabs((float)i - nx/2);
07518                                 y2 = (float)fabs((float)j - ny/2);
07519                                 z2 = (float)fabs((float)k - nz/2);
07520                                 if( x2<=xEdge && y2<=yEdge && z2<=zEdge ) {
07521                                         if( !fill) {
07522                                                 *dat = 0;
07523                                         }
07524                                         else {
07525                                                 *dat = 1;
07526                                         }
07527                                 }
07528                                 else {
07529                                         if( !fill ) {
07530                                                 *dat = 1;
07531                                         }
07532                                         else {
07533                                                 *dat = 0;
07534                                         }
07535                                 }
07536                         }
07537                 }
07538         }
07539 
07540         image->update();
07541 }


Member Data Documentation

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

Definition at line 6349 of file processor.h.

Referenced by get_name().


The documentation for this class was generated from the following files:
Generated on Mon Jul 19 13:07:25 2010 for EMAN2 by  doxygen 1.4.4