EMAN2
Public Member Functions | Static Public Member Functions | Static Public Attributes
EMAN::TestImageCirclesphere Class Reference

Replace a source image as a circle or sphere depends on 2D or 3D of the source image. More...

#include <processor.h>

Inheritance diagram for EMAN::TestImageCirclesphere:
Inheritance graph
[legend]
Collaboration diagram for EMAN::TestImageCirclesphere:
Collaboration graph
[legend]

List of all members.

Public Member Functions

virtual void process_inplace (EMData *image)
 To process an image in-place.
virtual string get_name () const
 Get the processor's name.
virtual string get_desc () const
 Get the descrition of this specific processor.
virtual TypeDict get_param_types () const
 Get processor parameter information in a dictionary.

Static Public Member Functions

static ProcessorNEW ()

Static Public Attributes

static const string NAME = "testimage.circlesphere"

Detailed Description

Replace a source image as a circle or sphere depends on 2D or 3D of the source image.

Parameters:
radiusradius of circle or sphere
axisspecify a major axis for asymmetric features
cdistance between focus and the center of an ellipse
fillanswer 'yes' or 'no' to specify if it's filled or hollow, default filled

Definition at line 6903 of file processor.h.


Member Function Documentation

virtual string EMAN::TestImageCirclesphere::get_desc ( ) const [inline, virtual]

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

                {
                        return "Replace a source image as a circle or sphere depends on 2D or 3D of the source image";
                }
virtual string EMAN::TestImageCirclesphere::get_name ( ) const [inline, virtual]

Get the processor's name.

Each processor is identified by a unique name.

Returns:
The processor's name.

Implements EMAN::Processor.

Definition at line 6908 of file processor.h.

References NAME.

                {
                        return NAME;
                }
virtual TypeDict EMAN::TestImageCirclesphere::get_param_types ( ) const [inline, virtual]

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

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

                {
                        TypeDict d;
                        d.put("radius", EMObject::FLOAT, "radius of circle or sphere, unit: pixel");
                        d.put("axis", EMObject::STRING, "specify a major axis for asymmetric features");
                        d.put("c", EMObject::FLOAT, "distance between focus and the center of an ellipse");
                        d.put("fill", EMObject::INT, "Flag indicating if image is filled, default filled, 1 for filled, 0 for blank.");
                        return d;
                }
static Processor* EMAN::TestImageCirclesphere::NEW ( ) [inline, static]

Definition at line 6918 of file processor.h.

                {
                        return new TestImageCirclesphere();
                }
void TestImageCirclesphere::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:
imageThe image to be processed.

Implements EMAN::Processor.

Definition at line 8214 of file processor.cpp.

References EMAN::EMData::get_data(), InvalidValueException, nx, ny, EMAN::Processor::params, EMAN::Dict::set_default(), and EMAN::EMData::update().

{
        preprocess(image);

        float radius = params.set_default("radius",nx/2.0f);
        string axis = (const char*)params["axis"];
        float c =  params.set_default("c",nx/2.0f);
        int fill = params.set_default("fill",1);

        float *dat = image->get_data();
        float x2, y2, z2; //this is coordinates of this pixel from center
        float r = 0.0f;
        float asy = 0.0f;
        if(axis == ""){
                asy = radius;
        }
        else if(axis == "x" || axis == "y"){
                asy = c;
        }
        else if(axis=="z"){
                if( nz == 1 ){
                        throw InvalidValueException(0, "This is a 2D image, no asymmetric feature for z axis");
                }
                asy = c;
        }
        else{
                throw InvalidValueException(0, "please specify a valid axis for asymmetric features");
        }

        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);
                                z2 = fabs((float)k - nz/2);
                                if( axis == "" ){
                                        r = (x2*x2)/(radius*radius) + (y2*y2)/(radius*radius) + (z2*z2)/(radius*radius);
                                }
                                else if (axis == "x"){
                                        r = (x2*x2)/(asy*asy) + (y2*y2)/(radius*radius) + (z2*z2)/(radius*radius);
                                }
                                else if(axis == "y"){
                                        r = (x2*x2)/(radius*radius) + (y2*y2)/(asy*asy) + (z2*z2)/(radius*radius);
                                }
                                else if(axis=="z"){
                                        r = (x2*x2)/(radius*radius) + (y2*y2)/(radius*radius) + (z2*z2)/(asy*asy);
                                }
                                if( r<=1 ) {
                                        if( !fill) {
                                                *dat = 0;
                                        }
                                        else {
                                                *dat = 1;
                                        }
                                }
                                else {
                                        if( !fill ) {
                                                *dat = 1;
                                        }
                                        else {
                                                *dat = 0;
                                        }
                                }
                        }
                }
        }

        image->update();
}

Member Data Documentation

const string TestImageCirclesphere::NAME = "testimage.circlesphere" [static]

Definition at line 6933 of file processor.h.

Referenced by get_name().


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