Replace a source image as a square or cube depends on 2D or 3D of the source image. More...

#include <processor.h>

Inheritance diagram for EMAN::TestImageSquarecube:

Collaboration diagram for EMAN::TestImageSquarecube:

[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.squarecube"

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 as a square or cube depends on 2D or 3D of the source image.

Parameters

edge_length	edge length of the square or cube
axis	specify a major axis for asymmetric features
odd_edge	edge length for the asymmetric axis
fill	answer 'yes' or 'no' to specify if it's filled or hollow, default filled

Definition at line 8604 of file processor.h.

Member Function Documentation

◆ get_desc()

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

                {
                        return "Replace a source image as a square or cube depends on 2D or 3D of the source image";
                }

◆ get_name()

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

                {
                        return NAME;
                }

References NAME.

◆ get_param_types()

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

                {
                        TypeDict d;
                        d.put("edge_length", EMObject::FLOAT, "edge length of the square or cube, unit: pixel");
                        d.put("axis", EMObject::STRING, "specify a major axis for asymmetric features");
                        d.put("odd_edge", EMObject::FLOAT, "edge length for the asymmetric axis");
                        d.put("fill", EMObject::INT, "Flag indicating if image is filled, default filled, 1 for filled, 0 for blank");
                        return d;
                }

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

◆ NEW()

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

inlinestatic

Definition at line 8619 of file processor.h.

                {
                        return new TestImageSquarecube();
                }

◆ process_inplace()

void TestImageSquarecube::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 9741 of file processor.cpp.

{
        preprocess(image);
 
        float edge_length = params["edge_length"];
        string axis = (const char*)params["axis"];
        float odd_edge = params["odd_edge"];
        int fill = 1;
        if(params.has_key("fill")) {
                fill = (int)params["fill"];
        }
 
        float *dat = image->get_data();
        float x2, y2, z2; //this coordinates of this pixel from center
        float xEdge, yEdge, zEdge; //half of edge length for this cube
        if(axis == ""){
                xEdge = edge_length/2.0f;
                yEdge = edge_length/2.0f;
                zEdge = edge_length/2.0f;
        }
        else if(axis == "x"){
                xEdge = odd_edge/2.0f;
                yEdge = edge_length/2.0f;
                zEdge = edge_length/2.0f;
        }
        else if(axis == "y"){
                xEdge = edge_length/2.0f;
                yEdge = odd_edge/2.0f;
                zEdge = edge_length/2.0f;
        }
        else if(axis == "z"){
                if( nz == 1 ){
                        throw InvalidValueException(0, "This is a 2D image, no asymmetric feature for z axis");
                }
                xEdge = edge_length/2.0f;
                yEdge = edge_length/2.0f;
                zEdge = odd_edge/2.0f;
        }
        else{
                throw InvalidValueException(0, "please specify a valid axis for asymmetric features");
        }
        for (int k = 0; k < nz; ++k) {
                for (int j = 0; j < ny; ++j) {
                        for (int i = 0; i < nx; ++i, ++dat) {
                                x2 = (float)fabs((float)i - nx/2);
                                y2 = (float)fabs((float)j - ny/2);
                                z2 = (float)fabs((float)k - nz/2);
                                if( x2<=xEdge && y2<=yEdge && z2<=zEdge ) {
                                        if( !fill) {
                                                *dat = 0;
                                        }
                                        else {
                                                *dat = 1;
                                        }
                                }
                                else {
                                        if( !fill ) {
                                                *dat = 1;
                                        }
                                        else {
                                                *dat = 0;
                                        }
                                }
                        }
                }
        }
 
        image->update();
}

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

Member Data Documentation

◆ NAME

const string TestImageSquarecube::NAME = "testimage.squarecube"

static

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