#include <classify_compare_classes.h>

Inheritance diagram for ProgCompareClass:

Collaboration diagram for ProgCompareClass:

Public Member Functions
void	readParams ()
	Read input parameters. More...

void	defineParams ()
	Define input parameters. More...

void	show ()
	Show. More...

void	run ()
	Execute. More...

Public Member Functions inherited from XmippProgram
const char *	getParam (const char *param, int arg=0)

const char *	getParam (const char param, const char subparam, int arg=0)

int	getIntParam (const char *param, int arg=0)

int	getIntParam (const char param, const char subparam, int arg=0)

double	getDoubleParam (const char *param, int arg=0)

double	getDoubleParam (const char param, const char subparam, int arg=0)

float	getFloatParam (const char *param, int arg=0)

float	getFloatParam (const char param, const char subparam, int arg=0)

void	getListParam (const char *param, StringVector &list)

int	getCountParam (const char *param)

bool	checkParam (const char *param)

bool	existsParam (const char *param)

void	addParamsLine (const String &line)

void	addParamsLine (const char *line)

ParamDef *	getParamDef (const char *param) const

virtual void	quit (int exit_code=0) const

virtual int	tryRun ()

void	initProgress (size_t total, size_t stepBin=60)

void	setProgress (size_t value=0)

void	endProgress ()

void	processDefaultComment (const char param, const char left)

void	setDefaultComment (const char param, const char comment)

virtual void	initComments ()

void	setProgramName (const char *name)

void	addUsageLine (const char *line, bool verbatim=false)

void	clearUsage ()

void	addExampleLine (const char *example, bool verbatim=true)

void	addSeeAlsoLine (const char *seeAlso)

void	addKeywords (const char *keywords)

const char *	name () const

virtual void	usage (int verb=0) const

virtual void	usage (const String &param, int verb=2)

int	version () const

virtual void	show () const

virtual void	read (int argc, const char **argv, bool reportErrors=true)

virtual void	read (int argc, char **argv, bool reportErrors=true)

void	read (const String &argumentsLine)

	XmippProgram ()

	XmippProgram (int argc, const char **argv)

virtual	~XmippProgram ()

Public Attributes
FileName	fnClass1
	Name of the two classification metadatas. More...

FileName	fnClass2

FileName	fnOut
	Name of the output text file. More...

bool	append
	Append to output. More...

Public Attributes inherited from XmippProgram
bool	doRun

bool	runWithoutArgs

int	verbose
	Verbosity level. More...

int	debug

Additional Inherited Members
Protected Member Functions inherited from XmippProgram
void	defineCommons ()

Protected Attributes inherited from XmippProgram
int	errorCode

ProgramDef *	progDef
	Program definition and arguments parser. More...

std::map< String, CommentList >	defaultComments

int	argc
	Original command line arguments. More...

const char **	argv

Detailed Description

Compare a set of classes

Definition at line 37 of file classify_compare_classes.h.

Member Function Documentation

◆ defineParams()

void ProgCompareClass::defineParams ( )

virtual

Define input parameters.

Reimplemented from XmippProgram.

Definition at line 39 of file classify_compare_classes.cpp.

 {
     addUsageLine("Compare two classifications");
     addUsageLine("+The program provides information about which class of classification 1 corresponds to which class of classification 2");
     addUsageLine("+");
     addParamsLine(" --i1 <infile1>             : Metadata with the classification 1");
     addParamsLine(" --i2 <infile2>             : Metadata with the classification 2");
     addParamsLine(" -o <outfile>              : Output text file");
     addParamsLine(" [--append]                : Append text to output");
     addExampleLine("xmipp_classify_compare_classes --i1 2D/CL2D/run_001/results_level_00_classes.xmd --i2 2D/CL2D/run_001/results_level_01_classes.xmd -o comparison_level_00_01.txt");
 }

◆ readParams()

void ProgCompareClass::readParams ( )

virtual

Read input parameters.

Reimplemented from XmippProgram.

Definition at line 31 of file classify_compare_classes.cpp.

 {
     fnClass1=getParam("--i1");
     fnClass2=getParam("--i2");
     fnOut=getParam("-o");
     append=checkParam("--append");
 }

◆ run()

void ProgCompareClass::run ( )

virtual

Execute.

Reimplemented from XmippProgram.

Definition at line 61 of file classify_compare_classes.cpp.

 {
     MetaDataVec MD1(formatString("classes@%s",fnClass1.c_str()));
     MetaDataVec MD2(formatString("classes@%s",fnClass2.c_str()));
     std::vector<int> ref1, ref2;
     int aux;
     for (size_t objId : MD1.ids())
     {
         MD1.getValue(MDL_REF,aux,objId);
         ref1.push_back(aux);
     }
     for (size_t objId : MD2.ids())
     {
         MD2.getValue(MDL_REF,aux,objId);
         ref2.push_back(aux);
     }
 
     Matrix2D<int> comparisonMatrix(MD1.size(),MD2.size());
     Matrix1D<int> MD1classSize(MAT_YSIZE(comparisonMatrix)), MD2classSize(MAT_XSIZE(comparisonMatrix));
 
     // Read the size of the individual classes
     MetaDataDb MDclass1, MDclass2;
     FOR_ALL_ELEMENTS_IN_MATRIX1D(MD1classSize)
     {
         MDclass1.read(formatString("class%06d_images@%s",ref1[i],fnClass1.c_str()));
         VEC_ELEM(MD1classSize,i)=MDclass1.size();
     }
 
     FOR_ALL_ELEMENTS_IN_MATRIX1D(MD2classSize)
     {
         MDclass2.read(formatString("class%06d_images@%s",ref2[i],fnClass2.c_str()));
         VEC_ELEM(MD2classSize,i)=MDclass2.size();
     }
 
     // Now compare the two classifications
     for (size_t i=0; i<MAT_YSIZE(comparisonMatrix); i++)
     {
         MDclass1.read(formatString("class%06d_images@%s",ref1[i],fnClass1.c_str()));
         for (size_t j=0; j<MAT_XSIZE(comparisonMatrix); j++)
         {
             MDclass2.read(formatString("class%06d_images@%s",ref2[j],fnClass2.c_str()));
             MDclass2.intersection(MDclass1,MDL_IMAGE);
             MAT_ELEM(comparisonMatrix,i,j)=MDclass2.size();
         }
     }
 
     // Report analysis
     std::ofstream fhOut;
     if (append)
     {
         fhOut.open(fnOut.c_str(),std::ios::app);
         fhOut << "\n\n------------------------------------------------------------------------\n";
     }
     else
         fhOut.open(fnOut.c_str());
     if (!fhOut)
         REPORT_ERROR(ERR_IO_NOWRITE,fnOut);
     fhOut << "Comparison of " << fnClass1 << " and " << fnClass2 << std::endl;
     fhOut << "Analysis of " << fnClass1 << " =======================\n";
     for (size_t i=0; i<MAT_YSIZE(comparisonMatrix); i++)
     {
         fhOut << "Class " << formatString("class%06d_images@%s",ref1[i],fnClass1.c_str()) << ": " << VEC_ELEM(MD1classSize,i) << " images\n";
         for (size_t j=0; j<MAT_XSIZE(comparisonMatrix); j++)
             if (MAT_ELEM(comparisonMatrix,i,j)>0)
                 fhOut << "   " << 100.0*MAT_ELEM(comparisonMatrix,i,j)/VEC_ELEM(MD1classSize,i) << "% are in class " << formatString("class%06d_images@%s",j+1,fnClass2.c_str()) << std::endl;
     }
     fhOut << "\n\nAnalysis of " << fnClass2 << " =======================\n";
     for (size_t j=0; j<MAT_XSIZE(comparisonMatrix); j++)
     {
         fhOut << "Class " << formatString("class%06d_images@%s",ref2[j],fnClass2.c_str()) << ": " << VEC_ELEM(MD2classSize,j) << " images\n";
         for (size_t i=0; i<MAT_YSIZE(comparisonMatrix); i++)
             if (MAT_ELEM(comparisonMatrix,i,j)>0)
                 fhOut << "   " << 100.0*MAT_ELEM(comparisonMatrix,i,j)/VEC_ELEM(MD2classSize,j) << "% are in class " << formatString("class%06d_images@%s",i+1,fnClass1.c_str()) << std::endl;
     }
     fhOut.close();
 }

◆ show()

void ProgCompareClass::show ( )

Show.

Definition at line 51 of file classify_compare_classes.cpp.

 {
     if (!verbose)
         return;
     std::cout
     << "Input1: " << fnClass1 << std::endl
     << "Input2: " << fnClass2 << std::endl
     << "Output: " << fnOut << std::endl;
 }

Member Data Documentation

◆ append

bool ProgCompareClass::append

Append to output.

Definition at line 45 of file classify_compare_classes.h.

◆ fnClass1

FileName ProgCompareClass::fnClass1

Name of the two classification metadatas.

Definition at line 41 of file classify_compare_classes.h.

◆ fnClass2

FileName ProgCompareClass::fnClass2

Definition at line 41 of file classify_compare_classes.h.

◆ fnOut

FileName ProgCompareClass::fnOut

Name of the output text file.

Definition at line 43 of file classify_compare_classes.h.

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

xmipp/libraries/reconstruction/classify_compare_classes.h
xmipp/libraries/reconstruction/classify_compare_classes.cpp

Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ defineParams()

◆ readParams()

◆ run()

◆ show()

Member Data Documentation

◆ append

◆ fnClass1

◆ fnClass2

◆ fnOut