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

EMAN::AutoMask2DProcessor Class Reference

Attempts to automatically mask out the particle, excluding other particles in the box, etc. More...

#include <processor.h>

Inheritance diagram for EMAN::AutoMask2DProcessor:

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

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.auto2d"

Detailed Description

Attempts to automatically mask out the particle, excluding other particles in the box, etc.

Parameters:
threshold runs from ~ -2 to 2, negative numbers for dark protein and positive numbers for light protein (stain).
filter is expressed as a fraction of the fourier radius.

Definition at line 4891 of file processor.h.


Member Function Documentation

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

04921                 {
04922                         return "2D version of mask.auto3d";
04923                 }

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

04897                 {
04898                         return NAME;
04899                 }

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

References EMAN::TypeDict::put().

04907                 {
04908                         TypeDict d;
04909                         d.put("radius", EMObject::INT,"Pixel radius of a ball which is used to seed the flood filling operation. ");
04910                         d.put("nmaxseed",EMObject::INT,"Use the n highest valued pixels in the map as a seed. Alternative to radius. Useful for viruses.");
04911                         d.put("threshold", EMObject::FLOAT, "An isosurface threshold that suitably encases the mass.");
04912                         d.put("sigma", EMObject::FLOAT, "Alternative to threshold based on mean + x*sigma");
04913                         d.put("nshells", EMObject::INT, "The number of dilation operations");
04914                         d.put("nshellsgauss", EMObject::INT, "number of Gaussian pixels to expand, following the dilation operations");
04915                         d.put("return_mask", EMObject::BOOL, "If true the result of the operation will produce the mask, not the masked volume.");
04916                         d.put("verbose", EMObject::INT, "How verbose to be (stdout)");
04917                         return d;
04918                 }

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

Definition at line 4901 of file processor.h.

04902                 {
04903                         return new AutoMask2DProcessor();
04904                 }

void AutoMask2DProcessor::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 5310 of file processor.cpp.

References abs, EMAN::EMData::calc_n_highest_locations(), EMAN::EMData::get_attr(), EMAN::EMData::get_data(), EMAN::EMData::get_ndim(), EMAN::EMData::get_size(), EMAN::EMData::get_xsize(), EMAN::EMData::get_ysize(), EMAN::Dict::has_key(), ImageDimensionException, LOGWARN, EMAN::EMData::mult(), nx, ny, EMAN::EMData::process_inplace(), EMAN::Dict::set_default(), EMAN::EMData::set_size(), EMAN::EMData::set_value_at(), and EMAN::EMData::update().

05311 {
05312         if (!image) {
05313                 LOGWARN("NULL Image");
05314                 return;
05315         }
05316 
05317         if (image->get_ndim() != 2) {
05318                 throw ImageDimensionException("This processor only supports 2D images.");
05319         }
05320 
05321         /*
05322          The mask writing functionality was removed to comply with an EMAN2 policy which dictates that file io is not allowed from within a processor
05323          To get around this just use the return_mask parameter.
05324         string mask_output = params.set_default("write_mask", "");
05325         if ( mask_output != "") {
05326                 if (Util::is_file_exist(mask_output) ) throw InvalidParameterException("The mask output file name already exists. Please remove it if you don't need it.");
05327                 if (!EMUtil::is_valid_filename(mask_output)) throw InvalidParameterException("The mask output file name type is invalid or unrecognized");
05328         }
05329         */
05330 
05331         int radius=0;
05332         if (params.has_key("radius")) {
05333                 radius = params["radius"];
05334         }
05335         int nmaxseed=0;
05336         if (params.has_key("nmaxseed")) {
05337                 nmaxseed = params["nmaxseed"];
05338         }
05339 
05340         float threshold=0.0;
05341         if (params.has_key("sigma")) threshold=(float)(image->get_attr("mean"))+(float)(image->get_attr("sigma"))*(float)params["sigma"];
05342         else threshold=params["threshold"];
05343 
05344 
05345         int nshells = params["nshells"];
05346         int nshellsgauss = params["nshellsgauss"];
05347         int verbose=params.set_default("verbose",0);
05348 
05349         int nx = image->get_xsize();
05350         int ny = image->get_ysize();
05351 
05352         EMData *amask = new EMData();
05353         amask->set_size(nx, ny);
05354 
05355         float *dat = image->get_data();
05356         float *dat2 = amask->get_data();
05357         int i,j;
05358         size_t l = 0;
05359 
05360         if (verbose) printf("%f\t%f\t%f\n",(float)image->get_attr("mean"),(float)image->get_attr("sigma"),threshold);
05361 
05362         // Seeds with the highest valued pixels
05363         if (nmaxseed>0) {
05364                 vector<Pixel> maxs=image->calc_n_highest_locations(nmaxseed);
05365 
05366                 for (vector<Pixel>::iterator i=maxs.begin(); i<maxs.end(); i++) {
05367                         amask->set_value_at((*i).x,(*i).y,0,1.0);
05368                         if (verbose) printf("Seed at %d,%d,%d (%1.3f)\n",(*i).x,(*i).y,(*i).z,(*i).value);
05369                 }
05370         }
05371 
05372         // Seeds with a circle
05373         if (radius>0) {
05374                 // start with an initial circle
05375                 l=0;
05376                 for (j = -ny / 2; j < ny / 2; ++j) {
05377                         for (i = -nx / 2; i < nx / 2; ++i,++l) {
05378                                 if ( abs(j) > radius || abs(i) > radius) continue;
05379 //                              if ( (j * j + i * i) > (radius*radius) || dat[l] < threshold) continue;         // torn on the whole threshold issue here. Removing it prevents images from being totally masked out
05380                                 if ( (j * j + i * i) > (radius*radius) ) continue;
05381                                 dat2[l] = 1.0f;
05382                         }
05383                 }
05384         }
05385 
05386         // iteratively 'flood fills' the map... recursion would be better
05387         int done=0;
05388         int iter=0;
05389         while (!done) {
05390                 iter++;
05391                 done=1;
05392                 if (verbose && iter%10==0) printf("%d iterations\n",iter);
05393                 for (j=1; j<ny-1; ++j) {
05394                         for (i=1; i<nx-1; ++i) {
05395                                 l=i+j*nx;
05396                                 if (dat2[l]) continue;
05397                                 if (dat[l]>threshold && (dat2[l-1]||dat2[l+1]||dat2[l+nx]||dat2[l-nx])) {
05398                                         dat2[l]=1.0;
05399                                         done=0;
05400                                 }
05401                         }
05402                 }
05403         }
05404 
05405         amask->update();
05406 
05407         if (verbose) printf("extending mask\n");
05408         amask->process_inplace("mask.addshells.gauss", Dict("val1", nshells, "val2", nshellsgauss));
05409 
05410         bool return_mask = params.set_default("return_mask",false);
05411         if (return_mask) {
05412                 // Yes there is probably a much more efficient way of getting the mask itself, but I am only providing a stop gap at the moment.
05413                 memcpy(dat,dat2,image->get_size()*sizeof(float));
05414         } else {
05415                 image->mult(*amask);
05416         }
05417 
05418         // EMAN2 policy is not to allow file io from with a processor
05419         //if (mask_output != "") {
05420         //      amask->write_image(mask_output);
05421         //}
05422 
05423 
05424         delete amask;
05425 }


Member Data Documentation

const string AutoMask2DProcessor::NAME = "mask.auto2d" [static]
 

Definition at line 166 of file processor.cpp.


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