Main Page | Modules | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Namespace Members | Class Members | File Members

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

ProcessorNEW ()

Static Public Attributes

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 5421 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 5444 of file processor.h.

05445                 {
05446                         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.";
05447                 }

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 5426 of file processor.h.

05427                 {
05428                         return NAME;
05429                 }

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 5436 of file processor.h.

References EMAN::TypeDict::put().

05437                 {
05438                         TypeDict d;
05439                         d.put("filename", EMObject::STRING, "mask image file name");
05440                         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");
05441                         return d;
05442                 }

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

Definition at line 5431 of file processor.h.

05432                 {
05433                         return new IndexMaskFileProcessor();
05434                 }

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 6221 of file processor.cpp.

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

06222 {
06223         if (!image) {
06224                 LOGWARN("NULL Image");
06225                 return;
06226         }
06227 
06228         const char *filename = params["filename"];
06229         EMData *msk = new EMData();
06230         msk->read_image(filename);
06231         if (!EMUtil::is_same_size(image, msk)) {
06232                 LOGERR("IndexMaskFileProcessor: Mask size different than image");
06233                 return;
06234         }
06235 
06236         if ((int) params["ismaskset"] != 0) {
06237                 msk->process_inplace("threshold.binaryrange", Dict("low", 0.5f, "high", 1.5f));
06238         }
06239 
06240         image->mult(*msk);
06241         if( msk )
06242         {
06243                 delete msk;
06244                 msk = 0;
06245         }
06246 }


Member Data Documentation

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

Definition at line 179 of file processor.cpp.


The documentation for this class was generated from the following files:
Generated on Tue Jun 11 13:42:41 2013 for EMAN2 by  doxygen 1.3.9.1