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

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

#include <processor.h>

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

List of all members.

Public Member Functions

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

Static Public Member Functions

static ProcessorNEW ()

Static Public Attributes

static const string NAME

Detailed Description

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

Author:
David Woolford
Date:
March 21, 2014

Definition at line 1568 of file processor.h.


Member Function Documentation

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

                        {
                                return "Adds a specified shape to a volume.";
                        }
string EMAN::AddShapeProcessor::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 1571 of file processor.h.

References NAME.

                        {
                                return NAME;
                        }
TypeDict EMAN::AddShapeProcessor::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 1583 of file processor.h.

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

                        {
                                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;
                        }
static Processor* EMAN::AddShapeProcessor::NEW ( ) [inline, static]

Definition at line 1576 of file processor.h.

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

Implements EMAN::Processor.


Member Data Documentation

const string EMAN::AddShapeProcessor::NAME [static]

Definition at line 1604 of file processor.h.

Referenced by get_name().


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