Generate an ellipse/ellipsoid image with an inner hollow ellipse/ellipsoid. More...

#include <processor.h>

Inheritance diagram for EMAN::TestImageHollowEllipse:

Collaboration diagram for EMAN::TestImageHollowEllipse:

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

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/ellipsoid image with an inner hollow ellipse/ellipsoid.

Parameters

xwidth	inner equatorial radii along x axes
ywidth	inner equatorial radii along y axes
zwidth	inner polar radius
a	outter equatorial radii along x axes
b	outter equatorial radii along y axes
c	outter polar radius
width	specify the width or specify each width explicitly - xwidth, ywidth, zwidth
transform	Optionally transform the ellipse
fill	value you want to fill in hollow ellipse, default to 1.0

Definition at line 8689 of file processor.h.

Member Function Documentation

◆ get_desc()

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

                        {
                                return "Insert a hollow ellipse into the image.";
                        }

◆ get_name()

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

                        {
                                return NAME;
                        }

References NAME.

◆ get_param_types()

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

                        {
                                TypeDict d;
                                d.put("xwidth", EMObject::FLOAT, "inner equatorial radii along x axes");
                                d.put("ywidth", EMObject::FLOAT, "inner equatorial radii along y axes");
                                d.put("zwidth", EMObject::FLOAT, "inner polar radius");
                                d.put("a", EMObject::FLOAT, "outter equatorial radii along x axes");
                                d.put("b", EMObject::FLOAT, "outter equatorial radii along y axes");
                                d.put("c", EMObject::FLOAT, "outter polar radius");
                                d.put("width",EMObject::FLOAT, "width - specify the width or specify each width explicitly - xwidth, ywidth, zwidth");
                                d.put("transform", EMObject::TRANSFORM, "Optionally transform the ellipse");
                                d.put("fill", EMObject::FLOAT, "value you want to fill in hollow ellipse, default to 1.0");
                                return d;
                        }

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

◆ NEW()

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

inlinestatic

Definition at line 8704 of file processor.h.

                        {
                                return new TestImageHollowEllipse();
                        }

◆ process_inplace()

void TestImageHollowEllipse::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 9881 of file processor.cpp.

{
        preprocess(image);
        image->to_zero();       // The testimage processors are supposed to replace the image contents
 
        float width = params.set_default("width",2.0f);
 
        float a2 = params.set_default("a",nx/2.0f-1.0f);
        float b2 = params.set_default("b",ny/2.0f-1.0f);
        float c2 = params.set_default("c",nz/2.0f-1.0f);
 
        float a1 = params.set_default("xwidth",a2-width);
        float b1 = params.set_default("ywidth",b2-width);
        float c1 = params.set_default("zwidth",c2-width);
 
        float fill = params.set_default("fill",1.0f);
        Transform* t;
        if (params.has_key("transform")) {
                t = params["transform"];
        } else {
                t = new Transform;
        }
 
 
        int mz = 2*(int)c2+1;
        if ( nz < mz ) mz = nz;
        int my = 2*(int)b2+1;
        if ( ny < my ) my = ny;
        int mx = 2*(int)a2+1;
        if ( nx < mx ) mx = nx;
 
        float ai1 = 1/(a1*a1);
        float bi1 = 1/(b1*b1);
        float ci1 = 1/(c1*c1);
 
        float ai2 = 1/(a2*a2);
        float bi2 = 1/(b2*b2);
        float ci2 = 1/(c2*c2);
 
        Vec3f origin(nx/2,ny/2,nz/2);
 
        float x2, y2, z2, r1,r2;
        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);
                                r1 = (x2*x2)*ai1 + (y2*y2)*bi1 + (z2*z2)*ci1;
                                r2 = (x2*x2)*ai2 + (y2*y2)*bi2 + (z2*z2)*ci2;
                                if (r2 <= 1 && r1 >= 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,1.0);
                                                                }
                                        } 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 TestImageHollowEllipse::NAME = "testimage.ellipsoid.hollow"

static

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