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

06202                 {
06203                         return "Replace a source image as a square or cube depends on 2D or 3D of the source image";
06204                 }

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

06197                 {
06198                         return NAME;
06199                 }

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

References EMAN::TypeDict::put().

06212                 {
06213                         TypeDict d;
06214                         d.put("edge_length", EMObject::FLOAT, "edge length of the square or cube, unit: pixel");
06215                         d.put("axis", EMObject::STRING, "specify a major axis for asymmetric features");
06216                         d.put("odd_edge", EMObject::FLOAT, "edge length for the asymmetric axis");
06217                         d.put("fill", EMObject::INT, "Flag indicating if image is filled, default filled, 1 for filled, 0 for blank");
06218                         return d;
06219                 }

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

Definition at line 6206 of file processor.h.

06207                 {
06208                         return new TestImageSquarecube();
06209                 }

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

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

07439 {
07440         preprocess(image);
07441 
07442         float edge_length = params["edge_length"];
07443         string axis = (const char*)params["axis"];
07444         float odd_edge = params["odd_edge"];
07445         int fill = 1;
07446         if(params.has_key("fill")) {
07447                 fill = (int)params["fill"];
07448         }
07449 
07450         float *dat = image->get_data();
07451         float x2, y2, z2; //this coordinates of this pixel from center
07452         float xEdge, yEdge, zEdge; //half of edge length for this cube
07453         if(axis == ""){
07454                 xEdge = edge_length/2.0f;
07455                 yEdge = edge_length/2.0f;
07456                 zEdge = edge_length/2.0f;
07457         }
07458         else if(axis == "x"){
07459                 xEdge = odd_edge/2.0f;
07460                 yEdge = edge_length/2.0f;
07461                 zEdge = edge_length/2.0f;
07462         }
07463         else if(axis == "y"){
07464                 xEdge = edge_length/2.0f;
07465                 yEdge = odd_edge/2.0f;
07466                 zEdge = edge_length/2.0f;
07467         }
07468         else if(axis == "z"){
07469                 if( nz == 1 ){
07470                         throw InvalidValueException(0, "This is a 2D image, no asymmetric feature for z axis");
07471                 }
07472                 xEdge = edge_length/2.0f;
07473                 yEdge = edge_length/2.0f;
07474                 zEdge = odd_edge/2.0f;
07475         }
07476         else{
07477                 throw InvalidValueException(0, "please specify a valid axis for asymmetric features");
07478         }
07479         for (int k = 0; k < nz; ++k) {
07480                 for (int j = 0; j < ny; ++j) {
07481                         for (int i = 0; i < nx; ++i, ++dat) {
07482                                 x2 = (float)fabs((float)i - nx/2);
07483                                 y2 = (float)fabs((float)j - ny/2);
07484                                 z2 = (float)fabs((float)k - nz/2);
07485                                 if( x2<=xEdge && y2<=yEdge && z2<=zEdge ) {
07486                                         if( !fill) {
07487                                                 *dat = 0;
07488                                         }
07489                                         else {
07490                                                 *dat = 1;
07491                                         }
07492                                 }
07493                                 else {
07494                                         if( !fill ) {
07495                                                 *dat = 1;
07496                                         }
07497                                         else {
07498                                                 *dat = 0;
07499                                         }
07500                                 }
07501                         }
07502                 }
07503         }
07504 
07505         image->update();
07506 }


Member Data Documentation

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

Definition at line 201 of file processor.cpp.


The documentation for this class was generated from the following files:
Generated on Thu Mar 10 23:01:00 2011 for EMAN2 by  doxygen 1.3.9.1