#include <processor.h>

Inheritance diagram for EMAN::AmpMultProcessor:

Collaboration diagram for EMAN::AmpMultProcessor:

[legend]

Public Member Functions
virtual void	process_inplace (EMData *image)
	To process an image in-place. More...

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

virtual string	get_name () const
	Get the processor's name. More...

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 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 = "math.multamplitude"

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

Definition at line 9760 of file processor.h.

Member Function Documentation

◆ get_desc()

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

                {
                        return "Multiply amplitude image. For reconstruction normalization.";
                }

◆ get_name()

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

                {
                        return NAME;
                }

References NAME.

◆ get_param_types()

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

                {
                        TypeDict d;
                        d.put("verbose", EMObject::INT, "Verbose");
                        d.put("amp", EMObject::EMDATA, "Amplitude to multiply.");
                        return d;
                }

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

◆ NEW()

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

inlinestatic

Definition at line 9770 of file processor.h.

                {
                        return new AmpMultProcessor();
                }

◆ process()

EMData * AmpMultProcessor::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 15432 of file processor.cpp.

{
        EMData* proc = image->copy();
        proc->process_inplace("math.multamplitude",params);
        return proc;
}

References EMAN::Processor::params.

◆ process_inplace()

void AmpMultProcessor::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 15439 of file processor.cpp.

{
        EMData *amp=params["amp"];
        float* data = image->get_data();
        float* mult = amp->get_data();
        
        int nx = image->get_xsize();
        int ny = image->get_ysize();
        int nz = image->get_zsize();
 
        
        
        int anx = amp->get_xsize();
        int any = amp->get_ysize();
        int anz = amp->get_zsize();
        
        int div=2;
        
        if (nx==anx){ // in case the amplitude volume has the same size...
                div=1;
                anx=nx/2;
        }
                
                
        
        if  (( (nx==anx*2) && (ny==any) && (nz==anz) )==false)
                throw InvalidParameterException("AmpMultProcessor: amplitude image size mismatch...");
 
        int sz=nx*ny*nz;
        
        for (int i=0; i<sz; i++){
                data[i]*=mult[i/div];
        }
        
        image->update();
 
}

References div(), InvalidParameterException, mult(), and EMAN::Processor::params.

Member Data Documentation

◆ NAME

const string AmpMultProcessor::NAME = "math.multamplitude"

static

Definition at line 9785 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

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ get_desc()

◆ get_name()

◆ get_param_types()

◆ NEW()

◆ process()

◆ process_inplace()

Member Data Documentation

◆ NAME