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]

Public Member Functions
virtual void	process_inplace (EMData *image)
	To process an image in-place. More...

virtual string	get_name () const
	Get the processor's name. More...

virtual string	get_desc () const
	Get the descrition of this specific processor. More...

virtual TypeDict	get_param_types () const
	Get processor parameter information in a dictionary. More...

Public Member Functions inherited from EMAN::Processor
virtual	~Processor ()

virtual EMData *	process (const EMData *const image)
	To proccess an image out-of-place. More...

virtual void	process_list_inplace (vector< EMData * > &images)
	To process multiple images using the same algorithm. More...

virtual Dict	get_params () const
	Get the processor parameters in a key/value dictionary. More...

virtual void	set_params (const Dict &new_params)
	Set the processor parameters using a key/value dictionary. More...

Static Public Member Functions
static Processor *	NEW ()

Static Public Member Functions inherited from EMAN::TestImageProcessor
static string	get_group_desc ()

Static Public Member Functions inherited from EMAN::Processor
static string	get_group_desc ()
	Get the description of this group of processors. More...

static void	EMFourierFilterInPlace (EMData *fimage, Dict params)
	Compute a Fourier-filter processed image in place. More...

static EMData *	EMFourierFilter (EMData *fimage, Dict params)
	Compute a Fourier-processor processed image without altering the original image. More...

Static Public Attributes
static const string	NAME = "testimage.gradient"

Additional Inherited Members
Public Types inherited from EMAN::Processor
enum	fourier_filter_types { TOP_HAT_LOW_PASS , TOP_HAT_HIGH_PASS , TOP_HAT_BAND_PASS , TOP_HOMOMORPHIC , GAUSS_LOW_PASS , GAUSS_HIGH_PASS , GAUSS_BAND_PASS , GAUSS_INVERSE , GAUSS_HOMOMORPHIC , BUTTERWORTH_LOW_PASS , BUTTERWORTH_HIGH_PASS , BUTTERWORTH_HOMOMORPHIC , KAISER_I0 , KAISER_SINH , KAISER_I0_INVERSE , KAISER_SINH_INVERSE , SHIFT , TANH_LOW_PASS , TANH_HIGH_PASS , TANH_HOMOMORPHIC , TANH_BAND_PASS , RADIAL_TABLE , CTF_ }
	Fourier filter Processor type enum. More...

Protected Member Functions inherited from EMAN::TestImageProcessor
void	preprocess (EMData *image)

Protected Attributes inherited from EMAN::TestImageProcessor
int	nx

int	ny

int	nz

Protected Attributes inherited from EMAN::Processor
Dict	params

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 woolf.nosp@m.ord@.nosp@m.bcm.e.nosp@m.du

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

Member Function Documentation

◆ get_desc()

virtual string EMAN::TestImageGradient::get_desc ( ) const

inlinevirtual

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

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

◆ get_name()

virtual string EMAN::TestImageGradient::get_name ( ) const

inlinevirtual

Get the processor's name.

Each processor is identified by a unique name.

Returns: The processor's name.

Implements EMAN::Processor.

Definition at line 8336 of file processor.h.

                        {
                                return NAME;
                        }

References NAME.

◆ get_param_types()

virtual TypeDict EMAN::TestImageGradient::get_param_types ( ) const

inlinevirtual

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

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

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

◆ NEW()

static Processor * EMAN::TestImageGradient::NEW ( )

inlinestatic

Definition at line 8346 of file processor.h.

                        {
                                return new TestImageGradient();
                        }

◆ process_inplace()

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

{
        string axis = params.set_default("axis", "x");
 
        float m = params.set_default("m", 1.0f);
        float b = params.set_default("b", 0.0f);
 
        if ( axis != "z" && axis != "y" && axis != "x") throw InvalidParameterException("Axis must be x,y or z");
 
        preprocess(image);
 
        if ( axis == "x")
        {
                for(int k=0; k<nz;++k) {
                        for(int j=0; j<ny; ++j) {
                                for(int i=0; i <nx; ++i) {
                                        image->set_value_at(i,j,k,m*i+b);
                                }
                        }
                }
        }
        else if ( axis == "y")
        {
                for(int k=0; k<nz;++k) {
                        for(int j=0; j<ny; ++j) {
                                for(int i=0; i <nx; ++i) {
                                        image->set_value_at(i,j,k,m*j+b);
                                }
                        }
                }
        }
        else if ( axis == "z")
        {
                for(int k=0; k<nz;++k) {
                        for(int j=0; j<ny; ++j) {
                                for(int i=0; i <nx; ++i) {
                                        image->set_value_at(i,j,k,m*k+b);
                                }
                        }
                }
        }
        image->update();
}

References InvalidParameterException, EMAN::TestImageProcessor::nx, EMAN::TestImageProcessor::ny, EMAN::TestImageProcessor::nz, EMAN::Processor::params, EMAN::TestImageProcessor::preprocess(), and EMAN::Dict::set_default().

Member Data Documentation

◆ NAME

const string TestImageGradient::NAME = "testimage.gradient"

static

Definition at line 8360 of file processor.h.

Referenced by get_name().

The documentation for this class was generated from the following files:

Public Member Functions

Static Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ get_desc()

◆ get_name()

◆ get_param_types()

◆ NEW()

◆ process_inplace()

Member Data Documentation

◆ NAME