Multiplies each Fourier pixel by its amplitude. More...

#include <processor.h>

Inheritance diagram for EMAN::AmpweightFourierProcessor:

Collaboration diagram for EMAN::AmpweightFourierProcessor:

[legend]

Public Member Functions
string	get_name () const
	Get the processor's name. 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 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...

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

Protected Attributes
EMData *	sum

int	dosqrt

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

Multiplies each Fourier pixel by its amplitude.

Parameters

sum	Adds the weights to sum for normalization
sqrt	Weights using sqrt of the amplitude if set

Definition at line 591 of file processor.h.

Member Function Documentation

◆ get_desc()

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

                {
                        return "Multiplies each Fourier pixel by its amplitude";
                }

◆ get_name()

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

                {
                        return NAME;
                }

References NAME.

◆ get_param_types()

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

                {
                        TypeDict d;
                        d.put("sum", EMObject::EMDATA, "Adds the weights to sum for normalization");
                        d.put("sqrt", EMObject::INT, "Weights using sqrt of the amplitude if set");
                        return d;
                }

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

◆ NEW()

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

inlinestatic

Definition at line 617 of file processor.h.

                {
                        return new AmpweightFourierProcessor();
                }

◆ process_inplace()

void AmpweightFourierProcessor::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 1380 of file processor.cpp.

{
        EMData *fft;
        float *fftd;
        int f=0;
//      static float sum1=0,sum1a=0;
//      static double sum2=0,sum2a=0;
 
        if (!image) {
                LOGWARN("NULL Image");
                return;
        }
 
        if (!image->is_complex()) {
                fft = image->do_fft();
                fftd = fft->get_data();
                f=1;
        }
        else {
                fft=image;
                fftd=image->get_data();
        }
        float *sumd = NULL;
        if (sum) sumd=sum->get_data();
//printf("%d %d    %d %d\n",fft->get_xsize(),fft->get_ysize(),sum->get_xsize(),sum->get_ysize());
        size_t n = (size_t)fft->get_xsize()*fft->get_ysize()*fft->get_zsize();
        for (size_t i=0; i<n; i+=2) {
                float c;
                if (dosqrt) c=pow(fftd[i]*fftd[i]+fftd[i+1]*fftd[i+1],0.25f);
                else c = static_cast<float>(hypot(fftd[i],fftd[i+1]));
                if (c==0) c=1.0e-30f;   // prevents divide by zero in normalization
                fftd[i]*=c;
                fftd[i+1]*=c;
                if (sumd) { sumd[i]+=c; sumd[i+1]+=0; }
 
                // debugging
/*              if (i==290*1+12) {
                        sum1+=fftd[i];
                        sum2+=fftd[i];
                        printf("%f\t%f\t%f\t%f\t%f\t%f\n",sum1,sum2,fftd[i],fftd[i+1],sumd[i],c);
                }
                if (i==290*50+60) {
                        sum1a+=fftd[i];
                        sum2a+=fftd[i];
                        printf("%f\t%f\t%f\t%f\t%f\t%f\n",sum1a,sum2a,fftd[i],fftd[i+1],sumd[i],c);
        }*/
        }
 
        if (f) {
                fft->update();
                EMData *ift=fft->do_ift();
                memcpy(image->get_data(),ift->get_data(),n*sizeof(float));
                delete fft;
                delete ift;
        }
 
        sum->update();
        image->update();
 
}

References dosqrt, LOGWARN, and sum.

◆ set_params()

void EMAN::AmpweightFourierProcessor::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 601 of file processor.h.

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

References dosqrt, EMAN::Processor::params, and sum.

Member Data Documentation

◆ dosqrt

int EMAN::AmpweightFourierProcessor::dosqrt

protected

Definition at line 631 of file processor.h.

Referenced by process_inplace(), and set_params().

◆ NAME

const string AmpweightFourierProcessor::NAME = "filter.ampweight"

static

Definition at line 627 of file processor.h.

Referenced by get_name().

◆ sum

EMData* EMAN::AmpweightFourierProcessor::sum

protected

Definition at line 630 of file processor.h.

Referenced by process_inplace(), and set_params().

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_inplace()

◆ set_params()

Member Data Documentation

◆ dosqrt

◆ NAME

◆ sum