Generate an ellipse or ellipsoid image. More...

#include <processor.h>

Inheritance diagram for EMAN::TestImageEllipse:

Collaboration diagram for EMAN::TestImageEllipse:

[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.ellipsoid"

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

Generate an ellipse or ellipsoid image.

Parameters

a	equatorial radii along x axes
b	equatorial radii along y axes
c	polar radius
transform	Optionally transform the ellipse
fill	value you want to fill in ellipse, default to 1.0

Definition at line 8644 of file processor.h.

Member Function Documentation

◆ get_desc()

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

                {
                        return "Insert an ellipse into the image.";
                }

◆ get_name()

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

                {
                        return NAME;
                }

References NAME.

◆ get_param_types()

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

                {
                        TypeDict d;
                        d.put("a", EMObject::FLOAT, "equatorial radius along x axes (major semiaxes)");
                        d.put("b", EMObject::FLOAT, "equatorial radius along y axes (minor semiaxes)");
                        d.put("c", EMObject::FLOAT, "polar radius for ellipsoid (x^2/a^2+y^2/b^2+z^2/c^2=1)");
                        d.put("transform", EMObject::TRANSFORM, "Optionally transform the ellipse");
                        d.put("fill", EMObject::FLOAT, "value you want to fill in ellipse, default to 1.0");
                        return d;
                }

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

◆ NEW()

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

inlinestatic

Definition at line 8659 of file processor.h.

                {
                        return new TestImageEllipse();
                }

◆ process_inplace()

void TestImageEllipse::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 9964 of file processor.cpp.

{
        preprocess(image);
        image->to_zero();       // The testimage processors are supposed to replace the image contents
 
 
        float a = params.set_default("a",nx/2.0f-1.0f);
        float b = params.set_default("b",ny/2.0f-1.0f);
        float c = params.set_default("c",nz/2.0f-1.0f);
        float fill = params.set_default("fill",1.0f);
        //bool hollow = params.set_default("hollow",false);
        Transform* t;
        if (params.has_key("transform")) {
                t = params["transform"];
        } else {
                t = new Transform;
        }
 
 
        int mz = 2*(int)c+1;
        if ( nz < mz ) mz = nz;
        int my = 2*(int)b+1;
        if ( ny < my ) my = ny;
        int mx = 2*(int)a+1;
        if ( nx < mx ) mx = nx;
 
 
        float ai = 1/(a*a);
        float bi = 1/(b*b);
        float ci = 1/(c*c);
 
        Vec3f origin(nx/2,ny/2,nz/2);
 
        float x2, y2, z2, r;
        int xl, yl, zl;
        for (int k = 0; k < mz; ++k) {
                for (int j = 0; j < my; ++j) {
                        for (int i = 0; i < mx; ++i) {
                                x2 = (float)(i - mx/2);
                                y2 = (float)(j - my/2);
                                z2 = (float)(k - mz/2);
                                r = (x2*x2)*ai + (y2*y2)*bi + (z2*z2)*ci;
                                if (r <= 1) {
 
                                        if (t != 0) {
                                                Vec3f v(x2,y2,z2);
                                                v = (*t)*v;
                                                v += origin;
 
                                                // THIS ISN'T THE BEST STRATEGY BUT IT'S A STOP GAP. A FLOOD FILL IS PROBABLY BETTER
                                                // I fill in 3x3 cubes to make sure there are no gaps...
 
                                                for( int kk = -1; kk <= 1; ++kk)
                                                        for( int jj = -1; jj <= 1; ++jj)
                                                                for( int ii = -1; ii <= 1; ++ii) {
                                                                        xl = (int)v[0]+ii;
                                                                        yl = (int)v[1]+jj;
                                                                        zl = (int)v[2]+kk;
                                                                        if (xl >= 0 && xl < nx && yl >= 0 && yl < ny && zl >= 0 && zl < nz)
                                                                                image->set_value_at(xl,yl,zl,fill);
                                                                }
                                        } else {
                                                image->set_value_at((int)x2+nx/2,(int)y2+ny/2,(int)z2+nz/2,fill);
                                        }
                                }
                        }
                }
        }
 
        delete t;
 
        image->update();
}

References EMAN::Dict::has_key(), 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 TestImageEllipse::NAME = "testimage.ellipsoid"

static

Definition at line 8675 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