ProgVolumeHalvesRestorationGpu< T > Class Template Reference

#include <volume_halves_restoration_gpu.h>

Inheritance diagram for ProgVolumeHalvesRestorationGpu< T >:

Collaboration diagram for ProgVolumeHalvesRestorationGpu< T >:

Public Member Functions
void	readParams () override
void	defineParams () override
void	run () override
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 ()

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

template<typename T>
class ProgVolumeHalvesRestorationGpu< T >

Definition at line 43 of file volume_halves_restoration_gpu.h.

Member Function Documentation

defineParams()

template<typename T >

void ProgVolumeHalvesRestorationGpu< T >::defineParams ( )

overridevirtual

Function in which the param of each Program are defined.

Reimplemented from XmippProgram.

Definition at line 128 of file volume_halves_restoration_gpu.cpp.

                                                     {
    addUsageLine("Given two halves of a volume (and an optional mask), produce a better estimate of the volume underneath");
    addParamsLine("   --i1 <volume1>              : First half");
    addParamsLine("   --i2 <volume2>              : Second half");
    addParamsLine("  [--oroot <root=\"volumeRestored\">] : Output rootname");
    addParamsLine("  [--denoising <N=0>]          : Number of iterations of denoising in real space");
    addParamsLine("  [--deconvolution <N=0> <sigma0=0.2> <lambda=0.001>]   : Number of iterations of deconvolution in Fourier space, initial sigma and lambda");
    addParamsLine("  [--filterBank <step=0> <overlap=0.5> <weightFun=1> <weightPower=3>] : Frequency step for the filter bank (typically, 0.01; between 0 and 0.5)");
    addParamsLine("                                        : filter overlap is between 0 (no overlap) and 1 (full overlap)");
    addParamsLine("                                : Weight function (0=mean, 1=min, 2=mean*diff");
    addParamsLine("  [--difference <N=0> <K=1.5>]  : Number of iterations of difference evaluation in real space");
    addParamsLine("  [--mask <binary_file>]        : Read from file and cast to binary");
    addParamsLine("  [--center <x0=0> <y0=0> <z0=0>]           : Mask center");
}

readParams()

template<typename T >

void ProgVolumeHalvesRestorationGpu< T >::readParams ( )

overridevirtual

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 28 of file volume_halves_restoration_gpu.cpp.

                                                   {
    readFilenames();
    readDenoisingParams();
    readDeconvolutionParams();
    readFilterBankParams();
    readDifferenceParams();
    readMaskParams();
}

run()

template<typename T >

void ProgVolumeHalvesRestorationGpu< T >::run ( )

overridevirtual

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

Reimplemented from XmippProgram.

Definition at line 144 of file volume_halves_restoration_gpu.cpp.

                                            {
    builder.setVerbosity(verbose);
    auto restorator = builder.build();

    show(restorator);

    readData();
    restorator.apply(V1(), V2(), maskData);

    saveResults(restorator);
}

---

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

• xmipp/libraries/reconstruction_adapt_cuda/volume_halves_restoration_gpu.h
• xmipp/libraries/reconstruction_adapt_cuda/volume_halves_restoration_gpu.cpp