EMAN::AddShapeProcessor Class Reference

Rotate by 180 using pixel swapping, works for 2D only. More...

#include <processor.h>

Inheritance diagram for EMAN::AddShapeProcessor:

Collaboration diagram for EMAN::AddShapeProcessor:

Public Member Functions
string	get_name () const
	Get the processor's name. More...
void	process_inplace (EMData *image)
	To process an image in-place. More...
TypeDict	get_param_types () const
	Get processor parameter information in a dictionary. More...
string	get_desc () const
	Get the descrition of this specific processor. 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

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

Rotate by 180 using pixel swapping, works for 2D only.

Author

David Woolford

Date

March 21, 2014

Definition at line 2716 of file processor.h.

Member Function Documentation

get_desc()

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

                        {
                                return "Adds a specified shape to a volume.";
                        }

get_name()

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

                        {
                                return NAME;
                        }

References NAME.

get_param_types()

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

                        {
                                TypeDict d;
                                d.put("shape", EMObject::STRING, "Name of the shape to add (");
                                d.put("x", EMObject::FLOAT, "X coordinate of object center");
                                d.put("y", EMObject::FLOAT, "Y coordinate of object center");
                                d.put("z", EMObject::FLOAT, "Z coordinate of object center");
                                d.put("size1", EMObject::FLOAT, "Size of the object. Meaning varies by shape.");
                                d.put("size2", EMObject::FLOAT, "2nd axis size of the object. Meaning varies by shape.");
                                d.put("size3", EMObject::FLOAT, "3rd axis size of the object. Meaning varies by shape.");
                                d.put("val1", EMObject::FLOAT, "First pixel value. Meaning varies by shape.");
                                d.put("val2", EMObject::FLOAT, "2nd pixel value. Meaning varies with shape");
 
                                return d;
                        }

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

NEW()

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

inlinestatic

Definition at line 2724 of file processor.h.

                        {
                                return new AddShapeProcessor();
                        }

process_inplace()

void EMAN::AddShapeProcessor::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.

Member Data Documentation

NAME

const string EMAN::AddShapeProcessor::NAME

static

Definition at line 2752 of file processor.h.

Referenced by get_name().

---

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

• processor.h