EMAN::TestImageDisc Class Reference

Replace source image with a disc (generalized cylinder) More...

#include <processor.h>

Inheritance diagram for EMAN::TestImageDisc:

Collaboration diagram for EMAN::TestImageDisc:

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

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

Replace source image with a disc (generalized cylinder)

Parameters

a	major axis length for face of disc
b	minor axis length for face of disc
height	height for the cylinder, by default it's the nz

Definition at line 8884 of file processor.h.

Member Function Documentation

get_desc()

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

                {
                        return "Replace source image with a disc";
                }

get_name()

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

                {
                        return NAME;
                }

References NAME.

get_param_types()

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

                {
                        TypeDict d;
                        d.put("major", EMObject::FLOAT, "major axis length for face of disc");
                        d.put("minor", EMObject::FLOAT, "major axis length for face of disc");
                        d.put("height", EMObject::FLOAT, "height of disc, by default it's nz");
                        return d;
                }

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

NEW()

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

inlinestatic

Definition at line 8899 of file processor.h.

                {
                        return new TestImageDisc();
                }

process_inplace()

void TestImageDisc::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 10130 of file processor.cpp.

{
        preprocess(image);
 
        int nx = image->get_xsize();
        int ny = image->get_ysize();
        int nz = image->get_zsize();
 
        if(nz == 1) {
                throw ImageDimensionException("This processor only works on 3D images");
        }
 
        float a = params["major"];
 
        if(a > Util::get_min(nx, ny)/2.0) {
                throw InvalidValueException(a, "major must be <= min(nx, ny)/2");
        }
 
        float b = params["minor"];
 
        if(b > Util::get_min(nx, ny)/2.0) {
                throw InvalidValueException(b, "minor must be <= min(nx, ny)/2");
        }
 
        float h;
        if(params.has_key("height")) {
                h = params["height"];
                if(h > nz) {
                        throw InvalidValueException(h, "height must be <= nz");
                }
        }
        else {
                h = static_cast<float>(nz);
        }
 
        float *dat = image->get_data();
        float x2, y2; //this is coordinates of this pixel from center axle
        float r = 0.0f;
        for (int k = 0; k < nz; ++k) {
                for (int j = 0; j < ny; ++j) {
                        for (int i = 0; i < nx; ++i, ++dat) {
                                x2 = fabs((float)i - nx/2);
                                y2 = fabs((float)j - ny/2);
                                r = (x2*x2)/(a*a) + (y2*y2)/(b*b);
                                if(r<=1 && k>=(nz-h)/2 && k<=(nz+h)/2) {
                                        *dat = 1;
                                }
                                else {
                                        *dat = 0;
                                }
                        }
                }
        }
 
        image->update();
}

References EMAN::Util::get_min(), EMAN::Dict::has_key(), ImageDimensionException, InvalidValueException, EMAN::TestImageProcessor::nx, EMAN::TestImageProcessor::ny, EMAN::TestImageProcessor::nz, EMAN::Processor::params, and EMAN::TestImageProcessor::preprocess().

Member Data Documentation

NAME

const string TestImageDisc::NAME = "testimage.disc"

static

Definition at line 8913 of file processor.h.

Referenced by get_name().

---

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

• processor.h
• processor.cpp