ProgMetadataImport Class Reference

Inheritance diagram for ProgMetadataImport:

Collaboration diagram for ProgMetadataImport:

Public Member Functions
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)
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 ()

Protected Member Functions
void	defineParams ()
void	readParams ()
Protected Member Functions inherited from XmippProgram
void	defineCommons ()

Additional Inherited Members
Public Attributes inherited from XmippProgram
bool	doRun
bool	runWithoutArgs
int	verbose
	Verbosity level. More...
int	debug
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

Definition at line 29 of file metadata_import_main.cpp.

Member Function Documentation

defineParams()

void ProgMetadataImport::defineParams ( )

inlineprotectedvirtual

Function in which the param of each Program are defined.

Reimplemented from XmippProgram.

Definition at line 37 of file metadata_import_main.cpp.

    {
        addUsageLine("Import metadata from plain text files.");
        addSeeAlsoLine("metadata_utilities");
        addParamsLine("  -i <text_file>     :Input file text file       ");
        addParamsLine("     alias --input;");
        addParamsLine(" [ -o <output_metadata>]     :If not provided, the resulting metadata will be printed on screen");
        addParamsLine("     alias --output;");
        addParamsLine("  --labels <label>                 :label to be imported, you also can pass a list beetween quotes and separated by spaces");
        addParamsLine("     alias -l;");
        addParamsLine(" [ --merge <metadata> ]           :merge the imported metadata to an existing one");
        addParamsLine("     alias -m;");

        addKeywords("import file text");
        addExampleLine("If you have a text file with 2 columns with real values and you want to import as 'angleRot' and 'angleTilt'", false);
        addExampleLine("xmipp_metadata_import -i angles.txt -o angles.doc --labels \"angleRot angleTilt\"");
       // addParamsLine(" [ -s <sep=\" \">]             :Separator to be used, default is space");
       // addParamsLine("     alias --separator;");

    }

readParams()

void ProgMetadataImport::readParams ( )

inlineprotectedvirtual

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 58 of file metadata_import_main.cpp.

    {
        fn_in = getParam("-i");
        //sep = getParam("-s");
        labels = getParam("-l");
    }

run()

void ProgMetadataImport::run ( )

inlinevirtual

This function will be start running the program. it also should be implemented by derived classes.

Reimplemented from XmippProgram.

Definition at line 66 of file metadata_import_main.cpp.

    {
      if (checkParam("-m"))
      {
        md.read(getParam("-m"));
        md.addPlain(fn_in, labels, sep);
      }
      else
        md.readPlain(fn_in, labels, sep);

        if (checkParam("-o"))
          md.write(getParam("-o"));
        else
          md.write(std::cout);
    }

---

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

• xmipp/applications/programs/metadata_import/metadata_import_main.cpp