documentation

Visometry.VisionLib.SDK.Core.API.Native.CalibratedImage Class Reference

The CalibratedImage is a wrapper for a CalibratedImage object. It is a container for an Image, IntrinsicData and ExtrinsicData such that the intrinsic data belongs to the image and the extrinsic data describes the transformation from the device to the image. More...

Inherits IDisposable.

Public Member Functions

 CalibratedImage (IntPtr handle, bool owner)
 Internal constructor of CalibratedImage. More...
 
CalibratedImage Clone ()
 Creates a copy of this object and returns a Wrapper of it. More...
 
void Dispose ()
 Explicitly releases references to unmanaged resources. More...
 
IntPtr getHandle ()
 
Image GetImage ()
 Returns the image of the calibrated image. More...
 
ExtrinsicData GetImageFromDeviceTransform ()
 Returns the extrinsic data for the transformation from device space to image space. More...
 
IntrinsicData GetIntrinsicData ()
 Returns the intrinsic data regarding the image. More...
 

Detailed Description

The CalibratedImage is a wrapper for a CalibratedImage object. It is a container for an Image, IntrinsicData and ExtrinsicData such that the intrinsic data belongs to the image and the extrinsic data describes the transformation from the device to the image.

Constructor & Destructor Documentation

◆ CalibratedImage()

Visometry.VisionLib.SDK.Core.API.Native.CalibratedImage.CalibratedImage ( IntPtr  handle,
bool  owner 
)
inline

Internal constructor of CalibratedImage.

This constructor is used internally by the VisionLib.

Parameters
handleHandle to the native object.
ownertrue, if the CalibratedImage is the owner of the native object; false, otherwise.

Member Function Documentation

◆ Clone()

CalibratedImage Visometry.VisionLib.SDK.Core.API.Native.CalibratedImage.Clone ( )
inline

Creates a copy of this object and returns a Wrapper of it.

Returns
A wrapper of a copy of this object.

◆ Dispose()

void Visometry.VisionLib.SDK.Core.API.Native.CalibratedImage.Dispose ( )
inline

Explicitly releases references to unmanaged resources.

Call Dispose when you are finished using the CalibratedImage. The Dispose method leaves the CalibratedImage in an unusable state. After calling Dispose, you must release all references to the CalibratedImage so the garbage collector can reclaim the memory that the CalibratedImage was occupying.

◆ GetImage()

Image Visometry.VisionLib.SDK.Core.API.Native.CalibratedImage.GetImage ( )
inline

Returns the image of the calibrated image.

Returns
Image of the image.

◆ GetImageFromDeviceTransform()

ExtrinsicData Visometry.VisionLib.SDK.Core.API.Native.CalibratedImage.GetImageFromDeviceTransform ( )
inline

Returns the extrinsic data for the transformation from device space to image space.

Returns
<see cref="ExtrinsicData"> for transformation from device to image space.

◆ GetIntrinsicData()

IntrinsicData Visometry.VisionLib.SDK.Core.API.Native.CalibratedImage.GetIntrinsicData ( )
inline

Returns the intrinsic data regarding the image.

Returns
IntrinsicData of the image.