Cmp class defines image comparison method. More...

#include <cmp.h>

Inheritance diagram for EMAN::Cmp:

[legend]

Collaboration diagram for EMAN::Cmp:

Public Member Functions
virtual	~Cmp ()

virtual float	cmp (EMData image, EMData with) const =0
	To compare 'image' with another image passed in through its parameters. More...

virtual string	get_name () const =0
	Get the Cmp's name. More...

virtual string	get_desc () const =0

virtual Dict	get_params () const
	Get the Cmp parameters in a key/value dictionary. More...

virtual void	set_params (const Dict &new_params)
	Set the Cmp parameters using a key/value dictionary. More...

virtual TypeDict	get_param_types () const =0
	Get Cmp parameter information in a dictionary. More...

Protected Member Functions
void	validate_input_args (const EMData image, const EMData with) const

Protected Attributes
Dict	params

Detailed Description

Cmp class defines image comparison method.

Using default arguments, smaller values indicate more similar images.

Cmp class is the base comparison class. Each specific comparison class is a subclass of Cmp, and must have a unique name. The name is used to create a new Cmp instance or call a Cmp.

All Cmp classes in EMAN are managed by a Factory pattern. So
each Cmp class must define:
  - a unique name to idenfity itself in the factory.
  - a static method to register itself in the factory.

Typical usage of Cmp:

How to get all Cmp names
vector<string> all_cmps = Factory<Cmp>::get_list();

EMAN::Factory::get_list
static vector< string > get_list()
Definition: emobject.h:837
How to use a Cmp
EMData *image1 = ...;

EMData *image2 = ...;

Dict params = ...;

float result = image1->cmp("CMP_NAME", image2, params);

EMAN::Cmp::params
Dict params
Definition: cmp.h:132
How to define a new Cmp class
A new XYZCmp class should implement the following functions: (Please replace 'XYZ' with your own class name).
float cmp(EMData * image, EMData * with) const;

TypeDict get_param_types() const;

string get_name() const { return "XYZ"; }

static Cmp *NEW() { return XYZCmp(); }

EMAN::Cmp::get_param_types
virtual TypeDict get_param_types() const =0
Get Cmp parameter information in a dictionary.

EMAN::Cmp::cmp
virtual float cmp(EMData *image, EMData *with) const =0
To compare 'image' with another image passed in through its parameters.

EMAN::Cmp::get_name
virtual string get_name() const =0
Get the Cmp's name.

Definition at line 81 of file cmp.h.

Constructor & Destructor Documentation

◆ ~Cmp()

virtual EMAN::Cmp::~Cmp ( )

inlinevirtual

Definition at line 84 of file cmp.h.

85 {

86 }

Member Function Documentation

◆ cmp()

virtual float EMAN::Cmp::cmp	(	EMData *	image,
		EMData *	with
	)		const

pure virtual

To compare 'image' with another image passed in through its parameters.

An optional transformation may be used to transform the 2 images.

Parameters

image	The first image to be compared.
with	The second image to be comppared.

Returns: The comparison result. Smaller better by default

Implemented in EMAN::CccCmp, EMAN::LodCmp, EMAN::SqEuclideanCmp, EMAN::DotCmp, EMAN::TomoCccCmp, EMAN::TomoWedgeCccCmp, EMAN::TomoWedgeFscCmp, EMAN::TomoFscCmp, EMAN::QuadMinDotCmp, EMAN::OptSubCmp, EMAN::OptVarianceCmp, EMAN::PhaseCmp, EMAN::FRCCmp, EMAN::VerticalCmp, and EMAN::XYZCmp.

Referenced by refalifn(), refalifn3dquat(), symquat(), EMAN::RT3DGridAligner::xform_align_nbest(), EMAN::RT3DSphereAligner::xform_align_nbest(), and EMAN::RT3DSymmetryAligner::xform_align_nbest().

◆ get_desc()

virtual string EMAN::Cmp::get_desc ( ) const

pure virtual

Implemented in EMAN::CccCmp, EMAN::LodCmp, EMAN::SqEuclideanCmp, EMAN::DotCmp, EMAN::TomoCccCmp, EMAN::TomoWedgeCccCmp, EMAN::TomoWedgeFscCmp, EMAN::TomoFscCmp, EMAN::QuadMinDotCmp, EMAN::OptSubCmp, EMAN::OptVarianceCmp, EMAN::PhaseCmp, EMAN::FRCCmp, EMAN::VerticalCmp, and EMAN::XYZCmp.

◆ get_name()

virtual string EMAN::Cmp::get_name ( ) const

pure virtual

Get the Cmp's name.

Each Cmp is identified by a unique name.

Returns: The Cmp's name.

Implemented in EMAN::CccCmp, EMAN::LodCmp, EMAN::SqEuclideanCmp, EMAN::DotCmp, EMAN::TomoCccCmp, EMAN::TomoWedgeCccCmp, EMAN::TomoWedgeFscCmp, EMAN::TomoFscCmp, EMAN::QuadMinDotCmp, EMAN::OptSubCmp, EMAN::OptVarianceCmp, EMAN::PhaseCmp, EMAN::FRCCmp, EMAN::VerticalCmp, and EMAN::XYZCmp.

◆ get_param_types()

virtual TypeDict EMAN::Cmp::get_param_types ( ) const

pure virtual

Get Cmp 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.

Implemented in EMAN::CccCmp, EMAN::LodCmp, EMAN::SqEuclideanCmp, EMAN::DotCmp, EMAN::TomoCccCmp, EMAN::TomoWedgeCccCmp, EMAN::TomoWedgeFscCmp, EMAN::TomoFscCmp, EMAN::QuadMinDotCmp, EMAN::OptSubCmp, EMAN::OptVarianceCmp, EMAN::PhaseCmp, EMAN::FRCCmp, EMAN::VerticalCmp, and EMAN::XYZCmp.

◆ get_params()

virtual Dict EMAN::Cmp::get_params ( ) const

inlinevirtual

Get the Cmp parameters in a key/value dictionary.

Returns: A key/value pair dictionary containing the parameters.

Definition at line 108 of file cmp.h.

                {
                        return params;
                }

References params.

◆ set_params()

virtual void EMAN::Cmp::set_params ( const Dict & new_params )

inlinevirtual

Set the Cmp parameters using a key/value dictionary.

Parameters

new_params A dictionary containing the new parameters.

Definition at line 116 of file cmp.h.

                {
                        params = new_params;
                }

References params.

◆ validate_input_args()

void Cmp::validate_input_args	(	const EMData *	image,
		const EMData *	with
	)		const

protected

Definition at line 81 of file cmp.cpp.

{
        
#ifdef EMAN2_USING_CUDA  
        if (image->getcudarwdata() && with->getcudarwdata()) {
                //no need for futher checking, which will induce an expensive copy from device to host
                return;
        }
#endif
        if (!image) {
                throw NullPointerException("compared image");
        }
        if (!with) {
                throw NullPointerException("compare-with image");
        }
 
        if (!EMUtil::is_same_size(image, with)) {
                throw ImageFormatException( "images not same size");
        }
 
        float *d1 = image->get_data();
        if (!d1) {
                throw NullPointerException("image contains no data");
        }
 
        float *d2 = with->get_data();
        if (!d2) {
                throw NullPointerException("compare-with image data");
        }
}

References ImageFormatException, EMAN::EMUtil::is_same_size(), and NullPointerException.

Referenced by EMAN::CccCmp::cmp(), EMAN::LodCmp::cmp(), EMAN::SqEuclideanCmp::cmp(), EMAN::DotCmp::cmp(), EMAN::QuadMinDotCmp::cmp(), EMAN::OptSubCmp::cmp(), EMAN::OptVarianceCmp::cmp(), EMAN::FRCCmp::cmp(), and EMAN::XYZCmp::cmp().

Member Data Documentation

◆ params

Dict EMAN::Cmp::params

mutableprotected

Definition at line 132 of file cmp.h.

Referenced by EMAN::CccCmp::cmp(), EMAN::LodCmp::cmp(), EMAN::SqEuclideanCmp::cmp(), EMAN::DotCmp::cmp(), EMAN::TomoCccCmp::cmp(), EMAN::TomoWedgeCccCmp::cmp(), EMAN::TomoWedgeFscCmp::cmp(), EMAN::TomoFscCmp::cmp(), EMAN::QuadMinDotCmp::cmp(), EMAN::OptSubCmp::cmp(), EMAN::OptVarianceCmp::cmp(), EMAN::PhaseCmp::cmp(), EMAN::FRCCmp::cmp(), EMAN::XYZCmp::cmp(), get_params(), and set_params().

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

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ~Cmp()

Member Function Documentation

◆ cmp()

◆ get_desc()

◆ get_name()

◆ get_param_types()

◆ get_params()

◆ set_params()

◆ validate_input_args()

Member Data Documentation

◆ params