EMAN::FileFourierProcessor Class Reference

A fourier processor specified in a 2 column text file. More...

#include <processor.h>

Inheritance diagram for EMAN::FileFourierProcessor:

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

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 string get_desc () const
 Get the descrition of this specific processor.
virtual TypeDict get_param_types () const
 Get processor parameter information in a dictionary.

Static Public Member Functions

static ProcessorNEW ()

Static Public Attributes

static const string NAME = "eman1.filter.byfile"

Detailed Description

A fourier processor specified in a 2 column text file.

Parameters:
filename file name for a 2 column text file which specified a radial function data array

Definition at line 5096 of file processor.h.


Member Function Documentation

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

05107                 {
05108                         return "A fourier processor specified in a 2 column text file.";
05109                 }

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

References NAME.

05102                 {
05103                         return NAME;
05104                 }

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

References EMAN::TypeDict::put(), and EMAN::EMObject::STRING.

05117                 {
05118                         TypeDict d;
05119                         d.put("filename", EMObject::STRING, "file name for a 2 column text file which specified a radial function data array.");
05120                         return d;
05121                 }

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

Definition at line 5111 of file processor.h.

05112                 {
05113                         return new FileFourierProcessor();
05114                 }

void FileFourierProcessor::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 5751 of file processor.cpp.

References EMAN::EMData::apply_radial_func(), EMAN::EMData::do_fft(), EMAN::EMData::do_ift(), EMAN::EMData::get_xsize(), in, LOGERR, LOGWARN, and EMAN::Processor::params.

05752 {
05753         if (!image) {
05754                 LOGWARN("NULL Image");
05755                 return;
05756         }
05757         const char *filename = params["filename"];
05758         float apix = params["apix"];
05759 
05760         FILE *in = fopen(filename, "rb");
05761         if (!in) {
05762                 LOGERR("FileFourierProcessor: cannot open file '%s'", filename);
05763                 return;
05764         }
05765 
05766         float f = 0;
05767         int n = 0;
05768         while (fscanf(in, " %f %f", &f, &f) == 2) {
05769                 n++;
05770         }
05771         rewind(in);
05772 
05773         vector < float >xd(n);
05774         vector < float >yd(n);
05775 
05776         float sf = apix * image->get_xsize();
05777 
05778         for (int i = 0; fscanf(in, " %f %f", &xd[i], &yd[i]) == 2; i++) {
05779                 xd[i] *= sf;
05780         }
05781 
05782         if (xd[2] - xd[1] != xd[1] - xd[0]) {
05783                 LOGWARN("Warning, x spacing appears nonuniform %g!=%g\n",
05784                                 xd[2] - xd[1], xd[1] - xd[0]);
05785         }
05786 
05787         EMData *d2 = image->do_fft();
05788         if( image )
05789         {
05790                 delete image;
05791                 image = 0;
05792         }
05793 
05794         d2->apply_radial_func(xd[0], xd[1] - xd[0], yd, 1);
05795         image = d2->do_ift();
05796 }


Member Data Documentation

const string FileFourierProcessor::NAME = "eman1.filter.byfile" [static]

Definition at line 5123 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:03:08 2011 for EMAN2 by  doxygen 1.4.7