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:

[legend]
Collaboration diagram for EMAN::TestImageGradient:
[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 6005 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 6015 of file processor.h.

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

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

06011                         {
06012                                 return NAME;
06013                         }

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

References EMAN::TypeDict::put().

06026                         {
06027                                 TypeDict d;
06028                                 d.put("axis", EMObject::STRING, "The axis the will be used to determine pixel values. Must be x,y or z");
06029                                 d.put("m", EMObject::FLOAT, "m in the equation m*axis+b. Default is 1.0");
06030                                 d.put("b", EMObject::FLOAT, "b in the equation m*axis+b. Default is 0.0");
06031                                 return d;
06032                         }

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

Definition at line 6020 of file processor.h.

06021                         {
06022                                 return new TestImageGradient();
06023                         }

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

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

06947 {
06948         string axis = params.set_default("axis", "x");
06949 
06950         float m = params.set_default("m", 1.0f);
06951         float b = params.set_default("b", 0.0f);
06952 
06953         if ( axis != "z" && axis != "y" && axis != "x") throw InvalidParameterException("Axis must be x,y or z");
06954 
06955         preprocess(image);
06956 
06957         if ( axis == "x")
06958         {
06959                 for(int k=0; k<nz;++k) {
06960                         for(int j=0; j<ny; ++j) {
06961                                 for(int i=0; i <nx; ++i) {
06962                                         image->set_value_at(i,j,k,m*i+b);
06963                                 }
06964                         }
06965                 }
06966         }
06967         else if ( axis == "y")
06968         {
06969                 for(int k=0; k<nz;++k) {
06970                         for(int j=0; j<ny; ++j) {
06971                                 for(int i=0; i <nx; ++i) {
06972                                         image->set_value_at(i,j,k,m*j+b);
06973                                 }
06974                         }
06975                 }
06976         }
06977         else if ( axis == "z")
06978         {
06979                 for(int k=0; k<nz;++k) {
06980                         for(int j=0; j<ny; ++j) {
06981                                 for(int i=0; i <nx; ++i) {
06982                                         image->set_value_at(i,j,k,m*k+b);
06983                                 }
06984                         }
06985                 }
06986         }
06987         image->update();
06988 }


Member Data Documentation

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

Definition at line 196 of file processor.cpp.


The documentation for this class was generated from the following files:
Generated on Fri Apr 30 15:39:28 2010 for EMAN2 by  doxygen 1.3.9.1