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 5270 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 5280 of file processor.h.

05281                 {
05282                         return "A fourier processor specified in a 2 column text file.";
05283                 }

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

References NAME.

05276                 {
05277                         return NAME;
05278                 }

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

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

05291                 {
05292                         TypeDict d;
05293                         d.put("filename", EMObject::STRING, "file name for a 2 column text file which specified a radial function data array.");
05294                         return d;
05295                 }

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

Definition at line 5285 of file processor.h.

05286                 {
05287                         return new FileFourierProcessor();
05288                 }

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 5955 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.

05956 {
05957         if (!image) {
05958                 LOGWARN("NULL Image");
05959                 return;
05960         }
05961         const char *filename = params["filename"];
05962         float apix = params["apix"];
05963 
05964         FILE *in = fopen(filename, "rb");
05965         if (!in) {
05966                 LOGERR("FileFourierProcessor: cannot open file '%s'", filename);
05967                 return;
05968         }
05969 
05970         float f = 0;
05971         int n = 0;
05972         while (fscanf(in, " %f %f", &f, &f) == 2) {
05973                 n++;
05974         }
05975         rewind(in);
05976 
05977         vector < float >xd(n);
05978         vector < float >yd(n);
05979 
05980         float sf = apix * image->get_xsize();
05981 
05982         for (int i = 0; fscanf(in, " %f %f", &xd[i], &yd[i]) == 2; i++) {
05983                 xd[i] *= sf;
05984         }
05985 
05986         if (xd[2] - xd[1] != xd[1] - xd[0]) {
05987                 LOGWARN("Warning, x spacing appears nonuniform %g!=%g\n",
05988                                 xd[2] - xd[1], xd[1] - xd[0]);
05989         }
05990 
05991         EMData *d2 = image->do_fft();
05992         if( image )
05993         {
05994                 delete image;
05995                 image = 0;
05996         }
05997 
05998         d2->apply_radial_func(xd[0], xd[1] - xd[0], yd, 1);
05999         image = d2->do_ift();
06000 }


Member Data Documentation

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

Definition at line 5297 of file processor.h.

Referenced by get_name().


The documentation for this class was generated from the following files:
Generated on Tue Jun 11 12:44:28 2013 for EMAN2 by  doxygen 1.4.7