Does a projection in one the axial directions Doesn't support process_inplace (because the output has potentially been compressed in one dimension) More...

#include <processor.h>

Inheritance diagram for EMAN::DirectionalSumProcessor:

[legend]

Collaboration diagram for EMAN::DirectionalSumProcessor:

[legend]

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

virtual EMData *	process (const EMData *const image)

virtual void	process_inplace (EMData *)

virtual TypeDict	get_param_types () const
	Get processor parameter information in a dictionary. More...

string	get_desc () const
	Get the descrition of this specific processor. 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 = "misc.directional_sum"

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

Does a projection in one the axial directions Doesn't support process_inplace (because the output has potentially been compressed in one dimension)

Parameters

direction The direction of the sum, either x,y or z

Definition at line 7646 of file processor.h.

Member Function Documentation

◆ get_desc()

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

                {
                        return "Calculates the projection of the image along one of the axial directions, either x, y or z";
                }

◆ get_name()

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

                {
                        return NAME;
                }

References NAME.

◆ get_param_types()

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

                {
                        TypeDict d;
                        d.put("axis", EMObject::STRING,"The direction of the sum, either x,y or z. Returned axes are xy, xz or zy.");
                        d.put("first", EMObject::INT,"The first position along the speficied axis to use in the sum. Neg val -> nx/y/z+first (default=0)");
                        d.put("last", EMObject::INT,"The last position along the speficied axis to use in the sum. Neg val -> nx/y/z+last (default=-1)");
                        return d;
                }

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

◆ NEW()

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

inlinestatic

Definition at line 7654 of file processor.h.

                {
                        return new DirectionalSumProcessor();
                }

◆ process()

EMData * DirectionalSumProcessor::process ( const EMData *const image )

virtual

Exceptions

InvalidParameterException raised if the direction parameter is not "x", "y" or "z"

Reimplemented from EMAN::Processor.

Definition at line 8811 of file processor.cpp.

                                                                   {
        string dir = params.set_default("axis", "");
        if ( dir == "" || ( dir != "x" && dir != "y" && dir != "z" ) )
                throw InvalidParameterException("The direction parameter must be either x, y, or z");
 
        int nx = image->get_xsize();
        int ny = image->get_ysize();
        int nz = image->get_zsize();
        EMData* ret = new EMData;
        if (image->has_attr("ptcl_repr")) ret->set_attr("ptcl_repr",image->get_attr("ptcl_repr"));
        if (image->has_attr("xform_align2d")) ret->set_attr("xform_align2d",image->get_attr("xform_align2d"));
        if (image->has_attr("xform_align3d")) ret->set_attr("xform_align3d",image->get_attr("xform_align3d"));
        ret->set_attr("apix_y",image->get_attr("apix_y"));      // potentially meaningless, may get overwritten, but better to be self-consistent
        ret->set_attr("apix_z",image->get_attr("apix_z"));      // meaningless, but better to be self-consistent
        
 
        if (nz==1) {
                if (dir=="x") {
                        ret->set_size(ny,1,1);
                        ret->set_attr("apix_x",image->get_attr("apix_y"));
                        for (int y=0; y<ny; y++) {
                                double sm=0;
                                for (int x=0; x<nx; x++) sm+=image->get_value_at(x,y);
                                ret->set_value_at(y,0,0,sm/nx);
                        }
                        return ret;
                }
                else if (dir=="y") {
                        ret->set_size(nx,1,1);
                        ret->set_attr("apix_x",image->get_attr("apix_x"));
                        for (int x=0; x<nx; x++) {
                                double sm=0;
                                for (int y=0; y<ny; y++) sm+=image->get_value_at(x,y);
                                ret->set_value_at(x,0,0,sm/ny);
                        }
                        return ret;
                }
                else throw InvalidParameterException("The direction parameter must be either x, y for 2-D images");
        }
 
        int a0 = params.set_default("first", 0);
        int a1 = params.set_default("last", -1);
 
        // compress one of the dimensions
        if ( dir == "x" ) {
                ret->set_size(nz,ny);
                ret->set_attr("apix_x",image->get_attr("apix_z"));
                ret->set_attr("apix_y",image->get_attr("apix_y"));
 
                // bounds checks
                if (a0<0) a0+=nx;
                if (a1<0) a1+=nx;
                if (a0<0) a0=0;
                if (a1<0) a1=0;
                if (a0>=nx) a0=nx-1;
                if (a1>=nx) a1=nx-1;
 
                for (int y=0; y<ny; y++) {
                        for (int z=0; z<nz; z++) {
                                double sum=0.0;
                                for (int x=a0; x<=a1; x++) sum+=image->get_value_at(x,y,z);
                                ret->set_value_at(z,y,(float)sum);
                        }
                }
        }
        else if ( dir == "y" ) {
                ret->set_size(nx,nz);
                ret->set_attr("apix_x",image->get_attr("apix_x"));
                ret->set_attr("apix_y",image->get_attr("apix_z"));
 
                // bounds checks
                if (a0<0) a0+=ny;
                if (a1<0) a1+=ny;
                if (a0<0) a0=0;
                if (a1<0) a1=0;
                if (a0>=ny) a0=ny-1;
                if (a1>=ny) a1=ny-1;
 
                for (int x=0; x<nx; x++) {
                        for (int z=0; z<nz; z++) {
                                double sum=0.0;
                                for (int y=a0; y<=a1; y++) sum+=image->get_value_at(x,y,z);
                                ret->set_value_at(x,z,(float)sum);
                        }
                }
        }
        else if ( dir == "z" ) {
                ret->set_size(nx,ny);
                ret->set_attr("apix_x",image->get_attr("apix_x"));
                ret->set_attr("apix_y",image->get_attr("apix_y"));
 
                // bounds checks
                if (a0<0) a0+=nz;
                if (a1<0) a1+=nz;
                if (a0<0) a0=0;
                if (a1<0) a1=0;
                if (a0>=nz) a0=nz-1;
                if (a1>=nz) a1=nz-1;
 
                for (int y=0; y<ny; y++) {
                        for (int x=0; x<nx; x++) {
                                double sum=0.0;
                                for (int z=a0; z<=a1; z++) sum+=image->get_value_at(x,y,z);
                                ret->set_value_at(x,y,(float)sum);
                        }
                }
        }
 
        ret->update();
        return ret;
}

References InvalidParameterException, EMAN::Processor::params, EMAN::Dict::set_default(), x, and y.

◆ process_inplace()

virtual void EMAN::DirectionalSumProcessor::process_inplace ( EMData * )

inlinevirtual

Exceptions

InvalidCallException raised if this function is called

Implements EMAN::Processor.

Definition at line 7667 of file processor.h.

                                                      {
                        throw InvalidCallException("The directional sum processor does not work inplace");
                }

References InvalidCallException.

Member Data Documentation

◆ NAME

const string DirectionalSumProcessor::NAME = "misc.directional_sum"

static

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