EMAN::TestImageAxes Class Reference

Make an image consisting of a single cross, with lines going in the axial directions, intersecting at the origin. More...

#include <processor.h>

Inheritance diagram for EMAN::TestImageAxes:

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

Collaboration graph
[legend]
List of all members.

Public Member Functions

virtual void process_inplace (EMData *image)
 Make an image where the axes (where x,y and z=0) are some nono zero value.
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.axes"

Detailed Description

Make an image consisting of a single cross, with lines going in the axial directions, intersecting at the origin.

Author:
David Woolford <woolford@bcm.edu>
Date:
October 2007
Parameters:
radius the radial length of the lines from the origin
fill the value to assign to pixels made non zero

Definition at line 6085 of file processor.h.


Member Function Documentation

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

06100                         {
06101                                 return "Make an image consisting of a single cross";
06102                         }

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

References NAME.

06095                         {
06096                                 return NAME;
06097                         }

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

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

06110                         {
06111                                 TypeDict d;
06112                                 d.put("int", EMObject::FLOAT, "radius of the lines emanating from the origin");
06113                                 d.put("fill", EMObject::FLOAT, "value to make non-zero pixels");
06114                                 return d;
06115                         }

static Processor* EMAN::TestImageAxes::NEW (  )  [inline, static]

Definition at line 6104 of file processor.h.

06105                         {
06106                                 return new TestImageAxes();
06107                         }

void TestImageAxes::process_inplace ( EMData image  )  [virtual]

Make an image where the axes (where x,y and z=0) are some nono zero value.

Parameters:
image the image to operate upon

Implements EMAN::Processor.

Definition at line 7128 of file processor.cpp.

References min, EMAN::Processor::params, EMAN::TestImageProcessor::preprocess(), EMAN::Dict::set_default(), and EMAN::EMData::update().

07129 {
07130         preprocess(image);
07131 
07132         float fill = params.set_default("fill", 1.0f);
07133         // get the central coordinates
07134         int cx = nx/2;
07135         int cy = ny/2;
07136         int cz = nz/2;
07137 
07138         // Offsets are used to detect when "the extra pixel" needs to be filled in
07139         // They are implemented on the assumption that for odd dimensions
07140         // the "center pixel" is the center pixel, but for even dimensions the "center
07141         // pixel" is displaced in the positive direction by 1
07142         int xoffset = (nx % 2 == 0? 1:0);
07143         int yoffset = (ny % 2 == 0? 1:0);
07144         int zoffset = (nz % 2 == 0? 1:0);
07145 
07146         // This should never occur - but if indeed it did occur, the code in this function
07147         // would break - the function would proceed into the final "else" and seg fault
07148         // It is commented out but left for clarity
07149 //      if ( nx < 1 || ny < 1 || nz < 1 ) throw ImageDimensionException("Error: one of the image dimensions was less than zero");
07150 
07151         if ( nx == 1 && ny == 1 && nz == 1 )
07152         {
07153                 (*image)(0) = fill;
07154         }
07155         else if ( ny == 1 && nz == 1 )
07156         {
07157                 int radius = params.set_default("radius", cx );
07158                 if ( radius > cx ) radius = cx;
07159 
07160                 (*image)(cx) = fill;
07161                 for ( int i = 1; i <= radius-xoffset; ++i ) (*image)(cx+i) = fill;
07162                 for ( int i = 1; i <= radius; ++i ) (*image)(cx-i) = fill;
07163         }
07164         else if ( nz == 1 )
07165         {
07166                 int min = ( nx < ny ? nx : ny );
07167                 min /= 2;
07168 
07169                 int radius = params.set_default("radius", min );
07170                 if ( radius > min ) radius = min;
07171 
07172                 (*image)(cx,cy) = fill;
07173 
07174                 for ( int i = 1; i <= radius-xoffset; ++i ) (*image)(cx+i,cy) = fill;
07175                 for ( int i = 1; i <= radius-yoffset; ++i )(*image)(cx,cy+i) = fill;
07176 
07177                 for ( int i = 1; i <= radius; ++i )
07178                 {
07179                         (*image)(cx-i,cy) = fill;
07180                         (*image)(cx,cy-i) = fill;
07181                 }
07182 
07183         }
07184         else
07185         {
07186                 // nx > 1 && ny > 1 && nz > 1
07187                 int min = ( nx < ny ? nx : ny );
07188                 if (nz < min ) min = nz;
07189                 min /= 2;
07190 
07191                 int radius = params.set_default("radius", min);
07192                 if ( radius > min ) radius = min;
07193 
07194 
07195                 (*image)(cx,cy,cz) = fill;
07196                 for ( int i = 1; i <=radius-xoffset; ++i ) (*image)(cx+i,cy,cz) = fill;
07197                 for ( int i = 1; i <=radius-yoffset; ++i ) (*image)(cx,cy+i,cz) = fill;
07198                 for ( int i = 1; i <=radius-zoffset; ++i ) (*image)(cx,cy,cz+i) = fill;
07199                 for ( int i = 1; i <= radius; ++i )
07200                 {
07201                         (*image)(cx-i,cy,cz) = fill;
07202                         (*image)(cx,cy-i,cz) = fill;
07203                         (*image)(cx,cy,cz-i) = fill;
07204                 }
07205         }
07206 
07207         image->update();
07208 }


Member Data Documentation

const string TestImageAxes::NAME = "testimage.axes" [static]

Definition at line 6117 of file processor.h.

Referenced by get_name().


The documentation for this class was generated from the following files:
Generated on Mon Jul 19 12:44:07 2010 for EMAN2 by  doxygen 1.4.7