lsst.afw.gpu Namespace Reference

Namespaces
	detail

Enumerations
enum	DevicePreference { AUTO, AUTO_WITH_CPU_FALLBACK, USE_CPU, USE_GPU }
	A type used to select whether to use CPU or GPU device. More...

Functions
void	setGpuEnable (bool enable)
	Enables or disables GPU acceleration globally. More...
bool	isGpuEnabled ()
	returns true if GPU acceleration is enabled More...
bool	isGpuBuild ()
	Inline function which returns true only when GPU_BUILD macro is defined. More...

Variables
const DevicePreference	DEFAULT_DEVICE_PREFERENCE = AUTO
	Default DevicePreference value. More...

Enumeration Type Documentation

enum lsst::afw::gpu::DevicePreference

A type used to select whether to use CPU or GPU device.

AUTO - If all conditions for GPU execution and performance conditions are satisfied (AFW built with GPU support, a suitable GPU is present, GPU execution limitations and performance conditions) the code will attempt to use a GPU. Otherwise, CPU code path will be used. If GPU execution results in a failure, an exception will be thrown. AUTO_WITH_CPU_FALLBACK - Same as AUTO, except that if the GPU code path throws an exception, it will fallback to CPU code path. USE_CPU - GPU will not be used. USE_GPU - code will always attempt to use a GPU (except when overriden by global settings). If a GPU can not be used, an exception will be thrown.

Note

To test whether a certain function call is GPU-accelerated, a dummy function call should be made, with the DevicePreference parameter set to USE_GPU. If it does not throw an exception, then the given function call is GPU-accelerated.

Enumerator
AUTO
AUTO_WITH_CPU_FALLBACK
USE_CPU
USE_GPU

Definition at line 61 of file DevicePreference.h.

{ AUTO, AUTO_WITH_CPU_FALLBACK, USE_CPU, USE_GPU };

Function Documentation

bool lsst::afw::gpu::isGpuBuild ( )

inline

Inline function which returns true only when GPU_BUILD macro is defined.

Used to determine whether compiling for GPU is enabled

Definition at line 45 of file IsGpuBuild.h.

{
    #ifdef GPU_BUILD
        return true;
    #else
        return false;
    #endif
}

bool lsst::afw::gpu::isGpuEnabled

(

)

returns true if GPU acceleration is enabled

Definition at line 81 of file DevicePreference.cc.

{
    return globalIsGpuEnabled;
}

void lsst::afw::gpu::setGpuEnable

(

bool

enable

)

Enables or disables GPU acceleration globally.

Changes a global variable. When it is set to false, the GPU acceleration will be disabled. Initial value of the global variable is true (enabled).

Calls to GPU-accelerated functions with DevicePreference set to USE_GPU will be redirected to use CPU code path.

Note: When the value of environment variable DISABLE_GPU_ACCELERATION is set to 1, setting GPU acceleration to enabled by this function may not have any effect . Also, it will set the initial value of the global variable to false (GPU acceleration disabled).

Definition at line 70 of file DevicePreference.cc.

{
    if (enable) {
        if (!envVarDisableGpuAccelerationSingleton.val) {
            globalIsGpuEnabled = true;
        }
    } else {
        globalIsGpuEnabled = false;
    }
}

Variable Documentation

const DevicePreference lsst::afw::gpu.DEFAULT_DEVICE_PREFERENCE = AUTO

Default DevicePreference value.

Used in all GPU-accelerated functions when DevicePreference is ommited by the caller.

Definition at line 68 of file DevicePreference.h.