EMAN2
Public Member Functions | Static Public Member Functions | Static Public Attributes
EMAN::TomoTiltAngleWeightProcessor Class Reference

A processor that can be used to weight an image by 1/cos(angle) This processor evolved originally as an experimental tool for weighting tomographic data by the width of its cross section relative to the electron beam. More...

#include <processor.h>

Inheritance diagram for EMAN::TomoTiltAngleWeightProcessor:
Inheritance graph
[legend]
Collaboration diagram for EMAN::TomoTiltAngleWeightProcessor:
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

static ProcessorNEW ()

Static Public Attributes

static const string NAME = "tomo.tiltangleweight"

Detailed Description

A processor that can be used to weight an image by 1/cos(angle) This processor evolved originally as an experimental tool for weighting tomographic data by the width of its cross section relative to the electron beam.

The relative width can be derived using elementary trigonometry to be 1/cos(tiltangle). This processor should hence probably be called OneOverCosineWeightingProcessor. You can specify the angle explicitly (which is the default behavior), or you can force the angle to be the altitude angle as derived from the EMData metadata. The processor could obviously be made more robust if the angle derived from the EMData header could be specified...

Author:
David Woolford <woolford@bcm.edu>
Date:
02/11/2008
Parameters:
angleThe angle that the image is, with respect to the zero tilt image
angle_fimRead fim as 'from image metadata' - this causes the altitude angle stored in by the image object (i.e. as extracted from the header, as currently stored in memory) to be used as the angle. This overrides the angle argument

Definition at line 7203 of file processor.h.


Member Function Documentation

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

                        {
                                return "Weights the image by 1/cos(angle)";
                        }
virtual string EMAN::TomoTiltAngleWeightProcessor::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 7208 of file processor.h.

References NAME.

                        {
                                return NAME;
                        }
virtual TypeDict EMAN::TomoTiltAngleWeightProcessor::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 7218 of file processor.h.

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

                        {
                                TypeDict d;
                                d.put("angle", EMObject::INT, "The angle that the image is, with respect to the zero tilt image");
                                d.put("angle_fim",EMObject::BOOL,"Read fim as 'from image metadata' - this causes the altitude angle stored in by the image object (i.e. as extracted from the header, as currently stored in memory) to be used as the angle. This overrides the angle argument");
                                return d;
                        }
static Processor* EMAN::TomoTiltAngleWeightProcessor::NEW ( ) [inline, static]

Definition at line 7213 of file processor.h.

                        {
                                return new TomoTiltAngleWeightProcessor();
                        }
void TomoTiltAngleWeightProcessor::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:
imageThe image to be processed.

Implements EMAN::Processor.

Definition at line 10165 of file processor.cpp.

References EMAN::EMData::get_attr(), EMAN::EMData::mult(), EMAN::Processor::params, and EMAN::Dict::set_default().

{
        bool fim = params.set_default("angle_fim", false);
        float alt;
        if ( fim ) {
                alt = image->get_attr("euler_alt");
        }
        else alt = params.set_default("angle", 0.0f);

        float cosine = cos(alt*M_PI/180.0f);
        float mult_fac =  1.0f/(cosine);
        image->mult( mult_fac );
}

Member Data Documentation

const string TomoTiltAngleWeightProcessor::NAME = "tomo.tiltangleweight" [static]

Definition at line 7231 of file processor.h.

Referenced by get_name().


The documentation for this class was generated from the following files: