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

06296                 {
06297                         return "Replace a source image as a square or cube depends on 2D or 3D of the source image";
06298                 }

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

06291                 {
06292                         return NAME;
06293                 }

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

References EMAN::TypeDict::put().

06306                 {
06307                         TypeDict d;
06308                         d.put("edge_length", EMObject::FLOAT, "edge length of the square or cube, unit: pixel");
06309                         d.put("axis", EMObject::STRING, "specify a major axis for asymmetric features");
06310                         d.put("odd_edge", EMObject::FLOAT, "edge length for the asymmetric axis");
06311                         d.put("fill", EMObject::INT, "Flag indicating if image is filled, default filled, 1 for filled, 0 for blank");
06312                         return d;
06313                 }

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

Definition at line 6300 of file processor.h.

06301                 {
06302                         return new TestImageSquarecube();
06303                 }

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

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

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


Member Data Documentation

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

Definition at line 208 of file processor.cpp.


The documentation for this class was generated from the following files:
Generated on Tue Jul 12 13:52:40 2011 for EMAN2 by  doxygen 1.3.9.1