Replace a source image with a Gaussian band in Fourier space with a given center and width. More...

#include <processor.h>

Inheritance diagram for EMAN::TestImageFourierGaussianBand:

Collaboration diagram for EMAN::TestImageFourierGaussianBand:

[legend]

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::TestImageProcessor
static string	get_group_desc ()

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 = "testimage.fourier.gaussianband"

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 Member Functions inherited from EMAN::TestImageProcessor
void	preprocess (EMData *image)

Protected Attributes inherited from EMAN::TestImageProcessor
int	nx

int	ny

int	nz

Protected Attributes inherited from EMAN::Processor
Dict	params

Detailed Description

Replace a source image with a Gaussian band in Fourier space with a given center and width.

Parameters

center	center of the Fourier band in pixels
width	1/e half-width for the Gaussian band

Definition at line 8146 of file processor.h.

Member Function Documentation

◆ get_desc()

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

                {
                        return "Replace a source image with a single radial Fourier band with a (truncated) Gaussian profile. f(s)=exp(-(s-c/w)^2). width=sqrt(2) is the minimum width to produce a flat sum with a spacing of 1 pixel.";
                }

◆ get_name()

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

                {
                        return NAME;
                }

References NAME.

◆ get_param_types()

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

                {
                        TypeDict d;
                        d.put("center", EMObject::FLOAT, "center of the band in Fourier pixels. required");
                        d.put("width", EMObject::FLOAT, "1/2e width of Gaussian in Fourier pixels. default = sqrt(2)");
                        return d;
                }

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

◆ NEW()

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

inlinestatic

Definition at line 8161 of file processor.h.

                {
                        return new TestImageFourierGaussianBand();
                }

◆ process_inplace()

void TestImageFourierGaussianBand::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 8935 of file processor.cpp.

{
        if (!image->is_complex()) {
                int nx = image->get_xsize();
                int offset = 2 - nx%2;
 
                image->set_size(nx+offset,image->get_ysize(),image->get_zsize());
                image->set_complex(true);
                if (1 == offset) image->set_fftodd(true);
                else image->set_fftodd(false);
                image->set_fftpad(true);
        }
        image->set_ri(true);
        image->to_zero();
 
        float center = params.set_default("center",ny/4);
        float width = params.set_default("width",sqrt(2.0f));
 
        int nx = image->get_xsize();
        int ny = image->get_ysize();
        int nz = image->get_zsize();
        int w3 = floor(width*3);
        float l0 = pow(center-w3,2.0f);
        float l1 = pow(center+w3,2.0f);
        
        if (nz==1) {
                // 1D
                if (ny==1) {
                        for (int x=0; x<nx/2; x++) {
                                if (abs(x-center)>w3) continue;
                                image->set_complex_at(x,0,exp(-pow((x-center)/width,2.0f)));
                        }
                }
                // 2D
                else {
                        for (int y=-ny/2; y<ny/2; y++) {
                                for (int x=0; x<nx/2; x++) {
                                        float r=Util::hypot_fast(x,y);
                                        if (r<center-w3 || r>center+w3) continue;
                                        image->set_complex_at(x,y,exp(-pow((r-center)/width,2.0f)));
                                }
                        }
                }
        }
        else {
                // 3D
                for (int z=-nz/2; z<nz/2; z++) {
                        for (int y=-ny/2; y<ny/2; y++) {
                                for (int x=0; x<nx/2; x++) {
                                        float r=Util::hypot3(x,y,z);
                                        if (r<center-w3 || r>center+w3) continue;
                                        image->set_complex_at(x,y,z,exp(-pow((r-center)/width,2.0f)));
                                }
                        }
                }
        }
}

References EMAN::Util::hypot3(), EMAN::Util::hypot_fast(), EMAN::TestImageProcessor::nx, EMAN::TestImageProcessor::ny, EMAN::TestImageProcessor::nz, EMAN::Processor::params, EMAN::Dict::set_default(), sqrt(), x, and y.

Member Data Documentation

◆ NAME

const string TestImageFourierGaussianBand::NAME = "testimage.fourier.gaussianband"

static

Definition at line 8174 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_inplace()

Member Data Documentation

◆ NAME