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

EMAN::TestImageGradient Class Reference

Put a gradient in the image of the form y = mx+b : "x" is a string indicating any of the image axes, i.e., x,y or z. More...

#include <processor.h>

Inheritance diagram for EMAN::TestImageGradient:

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

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.gradient"

Detailed Description

Put a gradient in the image of the form y = mx+b : "x" is a string indicating any of the image axes, i.e., x,y or z.

Author:
David Woolford <woolford@bcm.edu>
Date:
01/10/2008
Parameters:
axis The axis the will be used to determine pixel values. Must be x,y or z. Default is x
m m in the equation m*axis+b. Default is 1.0
b b in the equation m*axis+b. Default is 0.0

Definition at line 5833 of file processor.h.


Member Function Documentation

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

05844                         {
05845                                 return "Make a gradient image of the form y=mx+b, where x is any of the image axes.";
05846                         }

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

05839                         {
05840                                 return NAME;
05841                         }

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

References EMAN::TypeDict::put().

05854                         {
05855                                 TypeDict d;
05856                                 d.put("axis", EMObject::STRING, "The axis the will be used to determine pixel values. Must be x,y or z");
05857                                 d.put("m", EMObject::FLOAT, "m in the equation m*axis+b. Default is 1.0");
05858                                 d.put("b", EMObject::FLOAT, "b in the equation m*axis+b. Default is 0.0");
05859                                 return d;
05860                         }

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

Definition at line 5848 of file processor.h.

05849                         {
05850                                 return new TestImageGradient();
05851                         }

void TestImageGradient::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 6982 of file processor.cpp.

References b, InvalidParameterException, EMAN::TestImageProcessor::preprocess(), EMAN::Dict::set_default(), EMAN::EMData::set_value_at(), and EMAN::EMData::update().

06983 {
06984         string axis = params.set_default("axis", "x");
06985 
06986         float m = params.set_default("m", 1.0f);
06987         float b = params.set_default("b", 0.0f);
06988 
06989         if ( axis != "z" && axis != "y" && axis != "x") throw InvalidParameterException("Axis must be x,y or z");
06990 
06991         preprocess(image);
06992 
06993         if ( axis == "x")
06994         {
06995                 for(int k=0; k<nz;++k) {
06996                         for(int j=0; j<ny; ++j) {
06997                                 for(int i=0; i <nx; ++i) {
06998                                         image->set_value_at(i,j,k,m*i+b);
06999                                 }
07000                         }
07001                 }
07002         }
07003         else if ( axis == "y")
07004         {
07005                 for(int k=0; k<nz;++k) {
07006                         for(int j=0; j<ny; ++j) {
07007                                 for(int i=0; i <nx; ++i) {
07008                                         image->set_value_at(i,j,k,m*j+b);
07009                                 }
07010                         }
07011                 }
07012         }
07013         else if ( axis == "z")
07014         {
07015                 for(int k=0; k<nz;++k) {
07016                         for(int j=0; j<ny; ++j) {
07017                                 for(int i=0; i <nx; ++i) {
07018                                         image->set_value_at(i,j,k,m*k+b);
07019                                 }
07020                         }
07021                 }
07022         }
07023         image->update();
07024 }


Member Data Documentation

const string TestImageGradient::NAME = "testimage.gradient" [static]
 

Definition at line 191 of file processor.cpp.


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