Multiplies the image by the specified file using pixel coordinates instead of pixel indices. More...

#include <processor.h>

Inheritance diagram for EMAN::PaintProcessor:

Collaboration diagram for EMAN::PaintProcessor:

[legend]

Public Member Functions
	PaintProcessor ()

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

virtual void	set_params (const Dict &new_params)
	Set the processor parameters using a key/value 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...

Static Public Member Functions
static Processor *	NEW ()

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 = "mask.paint"

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

Protected Attributes
int	x

int	y

int	z

int	r1

float	v1

int	r2

float	v2

Protected Attributes inherited from EMAN::Processor
Dict	params

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

Detailed Description

Multiplies the image by the specified file using pixel coordinates instead of pixel indices.

The images can be different size.

Parameters

filename	mask image file name 'paints' a circle into the image at x,y,z with values inside r1 set to v1, values between r1 and r2 will be set to a value between v1 and v2, and values outside r2 will be unchanged
x	x coordinate for Center of circle
y	y coordinate for Center of circle
z	z coordinate for Center of circle
r1	Inner radius
v1	Inner value
r2	Outter radius
v2	Outer Value

Definition at line 7581 of file processor.h.

Constructor & Destructor Documentation

◆ PaintProcessor()

EMAN::PaintProcessor::PaintProcessor ( )

inline

Definition at line 7584 of file processor.h.

                                :x(0), y(0), z(0),r1(0), v1(0.0), r2(0), v2(0.0)
                {
                }

Referenced by NEW().

Member Function Documentation

◆ get_desc()

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

                {
                        return "Paints a circle with a decaying edge into the image. r<r1 -> v1, r1<r<r2 -> (v1,v2), r>r2 unchanged";
                }

◆ get_name()

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

                {
                        return NAME;
                }

References NAME.

◆ get_param_types()

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

                {
                        TypeDict d;
                        d.put("x", EMObject::INT, "x coordinate for Center of circle");
                        d.put("y", EMObject::INT, "y coordinate for Center of circle");
                        d.put("z", EMObject::INT, "z coordinate for Center of circle");
                        d.put("r1", EMObject::INT, "Inner radius");
                        d.put("v1", EMObject::FLOAT, "Inner value");
                        d.put("r2", EMObject::INT, "Outter radius");
                        d.put("v2", EMObject::FLOAT, "Outer Value");
                        return d;
                }

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

◆ NEW()

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

inlinestatic

Definition at line 7593 of file processor.h.

                {
                        return new PaintProcessor();
                }

References PaintProcessor().

◆ process_inplace()

void PaintProcessor::process_inplace ( EMData * image )

protectedvirtual

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

                                                  {
        int nx=image->get_xsize();
        int ny=image->get_ysize();
        int nz=image->get_zsize();
 
        if (nz==1) {
                float r;
                for (int j=(y<r2?0:y-r2); j<(y+r2>ny?ny:y+r2); j++) {
                        for (int i=(x<r2?0:x-r2); i<(x+r2>nx?nx:x+r2); i++) {
                                r=sqrt(float(Util::square(i-x)+Util::square(j-y)));
                                if (r>r2 && r>r1) continue;
                                if (r>r1) image->set_value_at(i,j,0,v2*(r-r1)/(r2-r1)+v1*(r2-r)/(r2-r1));
                                else image->set_value_at(i,j,0,v1);
                        }
                }
        }
        else {
                float r;
                for (int k=(z<r2?0:z-r2); k<(z+r2>nz?nz:z+r2); k++) {
                        for (int j=(y<r2?0:y-r2); j<(y+r2>ny?ny:y+r2); j++) {
                                for (int i=(x<r2?0:x-r2); i<(x+r2>nx?nx:x+r2); i++) {
                                r=sqrt(float(Util::square(i-x)+Util::square(j-y)+Util::square(k-z)));
                                if (r>r2 && r>r1) continue;
                                if (r>r1) image->set_value_at(i,j,k,v2*(r-r1)/(r2-r1)+v1*(r2-r)/(r2-r1));
                                else image->set_value_at(i,j,k,v1);
                                }
                        }
                }
        }
        image->update();
}

References r1, r2, sqrt(), EMAN::Util::square(), v1, v2, x, y, and z.

◆ set_params()

virtual void EMAN::PaintProcessor::set_params ( const Dict & new_params )

inlinevirtual

Set the processor parameters using a key/value dictionary.

Parameters

new_params A dictionary containing the new parameters.

Reimplemented from EMAN::Processor.

Definition at line 7616 of file processor.h.

                {
                        params = new_params;
 
                        if (params.has_key("x")) x = params["x"];
                        if (params.has_key("y")) y = params["y"];
                        if (params.has_key("z")) z = params["z"];
                        if (params.has_key("r1")) r1 = params["r1"];
                        if (params.has_key("r2")) r2 = params["r2"];
                        if (params.has_key("v1")) v1 = params["v1"];
                        if (params.has_key("v2")) v2 = params["v2"];
                }