Lowpass Phase Randomization processor applied in Fourier space. More...

#include <processor.h>

Inheritance diagram for EMAN::LowpassRandomPhaseProcessor:

Collaboration diagram for EMAN::LowpassRandomPhaseProcessor:

[legend]

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

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

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

void	create_radial_func (vector< float > &radial_mask) const

Public Member Functions inherited from EMAN::FourierProcessor
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::FourierProcessor
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 = "filter.lowpass.randomphase"

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::FourierProcessor
virtual void	preprocess (EMData *image)

Protected Attributes inherited from EMAN::Processor
Dict	params

Detailed Description

Lowpass Phase Randomization processor applied in Fourier space.

Definition at line 1924 of file processor.h.

Member Function Documentation

◆ create_radial_func()

void LowpassRandomPhaseProcessor::create_radial_func ( vector< float > & radial_mask ) const

virtual

Implements EMAN::FourierProcessor.

Definition at line 2059 of file processor.cpp.

2059{ };

◆ get_desc()

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

                {
                        return "Above the cutoff frequency, phases will be completely randomized, but amplitudes will be unchanged. Used for testing for noise bias. If you can reconstruct information that isn't there, then you have noise bias problems.";
                }

◆ get_name()

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

1928 { return NAME; }

EMAN::LowpassRandomPhaseProcessor::NAME

static const string NAME

Definition: processor.h:1937

References NAME.

◆ NEW()

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

inlinestatic

Definition at line 1929 of file processor.h.

1929{ return new LowpassRandomPhaseProcessor(); }

EMAN::LowpassRandomPhaseProcessor

Lowpass Phase Randomization processor applied in Fourier space.

Definition: processor.h:1925

◆ process_inplace()

void LowpassRandomPhaseProcessor::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.

Reimplemented from EMAN::FourierProcessor.

Definition at line 2061 of file processor.cpp.

{
        float cutoff=0;
        preprocess(image);
        if( params.has_key("cutoff_abs") ) {
                cutoff=(float)params["cutoff_abs"];
        }
        else {
                printf("A cutoff_* parameter is required by filter.lowpass.randomphase\n");
                return;
        }
 
 
        if (image->get_zsize()==1) {
                int flag=0;
                if (!image->is_complex()) { image->do_fft_inplace(); flag=1; }
                image->ri2ap();
                int nx=image->get_xsize();
                int ny=image->get_ysize();
 
                int z=0;
                float *data=image->get_data();
                for (int y=-ny/2; y<ny/2; y++) {
                        for (int x=0; x<nx/2+1; x++) {
                                if (hypot(x/float(nx),y/float(ny))>=cutoff) {
                                        size_t idx=image->get_complex_index_fast(x,y,z);                // location of the amplitude
                                        data[idx+1]=Util::get_frand(0.0f,(float)(M_PI*2.0));
                                }
                        }
                }
 
                image->ap2ri();
 
                if (flag) {
                        image->do_ift_inplace();
                        image->depad();
                }
        }
        else {          // 3D
                int flag=0;
                if (!image->is_complex()) { image->do_fft_inplace(); flag=1; }
                image->ri2ap();
                int nx=image->get_xsize();
                int ny=image->get_ysize();
                int nz=image->get_zsize();
 
                float *data=image->get_data();
                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++) {
                                        if (Util::hypot3(x/float(nx),y/float(ny),z/float(nz))>=cutoff) {
                                                size_t idx=image->get_complex_index_fast(x,y,z);                // location of the amplitude
                                                data[idx+1]=Util::get_frand(0.0f,(float)(M_PI*2.0));
                                        }
                                }
                        }
                }
                image->ap2ri();
 
                if (flag) {
                        image->do_ift_inplace();
                        image->depad();
                }
        }
}

References EMAN::Util::get_frand(), EMAN::Dict::has_key(), EMAN::Util::hypot3(), EMAN::Processor::params, EMAN::FourierProcessor::preprocess(), x, and y.

Member Data Documentation

◆ NAME

const string LowpassRandomPhaseProcessor::NAME = "filter.lowpass.randomphase"

static

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