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

EMAN::NormalizeProcessor Class Reference

Base class for normalization processors. More...

#include <processor.h>

Inheritance diagram for EMAN::NormalizeProcessor:

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

Collaboration graph
[legend]
List of all members.

Public Member Functions

void process_inplace (EMData *image)
 To process an image in-place.

Static Public Member Functions

string get_group_desc ()
 Get the description of this group of processors.

Protected Member Functions

virtual float calc_sigma (EMData *image) const
virtual float calc_mean (EMData *image) const =0

Detailed Description

Base class for normalization processors.

Each specific normalization processor needs to define how to calculate mean and how to calculate sigma.

Definition at line 3992 of file processor.h.


Member Function Documentation

virtual float EMAN::NormalizeProcessor::calc_mean EMData image  )  const [protected, pure virtual]
 

Implemented in EMAN::NormalizeUnitProcessor, EMAN::NormalizeUnitSumProcessor, EMAN::NormalizeStdProcessor, EMAN::NormalizeMaskProcessor, EMAN::NormalizeEdgeMeanProcessor, EMAN::NormalizeCircleMeanProcessor, EMAN::NormalizeLREdgeMeanProcessor, and EMAN::NormalizeMaxMinProcessor.

Referenced by process_inplace().

float NormalizeProcessor::calc_sigma EMData image  )  const [protected, virtual]
 

Reimplemented in EMAN::NormalizeUnitProcessor, EMAN::NormalizeUnitSumProcessor, EMAN::NormalizeMaskProcessor, and EMAN::NormalizeMaxMinProcessor.

Definition at line 3427 of file processor.cpp.

References EMAN::EMData::get_attr().

Referenced by process_inplace().

03428 {
03429         return image->get_attr("sigma");
03430 }

string EMAN::NormalizeProcessor::get_group_desc  )  [inline, static]
 

Get the description of this group of processors.

This function is defined in a parent class. It gives a introduction to a group of processors.

Returns:
The description of this group of processors.

Reimplemented from EMAN::Processor.

Definition at line 3997 of file processor.h.

03998                 {
03999                         return "Base class for normalization processors. Each specific normalization processor needs to define how to calculate mean and how to calculate sigma.";
04000                 }

void NormalizeProcessor::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 3432 of file processor.cpp.

References calc_mean(), calc_sigma(), data, EMAN::EMData::get_data(), EMAN::EMData::get_xsize(), EMAN::EMData::get_ysize(), EMAN::EMData::get_zsize(), EMAN::Util::goodf(), EMAN::EMData::is_complex(), LOGWARN, and EMAN::EMData::update().

03433 {
03434         if (!image) {
03435                 LOGWARN("cannot do normalization on NULL image");
03436                 return;
03437         }
03438 
03439         if (image->is_complex()) {
03440                 LOGWARN("cannot do normalization on complex image");
03441                 return;
03442         }
03443 
03444         float sigma = calc_sigma(image);
03445         if (sigma == 0 || !Util::goodf(&sigma)) {
03446                 LOGWARN("cannot do normalization on image with sigma = 0");
03447                 return;
03448         }
03449 
03450         float mean = calc_mean(image);
03451 
03452         size_t size = (size_t)image->get_xsize() * image->get_ysize() * image->get_zsize();
03453         float *data = image->get_data();
03454 
03455         for (size_t i = 0; i < size; ++i) {
03456                 data[i] = (data[i] - mean) / sigma;
03457         }
03458 
03459         image->update();
03460 }


The documentation for this class was generated from the following files:
Generated on Mon May 2 13:30:27 2011 for EMAN2 by  doxygen 1.3.9.1