Alignment::ProgAlignSignificantGPU< T > Class Template Reference

#include <align_significant_gpu.h>

Inheritance diagram for Alignment::ProgAlignSignificantGPU< T >:

Collaboration diagram for Alignment::ProgAlignSignificantGPU< T >:

Public Member Functions
void	defineParams () override
void	readParams () override
void	show () const override
Public Member Functions inherited from Alignment::AProgAlignSignificant< T >
virtual 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	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
std::vector< AlignmentEstimation >	align (const T *ref, const T *others) override
void	updateRefs (T *refs, const T *others, const std::vector< Assignment > &assignments) override
Protected Member Functions inherited from Alignment::AProgAlignSignificant< T >
virtual void	check () const
const Settings &	getSettings ()
ctpl::thread_pool &	getThreadPool ()
void	updateRefXmd (size_t refIndex, std::vector< Assignment > &images)
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

template<typename T>
class Alignment::ProgAlignSignificantGPU< T >

Definition at line 45 of file align_significant_gpu.h.

Member Function Documentation

align()

template<typename T >

std::vector< AlignmentEstimation > Alignment::ProgAlignSignificantGPU< T >::align ( const T *  ref, const T *  others  )

overrideprotectedvirtual

Implements Alignment::AProgAlignSignificant< T >.

Definition at line 73 of file align_significant_gpu.cpp.

                                                                                              {
    auto s = this->getSettings();

    auto &pool = this->getThreadPool();
    auto futures = std::vector<std::future<void>>();
    auto result = std::vector<AlignmentEstimation>();
    for (size_t n = 0; n < s.refDims.n(); ++n) {
        result.emplace_back(s.otherDims.n());
    }

    auto f = [this](int threadId, const T *ref, const Dimensions &refDims,
            const T *others, const Dimensions &otherDims,
            unsigned device,
            AlignmentEstimation *dest) {
        align(ref, refDims, others, otherDims, device, dest);
    };
    size_t step = s.refDims.n() / m_devices.size();
    for (size_t devIndex = 0; devIndex < m_devices.size(); ++devIndex) {
        size_t offset = devIndex * step;
        size_t toProcess = std::min(step, s.refDims.n() - offset);
        futures.emplace_back(pool.push(f,
                ref + (offset * s.refDims.sizeSingle()),
                s.refDims.copyForN(toProcess),
                others, s.otherDims,
                m_devices.at(devIndex),
                result.data() + offset));
    }
    for (auto &f : futures) {
        f.get();
    }
    std::cout << "Done" << std::endl;
    return result;
}

defineParams()

template<typename T >

void Alignment::ProgAlignSignificantGPU< T >::defineParams ( )

overridevirtual

Function in which the param of each Program are defined.

Reimplemented from Alignment::AProgAlignSignificant< T >.

Definition at line 31 of file align_significant_gpu.cpp.

                                              {
    AProgAlignSignificant<T>::defineParams();
    this->addParamsLine("  [--dev <...>]                    : space-separated list of GPU device(s) to use. Single, 0th GPU used by default");
}

readParams()

template<typename T >

void Alignment::ProgAlignSignificantGPU< 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 Alignment::AProgAlignSignificant< T >.

Definition at line 47 of file align_significant_gpu.cpp.

                                            {
    AProgAlignSignificant<T>::readParams();
    // read GPU
    StringVector devs;
    this->getListParam("--dev", devs);
    if (devs.empty()) {
        devs.emplace_back("0"); // by default, use one GPU, 0th
    }
    auto noOfAvailableDevices = GPU::getDeviceCount();
    for (auto &a : devs) {
        int d = std::stoi(a);
        if (0 > d) {
            REPORT_ERROR(ERR_ARG_INCORRECT, "Invalid GPU device '" + a + "' (must be non-negative number)");
        }
        // FIXME DS uncomment once we are decided if we want to run multiple executions on the same GPU
//        if (std::find(m_devices.begin(), m_devices.end(), d) != m_devices.end()) {
//            REPORT_ERROR(ERR_ARG_INCORRECT, "Invalid GPU device '" + a + "' (repeated index)");
//        }
        if (d >= noOfAvailableDevices) {
            REPORT_ERROR(ERR_ARG_INCORRECT, "Invalid GPU device '" + a + "' (index higher than number of available devices)");
        }
        m_devices.emplace_back(d);
    }
}

show()

template<typename T >

void Alignment::ProgAlignSignificantGPU< T >::show ( ) const

overridevirtual

Show parameters

Reimplemented from Alignment::AProgAlignSignificant< T >.

Definition at line 37 of file align_significant_gpu.cpp.

                                            {
    AProgAlignSignificant<T>::show();
    std::cout <<  "Device(s)                   :";
    for (auto d : m_devices) {
        std::cout << " " << d;
    }
    std::cout << std::endl;
}

updateRefs()

template<typename T >

void Alignment::ProgAlignSignificantGPU< T >::updateRefs ( T *  refs, const T *  others, const std::vector< Assignment > &  assignments  )

overrideprotectedvirtual

Implements Alignment::AProgAlignSignificant< T >.

Definition at line 256 of file align_significant_gpu.cpp.

                                                  {
    auto s = this->getSettings();

    auto &pool = this->getThreadPool();
    auto futures = std::vector<std::future<void>>();

    auto f = [this, &assignments](int threadId, T *ref, const Dimensions &refDims,
            const T *others, const Dimensions &otherDims,
            unsigned device,
            size_t refOffset) {
        updateRefs(ref, refDims, others, otherDims, assignments, device, refOffset);
    };
    size_t step = s.refDims.n() / m_devices.size();
    for (size_t devIndex = 0; devIndex < m_devices.size(); ++devIndex) {
        size_t offset = devIndex * step;
        size_t toProcess = std::min(step, s.refDims.n() - offset);
        futures.emplace_back(pool.push(f,
                refs,
                s.refDims.copyForN(toProcess),
                others, s.otherDims,
                m_devices.at(devIndex),
                offset));
    }
    for (auto &f : futures) {
        f.get();
    }
    std::cout << "Done" << std::endl;
}

---

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

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