EMAN::KmeansSegmentProcessor Class Reference

Segment a volume into ~n subvolumes using K-means classification. More...

#include <processor.h>

Inheritance diagram for EMAN::KmeansSegmentProcessor:

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

Collaboration graph
[legend]
List of all members.

Public Member Functions

string get_name () const
 Get the processor's name.
virtual EMDataprocess (const EMData *const image)
 To proccess an image out-of-place.
void process_inplace (EMData *image)
 To process an image in-place.
TypeDict get_param_types () const
 Get processor parameter information in a dictionary.
string get_desc () const
 Get the descrition of this specific processor.

Static Public Member Functions

static ProcessorNEW ()

Static Public Attributes

static const string NAME = "segment.kmeans"

Detailed Description

Segment a volume into ~n subvolumes using K-means classification.

Author:
Steve Ludtke
Date:
2008/11/03
Parameters:
ctf[in] A Ctf object to use

Definition at line 720 of file processor.h.


Member Function Documentation

string EMAN::KmeansSegmentProcessor::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 750 of file processor.h.

00751                 {
00752                         return "Performs K-means segmentation on a volume. Note that this method uses random seeds, and thus will return different results each time it is run. Returned map contains number of segment for each voxel (or 0 for unsegmented voxels). Segmentation centers are stored in 'segmentcenters' attribute, consisting of a list of 3n floats in x,y,z triples.";
00753                 }

string EMAN::KmeansSegmentProcessor::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 723 of file processor.h.

References NAME.

00724                 {
00725                         return NAME;
00726                 }

TypeDict EMAN::KmeansSegmentProcessor::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 731 of file processor.h.

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

00732                 {
00733                         TypeDict d ;
00734                         d.put("nseg", EMObject::INT, "Number of segments to divide the image into. default=12" );
00735                         d.put("thr",EMObject::FLOAT,"Isosurface threshold value. Pixels below this will not be segmented");
00736                         d.put("ampweight",EMObject::INT,"If set, will weight centers by voxel amplitude. default = 1");
00737                         d.put("maxsegsize",EMObject::FLOAT,"Maximum radial distance from segment center to member voxel. Default=10000");
00738                         d.put("minsegsep",EMObject::FLOAT,"Minimum segment separation. Segments too close will trigger a reseed");
00739                         d.put("maxiter",EMObject::FLOAT,"Maximum number of iterations to run before stopping. Default=100");
00740                         d.put("maxvoxmove",EMObject::FLOAT,"Maximum number of voxels that can move before quitting. Default=25");
00741                         d.put("verbose",EMObject::INT,"Be verbose while running");
00742                         return d;
00743                 }

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

Definition at line 745 of file processor.h.

00746                 {
00747                         return new KmeansSegmentProcessor();
00748                 }

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

To proccess an image out-of-place.

For those processors which can only be processed out-of-place, override this function to give the right behavior.

Parameters:
image The image will be copied, actual process happen on copy of image.
Returns:
the image processing result, may or may not be the same size of the input image

Reimplemented from EMAN::Processor.

Definition at line 932 of file processor.cpp.

References EMAN::EMData::copy(), EMAN::Util::get_frand(), EMAN::EMData::get_value_at(), EMAN::EMData::get_xsize(), EMAN::EMData::get_ysize(), EMAN::EMData::get_zsize(), EMAN::Util::hypot3(), nx, ny, EMAN::Processor::params, EMAN::EMData::set_attr(), EMAN::Dict::set_default(), EMAN::EMData::set_value_at(), x, and y.

00933 {
00934         EMData * result = image->copy();
00935 
00936         int nseg = params.set_default("nseg",12);
00937         float thr = params.set_default("thr",-1.0e30f);
00938         int ampweight = params.set_default("ampweight",1);
00939         float maxsegsize = params.set_default("maxsegsize",10000.0f);
00940         float minsegsep = params.set_default("minsegsep",0.0f);
00941         int maxiter = params.set_default("maxiter",100);
00942         int maxvoxmove = params.set_default("maxvoxmove",25);
00943         int verbose = params.set_default("verbose",0);
00944 
00945         vector<float> centers(nseg*3);
00946         vector<float> count(nseg);
00947         int nx=image->get_xsize();
00948         int ny=image->get_ysize();
00949         int nz=image->get_zsize();
00950 //      int nxy=nx*ny;
00951 
00952         // seed
00953         for (int i=0; i<nseg*3; i+=3) {
00954                 centers[i]=  Util::get_frand(0.0f,(float)nx);
00955                 centers[i+1]=Util::get_frand(0.0f,(float)ny);
00956                 centers[i+2]=Util::get_frand(0.0f,(float)nz);
00957         }
00958 
00959         for (int iter=0; iter<maxiter; iter++) {
00960                 // **** classify
00961                 size_t pixmov=0;                // count of moved pixels
00962                 for (int z=0; z<nz; z++) {
00963                         for (int y=0; y<ny; y++) {
00964                                 for (int x=0; x<nz; x++) {
00965                                         if (image->get_value_at(x,y,z)<thr) {
00966                                                 result->set_value_at(x,y,z,-1.0);               //below threshold -> -1 (unclassified)
00967                                                 continue;
00968                                         }
00969                                         int bcls=-1;                    // best matching class
00970                                         float bdist=(float)(nx+ny+nz);  // distance for best class
00971                                         for (int c=0; c<nseg; c++) {
00972                                                 float d=Util::hypot3(x-centers[c*3],y-centers[c*3+1],z-centers[c*3+2]);
00973                                                 if (d<bdist) { bdist=d; bcls=c; }
00974                                         }
00975                                         if ((int)result->get_value_at(x,y,z)!=bcls) pixmov++;
00976                                         if (bdist>maxsegsize) result->set_value_at(x,y,z,-1);           // pixel is too far from any center
00977                                         else result->set_value_at(x,y,z,(float)bcls);           // set the pixel to the class number
00978                                 }
00979                         }
00980                 }
00981 
00982                 // **** adjust centers
00983                 for (int i=0; i<nseg*3; i++) centers[i]=0;
00984                 for (int i=0; i<nseg; i++) count[i]=0;
00985 
00986                 // weighted sums
00987                 for (int z=0; z<nz; z++) {
00988                         for (int y=0; y<ny; y++) {
00989                                 for (int x=0; x<nz; x++) {
00990                                         int cls = (int)result->get_value_at(x,y,z);
00991                                         if (cls==-1) continue;
00992                                         float w=1.0;
00993                                         if (ampweight) w=image->get_value_at(x,y,z);
00994 
00995                                         centers[cls*3]+=x*w;
00996                                         centers[cls*3+1]+=y*w;
00997                                         centers[cls*3+2]+=z*w;
00998                                         count[cls]+=w;
00999                                 }
01000                         }
01001                 }
01002 
01003                 // now each becomes center of mass, or gets randomly reseeded
01004                 int nreseed=0;
01005                 for (int c=0; c<nseg; c++) {
01006                         // reseed
01007                         if (count[c]==0) {
01008                                 nreseed++;
01009                                 do {
01010                                         centers[c*3]=  Util::get_frand(0.0f,(float)nx);
01011                                         centers[c*3+1]=Util::get_frand(0.0f,(float)ny);
01012                                         centers[c*3+2]=Util::get_frand(0.0f,(float)nz);
01013                                 } while (image->get_value_at((int)centers[c*3],(int)centers[c*3+1],(int)centers[c*3+2])<thr);           // This makes sure the new point is inside density
01014                         }
01015                         // center of mass
01016                         else {
01017                                 centers[c*3]/=count[c];
01018                                 centers[c*3+1]/=count[c];
01019                                 centers[c*3+2]/=count[c];
01020                         }
01021                 }
01022 
01023                 // with minsegsep, check separation
01024                 if (minsegsep>0) {
01025                         for (int c1=0; c1<nseg-1; c1++) {
01026                                 for (int c2=c1+1; c2<nseg; c2++) {
01027                                         if (Util::hypot3(centers[c1*3]-centers[c2*3],centers[c1*3+1]-centers[c2*3+1],centers[c1*3+2]-centers[c2*3+2])<=minsegsep) {
01028                                                 nreseed++;
01029                                                 do {
01030                                                         centers[c1*3]=  Util::get_frand(0.0f,(float)nx);
01031                                                         centers[c1*3+1]=Util::get_frand(0.0f,(float)ny);
01032                                                         centers[c1*3+2]=Util::get_frand(0.0f,(float)nz);
01033                                                 } while (image->get_value_at((int)centers[c1*3],(int)centers[c1*3+1],(int)centers[c1*3+2])<thr);
01034                                         }
01035                                 }
01036                         }
01037                 }
01038 
01039 
01040                 if (verbose) printf("Iteration %3d: %6ld voxels moved, %3d classes reseeded\n",iter,pixmov,nreseed);
01041                 if (nreseed==0 && pixmov<(size_t)maxvoxmove) break;             // termination conditions met
01042         }
01043 
01044         result->set_attr("segment_centers",centers);
01045 
01046         return result;
01047 }

void KmeansSegmentProcessor::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 1049 of file processor.cpp.

01050 {
01051         printf("Process inplace not implemented. Please use process.\n");
01052         return;
01053 }


Member Data Documentation

const string KmeansSegmentProcessor::NAME = "segment.kmeans" [static]

Definition at line 755 of file processor.h.

Referenced by get_name().


The documentation for this class was generated from the following files:
Generated on Mon Mar 7 18:09:30 2011 for EMAN2 by  doxygen 1.4.7