EMAN::IndexMaskFileProcessor Class Reference

Multiplies the image by the specified file using pixel indices. More...

#include <processor.h>

Inheritance diagram for EMAN::IndexMaskFileProcessor:

Collaboration diagram for EMAN::IndexMaskFileProcessor:

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 TypeDict	get_param_types () const
	Get processor parameter information in a dictionary. More...
virtual string	get_desc () const
	Get the descrition of this specific processor. 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::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 = "mask.fromfile"

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

Multiplies the image by the specified file using pixel indices.

The images must be same size. If 'ismaskset=' is 1, it will take a file containing a set of masks and apply the first mask to the image.

Parameters

filename	mask image file name
ismaskset	If set to 1, it will take a file containing a set of masks and apply the first mask to the image

Definition at line 7506 of file processor.h.

Member Function Documentation

get_desc()

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

                {
                        return "Multiplies the image by the specified filename or image object. Note that 'image' should be specified rather than filename for e2proc2d or e2proc3d, as these programs automatically read image filenames when specified as parameters. So-called multi-level masks are also supported via the 'maskset' option.";
                }

get_name()

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

                {
                        return NAME;
                }

References NAME.

get_param_types()

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

                {
                        TypeDict d;
                        d.put("filename", EMObject::STRING, "mask image file name");
                        d.put("image", EMObject::EMDATA, "The actual mask image (instead of the filename).");
                        d.put("maskset", EMObject::INT, "One common way to store multiple masks in a single image is to assign a single integer value to each mask. For files of this type, will set values N-0.5<X<N+0.5 to 1, and other values to zero, before applying the mask.");
                        return d;
                }

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

NEW()

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

inlinestatic

Definition at line 7516 of file processor.h.

                {
                        return new IndexMaskFileProcessor();
                }

process_inplace()

void IndexMaskFileProcessor::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 8118 of file processor.cpp.

{
        if (!image) {
                LOGWARN("NULL Image");
                return;
        }
        EMData* mask = params.set_default("image",(EMData*)0);
 
        if (mask==0) {
                const char *filename = params["filename"];
                mask=new EMData(filename,0);
                if (!EMUtil::is_same_size(image, mask)) {
                        delete mask;
                        LOGERR("IndexMaskFileProcessor: Mask size different than image");
                        return;
                }
        }
        else mask=mask->copy();
 
        int maskset=params.set_default("maskset",-1);
        if (maskset>=0) {
                mask->process_inplace("threshold.binaryrange", Dict("low", (float)(maskset-0.5), "high", (float)(maskset+0.5)));
        }
 
        image->mult(*mask);
        delete mask;
}

References EMAN::EMUtil::is_same_size(), LOGERR, LOGWARN, EMAN::Processor::params, and EMAN::Dict::set_default().

Member Data Documentation

NAME

const string IndexMaskFileProcessor::NAME = "mask.fromfile"

static

Definition at line 7535 of file processor.h.

Referenced by get_name().

---

The documentation for this class was generated from the following files:

• processor.h
• processor.cpp