MaskAzProcessor masks out pixels within a specified cylindrical (or circular) arc. More...

#include <processor.h>

Inheritance diagram for EMAN::MaskAzProcessor:

Collaboration diagram for EMAN::MaskAzProcessor:

[legend]

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

string	get_name () const
	Get the processor's name. More...

string	get_desc () const
	Get the descrition of this specific processor. More...

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::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.cylinder"

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 Attributes inherited from EMAN::Processor
Dict	params

Detailed Description

MaskAzProcessor masks out pixels within a specified cylindrical (or circular) arc.

Parameters

phi1	angle in degrees ccw from the x-axis. Starting angle to be set to 0.
phi2	Ending angle to be set to 0
dx	Modify mask center by dx relative to the default center nx/2
dy	Modify mask center by dy relative to the default center ny/2

Definition at line 3667 of file processor.h.

Member Function Documentation

◆ get_desc()

string EMAN::MaskAzProcessor::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 3685 of file processor.h.

                {
                        return "Masks out an angular arc in circular/cylindrical coordinates with a sharp edge.";
                }

◆ get_name()

string EMAN::MaskAzProcessor::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 3678 of file processor.h.

                {
                        return NAME;
                }

References NAME.

◆ get_param_types()

TypeDict EMAN::MaskAzProcessor::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 3690 of file processor.h.

                {
                        TypeDict d;
 
                        d.put("phicen", EMObject::FLOAT,"Angle in degrees ccw from the x-axis. Center of the region to NOT set to zero.");
                        d.put("phirange", EMObject::FLOAT,"Angle in degrees. Region phicen+-phirange will not be zeroed");
                        d.put("phitrirange", EMObject::FLOAT,"Angle in degrees. With phitriangle, width outside phirange to fall from 1 to 0.");
                        d.put("phitriangle", EMObject::BOOL, "If set mask will fall from 1 at phicen+-phirange to 0 at +-phitrirange");
                        d.put("cx", EMObject::FLOAT,"Mask X center. Default nx/2");
                        d.put("cy", EMObject::FLOAT,"Mask Y center. Default ny/2");
                        d.put("zmin", EMObject::FLOAT,"Minimum Z to include");
                        d.put("zmax", EMObject::FLOAT,"Maximum Z to include");
                        d.put("ztriangle", EMObject::FLOAT,"1/2 width in pixels of linear falloff in Z margin. Centered on specified zmin/zmax.");
                        d.put("inner_radius", EMObject::INT, "inner mask radius. optional. Default 0");
                        d.put("outer_radius", EMObject::INT, "outer mask radius. optional. Default nx+ny. Negative value -> box radius + outer_radius +1");
 
                        return d;
                }

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

◆ NEW()

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

inlinestatic

Definition at line 3673 of file processor.h.

                {
                        return new MaskAzProcessor();
                }

◆ process_inplace()

void MaskAzProcessor::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 2336 of file processor.cpp.

                                                   {
        if (image->is_complex()) throw ImageFormatException("MaskAzProcessor: target image must be real");
 
        int nx=image->get_xsize();
        int ny=image->get_ysize();
        int nz=image->get_zsize();
 
        float phicen = params.set_default("phicen",0.0f)*M_PI/180.0;
        phicen=Util::angle_norm_pi(phicen);
        float phirange = params.set_default("phirange",180.0f)*M_PI/180.0;
        float phitrirange = params.set_default("phitrirange",0.0f)*M_PI/180.0;
        int phitriangle = params.set_default("phitriangle",0);
        float cx = params.set_default("cx",nx/2);
        float cy = params.set_default("cy",ny/2);
        float zmin = params.set_default("zmin",0);
        float zmax = params.set_default("zmax",nz);
        float ztri = params.set_default("ztriangle",0.0f);
        float inner_radius = params.set_default("inner_radius",0.0f);
        float outer_radius = params.set_default("outer_radius",nx+ny);
 
        for (int x=0; x<nx; x++) {
                for (int y=0; y<ny; y++) {
                        float az=atan2(y-cy,x-cx);
                        float az2=az-M_PI*2.0f;
                        float az3=az+M_PI*2.0f;
                        float r=hypot(y-cy,x-cx);
                        float val=0.0f;
                        if (r>inner_radius&&r<=outer_radius) {
                                float as=Util::angle_sub_2pi(az,phicen);
                                if (as<phirange) val=1.0f;
                                else if (!phitriangle || as>phirange+phitrirange) val=0.0f;
                                else val=1.0-(as-phirange)/float(phitrirange);
                        }
                        if (r==0 && inner_radius<=0)  val=1.0;
 
                        for (int z=0; z<nz; z++) {
                                if (z<zmin-ztri || z>zmax+ztri) image->mult_value_at_fast(x,y,z,0);
                                else if (z>=zmin+ztri && z<=zmax-ztri) image->mult_value_at_fast(x,y,z,val);
                                else if (z>=zmin-ztri && z<=zmin+ztri) image->mult_value_at_fast(x,y,z,val*((z-zmin)/(2.0f*ztri)+0.5));
                                else image->mult_value_at_fast(x,y,z,val*((zmax-z)/(2.0f*ztri)+0.5));
                        }
                }
        }
 
}

References EMAN::Util::angle_norm_pi(), EMAN::Util::angle_sub_2pi(), ImageFormatException, EMAN::Processor::params, EMAN::Dict::set_default(), x, and y.

Member Data Documentation

◆ NAME

const string MaskAzProcessor::NAME = "mask.cylinder"

static

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