eVision Python API
Loading...
Searching...
No Matches
eVision.Easy Class Reference

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

Static Public Member Functions

None Initialize ()
 Initializes eVision.
None Terminate ()
 Method not obligatory, but necessary for close dll cleanly.
None EnsureInitialized ()
 Ensures eVision is initialized.
None CheckLicenses ()
 Check if at least one license is available.
None OverrideResourcesPath (str path)
 Set a specific resources path.
str GetSampleImagesRootPath ()
 Retrieves the sample images installation path.
str GetDeepLearningAdditionalResourcesRootPath ()
 Retrieves the deep learning additional resources installation path.
str GetSampleProgramsRootPath ()
 Retrieves the sample programs installation path.
str GetResourcesRootPath ()
 Retrieves the resources installation path.
str GetOnlineDocumentationUrl ()
 Gets the URL to the online eVision documentation.
None SetOemKey (list[int] key, eVision.EDongleType type, int dongleIndex)
 Writes an OEM key value on a dongle.
None SetOemKey (list[int] key, eVision.EDongleType type)
 Writes an OEM key value on a dongle.
None SetOemKey (int keyIndex, list[int] key, eVision.EDongleType type, int dongleIndex)
 Writes an OEM key value on a dongle.
None SetOemKey (int keyIndex, list[int] key, eVision.EDongleType type)
 Writes an OEM key value on a dongle.
bool CheckOemKey (list[int] key, eVision.EDongleType type, int dongleIndex)
 Checks if the OEM key, if any, matches a given argument.
bool CheckOemKey (list[int] key, eVision.EDongleType type)
 Checks if the OEM key, if any, matches a given argument.
bool CheckOemKey (int keyIndex, list[int] key, eVision.EDongleType type, int dongleIndex)
 Checks if the OEM key, if any, matches a given argument.
bool CheckOemKey (int keyIndex, list[int] key, eVision.EDongleType type)
 Checks if the OEM key, if any, matches a given argument.
bool CheckLicense (eVision.LicenseFeatures.Features license)
 Checks if a given license is available.
int GetLicenseSources (eVision.LicenseFeatures.Features license)
 Gets the sources of a single license.
None SetAngleUnit (eVision.EAngleUnit unit)
 Current angular unit.
eVision.EAngleUnit GetAngleUnit ()
 Current angular unit.
None SetHandleSize (int size)
 Sets the handle size.
int GetHandleSize ()
 Gets the handle size.
float FromRadians (float angle)
 Returns the angle, converted from radians to the current angle unit.
float ToRadians (float angle)
 Returns the angle, converted from current angle unit to radians.
float ToDegrees (float angle)
 Returns the angle, converted from current angle unit to degrees.
float FromDegrees (float angle)
 Returns the angle, converted from degrees to the current angle unit.
str GetVersion ()
 Returns a string that contains the current version number of eVision.
None SetMaxNumberOfProcessingThreads (int maxNumThreads)
 Maximum number of threads used internally by the eVision tools (default value: 1).
int GetMaxNumberOfProcessingThreads ()
 Maximum number of threads used internally by the eVision tools (default value: 1).
int GetNumberOfAvailableProcessorCores ()
 Number of processor cores available to the system.
bool IsGPUAvailable ()
 Indicates if a supported GPU is available for eVision computation.
int GetNumGPUs ()
 Number of GPUs available to the system.
str GetGPUName (int gpuId)
 Name of the GPU.
str GetGPUComputeCapability (int gpuId)
 CUDA compute capability for the specified GPU.
None Render3D (eVision.EROIBW8|None sourceImage, eVision.EROIBW8|None destinationImage, float phi, float psi, float xScale, float yScale, float zScale, int dotSize)
 Prepares a three-dimensional rendering of an image where the gray-level values are taken for altitudes.
None Render3D (eVision.EROIBW8|None sourceImage, eVision.EROIBW8|None 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.
None Render3D (eVision.EROIBW8|None sourceImage, eVision.EROIBW8|None 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.
None Render3D (eVision.EROIBW8|None sourceImage, eVision.EROIBW8|None destinationImage, float phi, float psi, float xScale)
 Prepares a three-dimensional rendering of an image where the gray-level values are taken for altitudes.
None Render3D (eVision.EROIBW8|None sourceImage, eVision.EROIBW8|None destinationImage, float phi, float psi)
 Prepares a three-dimensional rendering of an image where the gray-level values are taken for altitudes.
None Render3D (eVision.EROIC24|None sourceImage, eVision.EROIBW8|None zImage, eVision.EROIC24|None destinationImage, float phi, float psi, float xScale, float yScale, float zScale, int dotSize)
 Prepares a three-dimensional rendering of an image where the gray-level values are taken for altitudes.
None Render3D (eVision.EROIC24|None sourceImage, eVision.EROIBW8|None zImage, eVision.EROIC24|None 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.
None Render3D (eVision.EROIC24|None sourceImage, eVision.EROIBW8|None zImage, eVision.EROIC24|None 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.
None Render3D (eVision.EROIC24|None sourceImage, eVision.EROIBW8|None zImage, eVision.EROIC24|None destinationImage, float phi, float psi, float xScale)
 Prepares a three-dimensional rendering of an image where the gray-level values are taken for altitudes.
None Render3D (eVision.EROIC24|None sourceImage, eVision.EROIBW8|None zImage, eVision.EROIC24|None destinationImage, float phi, float psi)
 Prepares a three-dimensional rendering of an image where the gray-level values are taken for altitudes.
None RenderColorHistogram (eVision.EROIC24|None sourceImage, eVision.EROIC24|None 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.
None RenderColorHistogram (eVision.EROIC24|None sourceImage, eVision.EROIC24|None 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.
None RenderColorHistogram (eVision.EROIC24|None sourceImage, eVision.EROIC24|None 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.
None RenderColorHistogram (eVision.EROIC24|None sourceImage, eVision.EROIC24|None 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.
None RenderColorHistogram (eVision.EROIC24|None sourceImage, eVision.EROIC24|None sysImage, eVision.EROIC24|None 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.
None RenderColorHistogram (eVision.EROIC24|None sourceImage, eVision.EROIC24|None sysImage, eVision.EROIC24|None 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.
None RenderColorHistogram (eVision.EROIC24|None sourceImage, eVision.EROIC24|None sysImage, eVision.EROIC24|None 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.
None RenderColorHistogram (eVision.EROIC24|None sourceImage, eVision.EROIC24|None sysImage, eVision.EROIC24|None 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.
eVision.EImageType GetBestMatchingImageType (str path, bool constrainToBW8AndC24)
 Returns the best matching image type for a given file on disk among eVision.EImageType.BW8, eVision.EImageType.BW16, eVision.EImageType.BW32, eVision.EImageType.BW32f, eVision.EImageType.C24, eVision.EImageType.C24A, eVision.EImageType.C48.
eVision.EImageType GetBestMatchingImageType (str path)
 Returns the best matching image type for a given file on disk among eVision.EImageType.BW8, eVision.EImageType.BW16, eVision.EImageType.BW32, eVision.EImageType.BW32f, eVision.EImageType.C24, eVision.EImageType.C24A, eVision.EImageType.C48.
int StopTiming (int resolution)
 Returns the time, in specified time units, elapsed since the last invocation of eVision.Easy.StartTiming.
int StopTiming ()
 Returns the time, in specified time units, elapsed since the last invocation of eVision.Easy.StartTiming.
None StartTiming ()
 Starts timing, using the system clock or performance counter.
int TrueTimingResolution ()
 Returns the actual resolution of the timing clock, in ticks per seconds.
None Resize (eVision.EROIBW8|None sourceImage, eVision.EROIBW8|None destinationImage)
 Resizes an image without interpolation.
None Resize (eVision.EROIBW16|None sourceImage, eVision.EROIBW16|None destinationImage)
 Resizes an image without interpolation.
None Resize (eVision.EROIC24|None sourceImage, eVision.EROIC24|None destinationImage)
 Resizes an image without interpolation.
None Resize (eVision.EROIC24A|None sourceImage, eVision.EROIC24A|None destinationImage)
 Resizes an image without interpolation.
int GetDongleCount (eVision.EDongleType type)
 Get the number of available dongle on the system.
str GetDongleInternalSerialNumber (eVision.EDongleType type, int index)
 Get the serial number of the selected dongle.
None SetEnableEnhancedImageDisplay (bool state)
 The enhanced mode for displaying the images.
bool GetEnableEnhancedImageDisplay ()
 The enhanced mode for displaying the images.
None LogInMemento (str message, eVision.EVerbosity verbosity, int user)
 Logs a message in eGrabber Memento.
None LogInMemento (str message, eVision.EVerbosity verbosity)
 Logs a message in eGrabber Memento.
None LogInMemento (str message)
 Logs a message in eGrabber Memento.
None HealthCheck (bool checkDeepLearningDependencies)
 Checks that eVision is correctly installed with a required dependencies and throws an exception if that's not the case.
None HealthCheck ()
 Checks that eVision is correctly installed with a required dependencies and throws an exception if that's not the case.

Detailed Description

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

Remarks:

License(s): BasicTypes

Member Function Documentation

◆ CheckLicense()

bool eVision.Easy.CheckLicense ( eVision.LicenseFeatures.Features license)
static

Checks if a given license is available.

Remarks:

License(s): None

Parameters
licenseThe license to check

◆ CheckLicenses()

None eVision.Easy.CheckLicenses ( )
static

Check if at least one license is available.

Otherwise, an exception is thrown.

◆ CheckOemKey() [1/4]

bool eVision.Easy.CheckOemKey ( int keyIndex,
list[int] key,
eVision.EDongleType type )
static

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

Remarks:

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

Parameters
keyIndexThe index of the key in the array of keys, must be in [0, 11]. This option is not compatible with eVision.EDongleType.Legacy
keyThe expected value of the OEM key
typeThe eVision.EDongleType for which you want to check the OEM key.

◆ CheckOemKey() [2/4]

bool eVision.Easy.CheckOemKey ( int keyIndex,
list[int] key,
eVision.EDongleType type,
int dongleIndex )
static

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

Remarks:

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

Parameters
keyIndexThe index of the key in the array of keys, must be in [0, 11]. This option is not compatible with eVision.EDongleType.Legacy
keyThe expected value of the OEM key
typeThe eVision.EDongleType for which you want to check the OEM key.
dongleIndexThe index of the dongle where the OEM key is expected. By default, the first dongle found is selected.

◆ CheckOemKey() [3/4]

bool eVision.Easy.CheckOemKey ( list[int] key,
eVision.EDongleType type )
static

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

Remarks:

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

Parameters
keyThe expected value of the OEM key
typeThe eVision.EDongleType for which you want to check the OEM key.

◆ CheckOemKey() [4/4]

bool eVision.Easy.CheckOemKey ( list[int] key,
eVision.EDongleType type,
int dongleIndex )
static

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

Remarks:

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

Parameters
keyThe expected value of the OEM key
typeThe eVision.EDongleType for which you want to check the OEM key.
dongleIndexThe index of the dongle where the OEM key is expected. By default, the first dongle found is selected.

◆ EnsureInitialized()

None 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 eVision.Easy.CheckLicenses that additionally check that licenses are correctly installed on the machine.

Remarks:

License(s): None

◆ FromDegrees()

float eVision.Easy.FromDegrees ( float angle)
static

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

Parameters
angleAngle to be converted

◆ FromRadians()

float eVision.Easy.FromRadians ( float angle)
static

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

Parameters
angleAngle to be converted

◆ GetAngleUnit()

eVision.EAngleUnit eVision.Easy.GetAngleUnit ( )
static

Current angular unit.

Remarks:

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 ( str path)
static

Returns the best matching image type for a given file on disk among eVision.EImageType.BW8, eVision.EImageType.BW16, eVision.EImageType.BW32, eVision.EImageType.BW32f, eVision.EImageType.C24, eVision.EImageType.C24A, eVision.EImageType.C48.

Parameters
pathThe path to the file on disk.

◆ GetBestMatchingImageType() [2/2]

eVision.EImageType eVision.Easy.GetBestMatchingImageType ( str path,
bool constrainToBW8AndC24 )
static

Returns the best matching image type for a given file on disk among eVision.EImageType.BW8, eVision.EImageType.BW16, eVision.EImageType.BW32, eVision.EImageType.BW32f, eVision.EImageType.C24, eVision.EImageType.C24A, eVision.EImageType.C48.

Parameters
pathThe path to the file on disk.
constrainToBW8AndC24Constrain the image type to be either eVision.EImageType.BW8 or eVision.EImageType.C24. False by default.

◆ GetDeepLearningAdditionalResourcesRootPath()

str eVision.Easy.GetDeepLearningAdditionalResourcesRootPath ( )
static

Retrieves the deep learning additional resources installation path.

Remarks:

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

◆ GetDongleCount()

int eVision.Easy.GetDongleCount ( eVision.EDongleType type)
static

Get the number of available dongle on the system.

Parameters
typeThe eVision.EDongleType you want to enumerate.

◆ GetDongleInternalSerialNumber()

str eVision.Easy.GetDongleInternalSerialNumber ( eVision.EDongleType type,
int index )
static

Get the serial number of the selected dongle.

Parameters
typeThe eVision.EDongleType.
indexThe index of the dongle.

◆ GetEnableEnhancedImageDisplay()

bool eVision.Easy.GetEnableEnhancedImageDisplay ( )
static

The enhanced mode for displaying the images.

Remarks:

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()

str eVision.Easy.GetGPUComputeCapability ( int gpuId)
static

CUDA compute capability for the specified GPU.

Parameters
gpuIdIndex of the GPU between 0 and eVision.Easy.GetNumGPUs - 1.

◆ GetGPUName()

str eVision.Easy.GetGPUName ( int gpuId)
static

Name of the GPU.

Parameters
gpuIdIndex of the GPU between 0 and eVision.Easy.GetNumGPUs - 1.

◆ GetHandleSize()

int eVision.Easy.GetHandleSize ( )
static

Gets the handle size.

Handle size is used when drawing or when hit testing.

◆ GetLicenseSources()

int eVision.Easy.GetLicenseSources ( eVision.LicenseFeatures.Features license)
static

Gets the sources of a single license.

Remarks:

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 eVision.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 eVision.Easy.SetMaxNumberOfProcessingThreads

◆ GetNumGPUs()

int eVision.Easy.GetNumGPUs ( )
static

Number of GPUs available to the system.

◆ GetOnlineDocumentationUrl()

str eVision.Easy.GetOnlineDocumentationUrl ( )
static

Gets the URL to the online eVision documentation.

◆ GetResourcesRootPath()

str eVision.Easy.GetResourcesRootPath ( )
static

Retrieves the resources installation path.

◆ GetSampleImagesRootPath()

str eVision.Easy.GetSampleImagesRootPath ( )
static

Retrieves the sample images installation path.

◆ GetSampleProgramsRootPath()

str eVision.Easy.GetSampleProgramsRootPath ( )
static

Retrieves the sample programs installation path.

◆ GetVersion()

str eVision.Easy.GetVersion ( )
static

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

Uses semver syntax.

◆ HealthCheck() [1/2]

None eVision.Easy.HealthCheck ( )
static

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

Remarks:

License(s): None

◆ HealthCheck() [2/2]

None 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.

Remarks:

License(s): None

Parameters
checkDeepLearningDependenciesIf 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.

◆ Initialize()

None eVision.Easy.Initialize ( )
static

Initializes eVision.

Remarks:

License(s): None

Deprecated

Library initialization is now performed automatically. This method doesn't perform any operation anymore. You can use eVision.Easy.EnsureInitialized instead to ensure eVision's DLL is properly loaded or eVision.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]

None eVision.Easy.LogInMemento ( str message)
static

Logs a message in eGrabber Memento.

Remarks:

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.

Parameters
messageThe message to log.

◆ LogInMemento() [2/3]

None eVision.Easy.LogInMemento ( str message,
eVision.EVerbosity verbosity )
static

Logs a message in eGrabber Memento.

Remarks:

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.

Parameters
messageThe message to log.
verbosityThe verbosity level of the message.

◆ LogInMemento() [3/3]

None eVision.Easy.LogInMemento ( str message,
eVision.EVerbosity verbosity,
int user )
static

Logs a message in eGrabber Memento.

Remarks:

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.

Parameters
messageThe message to log.
verbosityThe verbosity level of the message.
userThe user index, from 0 to 15

◆ OverrideResourcesPath()

None eVision.Easy.OverrideResourcesPath ( str path)
static

Set a specific resources path.

◆ Render3D() [1/10]

None eVision.Easy.Render3D ( eVision.EROIBW8 | None sourceImage,
eVision.EROIBW8 | None destinationImage,
float phi,
float psi )
static

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

Remarks:

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.

Parameters
sourceImagePointer to the source image.
destinationImagePointer to the destination image.
phiRotation angle about the X-axis.
psiRotation angle about the Y-axis.

◆ Render3D() [2/10]

None eVision.Easy.Render3D ( eVision.EROIBW8 | None sourceImage,
eVision.EROIBW8 | None 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.

Remarks:

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.

Parameters
sourceImagePointer to the source image.
destinationImagePointer to the destination image.
phiRotation angle about the X-axis.
psiRotation angle about the Y-axis.
xScaleMagnification factor along X (should remain close to 1).

◆ Render3D() [3/10]

None eVision.Easy.Render3D ( eVision.EROIBW8 | None sourceImage,
eVision.EROIBW8 | None 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.

Remarks:

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.

Parameters
sourceImagePointer to the source image.
destinationImagePointer to the destination image.
phiRotation angle about the X-axis.
psiRotation angle about the Y-axis.
xScaleMagnification factor along X (should remain close to 1).
yScaleMagnification factor along Y (should remain close to 1).

◆ Render3D() [4/10]

None eVision.Easy.Render3D ( eVision.EROIBW8 | None sourceImage,
eVision.EROIBW8 | None 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.

Remarks:

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.

Parameters
sourceImagePointer to the source image.
destinationImagePointer to the destination image.
phiRotation angle about the X-axis.
psiRotation angle about the Y-axis.
xScaleMagnification factor along X (should remain close to 1).
yScaleMagnification factor along Y (should remain close to 1).
zScaleMagnification factor along Z (should remain close to 1).

◆ Render3D() [5/10]

None eVision.Easy.Render3D ( eVision.EROIBW8 | None sourceImage,
eVision.EROIBW8 | None destinationImage,
float phi,
float psi,
float xScale,
float yScale,
float zScale,
int dotSize )
static

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

Remarks:

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.

Parameters
sourceImagePointer to the source image.
destinationImagePointer to the destination image.
phiRotation angle about the X-axis.
psiRotation angle about the Y-axis.
xScaleMagnification factor along X (should remain close to 1).
yScaleMagnification factor along Y (should remain close to 1).
zScaleMagnification factor along Z (should remain close to 1).
dotSizeSize of the rendered dots; allowed values are 1, 4, 5 or 9.

◆ Render3D() [6/10]

None eVision.Easy.Render3D ( eVision.EROIC24 | None sourceImage,
eVision.EROIBW8 | None zImage,
eVision.EROIC24 | None destinationImage,
float phi,
float psi )
static

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

Remarks:

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.

Parameters
sourceImagePointer to the source image.
zImagePointer to the altitude image.
destinationImagePointer to the destination image.
phiRotation angle about the X-axis.
psiRotation angle about the Y-axis.

◆ Render3D() [7/10]

None eVision.Easy.Render3D ( eVision.EROIC24 | None sourceImage,
eVision.EROIBW8 | None zImage,
eVision.EROIC24 | None 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.

Remarks:

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.

Parameters
sourceImagePointer to the source image.
zImagePointer to the altitude image.
destinationImagePointer to the destination image.
phiRotation angle about the X-axis.
psiRotation angle about the Y-axis.
xScaleMagnification factor along X (should remain close to 1).

◆ Render3D() [8/10]

None eVision.Easy.Render3D ( eVision.EROIC24 | None sourceImage,
eVision.EROIBW8 | None zImage,
eVision.EROIC24 | None 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.

Remarks:

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.

Parameters
sourceImagePointer to the source image.
zImagePointer to the altitude image.
destinationImagePointer to the destination image.
phiRotation angle about the X-axis.
psiRotation angle about the Y-axis.
xScaleMagnification factor along X (should remain close to 1).
yScaleMagnification factor along Y (should remain close to 1).

◆ Render3D() [9/10]

None eVision.Easy.Render3D ( eVision.EROIC24 | None sourceImage,
eVision.EROIBW8 | None zImage,
eVision.EROIC24 | None 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.

Remarks:

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.

Parameters
sourceImagePointer to the source image.
zImagePointer to the altitude image.
destinationImagePointer to the destination image.
phiRotation angle about the X-axis.
psiRotation angle about the Y-axis.
xScaleMagnification factor along X (should remain close to 1).
yScaleMagnification factor along Y (should remain close to 1).
zScaleMagnification factor along Z (should remain close to 1).

◆ Render3D() [10/10]

None eVision.Easy.Render3D ( eVision.EROIC24 | None sourceImage,
eVision.EROIBW8 | None zImage,
eVision.EROIC24 | None destinationImage,
float phi,
float psi,
float xScale,
float yScale,
float zScale,
int dotSize )
static

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

Remarks:

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.

Parameters
sourceImagePointer to the source image.
zImagePointer to the altitude image.
destinationImagePointer to the destination image.
phiRotation angle about the X-axis.
psiRotation angle about the Y-axis.
xScaleMagnification factor along X (should remain close to 1).
yScaleMagnification factor along Y (should remain close to 1).
zScaleMagnification factor along Z (should remain close to 1).
dotSizeSize of the rendered dots; allowed values are 1, 4, 5 or 9.

◆ RenderColorHistogram() [1/8]

None eVision.Easy.RenderColorHistogram ( eVision.EROIC24 | None sourceImage,
eVision.EROIC24 | None 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.

Remarks:

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.

Parameters
sourceImagePointer to the raw source image.
destinationImagePointer to the destination image.
phiRotation angle about the X-axis.
psiRotation angle about the Y-axis.

◆ RenderColorHistogram() [2/8]

None eVision.Easy.RenderColorHistogram ( eVision.EROIC24 | None sourceImage,
eVision.EROIC24 | None 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.

Remarks:

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.

Parameters
sourceImagePointer to the raw source image.
destinationImagePointer to the destination image.
phiRotation angle about the X-axis.
psiRotation angle about the Y-axis.
xScaleMagnification factor along X (should remain close to 1).

◆ RenderColorHistogram() [3/8]

None eVision.Easy.RenderColorHistogram ( eVision.EROIC24 | None sourceImage,
eVision.EROIC24 | None 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.

Remarks:

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.

Parameters
sourceImagePointer to the raw source image.
destinationImagePointer to the destination image.
phiRotation angle about the X-axis.
psiRotation angle about the Y-axis.
xScaleMagnification factor along X (should remain close to 1).
yScaleMagnification factor along Y (should remain close to 1).

◆ RenderColorHistogram() [4/8]

None eVision.Easy.RenderColorHistogram ( eVision.EROIC24 | None sourceImage,
eVision.EROIC24 | None 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.

Remarks:

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.

Parameters
sourceImagePointer to the raw source image.
destinationImagePointer to the destination image.
phiRotation angle about the X-axis.
psiRotation angle about the Y-axis.
xScaleMagnification factor along X (should remain close to 1).
yScaleMagnification factor along Y (should remain close to 1).
zScaleMagnification factor along Z (should remain close to 1).

◆ RenderColorHistogram() [5/8]

None eVision.Easy.RenderColorHistogram ( eVision.EROIC24 | None sourceImage,
eVision.EROIC24 | None sysImage,
eVision.EROIC24 | None 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.

Remarks:

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.

Parameters
sourceImagePointer to the raw source image.
sysImagePointer to the source image transformed into another color system.
destinationImagePointer to the destination image.
phiRotation angle about the X-axis.
psiRotation angle about the Y-axis.

◆ RenderColorHistogram() [6/8]

None eVision.Easy.RenderColorHistogram ( eVision.EROIC24 | None sourceImage,
eVision.EROIC24 | None sysImage,
eVision.EROIC24 | None 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.

Remarks:

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.

Parameters
sourceImagePointer to the raw source image.
sysImagePointer to the source image transformed into another color system.
destinationImagePointer to the destination image.
phiRotation angle about the X-axis.
psiRotation angle about the Y-axis.
xScaleMagnification factor along X (should remain close to 1).

◆ RenderColorHistogram() [7/8]

None eVision.Easy.RenderColorHistogram ( eVision.EROIC24 | None sourceImage,
eVision.EROIC24 | None sysImage,
eVision.EROIC24 | None 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.

Remarks:

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.

Parameters
sourceImagePointer to the raw source image.
sysImagePointer to the source image transformed into another color system.
destinationImagePointer to the destination image.
phiRotation angle about the X-axis.
psiRotation angle about the Y-axis.
xScaleMagnification factor along X (should remain close to 1).
yScaleMagnification factor along Y (should remain close to 1).

◆ RenderColorHistogram() [8/8]

None eVision.Easy.RenderColorHistogram ( eVision.EROIC24 | None sourceImage,
eVision.EROIC24 | None sysImage,
eVision.EROIC24 | None 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.

Remarks:

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.

Parameters
sourceImagePointer to the raw source image.
sysImagePointer to the source image transformed into another color system.
destinationImagePointer to the destination image.
phiRotation angle about the X-axis.
psiRotation angle about the Y-axis.
xScaleMagnification factor along X (should remain close to 1).
yScaleMagnification factor along Y (should remain close to 1).
zScaleMagnification factor along Z (should remain close to 1).

◆ Resize() [1/4]

None eVision.Easy.Resize ( eVision.EROIBW16 | None sourceImage,
eVision.EROIBW16 | None destinationImage )
static

Resizes an image without interpolation.

Parameters
sourceImagePointer to the source image/ROI.
destinationImagePointer to the destination image/ROI.

◆ Resize() [2/4]

None eVision.Easy.Resize ( eVision.EROIBW8 | None sourceImage,
eVision.EROIBW8 | None destinationImage )
static

Resizes an image without interpolation.

Parameters
sourceImagePointer to the source image/ROI.
destinationImagePointer to the destination image/ROI.

◆ Resize() [3/4]

None eVision.Easy.Resize ( eVision.EROIC24A | None sourceImage,
eVision.EROIC24A | None destinationImage )
static

Resizes an image without interpolation.

Parameters
sourceImagePointer to the source image/ROI.
destinationImagePointer to the destination image/ROI.

◆ Resize() [4/4]

None eVision.Easy.Resize ( eVision.EROIC24 | None sourceImage,
eVision.EROIC24 | None destinationImage )
static

Resizes an image without interpolation.

Parameters
sourceImagePointer to the source image/ROI.
destinationImagePointer to the destination image/ROI.

◆ SetAngleUnit()

None eVision.Easy.SetAngleUnit ( eVision.EAngleUnit unit)
static

Current angular unit.

Remarks:

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()

None eVision.Easy.SetEnableEnhancedImageDisplay ( bool state)
static

The enhanced mode for displaying the images.

Remarks:

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.

Parameters
stateSet to true to enable enhanced display mode.

◆ SetHandleSize()

None eVision.Easy.SetHandleSize ( int size)
static

Sets the handle size.

Handle size is used when drawing or when hit testing.

◆ SetMaxNumberOfProcessingThreads()

None 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 eVision.Easy.GetNumberOfAvailableProcessorCores. This value is thread local. It means that this value can be controlled independently for each thread you create.

◆ SetOemKey() [1/4]

None eVision.Easy.SetOemKey ( int keyIndex,
list[int] key,
eVision.EDongleType type )
static

Writes an OEM key value on a dongle.

Remarks:

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

Parameters
keyIndexThe index of the key in the array of keys, must be in [0, 11]. This option is not compatible with eVision.EDongleType.Legacy
keyThe OEM key value to write
typeThe eVision.EDongleType for which you want to set the OEM key.

◆ SetOemKey() [2/4]

None eVision.Easy.SetOemKey ( int keyIndex,
list[int] key,
eVision.EDongleType type,
int dongleIndex )
static

Writes an OEM key value on a dongle.

Remarks:

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

Parameters
keyIndexThe index of the key in the array of keys, must be in [0, 11]. This option is not compatible with eVision.EDongleType.Legacy
keyThe OEM key value to write
typeThe eVision.EDongleType for which you want to set the OEM key.
dongleIndexThe index of the dongle where the OEM key must be written. By default, the first dongle found is selected.

◆ SetOemKey() [3/4]

None eVision.Easy.SetOemKey ( list[int] key,
eVision.EDongleType type )
static

Writes an OEM key value on a dongle.

Remarks:

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

Parameters
keyThe OEM key value to write
typeThe eVision.EDongleType for which you want to set the OEM key.

◆ SetOemKey() [4/4]

None eVision.Easy.SetOemKey ( list[int] key,
eVision.EDongleType type,
int dongleIndex )
static

Writes an OEM key value on a dongle.

Remarks:

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

Parameters
keyThe OEM key value to write
typeThe eVision.EDongleType for which you want to set the OEM key.
dongleIndexThe index of the dongle where the OEM key must be written. By default, the first dongle found is selected.

◆ StartTiming()

None eVision.Easy.StartTiming ( )
static

Starts timing, using the system clock or performance counter.

◆ StopTiming() [1/2]

int eVision.Easy.StopTiming ( )
static

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

◆ StopTiming() [2/2]

int eVision.Easy.StopTiming ( int resolution)
static

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

Parameters
resolutionTemporal resolution, in ticks per second.

◆ Terminate()

None eVision.Easy.Terminate ( )
static

Method not obligatory, but necessary for close dll cleanly.

Remarks:

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
angleAngle to be converted.

◆ ToRadians()

float eVision.Easy.ToRadians ( float angle)
static

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

Parameters
angleAngle to be converted.

◆ TrueTimingResolution()

int eVision.Easy.TrueTimingResolution ( )
static

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

Remarks:

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 eVision.Easy.StopTiming.