EMAN::IntTranslateProcessor Class Reference
[a function or class that is CUDA enabled]

Translate the image an integer amount Uses EMData::clip_inplace (inplace) and EMData::get_clip (out of place) to do the translation. More...

#include <processor.h>

Inheritance diagram for EMAN::IntTranslateProcessor:

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

Collaboration graph
[legend]
List of all members.

Public Member Functions

virtual string get_name () const
 Get the processor's name.
virtual void process_inplace (EMData *image)
 
Exceptions:
ImageDimensionException if the image is not 1,2 or 3D
InvalidParameterException if the Transform parameter is not specified

virtual EMDataprocess (const EMData *const image)
 
Exceptions:
ImageDimensionException if the image is not 1,2 or 3D
InvalidParameterException if the Transform parameter is not specified

virtual TypeDict get_param_types () const
 Get processor parameter information in a dictionary.
virtual string get_desc () const
 Get the descrition of this specific processor.

Static Public Member Functions

static ProcessorNEW ()

Static Public Attributes

static const string NAME = "math.translate.int"

Private Member Functions

void assert_valid_aspect (const vector< int > &translation, const EMData *const image) const
 Check that the particular aspect is valid
Exceptions:
ImageDimensionException if the image is not 1,2 or 3D.

Region get_clip_region (vector< int > &translation, const EMData *const image) const
 Get the clip region that will achieve the desired translation
Exceptions:
ImageDimensionException if the image is not 1,2 or 3D.


Detailed Description

Translate the image an integer amount Uses EMData::clip_inplace (inplace) and EMData::get_clip (out of place) to do the translation.

Author:
David Woolford
Date:
March 2009
Parameters:
trans The displacement array, can be length 1-3

Definition at line 1370 of file processor.h.


Member Function Documentation

void IntTranslateProcessor::assert_valid_aspect ( const vector< int > &  translation,
const EMData *const   image 
) const [private]

Check that the particular aspect is valid

Exceptions:
ImageDimensionException if the image is not 1,2 or 3D.

Definition at line 8470 of file processor.cpp.

References InvalidParameterException.

Referenced by process(), and process_inplace().

08470                                                                                                          {
08471         if (translation.size() == 0 ) throw InvalidParameterException("You must specify the trans argument");
08472 }

Region IntTranslateProcessor::get_clip_region ( vector< int > &  translation,
const EMData *const   image 
) const [private]

Get the clip region that will achieve the desired translation

Exceptions:
ImageDimensionException if the image is not 1,2 or 3D.

Parameters:
translation the amount by which to translate
image the image that will eventually used for the translation operation

Definition at line 8474 of file processor.cpp.

References EMAN::EMData::get_ndim(), EMAN::EMData::get_xsize(), EMAN::EMData::get_ysize(), EMAN::EMData::get_zsize(), and ImageDimensionException.

Referenced by process(), and process_inplace().

08474                                                                                                        {
08475         unsigned int dim = static_cast<unsigned int> (image->get_ndim());
08476 
08477         if ( translation.size() != dim ) {
08478                 for(unsigned int i = translation.size(); i < dim; ++i ) translation.push_back(0);
08479         }
08480 
08481         Region clip_region;
08482         if (dim == 1) {
08483                 clip_region = Region(-translation[0],image->get_xsize());
08484         } else if ( dim == 2 ) {
08485                 clip_region = Region(-translation[0],-translation[1],image->get_xsize(),image->get_ysize());
08486         } else if ( dim == 3 ) {
08487                 clip_region = Region(-translation[0],-translation[1],-translation[2],image->get_xsize(),image->get_ysize(),image->get_zsize());
08488         } else throw ImageDimensionException("Only 1,2 and 3D images are supported");
08489 
08490         return clip_region;
08491 }

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

01403                         {
01404                                 return "The image is translated an integer amount";
01405                         }

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

References NAME.

01374                         {
01375                                 return NAME;
01376                         }

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

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

01396                         {
01397                                 TypeDict d;
01398                                 d.put("trans", EMObject::INTARRAY, "The displacement array, can be length 1-3" );
01399                                 return d;
01400                         }

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

Definition at line 1378 of file processor.h.

01379                         {
01380                                 return new IntTranslateProcessor();
01381                         }

EMData * IntTranslateProcessor::process ( const EMData *const   image  )  [virtual]

Exceptions:
ImageDimensionException if the image is not 1,2 or 3D
InvalidParameterException if the Transform parameter is not specified

Reimplemented from EMAN::Processor.

Definition at line 8506 of file processor.cpp.

References assert_valid_aspect(), EMAN::EMData::get_clip(), get_clip_region(), EMAN::Processor::params, and EMAN::Dict::set_default().

08506                                                                 {
08507 
08508         vector<int> translation = params.set_default("trans",vector<int>() );
08509 
08510         assert_valid_aspect(translation,image);
08511 
08512         Region clip_region = get_clip_region(translation,image);
08513 
08514         return image->get_clip(clip_region,0);
08515         // clip_inplace does the update!
08516 }

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

Exceptions:
ImageDimensionException if the image is not 1,2 or 3D
InvalidParameterException if the Transform parameter is not specified

Implements EMAN::Processor.

Definition at line 8493 of file processor.cpp.

References assert_valid_aspect(), EMAN::EMData::clip_inplace(), get_clip_region(), EMAN::Processor::params, and EMAN::Dict::set_default().

08493                                                          {
08494 
08495         vector<int> translation = params.set_default("trans",vector<int>() );
08496 
08497 
08498         assert_valid_aspect(translation,image);
08499 
08500         Region clip_region = get_clip_region(translation,image);
08501 
08502         image->clip_inplace(clip_region,0);
08503         // clip_inplace does the update!
08504 }


Member Data Documentation

const string IntTranslateProcessor::NAME = "math.translate.int" [static]

Definition at line 1407 of file processor.h.

Referenced by get_name().


The documentation for this class was generated from the following files:
Generated on Thu Mar 10 23:00:03 2011 for EMAN2 by  doxygen 1.4.7