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

static 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 4027 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 3380 of file processor.cpp.

References EMAN::EMData::get_attr().

Referenced by process_inplace().

03381 {
03382         return image->get_attr("sigma");
03383 }

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

04033                 {
04034                         return "Base class for normalization processors. Each specific normalization processor needs to define how to calculate mean and how to calculate sigma.";
04035                 }

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

References calc_mean(), calc_sigma(), 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().

03386 {
03387         if (!image) {
03388                 LOGWARN("cannot do normalization on NULL image");
03389                 return;
03390         }
03391 
03392         if (image->is_complex()) {
03393                 LOGWARN("cannot do normalization on complex image");
03394                 return;
03395         }
03396 
03397         float sigma = calc_sigma(image);
03398         if (sigma == 0 || !Util::goodf(&sigma)) {
03399                 LOGWARN("cannot do normalization on image with sigma = 0");
03400                 return;
03401         }
03402 
03403         float mean = calc_mean(image);
03404 
03405         size_t size = (size_t)image->get_xsize() * (size_t)image->get_ysize() *
03406                           (size_t)image->get_zsize();
03407         float *data = image->get_data();
03408 
03409         for (size_t i = 0; i < size; i++) {
03410                 data[i] = (data[i] - mean) / sigma;
03411         }
03412 
03413         image->update();
03414 }


The documentation for this class was generated from the following files:
Generated on Tue May 25 17:17:06 2010 for EMAN2 by  doxygen 1.4.7