Make an image consisting of a single cross, with lines going in the axial directions, intersecting at the origin. More...

#include <processor.h>

Inheritance diagram for EMAN::TestImageAxes:

[legend]

Collaboration diagram for EMAN::TestImageAxes:

[legend]

Public Member Functions
virtual void	process_inplace (EMData *image)
	Make an image where the axes (where x,y and z=0) are some nono zero value. 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.axes"

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

Make an image consisting of a single cross, with lines going in the axial directions, intersecting at the origin.

Author: David Woolford woolf.nosp@m.ord@.nosp@m.bcm.e.nosp@m.du

Date: October 2007

Parameters

radius	the radial length of the lines from the origin
fill	the value to assign to pixels made non zero

Definition at line 8370 of file processor.h.

Member Function Documentation

◆ get_desc()

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

                        {
                                return "Make an image consisting of a single cross";
                        }

◆ get_name()

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

                        {
                                return NAME;
                        }

References NAME.

◆ get_param_types()

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

                        {
                                TypeDict d;
                                d.put("int", EMObject::FLOAT, "radius of the lines emanating from the origin");
                                d.put("fill", EMObject::FLOAT, "value to make non-zero pixels");
                                return d;
                        }

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

◆ NEW()

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

inlinestatic

Definition at line 8389 of file processor.h.

                        {
                                return new TestImageAxes();
                        }

◆ process_inplace()

void TestImageAxes::process_inplace ( EMData * image )

virtual

Make an image where the axes (where x,y and z=0) are some nono zero value.

Parameters

image the image to operate upon

Implements EMAN::Processor.

Definition at line 9401 of file processor.cpp.

{
        preprocess(image);
 
        float fill = params.set_default("fill", 1.0f);
        // get the central coordinates
        int cx = nx/2;
        int cy = ny/2;
        int cz = nz/2;
 
        // Offsets are used to detect when "the extra pixel" needs to be filled in
        // They are implemented on the assumption that for odd dimensions
        // the "center pixel" is the center pixel, but for even dimensions the "center
        // pixel" is displaced in the positive direction by 1
        int xoffset = (nx % 2 == 0? 1:0);
        int yoffset = (ny % 2 == 0? 1:0);
        int zoffset = (nz % 2 == 0? 1:0);
 
        // This should never occur - but if indeed it did occur, the code in this function
        // would break - the function would proceed into the final "else" and seg fault
        // It is commented out but left for clarity
//      if ( nx < 1 || ny < 1 || nz < 1 ) throw ImageDimensionException("Error: one of the image dimensions was less than zero");
 
        if ( nx == 1 && ny == 1 && nz == 1 )
        {
                (*image)(0) = fill;
        }
        else if ( ny == 1 && nz == 1 )
        {
                int radius = params.set_default("radius", cx );
                if ( radius > cx ) radius = cx;
 
                (*image)(cx) = fill;
                for ( int i = 1; i <= radius-xoffset; ++i ) (*image)(cx+i) = fill;
                for ( int i = 1; i <= radius; ++i ) (*image)(cx-i) = fill;
        }
        else if ( nz == 1 )
        {
                int min = ( nx < ny ? nx : ny );
                min /= 2;
 
                int radius = params.set_default("radius", min );
                if ( radius > min ) radius = min;
 
                (*image)(cx,cy) = fill;
 
                for ( int i = 1; i <= radius-xoffset; ++i ) (*image)(cx+i,cy) = fill;
                for ( int i = 1; i <= radius-yoffset; ++i )(*image)(cx,cy+i) = fill;
 
                for ( int i = 1; i <= radius; ++i )
                {
                        (*image)(cx-i,cy) = fill;
                        (*image)(cx,cy-i) = fill;
                }
 
        }
        else
        {
                // nx > 1 && ny > 1 && nz > 1
                int min = ( nx < ny ? nx : ny );
                if (nz < min ) min = nz;
                min /= 2;
 
                int radius = params.set_default("radius", min);
                if ( radius > min ) radius = min;
 
 
                (*image)(cx,cy,cz) = fill;
                for ( int i = 1; i <=radius-xoffset; ++i ) (*image)(cx+i,cy,cz) = fill;
                for ( int i = 1; i <=radius-yoffset; ++i ) (*image)(cx,cy+i,cz) = fill;
                for ( int i = 1; i <=radius-zoffset; ++i ) (*image)(cx,cy,cz+i) = fill;
                for ( int i = 1; i <= radius; ++i )
                {
                        (*image)(cx-i,cy,cz) = fill;
                        (*image)(cx,cy-i,cz) = fill;
                        (*image)(cx,cy,cz-i) = fill;
                }
        }
 
        image->update();
}

References EMAN::TestImageProcessor::nx, EMAN::TestImageProcessor::ny, EMAN::TestImageProcessor::nz, EMAN::Processor::params, EMAN::TestImageProcessor::preprocess(), and EMAN::Dict::set_default().

Member Data Documentation

◆ NAME

const string TestImageAxes::NAME = "testimage.axes"

static

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