IMVCameraCalibration

The IMVCameraCalibration interface contains methods and properties to configure the MV Camera Calibration filter.

Methods:

AdvancedSegmentation Enables an advanced segmentation algorithm.
CalibImageFolder Output folder for calibration images.
Calibrate Status of the automatic camera calibration function.
CalibrationTarget The calibration target layout.
CopyImage Enable the copy image function from the filter.
EnableAutoCalibration Enable the Auto Calibration Function.
EnableSaveCalibImages Save calibration images into a folder.
GetCameraData Get current camera and objective datat.
GetCameraParameter Get the current camera parameter.
LoadCameraParameter Load camera parameter from a file.
MirrorPoints Mirrors the reference points from the input images.
RefImageCount Count of reference images used for camera calibration.
RefImageDelay Minimum delay between two reference images within the video stream.
Reset Reset the camera intrinsic parameter.
SaveCameraParameter Save camera parameter into a file.
SetCameraData Set current camera and objective datat.
SetCameraParameter Set new camera parameter.
TargetColumns Count of target columns.
TargetRows Count of target rows.
Undistortion Enable the undistortion function from the filter.
ValidRefImages Count of the current valid reference images.

Header file: IMVCameraCalibration.h
Interface definition language file: IMVCameraCalibration.idl
Typelib: MVCameraCalibration
Interface ID: IID_IMVCameraCalibration


Property IMVCameraCalibration::AdvancedSegmentation

Declaration: Property Get/Put AdvancedSegmentation As Boolean

Enables an advanced segmentation algorithm.

C Prototype:

HRESULT put_AdvancedSegmentation(VARIANT_BOOL newVal);
HRESULT get_AdvancedSegmentation(VARIANT_BOOL *pVal);


Property IMVCameraCalibration::CalibImageFolder

Declaration: Property Get/Put CalibImageFolder As String

Output folder for calibration images.

C Prototype:

HRESULT put_CalibImageFolder(BSTR newVal);
HRESULT get_CalibImageFolder(BSTR *pVal);


Property IMVCameraCalibration::Calibrate

Declaration: Property Get/Put Calibrate As Boolean

Status of the automatic camera calibration function.

C Prototype:

HRESULT put_Calibrate(VARIANT_BOOL newVal);
HRESULT get_Calibrate(VARIANT_BOOL *pVal);


Property IMVCameraCalibration::CalibrationTarget

Declaration: Property Get/Put CalibrationTarget As Long

The calibration target layout.

Current allowed values:
Target Value Description
MV_CALIBRATION_TARGET_CHESSBOARD 0 Use a chessboard calibration pattern

C Prototype:

HRESULT put_CalibrationTarget(LONG newVal);
HRESULT get_CalibrationTarget(LONG *pVal);


Property IMVCameraCalibration::CopyImage

Declaration: Property Get/Put CopyImage As Boolean

Enable the copy image function from the filter.

C Prototype:

HRESULT put_CopyImage(VARIANT_BOOL newVal);
HRESULT get_CopyImage(VARIANT_BOOL *pVal);


Property IMVCameraCalibration::EnableAutoCalibration

Declaration: Property Get/Put EnableAutoCalibration As Boolean

Enable the Auto Calibration Function.

C Prototype:

HRESULT put_EnableAutoCalibration(VARIANT_BOOL newVal);
HRESULT get_EnableAutoCalibration(VARIANT_BOOL *pVal);


Property IMVCameraCalibration::EnableSaveCalibImages

Declaration: Property Get/Put EnableSaveCalibImages As Boolean

Save calibration images into a folder.

C Prototype:

HRESULT put_EnableSaveCalibImages(VARIANT_BOOL newVal);
HRESULT get_EnableSaveCalibImages(VARIANT_BOOL *pVal);


Method IMVCameraCalibration::GetCameraData

Declaration: Sub GetCameraData(CameraLabel As String, CameraType As String, ChipWidth As Double, ChipHeight As Double, ObjectiveLabel As String, FocalLength As Double)

Get current camera and objective datat.

Parameter:

CameraLabel A friendly name for the camera.
CameraType The camera type.
ChipWidth The camera chip width in mm.
ChipHeight The camera chip height in mm.
ObjectiveLabel Name for the objective.
FocalLength Focal length from the objective in mm.
C Prototype:

HRESULT GetCameraData(BSTR* CameraLabel, BSTR* CameraType, DOUBLE* ChipWidth, DOUBLE* ChipHeight, BSTR* ObjectiveLabel, DOUBLE* FocalLength);


Method IMVCameraCalibration::GetCameraParameter

Declaration: Sub GetCameraParameter(FocalLength1 As Double, FocalLength2 As Double, Distortion1 As Double, Distortion2 As Double, Distortion3 As Double, Distortion4 As Double, PrincipalPoint1 As Double, PrincipalPoint2 As Double)

Get the current camera parameter.

Parameter:

FocalLength1 The first focal length in pixel size.
FocalLength2 The second focal length in pixel size.
Distortion1 The first distortion parameter.
Distortion2 The second distortion parameter.
Distortion3 The third distortion parameter.
Distortion4 The fourth distortion parameter.
PrincipalPoint1 x-coordinate from the principal point.
PrincipalPoint2 y-coordinate from the principal point.
C Prototype:

HRESULT GetCameraParameter(DOUBLE* FocalLength1, DOUBLE* FocalLength2, DOUBLE* Distortion1, DOUBLE* Distortion2, DOUBLE* Distortion3, DOUBLE* Distortion4, DOUBLE* PrincipalPoint1, DOUBLE* PrincipalPoint2);


Method IMVCameraCalibration::LoadCameraParameter

Declaration: Sub LoadCameraParameter(Path As String)

Load camera parameter from a file.

Parameter:

Path Path to the camera parameter file(*.mvc).
C Prototype:

HRESULT LoadCameraParameter(BSTR Path);


Property IMVCameraCalibration::MirrorPoints

Declaration: Property Get/Put MirrorPoints As Boolean

Mirrors the reference points from the input images.

C Prototype:

HRESULT put_MirrorPoints(VARIANT_BOOL newVal);
HRESULT get_MirrorPoints(VARIANT_BOOL *pVal);


Property IMVCameraCalibration::RefImageCount

Declaration: Property Get/Put RefImageCount As Long

Count of reference images used for camera calibration.

C Prototype:

HRESULT put_RefImageCount(LONG newVal);
HRESULT get_RefImageCount(LONG *pVal);


Property IMVCameraCalibration::RefImageDelay

Declaration: Property Get/Put RefImageDelay As Double

Minimum delay between two reference images within the video stream.

C Prototype:

HRESULT put_RefImageDelay(DOUBLE newVal);
HRESULT get_RefImageDelay(DOUBLE *pVal);


Method IMVCameraCalibration::Reset

Declaration: Sub Reset

Reset the camera intrinsic parameter.

C Prototype:

HRESULT Reset();


Method IMVCameraCalibration::SaveCameraParameter

Declaration: Sub SaveCameraParameter(Path As String)

Save camera parameter into a file.

Parameter:

Path Path to the new camera parameter file.
C Prototype:

HRESULT SaveCameraParameter(BSTR Path);


Method IMVCameraCalibration::SetCameraData

Declaration: Sub SetCameraData(CameraLabel As String, CameraType As String, ChipWidth As Double, ChipHeight As Double, ObjectiveLabel As String, FocalLength As Double)

Set current camera and objective datat.

Parameter:

CameraLabel A friendly name for the camera.
CameraType The camera type.
ChipWidth The camera chip width in mm.
ChipHeight The camera chip height in mm.
ObjectiveLabel Name for the objective.
FocalLength Focal length from the objective in mm.
C Prototype:

HRESULT SetCameraData(BSTR CameraLabel, BSTR CameraType, DOUBLE ChipWidth, DOUBLE ChipHeight, BSTR ObjectiveLabel, DOUBLE FocalLength);


Method IMVCameraCalibration::SetCameraParameter

Declaration: Sub SetCameraParameter(FocalLength1 As Double, FocalLength2 As Double, Distortion1 As Double, Distortion2 As Double, Distortion3 As Double, Distortion4 As Double, PrincipalPoint1 As Double, PrincipalPoint2 As Double)

Set new camera parameter.

Parameter:

FocalLength1 The first focal length in pixel size.
FocalLength2 The second focal length in pixel size.
Distortion1 The first distortion parameter.
Distortion2 The second distortion parameter.
Distortion3 The third distortion parameter.
Distortion4 The fourth distortion parameter.
PrincipalPoint1 x-coordinate from the principal point.
PrincipalPoint2 y-coordinate from the principal point.
C Prototype:

HRESULT SetCameraParameter(DOUBLE FocalLength1, DOUBLE FocalLength2, DOUBLE Distortion1, DOUBLE Distortion2, DOUBLE Distortion3, DOUBLE Distortion4, DOUBLE PrincipalPoint1, DOUBLE PrincipalPoint2);


Property IMVCameraCalibration::TargetColumns

Declaration: Property Get/Put TargetColumns As Long

Count of target columns.

C Prototype:

HRESULT put_TargetColumns(LONG newVal);
HRESULT get_TargetColumns(LONG *pVal);


Property IMVCameraCalibration::TargetRows

Declaration: Property Get/Put TargetRows As Long

Count of target rows.

C Prototype:

HRESULT put_TargetRows(LONG newVal);
HRESULT get_TargetRows(LONG *pVal);


Property IMVCameraCalibration::Undistortion

Declaration: Property Get/Put Undistortion As Boolean

Enable the undistortion function from the filter.

C Prototype:

HRESULT put_Undistortion(VARIANT_BOOL newVal);
HRESULT get_Undistortion(VARIANT_BOOL *pVal);


Property IMVCameraCalibration::ValidRefImages

Declaration: Property Get ValidRefImages As Long

Count of the current valid reference images.

C Prototype:

HRESULT get_ValidRefImages(LONG *pVal);