This class contains static properties and methods specific to the Easy library. More...

#include <eVision/Easy/Easy.h>

Collaboration diagram for eVision::Easy:

Static Public Member Functions
static void	Initialize ()
	Initializes eVision.
static void	Terminate ()
	Method not obligatory, but necessary for close dll cleanly.
static void	EnsureInitialized ()
	Ensures eVision is initialized.
static void	CheckLicenses ()
	Check if at least one license is available. Otherwise, an exception is thrown.
static void	OverrideResourcesPath (const std::string &path)
	Set a specific resources path.
static std::string	GetSampleImagesRootPath ()
	Retrieves the sample images installation path.
static std::string	GetDeepLearningAdditionalResourcesRootPath ()
	Retrieves the deep learning additional resources installation path.
static std::string	GetSampleProgramsRootPath ()
	Retrieves the sample programs installation path.
static std::string	GetResourcesRootPath ()
	Retrieves the resources installation path.
static std::string	GetOnlineDocumentationUrl ()
	Gets the URL to the online eVision documentation.
static void	SetOemKey (const std::vector< uint8_t > &key, eVision::EDongleType type, int32_t dongleIndex)
	Writes an OEM key value on a dongle.
static void	SetOemKey (const std::vector< uint8_t > &key, eVision::EDongleType type)
	Writes an OEM key value on a dongle.
static void	SetOemKey (uint32_t keyIndex, const std::vector< uint8_t > &key, eVision::EDongleType type, int32_t dongleIndex)
	Writes an OEM key value on a dongle.
static void	SetOemKey (uint32_t keyIndex, const std::vector< uint8_t > &key, eVision::EDongleType type)
	Writes an OEM key value on a dongle.
static bool	CheckOemKey (const std::vector< uint8_t > &key, eVision::EDongleType type, int32_t dongleIndex)
	Checks if the OEM key, if any, matches a given argument.
static bool	CheckOemKey (const std::vector< uint8_t > &key, eVision::EDongleType type)
	Checks if the OEM key, if any, matches a given argument.
static bool	CheckOemKey (uint32_t keyIndex, const std::vector< uint8_t > &key, eVision::EDongleType type, int32_t dongleIndex)
	Checks if the OEM key, if any, matches a given argument.
static bool	CheckOemKey (uint32_t keyIndex, const std::vector< uint8_t > &key, eVision::EDongleType type)
	Checks if the OEM key, if any, matches a given argument.
static bool	CheckLicense (eVision::LicenseFeatures::Features license)
	Checks if a given license is available.
static uint64_t	GetLicenseSources (eVision::LicenseFeatures::Features license)
	Gets the sources of a single license.
static void	SetAngleUnit (eVision::EAngleUnit unit)
	Current angular unit.
static eVision::EAngleUnit	GetAngleUnit ()
	Current angular unit.
static void	SetHandleSize (int32_t size)
	Sets the handle size. Handle size is used when drawing or when hit testing.
static int32_t	GetHandleSize ()
	Gets the handle size. Handle size is used when drawing or when hit testing.
static float	FromRadians (float angle)
	Returns the angle, converted from radians to the current angle unit.
static float	ToRadians (float angle)
	Returns the angle, converted from current angle unit to radians.
static float	ToDegrees (float angle)
	Returns the angle, converted from current angle unit to degrees.
static float	FromDegrees (float angle)
	Returns the angle, converted from degrees to the current angle unit.
static std::string	GetVersion ()
	Returns a string that contains the current version number of eVision.
static void	SetMaxNumberOfProcessingThreads (int maxNumThreads)
	Maximum number of threads used internally by the eVision tools (default value: 1). This number cannot be higher than the number of processor cores available to the system. See Easy::GetNumberOfAvailableProcessorCores. This value is thread local. It means that this value can be controlled independently for each thread you create.
static int	GetMaxNumberOfProcessingThreads ()
	Maximum number of threads used internally by the eVision tools (default value: 1). This number cannot be higher than the number of processor cores available to the system. See Easy::GetNumberOfAvailableProcessorCores. This value is thread local. It means that this value can be controlled independently for each thread you create.
static int	GetNumberOfAvailableProcessorCores ()
	Number of processor cores available to the system. This is the upper limit for the number of threads usable internally by the eVision tools. See Easy::SetMaxNumberOfProcessingThreads.
static bool	IsGPUAvailable ()
	Indicates if a supported GPU is available for eVision computation.
static int	GetNumGPUs ()
	Number of GPUs available to the system.
static std::string	GetGPUName (int gpuId)
	Name of the GPU.
static std::string	GetGPUComputeCapability (int gpuId)
	CUDA compute capability for the specified GPU.
static HDC	OpenImageGraphicContext (eVision::EImageBW8 *pImage)
	Allows to draw in a gray-level or a color image, using any of the Windows device context functions (the image contents is altered, allowing destructive overlays).
static HDC	OpenImageGraphicContext (eVision::EImageC24 *pImage)
	Allows to draw in a gray-level or a color image, using any of the Windows device context functions (the image contents is altered, allowing destructive overlays).
static void	CloseImageGraphicContext (eVision::EImageBW8 *pImage, HDC hDC)
	Releases the device context associated to an image.
static void	CloseImageGraphicContext (eVision::EImageC24 *pImage, HDC hDC)
	Releases the device context associated to an image.
static void	Render3D (eVision::EROIBW8 sourceImage, eVision::EROIBW8 destinationImage, float phi, float psi, float xScale, float yScale, float zScale, int32_t dotSize)
	Prepares a three-dimensional rendering of an image where the gray-level values are taken for altitudes.
static void	Render3D (eVision::EROIBW8 sourceImage, eVision::EROIBW8 destinationImage, float phi, float psi, float xScale, float yScale, float zScale)
	Prepares a three-dimensional rendering of an image where the gray-level values are taken for altitudes.
static void	Render3D (eVision::EROIBW8 sourceImage, eVision::EROIBW8 destinationImage, float phi, float psi, float xScale, float yScale)
	Prepares a three-dimensional rendering of an image where the gray-level values are taken for altitudes.
static void	Render3D (eVision::EROIBW8 sourceImage, eVision::EROIBW8 destinationImage, float phi, float psi, float xScale)
	Prepares a three-dimensional rendering of an image where the gray-level values are taken for altitudes.
static void	Render3D (eVision::EROIBW8 sourceImage, eVision::EROIBW8 destinationImage, float phi, float psi)
	Prepares a three-dimensional rendering of an image where the gray-level values are taken for altitudes.
static void	Render3D (eVision::EROIC24 sourceImage, eVision::EROIBW8 zImage, eVision::EROIC24 *destinationImage, float phi, float psi, float xScale, float yScale, float zScale, int32_t dotSize)
	Prepares a three-dimensional rendering of an image where the gray-level values are taken for altitudes.
static void	Render3D (eVision::EROIC24 sourceImage, eVision::EROIBW8 zImage, eVision::EROIC24 *destinationImage, float phi, float psi, float xScale, float yScale, float zScale)
	Prepares a three-dimensional rendering of an image where the gray-level values are taken for altitudes.
static void	Render3D (eVision::EROIC24 sourceImage, eVision::EROIBW8 zImage, eVision::EROIC24 *destinationImage, float phi, float psi, float xScale, float yScale)
	Prepares a three-dimensional rendering of an image where the gray-level values are taken for altitudes.
static void	Render3D (eVision::EROIC24 sourceImage, eVision::EROIBW8 zImage, eVision::EROIC24 *destinationImage, float phi, float psi, float xScale)
	Prepares a three-dimensional rendering of an image where the gray-level values are taken for altitudes.
static void	Render3D (eVision::EROIC24 sourceImage, eVision::EROIBW8 zImage, eVision::EROIC24 *destinationImage, float phi, float psi)
	Prepares a three-dimensional rendering of an image where the gray-level values are taken for altitudes.
static void	RenderColorHistogram (eVision::EROIC24 sourceImage, eVision::EROIC24 destinationImage, float phi, float psi, float xScale, float yScale, float zScale)
	Prepares a three-dimensional rendering of the histogram of a color image: the pixels are drawn in the RGB space rather than in the XY plane.
static void	RenderColorHistogram (eVision::EROIC24 sourceImage, eVision::EROIC24 destinationImage, float phi, float psi, float xScale, float yScale)
	Prepares a three-dimensional rendering of the histogram of a color image: the pixels are drawn in the RGB space rather than in the XY plane.
static void	RenderColorHistogram (eVision::EROIC24 sourceImage, eVision::EROIC24 destinationImage, float phi, float psi, float xScale)
	Prepares a three-dimensional rendering of the histogram of a color image: the pixels are drawn in the RGB space rather than in the XY plane.
static void	RenderColorHistogram (eVision::EROIC24 sourceImage, eVision::EROIC24 destinationImage, float phi, float psi)
	Prepares a three-dimensional rendering of the histogram of a color image: the pixels are drawn in the RGB space rather than in the XY plane.
static void	RenderColorHistogram (eVision::EROIC24 sourceImage, eVision::EROIC24 sysImage, eVision::EROIC24 *destinationImage, float phi, float psi, float xScale, float yScale, float zScale)
	Prepares a three-dimensional rendering of the histogram of a color image: the pixels are drawn in the RGB space rather than in the XY plane.
static void	RenderColorHistogram (eVision::EROIC24 sourceImage, eVision::EROIC24 sysImage, eVision::EROIC24 *destinationImage, float phi, float psi, float xScale, float yScale)
	Prepares a three-dimensional rendering of the histogram of a color image: the pixels are drawn in the RGB space rather than in the XY plane.
static void	RenderColorHistogram (eVision::EROIC24 sourceImage, eVision::EROIC24 sysImage, eVision::EROIC24 *destinationImage, float phi, float psi, float xScale)
	Prepares a three-dimensional rendering of the histogram of a color image: the pixels are drawn in the RGB space rather than in the XY plane.
static void	RenderColorHistogram (eVision::EROIC24 sourceImage, eVision::EROIC24 sysImage, eVision::EROIC24 *destinationImage, float phi, float psi)
	Prepares a three-dimensional rendering of the histogram of a color image: the pixels are drawn in the RGB space rather than in the XY plane.
static eVision::EImageType	GetBestMatchingImageType (const std::string &path, bool constrainToBW8AndC24)
	Returns the best matching image type for a given file on disk among EImageType::EImageType_BW8, EImageType::EImageType_BW16, EImageType::EImageType_BW32, EImageType::EImageType_BW32f, EImageType::EImageType_C24, EImageType::EImageType_C24A, EImageType::EImageType_C48.
static eVision::EImageType	GetBestMatchingImageType (const std::string &path)
	Returns the best matching image type for a given file on disk among EImageType::EImageType_BW8, EImageType::EImageType_BW16, EImageType::EImageType_BW32, EImageType::EImageType_BW32f, EImageType::EImageType_C24, EImageType::EImageType_C24A, EImageType::EImageType_C48.
static int32_t	StopTiming (int32_t resolution)
	Returns the time, in specified time units, elapsed since the last invocation of Easy::StartTiming.
static int32_t	StopTiming ()
	Returns the time, in specified time units, elapsed since the last invocation of Easy::StartTiming.
static void	StartTiming ()
	Starts timing, using the system clock or performance counter.
static int32_t	TrueTimingResolution ()
	Returns the actual resolution of the timing clock, in ticks per seconds.
static void	Resize (eVision::EROIBW8 sourceImage, eVision::EROIBW8 destinationImage)
	Resizes an image without interpolation.
static void	Resize (eVision::EROIBW16 sourceImage, eVision::EROIBW16 destinationImage)
	Resizes an image without interpolation.
static void	Resize (eVision::EROIC24 sourceImage, eVision::EROIC24 destinationImage)
	Resizes an image without interpolation.
static void	Resize (eVision::EROIC24A sourceImage, eVision::EROIC24A destinationImage)
	Resizes an image without interpolation.
static uint32_t	GetDongleCount (eVision::EDongleType type)
	Get the number of available dongle on the system.
static std::string	GetDongleInternalSerialNumber (eVision::EDongleType type, int index)
	Get the serial number of the selected dongle.
static void	SetEnableEnhancedImageDisplay (bool state)
	The enhanced mode for displaying the images.
static bool	GetEnableEnhancedImageDisplay ()
	The enhanced mode for displaying the images.
static void	LogInMemento (const std::string &message, eVision::EVerbosity verbosity, uint8_t user)
	Logs a message in eGrabber Memento.
static void	LogInMemento (const std::string &message, eVision::EVerbosity verbosity)
	Logs a message in eGrabber Memento.
static void	LogInMemento (const std::string &message)
	Logs a message in eGrabber Memento.
static void	HealthCheck (bool checkDeepLearningDependencies)
	Checks that eVision is correctly installed with a required dependencies and throws an exception if that's not the case.
static void	HealthCheck ()
	Checks that eVision is correctly installed with a required dependencies and throws an exception if that's not the case.

Public Attributes
CppWrapperInternal::WrappedClass	wrappedClass_

Detailed Description

This class contains static properties and methods specific to the Easy library.

License(s): BasicTypes

Member Function Documentation

◆ CheckLicense()

bool eVision::Easy::CheckLicense ( eVision::LicenseFeatures::Features license )

static

Checks if a given license is available.

Parameters

license The license to check

License(s): None

◆ CheckLicenses()

void eVision::Easy::CheckLicenses ( )

static

Check if at least one license is available. Otherwise, an exception is thrown.

◆ CheckOemKey() [1/4]

bool eVision::Easy::CheckOemKey	(	const std::vector< uint8_t > &	key,
		eVision::EDongleType	type )

static

Checks if the OEM key, if any, matches a given argument.

Parameters

key	The expected value of the OEM key
type	The EDongleType for which you want to check the OEM key.

The length of the OEM key must be in [8, 64] characters.

◆ CheckOemKey() [2/4]

bool eVision::Easy::CheckOemKey	(	const std::vector< uint8_t > &	key,
		eVision::EDongleType	type,
		int32_t	dongleIndex )

static

Checks if the OEM key, if any, matches a given argument.

Parameters

key	The expected value of the OEM key
type	The EDongleType for which you want to check the OEM key.
dongleIndex	The index of the dongle where the OEM key is expected. By default, the first dongle found is selected.

The length of the OEM key must be in [8, 64] characters.

◆ CheckOemKey() [3/4]

bool eVision::Easy::CheckOemKey	(	uint32_t	keyIndex,
		const std::vector< uint8_t > &	key,
		eVision::EDongleType	type )

static

Checks if the OEM key, if any, matches a given argument.

Parameters

keyIndex	The index of the key in the array of keys, must be in [0, 11]. This option is not compatible with EDongleType::EDongleType_Legacy
key	The expected value of the OEM key
type	The EDongleType for which you want to check the OEM key.

The length of the OEM key must be in [8, 64] characters.

◆ CheckOemKey() [4/4]

bool eVision::Easy::CheckOemKey	(	uint32_t	keyIndex,
		const std::vector< uint8_t > &	key,
		eVision::EDongleType	type,
		int32_t	dongleIndex )

static

Checks if the OEM key, if any, matches a given argument.

Parameters

keyIndex	The index of the key in the array of keys, must be in [0, 11]. This option is not compatible with EDongleType::EDongleType_Legacy
key	The expected value of the OEM key
type	The EDongleType for which you want to check the OEM key.
dongleIndex	The index of the dongle where the OEM key is expected. By default, the first dongle found is selected.

The length of the OEM key must be in [8, 64] characters.

◆ CloseImageGraphicContext() [1/2]

void eVision::Easy::CloseImageGraphicContext	(	eVision::EImageBW8 *	pImage,
		HDC	hDC )

static

Releases the device context associated to an image.

Parameters

pImage	Pointer to the target image (must be the same as that passed to Easy::OpenImageGraphicContext).
hDC	Handle to a device context that was produced by Easy::OpenImageGraphicContext.

Deprecated

Use EWindowsDrawAdapter class by passing an image to its constructor instead.

Deprecated in version 23.12. Scheduled to be removed in version 27.6.

◆ CloseImageGraphicContext() [2/2]

void eVision::Easy::CloseImageGraphicContext	(	eVision::EImageC24 *	pImage,
		HDC	hDC )

static

Releases the device context associated to an image.

Parameters

pImage	Pointer to the target image (must be the same as that passed to Easy::OpenImageGraphicContext).
hDC	Handle to a device context that was produced by Easy::OpenImageGraphicContext.

Deprecated

Use EWindowsDrawAdapter class by passing an image to its constructor instead.

Deprecated in version 23.12. Scheduled to be removed in version 27.6.

◆ EnsureInitialized()

void eVision::Easy::EnsureInitialized ( )

static

Ensures eVision is initialized.

As of eVision 24.06, the initialization of eVision is fully automatic and implicit as the first call to any method of the library in all programming languages. This method performs no specific operation by itself, and it is never necessary to call it prior to using eVision. Its only use is to ensure that the eVision DLL is correctly loaded outside of code dedicated to computations in order to help isolate potential eVision installation problems.

Also see Easy::CheckLicenses that additionally check that licenses are correctly installed on the machine.

License(s): None

◆ FromDegrees()

float eVision::Easy::FromDegrees ( float angle )

static

Returns the angle, converted from degrees to the current angle unit.

Parameters

angle Angle to be converted

◆ FromRadians()

float eVision::Easy::FromRadians ( float angle )

static

Returns the angle, converted from radians to the current angle unit.

Parameters

angle Angle to be converted

◆ GetAngleUnit()

eVision::EAngleUnit eVision::Easy::GetAngleUnit ( )

static

Current angular unit.

All angles are computed using some angular unit, as well on input as on output. The desired unit can be changed at any time. By default, all angles are given in degrees (0..360).

If you wish to use another Angle Unit than the default one (degrees), you must set the Angle Unit in each of your threads.

◆ GetBestMatchingImageType() [1/2]

eVision::EImageType eVision::Easy::GetBestMatchingImageType ( const std::string & path )

static

Returns the best matching image type for a given file on disk among EImageType::EImageType_BW8, EImageType::EImageType_BW16, EImageType::EImageType_BW32, EImageType::EImageType_BW32f, EImageType::EImageType_C24, EImageType::EImageType_C24A, EImageType::EImageType_C48.

Parameters

path	The path to the file on disk.

◆ GetBestMatchingImageType() [2/2]

eVision::EImageType eVision::Easy::GetBestMatchingImageType	(	const std::string &	path,
		bool	constrainToBW8AndC24 )

static

Returns the best matching image type for a given file on disk among EImageType::EImageType_BW8, EImageType::EImageType_BW16, EImageType::EImageType_BW32, EImageType::EImageType_BW32f, EImageType::EImageType_C24, EImageType::EImageType_C24A, EImageType::EImageType_C48.

Parameters

path	The path to the file on disk.
constrainToBW8AndC24	Constrain the image type to be either EImageType::EImageType_BW8 or EImageType::EImageType_C24. False by default.

◆ GetDeepLearningAdditionalResourcesRootPath()

std::string eVision::Easy::GetDeepLearningAdditionalResourcesRootPath ( )

static

Retrieves the deep learning additional resources installation path.

The deep learning additional resources are installed through their own installer, available on euresys website.

◆ GetDongleCount()

uint32_t eVision::Easy::GetDongleCount ( eVision::EDongleType type )

static

Get the number of available dongle on the system.

Parameters

type	The EDongleType you want to enumerate.

◆ GetDongleInternalSerialNumber()

std::string eVision::Easy::GetDongleInternalSerialNumber	(	eVision::EDongleType	type,
		int	index )

static

Get the serial number of the selected dongle.

Parameters

type	The EDongleType.
index	The index of the dongle.

◆ GetEnableEnhancedImageDisplay()

bool eVision::Easy::GetEnableEnhancedImageDisplay ( )

static

The enhanced mode for displaying the images.

When enabled, enhanced mode performs advanced interpolation for image display. By default, enhanced mode is disabled. Enhanced mode has a significant impact on drawing performances. Enhanced display mode is set for the current thread.

◆ GetGPUComputeCapability()

std::string eVision::Easy::GetGPUComputeCapability ( int gpuId )

static

CUDA compute capability for the specified GPU.

Parameters

gpuId Index of the GPU between 0 and Easy::GetNumGPUs - 1.

◆ GetGPUName()

std::string eVision::Easy::GetGPUName ( int gpuId )

static

Name of the GPU.

Parameters

gpuId Index of the GPU between 0 and Easy::GetNumGPUs - 1.

◆ GetHandleSize()

int32_t eVision::Easy::GetHandleSize ( )

static

Gets the handle size. Handle size is used when drawing or when hit testing.

◆ GetLicenseSources()

uint64_t eVision::Easy::GetLicenseSources ( eVision::LicenseFeatures::Features license )

static

Gets the sources of a single license.

This will work for a single license only. If you try to pass a license mask, it will fail.

License(s): None

◆ GetMaxNumberOfProcessingThreads()

int eVision::Easy::GetMaxNumberOfProcessingThreads ( )

static

Maximum number of threads used internally by the eVision tools (default value: 1). This number cannot be higher than the number of processor cores available to the system. See Easy::GetNumberOfAvailableProcessorCores. This value is thread local. It means that this value can be controlled independently for each thread you create.

◆ GetNumberOfAvailableProcessorCores()

int eVision::Easy::GetNumberOfAvailableProcessorCores ( )

static

Number of processor cores available to the system. This is the upper limit for the number of threads usable internally by the eVision tools. See Easy::SetMaxNumberOfProcessingThreads.

◆ GetNumGPUs()

int eVision::Easy::GetNumGPUs ( )

static

Number of GPUs available to the system.

◆ GetOnlineDocumentationUrl()

std::string eVision::Easy::GetOnlineDocumentationUrl ( )

static

Gets the URL to the online eVision documentation.

◆ GetResourcesRootPath()

std::string eVision::Easy::GetResourcesRootPath ( )

static

Retrieves the resources installation path.

◆ GetSampleImagesRootPath()

std::string eVision::Easy::GetSampleImagesRootPath ( )

static

Retrieves the sample images installation path.

◆ GetSampleProgramsRootPath()

std::string eVision::Easy::GetSampleProgramsRootPath ( )

static

Retrieves the sample programs installation path.

◆ GetVersion()

std::string eVision::Easy::GetVersion ( )

static

Returns a string that contains the current version number of eVision.

Uses semver syntax.

◆ HealthCheck() [1/2]

void eVision::Easy::HealthCheck ( )

static

Checks that eVision is correctly installed with a required dependencies and throws an exception if that's not the case.

License(s): None

◆ HealthCheck() [2/2]

void eVision::Easy::HealthCheck ( bool checkDeepLearningDependencies )

static

Checks that eVision is correctly installed with a required dependencies and throws an exception if that's not the case.

Parameters

checkDeepLearningDependencies If false, this function will only check the base installation and dependencies of eVision.

It true, it will also check the proper installation and dependencies of the eVision Deep Learning Dependencies.

Note: Regardless of the state of this flag, this function will not check the availability of a compatible GPU on the machine to perform computation using EasyDeepLearning.

License(s): None

◆ Initialize()

void eVision::Easy::Initialize ( )

static

Initializes eVision.

License(s): None

Deprecated

Library initialization is now performed automatically. This method doesn't perform any operation anymore. You can use Easy::EnsureInitialized instead to ensure eVision's DLL is properly loaded or Easy::CheckLicenses to also check that licenses are correctly installed.

Deprecated in version 24.6. Scheduled to be removed in version 27.6.

◆ IsGPUAvailable()

bool eVision::Easy::IsGPUAvailable ( )

static

Indicates if a supported GPU is available for eVision computation.

◆ LogInMemento() [1/3]

void eVision::Easy::LogInMemento ( const std::string & message )

static

Logs a message in eGrabber Memento.

Parameters

message The message to log.

The default verbosity level is EVerbosity_Info and the default user ID is 0. For more information about how Memento handles messages, please refer to the Memento documentation.

◆ LogInMemento() [2/3]

void eVision::Easy::LogInMemento	(	const std::string &	message,
		eVision::EVerbosity	verbosity )

static

Logs a message in eGrabber Memento.

Parameters

message	The message to log.
verbosity	The verbosity level of the message.

The default verbosity level is EVerbosity_Info and the default user ID is 0. For more information about how Memento handles messages, please refer to the Memento documentation.

◆ LogInMemento() [3/3]

void eVision::Easy::LogInMemento	(	const std::string &	message,
		eVision::EVerbosity	verbosity,
		uint8_t	user )

static

Logs a message in eGrabber Memento.

Parameters

message	The message to log.
verbosity	The verbosity level of the message.
user	The user index, from 0 to 15

The default verbosity level is EVerbosity_Info and the default user ID is 0. For more information about how Memento handles messages, please refer to the Memento documentation.

◆ OpenImageGraphicContext() [1/2]

HDC eVision::Easy::OpenImageGraphicContext ( eVision::EImageBW8 * pImage )

static

Allows to draw in a gray-level or a color image, using any of the Windows device context functions (the image contents is altered, allowing destructive overlays).

Parameters

pImage Pointer to the target image.

The function returns a handle to a device context associated to the image pixel data. When the device context is no more needed, call the Easy::CloseImageGraphicContext function with the same argument.

Deprecated

Use EWindowsDrawAdapter class by passing an image to its constructor instead.

Deprecated in version 23.12. Scheduled to be removed in version 27.6.

◆ OpenImageGraphicContext() [2/2]

HDC eVision::Easy::OpenImageGraphicContext ( eVision::EImageC24 * pImage )

static

Allows to draw in a gray-level or a color image, using any of the Windows device context functions (the image contents is altered, allowing destructive overlays).

Parameters

pImage Pointer to the target image.

The function returns a handle to a device context associated to the image pixel data. When the device context is no more needed, call the Easy::CloseImageGraphicContext function with the same argument.

Deprecated

Use EWindowsDrawAdapter class by passing an image to its constructor instead.

Deprecated in version 23.12. Scheduled to be removed in version 27.6.

◆ OverrideResourcesPath()

void eVision::Easy::OverrideResourcesPath ( const std::string & path )

static

Set a specific resources path.

◆ Render3D() [1/10]

void eVision::Easy::Render3D	(	eVision::EROIBW8 *	sourceImage,
		eVision::EROIBW8 *	destinationImage,
		float	phi,
		float	psi )

static

Prepares a three-dimensional rendering of an image where the gray-level values are taken for altitudes.

Parameters

sourceImage	Pointer to the source image.
destinationImage	Pointer to the destination image.
phi	Rotation angle about the X-axis.
psi	Rotation angle about the Y-axis.

The image is viewed by rotating it about the X-axis, then about the Y-axis. Magnification factors in the three directions (X = width, Y = height, and Z = depth) can be given.

The rendered image appears as independent dots. The dot size can be adjusted so that the surface appears more or less opaque.

The function does not display the rendered image by itself. Rather, it prepares a destination image to be displayed.

◆ Render3D() [2/10]

void eVision::Easy::Render3D	(	eVision::EROIBW8 *	sourceImage,
		eVision::EROIBW8 *	destinationImage,
		float	phi,
		float	psi,
		float	xScale )

static

Prepares a three-dimensional rendering of an image where the gray-level values are taken for altitudes.

Parameters

sourceImage	Pointer to the source image.
destinationImage	Pointer to the destination image.
phi	Rotation angle about the X-axis.
psi	Rotation angle about the Y-axis.
xScale	Magnification factor along X (should remain close to 1).

The image is viewed by rotating it about the X-axis, then about the Y-axis. Magnification factors in the three directions (X = width, Y = height, and Z = depth) can be given.

The rendered image appears as independent dots. The dot size can be adjusted so that the surface appears more or less opaque.

The function does not display the rendered image by itself. Rather, it prepares a destination image to be displayed.

◆ Render3D() [3/10]

void eVision::Easy::Render3D	(	eVision::EROIBW8 *	sourceImage,
		eVision::EROIBW8 *	destinationImage,
		float	phi,
		float	psi,
		float	xScale,
		float	yScale )

static

Prepares a three-dimensional rendering of an image where the gray-level values are taken for altitudes.

Parameters

sourceImage	Pointer to the source image.
destinationImage	Pointer to the destination image.
phi	Rotation angle about the X-axis.
psi	Rotation angle about the Y-axis.
xScale	Magnification factor along X (should remain close to 1).
yScale	Magnification factor along Y (should remain close to 1).

The image is viewed by rotating it about the X-axis, then about the Y-axis. Magnification factors in the three directions (X = width, Y = height, and Z = depth) can be given.

The rendered image appears as independent dots. The dot size can be adjusted so that the surface appears more or less opaque.

The function does not display the rendered image by itself. Rather, it prepares a destination image to be displayed.

◆ Render3D() [4/10]

void eVision::Easy::Render3D	(	eVision::EROIBW8 *	sourceImage,
		eVision::EROIBW8 *	destinationImage,
		float	phi,
		float	psi,
		float	xScale,
		float	yScale,
		float	zScale )

static

Prepares a three-dimensional rendering of an image where the gray-level values are taken for altitudes.

Parameters

sourceImage	Pointer to the source image.
destinationImage	Pointer to the destination image.
phi	Rotation angle about the X-axis.
psi	Rotation angle about the Y-axis.
xScale	Magnification factor along X (should remain close to 1).
yScale	Magnification factor along Y (should remain close to 1).
zScale	Magnification factor along Z (should remain close to 1).

The image is viewed by rotating it about the X-axis, then about the Y-axis. Magnification factors in the three directions (X = width, Y = height, and Z = depth) can be given.

The rendered image appears as independent dots. The dot size can be adjusted so that the surface appears more or less opaque.

The function does not display the rendered image by itself. Rather, it prepares a destination image to be displayed.

◆ Render3D() [5/10]

void eVision::Easy::Render3D	(	eVision::EROIBW8 *	sourceImage,
		eVision::EROIBW8 *	destinationImage,
		float	phi,
		float	psi,
		float	xScale,
		float	yScale,
		float	zScale,
		int32_t	dotSize )

static

Prepares a three-dimensional rendering of an image where the gray-level values are taken for altitudes.

Parameters

sourceImage	Pointer to the source image.
destinationImage	Pointer to the destination image.
phi	Rotation angle about the X-axis.
psi	Rotation angle about the Y-axis.
xScale	Magnification factor along X (should remain close to 1).
yScale	Magnification factor along Y (should remain close to 1).
zScale	Magnification factor along Z (should remain close to 1).
dotSize	Size of the rendered dots; allowed values are 1, 4, 5 or 9.

The image is viewed by rotating it about the X-axis, then about the Y-axis. Magnification factors in the three directions (X = width, Y = height, and Z = depth) can be given.

The rendered image appears as independent dots. The dot size can be adjusted so that the surface appears more or less opaque.

The function does not display the rendered image by itself. Rather, it prepares a destination image to be displayed.

◆ Render3D() [6/10]

void eVision::Easy::Render3D	(	eVision::EROIC24 *	sourceImage,
		eVision::EROIBW8 *	zImage,
		eVision::EROIC24 *	destinationImage,
		float	phi,
		float	psi )

static

Prepares a three-dimensional rendering of an image where the gray-level values are taken for altitudes.

Parameters

sourceImage	Pointer to the source image.
zImage	Pointer to the altitude image.
destinationImage	Pointer to the destination image.
phi	Rotation angle about the X-axis.
psi	Rotation angle about the Y-axis.

The image is viewed by rotating it about the X-axis, then about the Y-axis. Magnification factors in the three directions (X = width, Y = height, and Z = depth) can be given.

The rendered image appears as independent dots. The dot size can be adjusted so that the surface appears more or less opaque.

The function does not display the rendered image by itself. Rather, it prepares a destination image to be displayed.

◆ Render3D() [7/10]

void eVision::Easy::Render3D	(	eVision::EROIC24 *	sourceImage,
		eVision::EROIBW8 *	zImage,
		eVision::EROIC24 *	destinationImage,
		float	phi,
		float	psi,
		float	xScale )

static

Prepares a three-dimensional rendering of an image where the gray-level values are taken for altitudes.

Parameters

sourceImage	Pointer to the source image.
zImage	Pointer to the altitude image.
destinationImage	Pointer to the destination image.
phi	Rotation angle about the X-axis.
psi	Rotation angle about the Y-axis.
xScale	Magnification factor along X (should remain close to 1).

The image is viewed by rotating it about the X-axis, then about the Y-axis. Magnification factors in the three directions (X = width, Y = height, and Z = depth) can be given.

The rendered image appears as independent dots. The dot size can be adjusted so that the surface appears more or less opaque.

The function does not display the rendered image by itself. Rather, it prepares a destination image to be displayed.

◆ Render3D() [8/10]

void eVision::Easy::Render3D	(	eVision::EROIC24 *	sourceImage,
		eVision::EROIBW8 *	zImage,
		eVision::EROIC24 *	destinationImage,
		float	phi,
		float	psi,
		float	xScale,
		float	yScale )

static

Prepares a three-dimensional rendering of an image where the gray-level values are taken for altitudes.

Parameters

sourceImage	Pointer to the source image.
zImage	Pointer to the altitude image.
destinationImage	Pointer to the destination image.
phi	Rotation angle about the X-axis.
psi	Rotation angle about the Y-axis.
xScale	Magnification factor along X (should remain close to 1).
yScale	Magnification factor along Y (should remain close to 1).

The image is viewed by rotating it about the X-axis, then about the Y-axis. Magnification factors in the three directions (X = width, Y = height, and Z = depth) can be given.

The rendered image appears as independent dots. The dot size can be adjusted so that the surface appears more or less opaque.

The function does not display the rendered image by itself. Rather, it prepares a destination image to be displayed.

◆ Render3D() [9/10]

void eVision::Easy::Render3D	(	eVision::EROIC24 *	sourceImage,
		eVision::EROIBW8 *	zImage,
		eVision::EROIC24 *	destinationImage,
		float	phi,
		float	psi,
		float	xScale,
		float	yScale,
		float	zScale )

static

Prepares a three-dimensional rendering of an image where the gray-level values are taken for altitudes.

Parameters

sourceImage	Pointer to the source image.
zImage	Pointer to the altitude image.
destinationImage	Pointer to the destination image.
phi	Rotation angle about the X-axis.
psi	Rotation angle about the Y-axis.
xScale	Magnification factor along X (should remain close to 1).
yScale	Magnification factor along Y (should remain close to 1).
zScale	Magnification factor along Z (should remain close to 1).

The image is viewed by rotating it about the X-axis, then about the Y-axis. Magnification factors in the three directions (X = width, Y = height, and Z = depth) can be given.

The rendered image appears as independent dots. The dot size can be adjusted so that the surface appears more or less opaque.

The function does not display the rendered image by itself. Rather, it prepares a destination image to be displayed.

◆ Render3D() [10/10]

void eVision::Easy::Render3D	(	eVision::EROIC24 *	sourceImage,
		eVision::EROIBW8 *	zImage,
		eVision::EROIC24 *	destinationImage,
		float	phi,
		float	psi,
		float	xScale,
		float	yScale,
		float	zScale,
		int32_t	dotSize )

static

Prepares a three-dimensional rendering of an image where the gray-level values are taken for altitudes.

Parameters

sourceImage	Pointer to the source image.
zImage	Pointer to the altitude image.
destinationImage	Pointer to the destination image.
phi	Rotation angle about the X-axis.
psi	Rotation angle about the Y-axis.
xScale	Magnification factor along X (should remain close to 1).
yScale	Magnification factor along Y (should remain close to 1).
zScale	Magnification factor along Z (should remain close to 1).
dotSize	Size of the rendered dots; allowed values are 1, 4, 5 or 9.

The image is viewed by rotating it about the X-axis, then about the Y-axis. Magnification factors in the three directions (X = width, Y = height, and Z = depth) can be given.

The rendered image appears as independent dots. The dot size can be adjusted so that the surface appears more or less opaque.

The function does not display the rendered image by itself. Rather, it prepares a destination image to be displayed.

◆ RenderColorHistogram() [1/8]

void eVision::Easy::RenderColorHistogram	(	eVision::EROIC24 *	sourceImage,
		eVision::EROIC24 *	destinationImage,
		float	phi,
		float	psi )

static

Prepares a three-dimensional rendering of the histogram of a color image: the pixels are drawn in the RGB space rather than in the XY plane.

Parameters

sourceImage	Pointer to the raw source image.
destinationImage	Pointer to the destination image.
phi	Rotation angle about the X-axis.
psi	Rotation angle about the Y-axis.

This allows to observe the clustering and dispersion of the RGB values. The image is viewed by rotating it about the X-axis, then about the Y-axis. Magnification factors in the three directions (X = Red, Y = Green, and Z = Blue) can be given.

In a more advanced version, prepares a three-dimensional rendering of the pixels in another system than RGB (EasyColor provides conversion means). However, the raw RGB image must still be provided to allow the display of the pixels in their usual colors. The rendered image appears as independent dots. The function does not display the rendered image by itself. Rather, it prepares a destination image to be displayed.

◆ RenderColorHistogram() [2/8]

void eVision::Easy::RenderColorHistogram	(	eVision::EROIC24 *	sourceImage,
		eVision::EROIC24 *	destinationImage,
		float	phi,
		float	psi,
		float	xScale )

static

Prepares a three-dimensional rendering of the histogram of a color image: the pixels are drawn in the RGB space rather than in the XY plane.

Parameters

sourceImage	Pointer to the raw source image.
destinationImage	Pointer to the destination image.
phi	Rotation angle about the X-axis.
psi	Rotation angle about the Y-axis.
xScale	Magnification factor along X (should remain close to 1).

This allows to observe the clustering and dispersion of the RGB values. The image is viewed by rotating it about the X-axis, then about the Y-axis. Magnification factors in the three directions (X = Red, Y = Green, and Z = Blue) can be given.

In a more advanced version, prepares a three-dimensional rendering of the pixels in another system than RGB (EasyColor provides conversion means). However, the raw RGB image must still be provided to allow the display of the pixels in their usual colors. The rendered image appears as independent dots. The function does not display the rendered image by itself. Rather, it prepares a destination image to be displayed.

◆ RenderColorHistogram() [3/8]

void eVision::Easy::RenderColorHistogram	(	eVision::EROIC24 *	sourceImage,
		eVision::EROIC24 *	destinationImage,
		float	phi,
		float	psi,
		float	xScale,
		float	yScale )

static

Prepares a three-dimensional rendering of the histogram of a color image: the pixels are drawn in the RGB space rather than in the XY plane.

Parameters

sourceImage	Pointer to the raw source image.
destinationImage	Pointer to the destination image.
phi	Rotation angle about the X-axis.
psi	Rotation angle about the Y-axis.
xScale	Magnification factor along X (should remain close to 1).
yScale	Magnification factor along Y (should remain close to 1).

This allows to observe the clustering and dispersion of the RGB values. The image is viewed by rotating it about the X-axis, then about the Y-axis. Magnification factors in the three directions (X = Red, Y = Green, and Z = Blue) can be given.

In a more advanced version, prepares a three-dimensional rendering of the pixels in another system than RGB (EasyColor provides conversion means). However, the raw RGB image must still be provided to allow the display of the pixels in their usual colors. The rendered image appears as independent dots. The function does not display the rendered image by itself. Rather, it prepares a destination image to be displayed.

◆ RenderColorHistogram() [4/8]

void eVision::Easy::RenderColorHistogram	(	eVision::EROIC24 *	sourceImage,
		eVision::EROIC24 *	destinationImage,
		float	phi,
		float	psi,
		float	xScale,
		float	yScale,
		float	zScale )

static

Prepares a three-dimensional rendering of the histogram of a color image: the pixels are drawn in the RGB space rather than in the XY plane.

Parameters

sourceImage	Pointer to the raw source image.
destinationImage	Pointer to the destination image.
phi	Rotation angle about the X-axis.
psi	Rotation angle about the Y-axis.
xScale	Magnification factor along X (should remain close to 1).
yScale	Magnification factor along Y (should remain close to 1).
zScale	Magnification factor along Z (should remain close to 1).

This allows to observe the clustering and dispersion of the RGB values. The image is viewed by rotating it about the X-axis, then about the Y-axis. Magnification factors in the three directions (X = Red, Y = Green, and Z = Blue) can be given.

In a more advanced version, prepares a three-dimensional rendering of the pixels in another system than RGB (EasyColor provides conversion means). However, the raw RGB image must still be provided to allow the display of the pixels in their usual colors. The rendered image appears as independent dots. The function does not display the rendered image by itself. Rather, it prepares a destination image to be displayed.

◆ RenderColorHistogram() [5/8]

void eVision::Easy::RenderColorHistogram	(	eVision::EROIC24 *	sourceImage,
		eVision::EROIC24 *	sysImage,
		eVision::EROIC24 *	destinationImage,
		float	phi,
		float	psi )

static

Prepares a three-dimensional rendering of the histogram of a color image: the pixels are drawn in the RGB space rather than in the XY plane.

Parameters

sourceImage	Pointer to the raw source image.
sysImage	Pointer to the source image transformed into another color system.
destinationImage	Pointer to the destination image.
phi	Rotation angle about the X-axis.
psi	Rotation angle about the Y-axis.

This allows to observe the clustering and dispersion of the RGB values. The image is viewed by rotating it about the X-axis, then about the Y-axis. Magnification factors in the three directions (X = Red, Y = Green, and Z = Blue) can be given.

In a more advanced version, prepares a three-dimensional rendering of the pixels in another system than RGB (EasyColor provides conversion means). However, the raw RGB image must still be provided to allow the display of the pixels in their usual colors. The rendered image appears as independent dots. The function does not display the rendered image by itself. Rather, it prepares a destination image to be displayed.

◆ RenderColorHistogram() [6/8]

void eVision::Easy::RenderColorHistogram	(	eVision::EROIC24 *	sourceImage,
		eVision::EROIC24 *	sysImage,
		eVision::EROIC24 *	destinationImage,
		float	phi,
		float	psi,
		float	xScale )

static

Prepares a three-dimensional rendering of the histogram of a color image: the pixels are drawn in the RGB space rather than in the XY plane.

Parameters

sourceImage	Pointer to the raw source image.
sysImage	Pointer to the source image transformed into another color system.
destinationImage	Pointer to the destination image.
phi	Rotation angle about the X-axis.
psi	Rotation angle about the Y-axis.
xScale	Magnification factor along X (should remain close to 1).

This allows to observe the clustering and dispersion of the RGB values. The image is viewed by rotating it about the X-axis, then about the Y-axis. Magnification factors in the three directions (X = Red, Y = Green, and Z = Blue) can be given.

In a more advanced version, prepares a three-dimensional rendering of the pixels in another system than RGB (EasyColor provides conversion means). However, the raw RGB image must still be provided to allow the display of the pixels in their usual colors. The rendered image appears as independent dots. The function does not display the rendered image by itself. Rather, it prepares a destination image to be displayed.

◆ RenderColorHistogram() [7/8]

void eVision::Easy::RenderColorHistogram	(	eVision::EROIC24 *	sourceImage,
		eVision::EROIC24 *	sysImage,
		eVision::EROIC24 *	destinationImage,
		float	phi,
		float	psi,
		float	xScale,
		float	yScale )

static

Prepares a three-dimensional rendering of the histogram of a color image: the pixels are drawn in the RGB space rather than in the XY plane.

Parameters

sourceImage	Pointer to the raw source image.
sysImage	Pointer to the source image transformed into another color system.
destinationImage	Pointer to the destination image.
phi	Rotation angle about the X-axis.
psi	Rotation angle about the Y-axis.
xScale	Magnification factor along X (should remain close to 1).
yScale	Magnification factor along Y (should remain close to 1).

This allows to observe the clustering and dispersion of the RGB values. The image is viewed by rotating it about the X-axis, then about the Y-axis. Magnification factors in the three directions (X = Red, Y = Green, and Z = Blue) can be given.

In a more advanced version, prepares a three-dimensional rendering of the pixels in another system than RGB (EasyColor provides conversion means). However, the raw RGB image must still be provided to allow the display of the pixels in their usual colors. The rendered image appears as independent dots. The function does not display the rendered image by itself. Rather, it prepares a destination image to be displayed.

◆ RenderColorHistogram() [8/8]

void eVision::Easy::RenderColorHistogram	(	eVision::EROIC24 *	sourceImage,
		eVision::EROIC24 *	sysImage,
		eVision::EROIC24 *	destinationImage,
		float	phi,
		float	psi,
		float	xScale,
		float	yScale,
		float	zScale )

static

Prepares a three-dimensional rendering of the histogram of a color image: the pixels are drawn in the RGB space rather than in the XY plane.

Parameters

sourceImage	Pointer to the raw source image.
sysImage	Pointer to the source image transformed into another color system.
destinationImage	Pointer to the destination image.
phi	Rotation angle about the X-axis.
psi	Rotation angle about the Y-axis.
xScale	Magnification factor along X (should remain close to 1).
yScale	Magnification factor along Y (should remain close to 1).
zScale	Magnification factor along Z (should remain close to 1).

This allows to observe the clustering and dispersion of the RGB values. The image is viewed by rotating it about the X-axis, then about the Y-axis. Magnification factors in the three directions (X = Red, Y = Green, and Z = Blue) can be given.

In a more advanced version, prepares a three-dimensional rendering of the pixels in another system than RGB (EasyColor provides conversion means). However, the raw RGB image must still be provided to allow the display of the pixels in their usual colors. The rendered image appears as independent dots. The function does not display the rendered image by itself. Rather, it prepares a destination image to be displayed.

◆ Resize() [1/4]

void eVision::Easy::Resize	(	eVision::EROIBW16 *	sourceImage,
		eVision::EROIBW16 *	destinationImage )

static

Resizes an image without interpolation.

Parameters

sourceImage	Pointer to the source image/ROI.
destinationImage	Pointer to the destination image/ROI.

◆ Resize() [2/4]

void eVision::Easy::Resize	(	eVision::EROIBW8 *	sourceImage,
		eVision::EROIBW8 *	destinationImage )

static

Resizes an image without interpolation.

Parameters

sourceImage	Pointer to the source image/ROI.
destinationImage	Pointer to the destination image/ROI.

◆ Resize() [3/4]

void eVision::Easy::Resize	(	eVision::EROIC24 *	sourceImage,
		eVision::EROIC24 *	destinationImage )

static

Resizes an image without interpolation.

Parameters

sourceImage	Pointer to the source image/ROI.
destinationImage	Pointer to the destination image/ROI.

◆ Resize() [4/4]

void eVision::Easy::Resize	(	eVision::EROIC24A *	sourceImage,
		eVision::EROIC24A *	destinationImage )

static

Resizes an image without interpolation.

Parameters

sourceImage	Pointer to the source image/ROI.
destinationImage	Pointer to the destination image/ROI.

◆ SetAngleUnit()

void eVision::Easy::SetAngleUnit ( eVision::EAngleUnit unit )

static

Current angular unit.

All angles are computed using some angular unit, as well on input as on output. The desired unit can be changed at any time. By default, all angles are given in degrees (0..360).

If you wish to use another Angle Unit than the default one (degrees), you must set the Angle Unit in each of your threads.

◆ SetEnableEnhancedImageDisplay()

void eVision::Easy::SetEnableEnhancedImageDisplay ( bool state )

static

The enhanced mode for displaying the images.

Parameters

state Set to true to enable enhanced display mode.

When enabled, enhanced mode performs advanced interpolation for image display. By default, enhanced mode is disabled. Enhanced mode has a significant impact on drawing performances. Enhanced display mode is set for the current thread.

◆ SetHandleSize()

void eVision::Easy::SetHandleSize ( int32_t size )

static

Sets the handle size. Handle size is used when drawing or when hit testing.

◆ SetMaxNumberOfProcessingThreads()

void eVision::Easy::SetMaxNumberOfProcessingThreads ( int maxNumThreads )

static

Maximum number of threads used internally by the eVision tools (default value: 1). This number cannot be higher than the number of processor cores available to the system. See Easy::GetNumberOfAvailableProcessorCores. This value is thread local. It means that this value can be controlled independently for each thread you create.

◆ SetOemKey() [1/4]

void eVision::Easy::SetOemKey	(	const std::vector< uint8_t > &	key,
		eVision::EDongleType	type )

static

Writes an OEM key value on a dongle.

Parameters

key	The OEM key value to write
type	The EDongleType for which you want to set the OEM key.

The length of the OEM key must be in [8, 64] characters. This method raises an EError::EError_CannotWriteOEMKey error if the value cannot be set properly.

◆ SetOemKey() [2/4]

void eVision::Easy::SetOemKey	(	const std::vector< uint8_t > &	key,
		eVision::EDongleType	type,
		int32_t	dongleIndex )

static

Writes an OEM key value on a dongle.

Parameters

key	The OEM key value to write
type	The EDongleType for which you want to set the OEM key.
dongleIndex	The index of the dongle where the OEM key must be written. By default, the first dongle found is selected.

The length of the OEM key must be in [8, 64] characters. This method raises an EError::EError_CannotWriteOEMKey error if the value cannot be set properly.

◆ SetOemKey() [3/4]

void eVision::Easy::SetOemKey	(	uint32_t	keyIndex,
		const std::vector< uint8_t > &	key,
		eVision::EDongleType	type )

static

Writes an OEM key value on a dongle.

Parameters

keyIndex	The index of the key in the array of keys, must be in [0, 11]. This option is not compatible with EDongleType::EDongleType_Legacy
key	The OEM key value to write
type	The EDongleType for which you want to set the OEM key.

The length of the OEM key must be in [8, 64] characters. This method raises an EError::EError_CannotWriteOEMKey error if the value cannot be set properly.

◆ SetOemKey() [4/4]

void eVision::Easy::SetOemKey	(	uint32_t	keyIndex,
		const std::vector< uint8_t > &	key,
		eVision::EDongleType	type,
		int32_t	dongleIndex )

static

Writes an OEM key value on a dongle.

Parameters

keyIndex	The index of the key in the array of keys, must be in [0, 11]. This option is not compatible with EDongleType::EDongleType_Legacy
key	The OEM key value to write
type	The EDongleType for which you want to set the OEM key.
dongleIndex	The index of the dongle where the OEM key must be written. By default, the first dongle found is selected.

The length of the OEM key must be in [8, 64] characters. This method raises an EError::EError_CannotWriteOEMKey error if the value cannot be set properly.

◆ StartTiming()

void eVision::Easy::StartTiming ( )

static

Starts timing, using the system clock or performance counter.

◆ StopTiming() [1/2]

int32_t eVision::Easy::StopTiming ( )

static

Returns the time, in specified time units, elapsed since the last invocation of Easy::StartTiming.

◆ StopTiming() [2/2]

int32_t eVision::Easy::StopTiming ( int32_t resolution )

static

Returns the time, in specified time units, elapsed since the last invocation of Easy::StartTiming.

Parameters

resolution Temporal resolution, in ticks per second.

◆ Terminate()

void eVision::Easy::Terminate ( )

static

Method not obligatory, but necessary for close dll cleanly.

License(s): None

Deprecated

Library termination is now performed automatically. This method has no use anymore.

Deprecated in version 24.6. Scheduled to be removed in version 27.6.

◆ ToDegrees()

float eVision::Easy::ToDegrees ( float angle )

static

Returns the angle, converted from current angle unit to degrees.

Parameters

angle Angle to be converted.

◆ ToRadians()

float eVision::Easy::ToRadians ( float angle )

static

Returns the angle, converted from current angle unit to radians.

Parameters

angle Angle to be converted.

◆ TrueTimingResolution()

int32_t eVision::Easy::TrueTimingResolution ( )

static

Returns the actual resolution of the timing clock, in ticks per seconds.

Timing granularity is hardware-dependent, but is usually better than 1 microsecond. This function can be used to select an appropriate timing resolution when using Easy::StopTiming.

Member Data Documentation

◆ wrappedClass_

CppWrapperInternal::WrappedClass eVision::Easy::wrappedClass_

Static Public Member Functions

Public Attributes

Detailed Description

Member Function Documentation

◆ CheckLicense()

◆ CheckLicenses()

◆ CheckOemKey() [1/4]

◆ CheckOemKey() [2/4]

◆ CheckOemKey() [3/4]

◆ CheckOemKey() [4/4]

◆ CloseImageGraphicContext() [1/2]

◆ CloseImageGraphicContext() [2/2]

◆ EnsureInitialized()

◆ FromDegrees()

◆ FromRadians()

◆ GetAngleUnit()

◆ GetBestMatchingImageType() [1/2]

◆ GetBestMatchingImageType() [2/2]

◆ GetDeepLearningAdditionalResourcesRootPath()

◆ GetDongleCount()

◆ GetDongleInternalSerialNumber()

◆ GetEnableEnhancedImageDisplay()

◆ GetGPUComputeCapability()

◆ GetGPUName()

◆ GetHandleSize()

◆ GetLicenseSources()

◆ GetMaxNumberOfProcessingThreads()

◆ GetNumberOfAvailableProcessorCores()

◆ GetNumGPUs()

◆ GetOnlineDocumentationUrl()

◆ GetResourcesRootPath()

◆ GetSampleImagesRootPath()

◆ GetSampleProgramsRootPath()

◆ GetVersion()

◆ HealthCheck() [1/2]

◆ HealthCheck() [2/2]

◆ Initialize()

◆ IsGPUAvailable()

◆ LogInMemento() [1/3]

◆ LogInMemento() [2/3]

◆ LogInMemento() [3/3]

◆ OpenImageGraphicContext() [1/2]

◆ OpenImageGraphicContext() [2/2]

◆ OverrideResourcesPath()

◆ Render3D() [1/10]

◆ Render3D() [2/10]

◆ Render3D() [3/10]

◆ Render3D() [4/10]

◆ Render3D() [5/10]

◆ Render3D() [6/10]

◆ Render3D() [7/10]

◆ Render3D() [8/10]

◆ Render3D() [9/10]

◆ Render3D() [10/10]

◆ RenderColorHistogram() [1/8]

◆ RenderColorHistogram() [2/8]

◆ RenderColorHistogram() [3/8]

◆ RenderColorHistogram() [4/8]

◆ RenderColorHistogram() [5/8]

◆ RenderColorHistogram() [6/8]

◆ RenderColorHistogram() [7/8]

◆ RenderColorHistogram() [8/8]

◆ Resize() [1/4]

◆ Resize() [2/4]

◆ Resize() [3/4]

◆ Resize() [4/4]

◆ SetAngleUnit()

◆ SetEnableEnhancedImageDisplay()

◆ SetHandleSize()

◆ SetMaxNumberOfProcessingThreads()

◆ SetOemKey() [1/4]

◆ SetOemKey() [2/4]

◆ SetOemKey() [3/4]

◆ SetOemKey() [4/4]

◆ StartTiming()

◆ StopTiming() [1/2]

◆ StopTiming() [2/2]

◆ Terminate()

◆ ToDegrees()

◆ ToRadians()