McalInquire

Inquires the plane in which the calibration points are defined. SET

Inquires the status of a calibration.

Inquires whether a rigid link exists between the camera coordinate system and the tool coordinate system. SET

Inquires the maximum number of iterations to attempt to fit the provided points when calculating the new position of the camera or relative coordinate system, when using McalList() and McalGrid() with M_DISPLACE_CAMERA_COORD or M_DISPLACE_RELATIVE_COORD respectively. SET

Inquires the maximum number of possible outliers that can occur in the data set used by McalList() or McalGrid() with M_DISPLACE_CAMERA_COORD or M_DISPLACE_RELATIVE_COORD. SET

Inquires the identifier of the system on which the calibration context has been allocated. SET

Inquires the angle of rotation of the relative world coordinate system.

For 2D-based calibration contexts, the angle of rotation is of the relative coordinate system about the Z-axis of the absolute coordinate system. A positive angle corresponds to the rotation of the X-axis in the direction of the negative Y-axis.

For 3D-based calibration contexts (M_TSAI_BASED or M_3D_ROBOTICS), the axis of rotation is not necessarily the Z-axis. The returned value is equivalent to Param4Ptr of M_ROTATION_AXIS_ANGLE in McalGetCoordinateSystem().

The angle of rotation of the relative coordinate system is affected by transformations performed using McalSetCoordinateSystem() or McalRelativeOrigin() with AngularOffset. If you are using a 3D-based calibration context, it is recommended to use McalGetCoordinateSystem(). SET

Inquires the X-coordinate of the origin of the relative world coordinate system.

The X-coordinate of the origin of the relative coordinate system is affected by transformations performed using McalSetCoordinateSystem() or McalRelativeOrigin() with XOffset. If you are using a 3D-based calibration context, it is recommended to use McalSetCoordinateSystem(). SET

Inquires the Y-coordinate of the origin of the relative world coordinate system.

The Y-coordinate of the origin of the relative coordinate system is affected by transformations performed using McalSetCoordinateSystem() or McalRelativeOrigin() with YOffset. If you are using a 3D-based calibration context, it is recommended to use McalSetCoordinateSystem(). SET

Inquires the Z-coordinate of the origin of the relative world coordinate system.

The Z-coordinate of the origin of the relative coordinate system is affected by transformations performed using McalSetCoordinateSystem() or McalRelativeOrigin() with ZOffset. If you are using a 3D-based calibration context, it is recommended to use McalSetCoordinateSystem(). SET

Inquires the X-position of the origin of the tool coordinate system. SET

Inquires the Y-position of the origin of the tool coordinate system. SET

Inquires the Z-position of the origin of the tool coordinate system. SET

Inquires whether a cache is used to accelerate McalTransformImage(). SET

Inquires the number of columns in the calibration grid. SET

Inquires the number of world units between columns. SET

Inquires whether the grid's circles are lighter or darker than the background. SET

Inquires the approximate pixel X-coordinate of the circle that is actually at the top-left corner of the calibration grid in the real-world. SET

Inquires the approximate pixel Y-coordinate of the circle that is actually at the top-left corner of the calibration grid in the real-world. SET

Inquires the X-position of the top-left circle of a circle grid, or the top-left point connecting four squares in a chessboard grid, in the camera calibration plane coordinate system. SET

Inquires the Y-position of the top-left circle of a circle grid, or the top-left point connecting four squares in a chessboard grid, in the camera calibration plane coordinate system. SET

Inquires the Z-position of the top-left circle of a circle grid, or the top-left point connecting four squares in a chessboard grid, in the camera calibration plane coordinate system. SET

Inquires the type of grid used to perform the calibration. SET

Inquires the number of rows in the calibration grid. SET

Inquires the spacing between rows in the calibration grid. SET

Inquires the average calibration error in the pixel coordinate system. You can only inquire this value for a successfully calibrated calibration context.

This is the average distance in the pixel coordinate system between the initial calibration points and their projected points in an image.

When working in M_3D_ROBOTICS calibration mode, this only returns the average calibration error of the last calibration call. To return an average calibration error for all calibration grids used, it is recommended to use M_GLOBAL_AVERAGE_PIXEL_ERROR instead.

Inquires the average calibration error in the absolute coordinate system. You can only inquire this value for a successfully calibrated calibration context.

This is the average distance in the absolute coordinate system between the initial calibration points and their projected points in an image.

When working in M_3D_ROBOTICS calibration mode, this only returns the average calibration error of the last calibration call. To return an average calibration error for all calibration grids used, it is recommended to use M_GLOBAL_AVERAGE_WORLD_ERROR instead.

Inquires the X-coordinate of the calibration points in the pixel coordinate system. These coordinates are extracted from the image.

If you used McalList() to calibrate your camera setup, you explicitly set the calibration points' pixel coordinates with the PixCoordXArrayPtr parameter.

If you used McalGrid() to calibrate your camera setup, the calibration points' pixel coordinates are determined by the pixel positions of the circles in a circle grid or the pixel positions of the points connecting four corners in a chessboard grid. SET

Inquires the Y-coordinate of the calibration points in the pixel coordinate system. These coordinates are extracted from the image.

If you used McalList() to calibrate your camera setup, you explicitly set the calibration points' pixel coordinates with the PixCoordYArrayPtr parameter.

If you used McalGrid() to calibrate your camera setup, the calibration points' pixel coordinates are determined by the pixel positions of the circles in a circle grid or the pixel positions of the points connecting four corners in a chessboard grid. SET

Inquires the X-coordinate of the calibration points, in real-world units of the camera calibration plane (M_CALIBRATION_PLANE). These coordinates are computed based on explicitly specified values.

If you used McalList() to calibrate your camera setup, you explicitly set the calibration points' world coordinates with the WorldCoordXArrayPtr parameter.

If you used McalGrid() to calibrate your camera setup, the calibration points are computed from the parameters GridOffsetX, ColumnNumber, and ColumnSpacing. SET

Inquires the Y-coordinate of the calibration points, in real-world units of the camera calibration plane (M_CALIBRATION_PLANE). These coordinates are computed based on explicitly specified values.

If you used McalList() to calibrate your camera setup, you explicitly set the calibration points' world coordinates with the WorldCoordYArrayPtr parameter.

If you used McalGrid() to calibrate your camera setup, the calibration points are computed from the parameters GridOffsetY, RowNumber, and RowSpacing. SET

Inquires the Z-coordinate of the calibration points, in real-world units of the camera calibration plane (M_CALIBRATION_PLANE). If this value is inquired for 2D-based calibration contexts, the specified array will be filled with 0.0 values. These coordinates are based on explicitly specified values.

If you used McalList() to calibrate your camera setup, you explicitly set the calibration points' pixel coordinates with the WorldCoordZArrayPtr parameter.

If you used McalGrid() to calibrate your camera setup, you explicitly set the Z-coordinate of all the calibration points with the GridOffsetZ parameter. SET

Inquires the average calibration error, in pixels, for all the points used in all successive calls to McalGrid() and McalList(). You can only inquire this value for a successfully calibrated M_3D_ROBOTICS calibration context.

Inquires the average calibration error, in world units, for all the points used in all successive calls to McalGrid() and McalList(). You can only inquire this value for a successfully calibrated M_3D_ROBOTICS calibration context.

Inquires the maximum calibration error, in pixels, for all the points used in all successive calls to McalGrid() and McalList(). You can only inquire this value for a successfully calibrated M_3D_ROBOTICS calibration context.

Inquires the maximum calibration error, in world units, for all the points used in all successive calls to McalGrid() and McalList(). You can only inquire this value for a successfully calibrated M_3D_ROBOTICS calibration context.

Inquires the maximum calibration error, in pixels. You can only inquire this value for a successfully calibrated calibration context.

For an M_3D_ROBOTICS calibration context, this only returns the average calibration error of the last calibration call. To return an average calibration error for all calibration grids used, it is recommended to use M_GLOBAL_MAXIMUM_PIXEL_ERROR instead.

Inquires the maximum calibration error, in world units. You can only inquire this value for a successfully calibrated calibration context.

For an M_3D_ROBOTICS calibration context, this only returns the average calibration error of the last calibration call. To return an average calibration error for all calibration grids used, it is recommended to use M_GLOBAL_MAXIMUM_WORLD_ERROR instead.

Inquires the number of calibration points found by McalGrid() or passed to McalList().

If you used McalList() to calibrate your camera setup, you can explicitly set the number of calibration points with the NumPoint parameter.

If you used McalGrid() to calibrate your camera setup, the number of calibration points is determined by the number of columns and rows in your grid. SET

Inquires the number of calls made to McalGrid() or McalList() with the same CalibrationOrMilId parameter passed. You can only inquire this value for a successfully calibrated M_3D_ROBOTICS calibration context.

Inquires the average aspect ratio. The ratio is the average pixel width, divided by average pixel height, calculated with world units.

Specifies the type of data that was used to perform the calibration.

Inquires the width to height ratio of the individual elements of the CCD. SET

Inquires the value of the second order radial distortion coefficient used in the calibration algorithm. Radial distortion refers to image distortions caused by the camera's lens.

Inquires the effective focal length of the pinhole camera model used in the calibration.

Inquires the X-coordinate of the intersection of the camera's optical axis and the image plane. SET

Inquires the Y-coordinate of the intersection of the camera's optical axis and the image plane. SET

Inquires the identifier of the associated calibration context.

Inquires whether the calibration mode of the specified MIL object is 2D-based or 3D-based. SET

Inquires the calibration mode of the associated camera calibration of the specified MIL object. SET

Inquires whether the image has a constant pixel size.

When inquiring a calibration context, M_CONSTANT_PIXEL_SIZE will always return M_FALSE.

Inquires whether the image has been physically corrected. Physically corrected images have square pixels with a constant size and no rotation between the pixel and absolute coordinate systems. Images can be corrected using McalTransformImage() with M_FULL_CORRECTION.

When inquiring a calibration context, M_CORRECTION_STATE will always return M_FALSE.

Inquires whether the MIL object is a fully corrected depth map.

Inquires whether the Y-axis of the absolute coordinate system is oriented counter-clockwise with respect to its positive X-axis.

If you used McalList() to calibrate your camera setup, the Y-axis orientation was determined by the calibration points that you specified. For more information, see the List of coordinates subsection of the Calibrating using calibration points from a grid or a list section of Chapter 25: Calibrating your camera setup.

If you used McalGrid() to calibrate your camera setup, the explicitly specified Y-axis orientation is used.

Note that this constant does not support images without an associated calibration context. An uncalibrated image will return an error.

Inquires the X-offset of a child buffer relative to the highest calibrated parent image that was originally associated with the calibration context. SET

Inquires the Y-offset of a child buffer relative to the highest calibrated parent image that was originally associated with the calibration context. SET

Inquires the step, in world units, along the Z-axis of the relative coordinate system, represented by one gray level. Since the Z-axis is pointing downwards, positive M_GRAY_LEVEL_SIZE_Z values mean that lower (darker) pixel values represent higher world points (top-black); negative M_GRAY_LEVEL_SIZE_Z values mean that higher (brighter) pixel values represent higher world points (top-white).

This inquire type is only useful when inquiring about an image buffer that contains a depth map. SET

Inquires the angle of the X-axis of the pixel coordinate system measured in the relative world coordinate system, starting from the positive X-axis of the relative world coordinate system and going towards its positive Y-axis.

This value corresponds to R in the above formulas. SET

Inquires the width of the pixels in the corrected image.

You can multiply a measure in pixels, along the X-axis, by M_PIXEL_SIZE_X to get the measure in world units. If there is rotation between the relative world coordinate system and the pixel coordinate system, this distance won't be along the X-axis of the relative world coordinate system.

This value corresponds to S_x in the above formulas. SET

Inquires the height of the pixels in the corrected image.

You can multiply a measure in pixels, along the Y-axis, by M_PIXEL_SIZE_Y to get the measure in world units. If there is rotation between the relative world coordinate system and the pixel coordinate system, this distance won't be along the Y-axis of the relative world coordinate system.

This value corresponds to S_y in the above formulas. SET

Inquires the X-coordinate of the center of the top-left pixel in the corrected image. This value corresponds to T_x in the above formulas. SET

Inquires the Y-coordinate of the center of the top-left pixel in the corrected image. This value corresponds to T_y in the above formulas. SET

Inquires the Z-coordinate of gray level 0 in the corrected image. SET

Inquires the angular offset to apply to the reference location when setting the relative world coordinate system. SET

Inquires the X-offset to apply to the reference location when setting the relative world coordinate system. SET

Inquires the Y-offset to apply to the reference location when setting the relative world coordinate system. SET