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

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

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 (string path)
 Set a specific resources path.
static void SetOemKey (byte[] key, eVision.EDongleType type, int dongleIndex)
 Writes an OEM key value on a dongle.
static void SetOemKey (byte[] key, eVision.EDongleType type)
 Writes an OEM key value on a dongle.
static void SetOemKey (uint keyIndex, byte[] key, eVision.EDongleType type, int dongleIndex)
 Writes an OEM key value on a dongle.
static void SetOemKey (uint keyIndex, byte[] key, eVision.EDongleType type)
 Writes an OEM key value on a dongle.
static bool CheckOemKey (byte[] key, eVision.EDongleType type, int dongleIndex)
 Checks if the OEM key, if any, matches a given argument.
static bool CheckOemKey (byte[] key, eVision.EDongleType type)
 Checks if the OEM key, if any, matches a given argument.
static bool CheckOemKey (uint keyIndex, byte[] key, eVision.EDongleType type, int dongleIndex)
 Checks if the OEM key, if any, matches a given argument.
static bool CheckOemKey (uint keyIndex, byte[] 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 ulong GetLicenseSources (eVision.LicenseFeatures.Features license)
 Gets the sources of a single license.
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 bool IsGPUAvailable ()
 Indicates if a supported GPU is available for eVision computation.
static string GetGPUName (int gpuId)
 Name of the GPU.
static string GetGPUComputeCapability (int gpuId)
 CUDA compute capability for the specified GPU.
static IntPtr 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 IntPtr 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, IntPtr hDC)
 Releases the device context associated to an image.
static void CloseImageGraphicContext (eVision.EImageC24 pImage, IntPtr 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, int 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, int 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 (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 (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 int StopTiming (int resolution)
 Returns the time, in specified time units, elapsed since the last invocation of Easy.StartTiming.
static int 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 int 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 uint GetDongleCount (eVision.EDongleType type)
 Get the number of available dongle on the system.
static string GetDongleInternalSerialNumber (eVision.EDongleType type, int index)
 Get the serial number of the selected dongle.
static void LogInMemento (string message, eVision.EVerbosity verbosity, byte user)
 Logs a message in eGrabber Memento.
static void LogInMemento (string message, eVision.EVerbosity verbosity)
 Logs a message in eGrabber Memento.
static void LogInMemento (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.

Properties

static string SampleImagesRootPath [get]
 Retrieves the sample images installation path.
static string DeepLearningAdditionalResourcesRootPath [get]
 Retrieves the deep learning additional resources installation path.
static string SampleProgramsRootPath [get]
 Retrieves the sample programs installation path.
static string ResourcesRootPath [get]
 Retrieves the resources installation path.
static string OnlineDocumentationUrl [get]
 Gets the URL to the online eVision documentation.
static eVision.EAngleUnit AngleUnit [get, set]
 Current angular unit.
static int HandleSize [get, set]
 Gets the handle size. Handle size is used when drawing or when hit testing.
static string Version [get]
 Returns a string that contains the current version number of eVision.
static int MaxNumberOfProcessingThreads [get, set]
 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.NumberOfAvailableProcessorCores. This value is thread local. It means that this value can be controlled independently for each thread you create.
static int NumberOfAvailableProcessorCores [get]
 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.MaxNumberOfProcessingThreads.
static int NumGPUs [get]
 Number of GPUs available to the system.
static bool EnableEnhancedImageDisplay [get, set]
 The enhanced mode for displaying the images.

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
licenseThe 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 ( byte[] key,
eVision.EDongleType type )
static

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

Parameters
keyThe expected value of the OEM key
typeThe 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 ( byte[] key,
eVision.EDongleType type,
int dongleIndex )
static

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

Parameters
keyThe expected value of the OEM key
typeThe 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.

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

◆ CheckOemKey() [3/4]

bool eVision.Easy.CheckOemKey ( uint keyIndex,
byte[] key,
eVision.EDongleType type )
static

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

Parameters
keyIndexThe index of the key in the array of keys, must be in [0, 11]. This option is not compatible with EDongleType.EDongleType_Legacy
keyThe expected value of the OEM key
typeThe 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 ( uint keyIndex,
byte[] key,
eVision.EDongleType type,
int dongleIndex )
static

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

Parameters
keyIndexThe index of the key in the array of keys, must be in [0, 11]. This option is not compatible with EDongleType.EDongleType_Legacy
keyThe expected value of the OEM key
typeThe 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.

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

◆ CloseImageGraphicContext() [1/2]

void eVision.Easy.CloseImageGraphicContext ( eVision.EImageBW8 pImage,
IntPtr hDC )
static

Releases the device context associated to an image.

Parameters
pImagePointer to the target image (must be the same as that passed to Easy.OpenImageGraphicContext).
hDCHandle 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,
IntPtr hDC )
static

Releases the device context associated to an image.

Parameters
pImagePointer to the target image (must be the same as that passed to Easy.OpenImageGraphicContext).
hDCHandle 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
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

◆ GetBestMatchingImageType() [1/2]

eVision.EImageType eVision.Easy.GetBestMatchingImageType ( 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
pathThe path to the file on disk.

◆ GetBestMatchingImageType() [2/2]

eVision.EImageType eVision.Easy.GetBestMatchingImageType ( 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
pathThe path to the file on disk.
constrainToBW8AndC24Constrain the image type to be either EImageType.EImageType_BW8 or EImageType.EImageType_C24. False by default.

◆ GetDongleCount()

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

Get the number of available dongle on the system.

Parameters
typeThe EDongleType you want to enumerate.

◆ GetDongleInternalSerialNumber()

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

Get the serial number of the selected dongle.

Parameters
typeThe EDongleType.
indexThe index of the dongle.

◆ GetGPUComputeCapability()

string eVision.Easy.GetGPUComputeCapability ( int gpuId)
static

CUDA compute capability for the specified GPU.

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

◆ GetGPUName()

string eVision.Easy.GetGPUName ( int gpuId)
static

Name of the GPU.

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

◆ GetLicenseSources()

ulong 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

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

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 ( string message)
static

Logs a message in eGrabber Memento.

Parameters
messageThe 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 ( string message,
eVision.EVerbosity verbosity )
static

Logs a message in eGrabber Memento.

Parameters
messageThe message to log.
verbosityThe 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 ( string message,
eVision.EVerbosity verbosity,
byte user )
static

Logs a message in eGrabber Memento.

Parameters
messageThe message to log.
verbosityThe verbosity level of the message.
userThe 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]

IntPtr 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
pImagePointer 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]

IntPtr 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
pImagePointer 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 ( 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
sourceImagePointer to the source image.
destinationImagePointer to the destination image.
phiRotation angle about the X-axis.
psiRotation 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
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).

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

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

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,
int dotSize )
static

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

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.

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

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

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

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

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,
int dotSize )
static

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

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.

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
sourceImagePointer to the raw source image.
destinationImagePointer to the destination image.
phiRotation angle about the X-axis.
psiRotation 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
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).

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

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

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

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

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

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

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
sourceImagePointer to the source image/ROI.
destinationImagePointer 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
sourceImagePointer to the source image/ROI.
destinationImagePointer 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
sourceImagePointer to the source image/ROI.
destinationImagePointer 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
sourceImagePointer to the source image/ROI.
destinationImagePointer to the destination image/ROI.

◆ SetOemKey() [1/4]

void eVision.Easy.SetOemKey ( byte[] key,
eVision.EDongleType type )
static

Writes an OEM key value on a dongle.

Parameters
keyThe OEM key value to write
typeThe 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 ( byte[] key,
eVision.EDongleType type,
int dongleIndex )
static

Writes an OEM key value on a dongle.

Parameters
keyThe OEM key value to write
typeThe 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.

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 ( uint keyIndex,
byte[] key,
eVision.EDongleType type )
static

Writes an OEM key value on a dongle.

Parameters
keyIndexThe index of the key in the array of keys, must be in [0, 11]. This option is not compatible with EDongleType.EDongleType_Legacy
keyThe OEM key value to write
typeThe 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 ( uint keyIndex,
byte[] key,
eVision.EDongleType type,
int dongleIndex )
static

Writes an OEM key value on a dongle.

Parameters
keyIndexThe index of the key in the array of keys, must be in [0, 11]. This option is not compatible with EDongleType.EDongleType_Legacy
keyThe OEM key value to write
typeThe 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.

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]

int eVision.Easy.StopTiming ( )
static

Returns the time, in specified time units, elapsed since the last invocation of 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 Easy.StartTiming.

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

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.

Property Documentation

◆ AngleUnit

eVision.EAngleUnit eVision.Easy.AngleUnit
staticgetset

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.

◆ DeepLearningAdditionalResourcesRootPath

string eVision.Easy.DeepLearningAdditionalResourcesRootPath
staticget

Retrieves the deep learning additional resources installation path.

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

◆ EnableEnhancedImageDisplay

bool eVision.Easy.EnableEnhancedImageDisplay
staticgetset

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.

◆ HandleSize

int eVision.Easy.HandleSize
staticgetset

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

◆ MaxNumberOfProcessingThreads

int eVision.Easy.MaxNumberOfProcessingThreads
staticgetset

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

◆ NumberOfAvailableProcessorCores

int eVision.Easy.NumberOfAvailableProcessorCores
staticget

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

◆ NumGPUs

int eVision.Easy.NumGPUs
staticget

Number of GPUs available to the system.

◆ OnlineDocumentationUrl

string eVision.Easy.OnlineDocumentationUrl
staticget

Gets the URL to the online eVision documentation.

◆ ResourcesRootPath

string eVision.Easy.ResourcesRootPath
staticget

Retrieves the resources installation path.

◆ SampleImagesRootPath

string eVision.Easy.SampleImagesRootPath
staticget

Retrieves the sample images installation path.

◆ SampleProgramsRootPath

string eVision.Easy.SampleProgramsRootPath
staticget

Retrieves the sample programs installation path.

◆ Version

string eVision.Easy.Version
staticget

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

Uses semver syntax.