EMAN::FileFourierProcessor Class Reference

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

#include <processor.h>

Inheritance diagram for EMAN::FileFourierProcessor:

Collaboration diagram for EMAN::FileFourierProcessor:

Public Member Functions
virtual void	process_inplace (EMData *image)
	To process an image in-place. More...
virtual string	get_name () const
	Get the processor's name. More...
virtual string	get_desc () const
	Get the descrition of this specific processor. More...
virtual TypeDict	get_param_types () const
	Get processor parameter information in a dictionary. More...
Public Member Functions inherited from EMAN::Processor
virtual	~Processor ()
virtual EMData *	process (const EMData *const image)
	To proccess an image out-of-place. More...
virtual void	process_list_inplace (vector< EMData * > &images)
	To process multiple images using the same algorithm. More...
virtual Dict	get_params () const
	Get the processor parameters in a key/value dictionary. More...
virtual void	set_params (const Dict &new_params)
	Set the processor parameters using a key/value dictionary. More...

Static Public Member Functions
static Processor *	NEW ()
Static Public Member Functions inherited from EMAN::Processor
static string	get_group_desc ()
	Get the description of this group of processors. More...
static void	EMFourierFilterInPlace (EMData *fimage, Dict params)
	Compute a Fourier-filter processed image in place. More...
static EMData *	EMFourierFilter (EMData *fimage, Dict params)
	Compute a Fourier-processor processed image without altering the original image. More...

Static Public Attributes
static const string	NAME = "eman1.filter.byfile"

Additional Inherited Members
Public Types inherited from EMAN::Processor
enum	fourier_filter_types {   TOP_HAT_LOW_PASS , TOP_HAT_HIGH_PASS , TOP_HAT_BAND_PASS , TOP_HOMOMORPHIC ,   GAUSS_LOW_PASS , GAUSS_HIGH_PASS , GAUSS_BAND_PASS , GAUSS_INVERSE ,   GAUSS_HOMOMORPHIC , BUTTERWORTH_LOW_PASS , BUTTERWORTH_HIGH_PASS , BUTTERWORTH_HOMOMORPHIC ,   KAISER_I0 , KAISER_SINH , KAISER_I0_INVERSE , KAISER_SINH_INVERSE ,   SHIFT , TANH_LOW_PASS , TANH_HIGH_PASS , TANH_HOMOMORPHIC ,   TANH_BAND_PASS , RADIAL_TABLE , CTF_ }
	Fourier filter Processor type enum. More...
Protected Attributes inherited from EMAN::Processor
Dict	params

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

Member Function Documentation

get_desc()

virtual string EMAN::FileFourierProcessor::get_desc ( ) const

inlinevirtual

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

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

get_name()

virtual string EMAN::FileFourierProcessor::get_name ( ) const

inlinevirtual

Get the processor's name.

Each processor is identified by a unique name.

Returns

The processor's name.

Implements EMAN::Processor.

Definition at line 7324 of file processor.h.

                {
                        return NAME;
                }

References NAME.

get_param_types()

virtual TypeDict EMAN::FileFourierProcessor::get_param_types ( ) const

inlinevirtual

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

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

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

NEW()

static Processor * EMAN::FileFourierProcessor::NEW ( )

inlinestatic

Definition at line 7334 of file processor.h.

                {
                        return new FileFourierProcessor();
                }

process_inplace()

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

{
        if (!image) {
                LOGWARN("NULL Image");
                return;
        }
        const char *filename = params["filename"];
        float apix = params["apix"];
 
        FILE *in = fopen(filename, "rb");
        if (!in) {
                LOGERR("FileFourierProcessor: cannot open file '%s'", filename);
                return;
        }
 
        float f = 0;
        int n = 0;
        while (fscanf(in, " %f %f", &f, &f) == 2) {
                n++;
        }
        rewind(in);
 
        vector < float >xd(n);
        vector < float >yd(n);
 
        float sf = apix * image->get_xsize();
 
        for (int i = 0; fscanf(in, " %f %f", &xd[i], &yd[i]) == 2; i++) {
                xd[i] *= sf;
        }
 
        if (xd[2] - xd[1] != xd[1] - xd[0]) {
                LOGWARN("Warning, x spacing appears nonuniform %g!=%g\n",
                                xd[2] - xd[1], xd[1] - xd[0]);
        }
 
        EMData *d2 = image->do_fft();
        if( image )
        {
                delete image;
                image = 0;
        }
 
        d2->apply_radial_func(xd[0], xd[1] - xd[0], yd, 1);
        image = d2->do_ift();
}

References EMAN::EMData::apply_radial_func(), LOGERR, LOGWARN, and EMAN::Processor::params.

Member Data Documentation

NAME

const string FileFourierProcessor::NAME = "eman1.filter.byfile"

static

Definition at line 7346 of file processor.h.

Referenced by get_name().

---

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

• processor.h
• processor.cpp