#include <xmipp_mpi.h>

Inheritance diagram for MpiMetadataProgram:

Collaboration diagram for MpiMetadataProgram:

Public Member Functions
	MpiMetadataProgram ()

	MpiMetadataProgram (const MpiMetadataProgram &)=delete

	MpiMetadataProgram (const MpiMetadataProgram &&)=delete

	~MpiMetadataProgram ()

MpiMetadataProgram &	operator= (const MpiMetadataProgram &)=delete

MpiMetadataProgram &	operator= (const MpiMetadataProgram &&)=delete

void	read (int argc, char **argv)

void	defineParams ()

void	readParams ()

void	createTaskDistributor (MetaData &mdIn, size_t blockSize=0)

virtual void	preProcess ()

virtual void	finishProcessing ()

bool	getTaskToProcess (size_t &objId, size_t &objIndex)

Public Member Functions inherited from XmippMpiProgram
void	read (int argc, char **argv)

virtual int	tryRun ()

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	run ()

virtual void	quit (int exit_code=0) const

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 ()

Protected Attributes
int	blockSize

std::vector< size_t >	imgsId

MpiTaskDistributor *	distributor =nullptr

size_t	first

size_t	last

Protected Attributes inherited from XmippMpiProgram
std::shared_ptr< MpiNode >	node

size_t	nProcs

size_t	numberOfJobs

MPI_Status	status

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

Additional Inherited Members
Public Attributes inherited from XmippProgram
bool	doRun

bool	runWithoutArgs

int	verbose
	Verbosity level. More...

int	debug

Protected Member Functions inherited from XmippMpiProgram
void	setNode (const std::shared_ptr< MpiNode > &node)

Protected Member Functions inherited from XmippProgram
void	defineCommons ()

Detailed Description

Definition at line 184 of file xmipp_mpi.h.

Constructor & Destructor Documentation

◆ MpiMetadataProgram() [1/3]

MpiMetadataProgram::MpiMetadataProgram ( )

inline

Constructor

Definition at line 195 of file xmipp_mpi.h.

195 {}

◆ MpiMetadataProgram() [2/3]

MpiMetadataProgram::MpiMetadataProgram ( const MpiMetadataProgram & )

delete

◆ MpiMetadataProgram() [3/3]

MpiMetadataProgram::MpiMetadataProgram ( const MpiMetadataProgram && )

delete

◆ ~MpiMetadataProgram()

MpiMetadataProgram::~MpiMetadataProgram ( )

Destructor

Definition at line 279 of file xmipp_mpi.cpp.

 {
     delete distributor;
 }

Member Function Documentation

◆ createTaskDistributor()

void MpiMetadataProgram::createTaskDistributor	(	MetaData &	mdIn,
		size_t	blockSize = `0`
	)

Create task distributor

Definition at line 302 of file xmipp_mpi.cpp.

 {
     size_t size = mdIn.size();
     if (blockSize < 1)
         blockSize = XMIPP_MAX(1, size/(node->size * 5));
     else if (blockSize > size)
         blockSize = size;
 
     mdIn.findObjects(imgsId);
     distributor = new MpiTaskDistributor(size, blockSize, node);
 }

◆ defineParams()

void MpiMetadataProgram::defineParams ( )

virtual

Function in which the param of each Program are defined.

Reimplemented from XmippProgram.

Definition at line 291 of file xmipp_mpi.cpp.

 {
     addParamsLine("== MPI ==");
     addParamsLine(" [--mpi_job_size <size=0>]     : Number of images sent simultaneously to a mpi node");
 }

◆ finishProcessing()

virtual void MpiMetadataProgram::finishProcessing ( )

inlinevirtual

finishProcessing

Definition at line 214 of file xmipp_mpi.h.

214 { /* nothing to do */ };

◆ getTaskToProcess()

bool MpiMetadataProgram::getTaskToProcess	(	size_t &	objId,
		size_t &	objIndex
	)

Get task to process

Definition at line 316 of file xmipp_mpi.cpp.

 {
     bool moreTasks = true;
     if (first > last)
         moreTasks = distributor->getTasks(first, last);
     if (moreTasks)
     {
         objIndex = first;
         objId = imgsId[first++];
         return true;
     }
     first = distributor->numberOfTasks - 1;
     return false;
 }

◆ operator=() [1/2]

MpiMetadataProgram& MpiMetadataProgram::operator= ( const MpiMetadataProgram & )

delete

◆ operator=() [2/2]

MpiMetadataProgram& MpiMetadataProgram::operator= ( const MpiMetadataProgram && )

delete

◆ preProcess()

virtual void MpiMetadataProgram::preProcess ( )

inlinevirtual

Preprocess

Definition at line 212 of file xmipp_mpi.h.

212 { /* nothing to do */ };

◆ read()

void MpiMetadataProgram::read	(	int	argc,
		char **	argv
	)

Read arguments

Definition at line 284 of file xmipp_mpi.cpp.

 {
     XmippMpiProgram::read(argc, argv);
     last = 0;
     first = 1;
 }

◆ readParams()

void MpiMetadataProgram::readParams ( )

virtual

Function in which each program will read parameters that it need. If some error occurs the usage will be printed out.

Reimplemented from XmippProgram.

Definition at line 297 of file xmipp_mpi.cpp.

 {
     blockSize = getIntParam("--mpi_job_size");
 }

Member Data Documentation

◆ blockSize

int MpiMetadataProgram::blockSize

protected

Divide the job in this number block with this number of images

Definition at line 188 of file xmipp_mpi.h.

◆ distributor

MpiTaskDistributor* MpiMetadataProgram::distributor =nullptr

protected

Definition at line 190 of file xmipp_mpi.h.

◆ first

size_t MpiMetadataProgram::first

protected

Definition at line 191 of file xmipp_mpi.h.

◆ imgsId

std::vector<size_t> MpiMetadataProgram::imgsId

protected

Definition at line 189 of file xmipp_mpi.h.

◆ last

size_t MpiMetadataProgram::last

protected

Definition at line 191 of file xmipp_mpi.h.

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

xmipp/libraries/parallel/xmipp_mpi.h
xmipp/libraries/parallel/xmipp_mpi.cpp

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ MpiMetadataProgram() [1/3]

◆ MpiMetadataProgram() [2/3]

◆ MpiMetadataProgram() [3/3]

◆ ~MpiMetadataProgram()

Member Function Documentation

◆ createTaskDistributor()

◆ defineParams()

◆ finishProcessing()

◆ getTaskToProcess()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ preProcess()

◆ read()

◆ readParams()

Member Data Documentation

◆ blockSize

◆ distributor

◆ first

◆ imgsId

◆ last