Xmipp  v3.23.11-Nereus
Public Member Functions | Public Attributes | List of all members
ProgPerformanceTest Class Reference

#include <mpi_performance_test.h>

Inheritance diagram for ProgPerformanceTest:
Inheritance graph
[legend]
Collaboration diagram for ProgPerformanceTest:
Collaboration graph
[legend]

Public Member Functions

 ProgPerformanceTest (int argc, char **argv)
 Empty constructor. More...
 
 ProgPerformanceTest (const ProgPerformanceTest &)=delete
 
 ProgPerformanceTest (const ProgPerformanceTest &&)=delete
 
 ~ProgPerformanceTest ()
 Destructor. More...
 
ProgPerformanceTestoperator= (const ProgPerformanceTest &)=delete
 
ProgPerformanceTestoperator= (const ProgPerformanceTest &&)=delete
 
void readParams ()
 Read argument from command line. More...
 
void show ()
 Show. More...
 
void defineParams ()
 Usage. More...
 
void produceSideInfo ()
 Produce side info. More...
 
void run ()
 
- 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)
 
ParamDefgetParamDef (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 fnIn
 
MpiNodenode =nullptr
 
- 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
 
ProgramDefprogDef
 Program definition and arguments parser. More...
 
std::map< String, CommentListdefaultComments
 
int argc
 Original command line arguments. More...
 
const char ** argv
 

Detailed Description

Definition at line 34 of file mpi_performance_test.h.

Constructor & Destructor Documentation

◆ ProgPerformanceTest() [1/3]

ProgPerformanceTest::ProgPerformanceTest ( int  argc,
char **  argv 
)

Empty constructor.

Definition at line 35 of file mpi_performance_test.cpp.

36 {
37  node=new MpiNode(argc,argv);
38  if (!node->isMaster())
39  verbose=0;
40 }
int argc
Original command line arguments.
Definition: xmipp_program.h:86
const char ** argv
Definition: xmipp_program.h:87
int verbose
Verbosity level.
bool isMaster() const
Definition: xmipp_mpi.cpp:166

◆ ProgPerformanceTest() [2/3]

ProgPerformanceTest::ProgPerformanceTest ( const ProgPerformanceTest )
delete

◆ ProgPerformanceTest() [3/3]

ProgPerformanceTest::ProgPerformanceTest ( const ProgPerformanceTest &&  )
delete

◆ ~ProgPerformanceTest()

ProgPerformanceTest::~ProgPerformanceTest ( )

Destructor.

Definition at line 43 of file mpi_performance_test.cpp.

44 {
45  delete node;
46 }

Member Function Documentation

◆ defineParams()

void ProgPerformanceTest::defineParams ( )
virtual

Usage.

Reimplemented from XmippProgram.

Definition at line 65 of file mpi_performance_test.cpp.

66 {
67  addUsageLine("Makes a rotational invariant representation of the image collection");
68  addParamsLine(" -i <selfile> : Selfile with experimental images");
69  addExampleLine("mpirun -np 4 `which xmipp_mpi_image_rotational_pca` -i images.stk --oroot images_eigen --thr 4");
70 }
void addExampleLine(const char *example, bool verbatim=true)
void addUsageLine(const char *line, bool verbatim=false)
void addParamsLine(const String &line)

◆ operator=() [1/2]

ProgPerformanceTest& ProgPerformanceTest::operator= ( const ProgPerformanceTest )
delete

◆ operator=() [2/2]

ProgPerformanceTest& ProgPerformanceTest::operator= ( const ProgPerformanceTest &&  )
delete

◆ produceSideInfo()

void ProgPerformanceTest::produceSideInfo ( )

Produce side info.

Definition at line 73 of file mpi_performance_test.cpp.

74 {
75  TimeStamp t0;
76  annotate_time(&t0);
77  MetaDataVec MDin(fnIn);
78  print_elapsed_time(t0,false);
79 }
void print_elapsed_time(ProcessorTimeStamp &time, bool _IN_SECS)
void annotate_time(TimeStamp *time)
size_t TimeStamp
Definition: xmipp_funcs.h:823

◆ readParams()

void ProgPerformanceTest::readParams ( )
virtual

Read argument from command line.

Reimplemented from XmippProgram.

Definition at line 49 of file mpi_performance_test.cpp.

50 {
51  fnIn = getParam("-i");
52 }
const char * getParam(const char *param, int arg=0)

◆ run()

void ProgPerformanceTest::run ( )
virtual

Run.

Reimplemented from XmippProgram.

Definition at line 82 of file mpi_performance_test.cpp.

83 {
84  show();
85  if (system("hostname")==-1)
86  REPORT_ERROR(ERR_UNCLASSIFIED,"Cannot open shell");
88 }
Just to locate unclassified errors.
Definition: xmipp_error.h:192
#define REPORT_ERROR(nerr, ErrormMsg)
Definition: xmipp_error.h:211
void produceSideInfo()
Produce side info.

◆ show()

void ProgPerformanceTest::show ( )

Show.

Definition at line 55 of file mpi_performance_test.cpp.

56 {
57  if (!verbose)
58  return;
59  std::cout
60  << "Input: " << fnIn << std::endl
61  ;
62 }
int verbose
Verbosity level.

Member Data Documentation

◆ fnIn

FileName ProgPerformanceTest::fnIn

Input selfile

Definition at line 38 of file mpi_performance_test.h.

◆ node

MpiNode* ProgPerformanceTest::node =nullptr

Definition at line 41 of file mpi_performance_test.h.


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