Wiener filter based on a Ctf object either in the image header. More...

#include <processor.h>

Inheritance diagram for EMAN::Wiener2DFourierProcessor:

Collaboration diagram for EMAN::Wiener2DFourierProcessor:

[legend]

Public Member Functions
string	get_name () const
	Get the processor's name. More...

virtual EMData *	process (const EMData *const image)
	To proccess an image out-of-place. More...

void	process_inplace (EMData *image)
	To process an image in-place. More...

void	set_params (const Dict &new_params)
	Set the processor parameters using a key/value dictionary. More...

TypeDict	get_param_types () const
	Get processor parameter information in a dictionary. More...

string	get_desc () const
	Get the descrition of this specific processor. More...

Public Member Functions inherited from EMAN::Processor
virtual	~Processor ()

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

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 = "filter.wiener2d"

Protected Attributes
Ctf *	ctf

Protected Attributes inherited from EMAN::Processor
Dict	params

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

Detailed Description

Wiener filter based on a Ctf object either in the image header.

Parameters

ctf[in] A Ctf object to use

Author: Steve Ludtke

Date: 2008/11/03

Definition at line 1855 of file processor.h.

Member Function Documentation

◆ get_desc()

string EMAN::Wiener2DFourierProcessor::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 1886 of file processor.h.

                {
                        return "Applies a 2-D Wiener filter to an image based on its Ctf parameters";
                }

◆ get_name()

string EMAN::Wiener2DFourierProcessor::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 1858 of file processor.h.

                {
                        return NAME;
                }

References NAME.

◆ get_param_types()

TypeDict EMAN::Wiener2DFourierProcessor::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 1874 of file processor.h.

                {
                        TypeDict d;
                        d.put("ctf", EMObject::EMDATA, "Ctf object to use for Wiener filter parameters");
                        return d;
                }

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

◆ NEW()

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

inlinestatic

Definition at line 1881 of file processor.h.

                {
                        return new Wiener2DFourierProcessor();
                }

◆ process()

EMData * Wiener2DFourierProcessor::process ( const EMData *const image )

virtual

To proccess an image out-of-place.

For those processors which can only be processed out-of-place, override this function to give the right behavior.

Parameters

image The image will be copied, actual process happen on copy of image.

Returns: the image processing result, may or may not be the same size of the input image

Reimplemented from EMAN::Processor.

Definition at line 1991 of file processor.cpp.

{
        const EMData *in2 = 0;
        if (in->is_complex()) in2=in;
        else in=in->do_fft();
 
        EMData *filt = in->copy_head();
        Ctf *ictf = ctf;
 
        if (!ictf) ctf=(Ctf *)in->get_attr("ctf");
 
        ictf->compute_2d_complex(filt,Ctf::CTF_WIENER_FILTER);
        filt->mult(*in2);
        EMData *ret=filt->do_ift();
 
        delete filt;
        if (!in->is_complex()) delete in2;
 
        if(!ictf && ctf) {delete ctf; ctf=0;}
        return(ret);
/*      const EMData *fft;
        float *fftd;
        int f=0;
 
        if (!image) {
                LOGWARN("NULL Image");
                return ret;
        }
 
        if (!image->is_complex()) {
                fft = image->do_fft();
                fftd = fft->get_data();
                f=1;
        }
        else {
                fft=image;
                fftd=image->get_data();
        }
        powd=image->get_data();
 
        int bad=0;
        for (int i=0; i<image->get_xsize()*image->get_ysize(); i+=2) {
                snr=(fftd[i]*fftd[i]+fftd[i+1]*fftd[i+1]-powd[i])/powd[i];
                if (snr<0) { bad++; snr=0; }
 
        }
 
        print("%d bad pixels\n",snr);
*/      return ret;
 
}

References EMAN::Ctf::compute_2d_complex(), ctf, and EMAN::Ctf::CTF_WIENER_FILTER.

Referenced by process_inplace().

◆ process_inplace()

void Wiener2DFourierProcessor::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 2043 of file processor.cpp.

                                                            {
        EMData *tmp=process(image);
        memcpy(image->get_data(),tmp->get_data(),image->get_xsize()*image->get_ysize()*image->get_zsize()*sizeof(float));
        delete tmp;
        image->update();
        return;
}

References process().

◆ set_params()

void EMAN::Wiener2DFourierProcessor::set_params ( const Dict & new_params )

inlinevirtual

Set the processor parameters using a key/value dictionary.

Parameters

new_params A dictionary containing the new parameters.

Reimplemented from EMAN::Processor.

Definition at line 1867 of file processor.h.

                {
                        params = new_params;
                        ctf = params["ctf"];
//                      printf("%s %f\n",params.keys()[0].c_str(),lowpass);
                }

References ctf, and EMAN::Processor::params.

Member Data Documentation

◆ ctf

Ctf* EMAN::Wiener2DFourierProcessor::ctf

protected

Definition at line 1894 of file processor.h.

Referenced by process(), and set_params().

◆ NAME

const string Wiener2DFourierProcessor::NAME = "filter.wiener2d"

static

Definition at line 1891 of file processor.h.

Referenced by get_name().

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

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ get_desc()

◆ get_name()

◆ get_param_types()

◆ NEW()

◆ process()

◆ process_inplace()

◆ set_params()

Member Data Documentation

◆ ctf

◆ NAME