EMAN::IndexMaskFileProcessor Class Reference

Multiplies the image by the specified file using pixel indices. More...

#include <processor.h>

Inheritance diagram for EMAN::IndexMaskFileProcessor:

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

Collaboration graph
[legend]
List of all members.

Public Member Functions

virtual void process_inplace (EMData *image)
 To process an image in-place.
virtual string get_name () const
 Get the processor's name.
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 = "mask.fromfile"

Detailed Description

Multiplies the image by the specified file using pixel indices.

The images must be same size. If 'ismaskset=' is 1, it will take a file containing a set of masks and apply the first mask to the image.

Parameters:
filename mask image file name
ismaskset If set to 1, it will take a file containing a set of masks and apply the first mask to the image

Definition at line 5335 of file processor.h.


Member Function Documentation

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

05359                 {
05360                         return "Multiplies the image by the specified file using pixel indices. The images must be same size. If 'ismaskset=' is 1, it will take a file containing a set of masks and apply the first mask to the image.";
05361                 }

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

References NAME.

05341                 {
05342                         return NAME;
05343                 }

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

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

05351                 {
05352                         TypeDict d;
05353                         d.put("filename", EMObject::STRING, "mask image file name");
05354                         d.put("ismaskset", EMObject::INT, "If set to 1, it will take a file containing a set of masks and apply the first mask to the image");
05355                         return d;
05356                 }

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

Definition at line 5345 of file processor.h.

05346                 {
05347                         return new IndexMaskFileProcessor();
05348                 }

void IndexMaskFileProcessor::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 6080 of file processor.cpp.

References EMAN::EMUtil::is_same_size(), LOGERR, LOGWARN, EMAN::Processor::params, EMAN::EMData::process_inplace(), and EMAN::EMData::read_image().

06081 {
06082         if (!image) {
06083                 LOGWARN("NULL Image");
06084                 return;
06085         }
06086 
06087         const char *filename = params["filename"];
06088         EMData *msk = new EMData();
06089         msk->read_image(filename);
06090         if (!EMUtil::is_same_size(image, msk)) {
06091                 LOGERR("IndexMaskFileProcessor: Mask size different than image");
06092                 return;
06093         }
06094 
06095         if ((int) params["ismaskset"] != 0) {
06096                 msk->process_inplace("threshold.binaryrange", Dict("low", 0.5f, "high", 1.5f));
06097         }
06098 
06099         image->mult(*msk);
06100         if( msk )
06101         {
06102                 delete msk;
06103                 msk = 0;
06104         }
06105 }


Member Data Documentation

const string IndexMaskFileProcessor::NAME = "mask.fromfile" [static]

Definition at line 5363 of file processor.h.

Referenced by get_name().


The documentation for this class was generated from the following files:
Generated on Thu Nov 17 12:46:47 2011 for EMAN2 by  doxygen 1.4.7