Scale the image with control over the output dimensions. More...

#include <processor.h>

Inheritance diagram for EMAN::ScaleTransformProcessor:

Collaboration diagram for EMAN::ScaleTransformProcessor:

[legend]

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

virtual void	process_inplace (EMData *image)

virtual EMData *	process (const EMData *const image)

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 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 = "xform.scale"

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

Scale the image with control over the output dimensions.

Author: David Woolford

Date: June 2009

Parameters

scale	The amount by which to scale
cip	The length of each output dimension. Non sophisticated, output dimensions can't be different

Definition at line 2985 of file processor.h.

Member Function Documentation

◆ get_desc()

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

                        {
                                return "The image is scaled with the clip variable in mind, being sure to preserve as much pixel information as possible.";
                        }

◆ get_name()

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

                        {
                                return NAME;
                        }

References NAME.

◆ get_param_types()

virtual TypeDict EMAN::ScaleTransformProcessor::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.

d.put("clipx", EMObject::INT, "The length of the output x dimension. Exclusive of the clip.");

Reimplemented from EMAN::Processor.

Definition at line 3008 of file processor.h.

                        {
                                TypeDict d;
                                d.put("scale", EMObject::FLOAT, "The amount by which to scale" );
                                d.put("clip", EMObject::INT, "The length of each output dimension. Non sophisticated, output dimensions can't be different" );
                                return d;
                        }

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

◆ NEW()

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

inlinestatic

Definition at line 2992 of file processor.h.

                        {
                                return new ScaleTransformProcessor();
                        }

◆ process()

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

virtual

Exceptions

ImageDimensionException	if the image is not 2D or 3D
InvalidParameterException	if the Transform parameter is not specified

Reimplemented from EMAN::Processor.

Definition at line 12072 of file processor.cpp.

                                                                  {
        int ndim = image->get_ndim();
        if (ndim != 2 && ndim != 3) throw UnexpectedBehaviorException("The Scale Transform processors only works for 2D and 3D images");
 
        if ( image->get_xsize() != image->get_ysize()) {
                throw ImageDimensionException("x size and y size of image do not match. This processor only works for uniformly sized data");
        }
        if ( ndim == 3 ) {
                if ( image->get_xsize() != image->get_zsize()) {
                throw ImageDimensionException("x size and z size of image do not match. This processor only works for uniformly sized data");
                }
        }
 
        float scale = params.set_default("scale",0.0f);
        if (scale <= 0.0f) throw InvalidParameterException("The scale parameter must be greater than 0");
 
        int clip = 0;
 
        if(params.has_key("clip"))
        {
                clip = params["clip"];
                if (clip < 0) throw InvalidParameterException("The clip parameter must be greater than 0"); // If it's zero it's not used
        }
        else
        {
                clip = (int)(scale*image->get_xsize());
        }
 
        Region r;
        if (ndim == 3) {
                 r = Region( (image->get_xsize()-clip)/2, (image->get_xsize()-clip)/2, (image->get_xsize()-clip)/2,clip, clip,clip);
        } else { // ndim == 2 guaranteed by check at beginning of function
                 r = Region( (image->get_xsize()-clip)/2, (image->get_xsize()-clip)/2, clip, clip);
        }
 
        EMData* ret = 0;
        if (scale > 1) {
                if ( clip != 0) {
                        ret = image->get_clip(r);
                }
                Transform t;
                t.set_scale(scale);
                if (ret != 0) {
                        ret->process_inplace("xform",Dict("transform",&t));
                } else {
                        ret = image->process("xform",Dict("transform",&t));
                }
        } else if (scale < 1) {
                Transform t;
                t.set_scale(scale);
                ret = image->process("xform",Dict("transform",&t));
                if ( clip != 0) {
                        ret->clip_inplace(r);
                }
        } else {
                if ( clip != 0) {
                        ret = image->get_clip(r);
                } else {
                        ret = image->copy();
                }
        }
        return ret;
 
}

References EMAN::EMData::clip_inplace(), EMAN::EMData::get_clip(), EMAN::Dict::has_key(), ImageDimensionException, InvalidParameterException, EMAN::Processor::params, EMAN::Dict::set_default(), EMAN::Transform::set_scale(), and UnexpectedBehaviorException.

◆ process_inplace()

void ScaleTransformProcessor::process_inplace ( EMData * image )

virtual

Exceptions

ImageDimensionException	if the image is not 2D or 3D
InvalidParameterException	if the Transform parameter is not specified

Implements EMAN::Processor.

Definition at line 11813 of file processor.cpp.

                                                           {
        int ndim = image->get_ndim();
        if (ndim != 2 && ndim != 3) throw UnexpectedBehaviorException("The Scale Transform processors only works for 2D and 3D images");
 
        if ( image->get_xsize() != image->get_ysize()) {
                throw ImageDimensionException("x size and y size of image do not match. This processor only works for uniformly sized data");
        }
        if ( ndim == 3 ) {
                if ( image->get_xsize() != image->get_zsize()) {
                throw ImageDimensionException("x size and z size of image do not match. This processor only works for uniformly sized data");
                }
        }
 
        float scale = params.set_default("scale",0.0f);
        if (scale <= 0.0f) throw InvalidParameterException("The scale parameter must be greater than 0");
 
        int clip = 0;
 
        if(params.has_key("clip"))
        {
                clip = params["clip"];
                if (clip < 0) throw InvalidParameterException("The clip parameter must be greater than 0"); // If it's zero it's not used
        }
        else
        {
                clip = (int)(scale*image->get_xsize());
        }
 
        Region r;
        if (ndim == 3) {
                 r = Region( (image->get_xsize()-clip)/2, (image->get_xsize()-clip)/2, (image->get_xsize()-clip)/2,clip, clip,clip);
        } else { // ndim == 2 guaranteed by check at beginning of function
                 r = Region( (image->get_xsize()-clip)/2, (image->get_xsize()-clip)/2, clip, clip);
        }
 
        if (scale > 1) {
                if ( clip != 0) {
                        image->clip_inplace(r);
                }
                Transform t;
                t.set_scale(scale);
                image->process_inplace("xform",Dict("transform",&t));
        } else if (scale < 1) {
                Transform t;
                t.set_scale(scale);
                image->process_inplace("xform",Dict("transform",&t));
                if ( clip != 0) {
                        image->clip_inplace(r);
                }
        } else {
                if ( clip != 0) {
                        image->clip_inplace(r);
                }
        }
}

References EMAN::EMData::clip_inplace(), EMAN::Dict::has_key(), ImageDimensionException, InvalidParameterException, EMAN::Processor::params, EMAN::Dict::set_default(), EMAN::Transform::set_scale(), and UnexpectedBehaviorException.

Member Data Documentation

◆ NAME

const string ScaleTransformProcessor::NAME = "xform.scale"

static

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