MregControl

Sets the number of registration elements in the registration context. If you reduce the number of registration elements, the settings of the ones that remain are kept unchanged. If you increase the number of registration elements, the new ones are initialized with the default settings.

You should have at least as many registration elements as the number of images that you want to register.

For a photometric stereo registration context, the number of registration elements also corresponds to the maximum number of lights used during the photometric stereo computation. INQ

Sets the accuracy of the registration calculation. Accuracy depends on the image's dynamic range, sharpness, and noise. The best accuracy is achieved for well-contrasted noise-free images. INQ

Sets the maximum displacement that will be applied to any pixel in the images during registration, relative to its initial location set using MregSetLocation(). With a larger maximum displacement, you can align the images even if the location that was set using MregSetLocation() was not precise. However, this can lead to a longer calculation time.

Note that if you have not set the rough location using MregSetLocation(), set M_LOCATION_DELTA to 100, so that all possible translations are searched. INQ

Sets the minimum overlap that should exist between an image and its reference image so that the registration calculation can optimize the match in their overlapping region. If the minimum overlap is not met, the optimization step will not be performed for this image. Instead, the transformation that was set using MregSetLocation() becomes the optimal transformation.

The image's registration result element will indicate that the registration operation failed for this image. INQ

Sets the type of score calculated during registration. This calculated score can be retrieved after registration using MregGetResult() with M_SCORE. INQ

Sets the type of transformation that the registration calculation will use to optimize the match in the images' overlapping regions. INQ

Sets whether to perform the optimization step of the registration calculation for the registration element's image. If you choose not to perform the optimization calculation, the transformation that you set with MregSetLocation() becomes the optimal transformation for this image. When MregCalculate() is called, the transformation is converted so that it maps the image into the global pixel coordinate system instead of into its reference image's pixel coordinate system. INQ

Sets the X-coordinate of the origin of the image's pixel coordinate system.

This is an advanced control type and changing the origin of an image's pixel coordinate system will affect various aspects of the registration process. This origin is used when specifying the approximate location of the image in its registration element's image (MregSetLocation()); you must specify the location of the origin with respect to the origin of the reference element's image. Similarly, if you use the image to position other images, specify locations relative to this origin. The position of your mosaic in the destination image buffer depends on the mosaic's reference coordinate system (MregControl() with M_MOSAIC_STATIC_INDEX), which can be the coordinate system of a particular image. Finally, you can convert coordinates to and from an image's pixel coordinate system, with MregTransformCoordinate() and MregTransformCoordinateList(). If you modify the origin of an image's pixel coordinate system, you must keep the origin's new location in mind when performing any of these operations. INQ

Sets the Y-coordinate of the origin of the image's pixel coordinate system.

This is an advanced control type and changing the origin of an image's pixel coordinate system will affect various aspects of the registration process. This origin is used when specifying the approximate location of the image in its registration element's image (MregSetLocation()); you must specify the location of the origin with respect to the origin of the reference element's image. Similarly, if you use this image to position other images, specify locations relative to this origin. The position of your mosaic in the destination image buffer depends on the mosaic's reference coordinate system (MregControl() with M_MOSAIC_STATIC_INDEX), which can be the coordinate system of a particular image. Finally, you can convert coordinates to and from an image's pixel coordinate system, with MregTransformCoordinate() and MregTransformCoordinateList(). If you modify the origin of an image's pixel coordinate system, you must keep the origin's new location in mind when performing any of these operations. INQ

Sets which image's pixel values to use when composing the mosaic and two or more images overlap. INQ

Sets the X-offset between the origin of the coordinate system used to compose the mosaic and the left side of the destination image buffer. The coordinate system used to compose the mosaic is the one specified with M_MOSAIC_STATIC_INDEX. INQ

Sets the Y-offset between the origin of the coordinate system used to compose the mosaic and the top of the destination image buffer. The coordinate system used to compose the mosaic is the one specified with M_MOSAIC_STATIC_INDEX. INQ

Sets the scale factor to apply to the images before composition of the mosaic. A value greater than 1.0 produces an enlarged mosaic, while a value less than 1.0 produces a reduced one. INQ

Sets the coordinate system relative to which the mosaic will be composed. This can be a registered image's pixel coordinate system or the global pixel coordinate system. If you select an image's pixel coordinate system, that image will appear upright in the mosaic, and the other images will be oriented relative to it.

By default, the origin of the mosaic will appear at the top-left corner of the destination image buffer. You can adjust the horizontal and vertical offset of the origin using M_MOSAIC_OFFSET_X and M_MOSAIC_OFFSET_Y. INQ

Sets the radius of the M_CIRCULAR and M_GAUSSIAN point-spread functions (PSF). For M_GAUSSIAN, the radius corresponds to the standard deviation. For M_SQUARE, the radius corresponds to half the size of the square side.

This control type is only taken into account when M_MOSAIC_COMPOSITION is set to M_SUPER_RESOLUTION and M_SR_PSF_TYPE is not set to M_DISABLE. INQ

Sets the type of point-spread function (PSF) to use during super-resolution calculations to model the blurring in source images.

The point-spread function describes how a small point of light in the world is blurred by the acquisition setup (lens and CCD). Use M_SR_PSF_RADIUS to set the radius of the PSF.

The value of this control type is only taken into account when M_MOSAIC_COMPOSITION is set to M_SUPER_RESOLUTION. INQ

Sets the smoothness value to use during super-resolution calculations.

Use a high smoothness value to reduce local variations in the mosaic image. This is useful to prevent artifacts caused by noise in the source images.

Use a low smoothness value when there is little noise in the source image. This is useful to preserve the most detail in your mosaic.

This control type is only taken into account when M_MOSAIC_COMPOSITION is set to M_SUPER_RESOLUTION. INQ

Sets the type of image to draw when using MregCalculate() with RegResultOrImageId set to an image buffer. INQ

Sets whether to compute the Gaussian curvature image when using MregCalculate() with RegResultOrImageId set to a result buffer.

The Gaussian curvature image reveals defects on smooth surfaces, because surface curvature values change abruptly when a defect occurs on such surfaces. This setting is useful when examining a flat printed surface where the printing can obscure defects. Note that this setting is not suitable for finely textured surfaces. Try M_MEAN_CURVATURE instead. INQ

Sets whether to compute the local contrast image when using MregCalculate() with RegResultOrImageId set to a result buffer.

M_LOCAL_CONTRAST reveals surface height variations by increasing the contrast between highlights and shadows. This setting performs morphological operations using M_OBJECT_SIZE to control the number of iterations to perform.

A local contrast operation can remove printed text on flat surface areas in the resulting enhanced image, provided source image illumination is even (equal relative intensities across the light sources). INQ

Sets whether to compute the local shape image when using MregCalculate() with RegResultOrImageId set to a result buffer.

A local shape image captures raised and recessed features on a surface that are not apparent with a single image using one light source. Multiple acquisitions using many light sources allow the extraction of structural content not otherwise visible, facilitating further image analysis.

You can control shape smoothness in the resulting image with M_SHAPE_SMOOTHNESS.

Note that, while each image uses one light source, your lights must be set up in opposite pairs. That is, for each light in the setup, there should be another light positioned 180 degrees opposite. INQ

Sets whether to compute the mean curvature image when using MregCalculate() with RegResultOrImageId set to a result buffer.

A mean curvature image can reveal small (local) curvature changes, because the curvature is calculated at every pixel, resulting in more local information. Fine scratches or very small features on a surface are revealed.

Note that the mean curvature operation can substitute for local shape when opposite-paired lighting is not achievable. INQ

Sets whether to compute a correction for non-uniform illumination on the input image. INQ

Sets the number of iterations to perform when computing a local contrast image (M_LOCAL_CONTRAST or M_DRAW_WITH_NO_RESULT set to M_DRAW_LOCAL_CONTRAST_IMAGE).

For the local contrast operation, M_OBJECT_SIZE controls the number of iterations of a morphological operation. The number of iterations to perform is related to the feature size of the object(s) in the scene. For larger features, more iterations might be needed. The default is 1 iteration, but it is recommended to experiment to find the best setting for your needs. INQ

Sets whether to perform shape normalization when computing a local shape image (M_LOCAL_SHAPE or M_DRAW_WITH_NO_RESULT set to M_DRAW_LOCAL_SHAPE_IMAGE).

Shape normalization is performed by default. You can choose to disable shape normalization if the region undergoing photometric stereo registration is mostly flat (perpendicular to the camera). Disabling shape normalization can improve results in such instances, because surface normals from flat regions will be ignored. INQ

Sets the shape smoothness value when computing a local shape image (M_LOCAL_SHAPE or M_DRAW_WITH_NO_RESULT set to M_DRAW_LOCAL_SHAPE_IMAGE).

Sets whether to compute the texture image when using MregCalculate() with RegResultOrImageId set to a result buffer.

This operation targets surface luminance and can remove spectral reflections. INQ

Sets whether to automatically calculate the remap factor, or to use a user-defined value. The remap factor is the factor needed to remap the result of an M_DRAW_GAUSSIAN_CURVATURE_IMAGE, M_DRAW_LOCAL_SHAPE_IMAGE, or M_DRAW_MEAN_CURVATURE_IMAGE operation when the destination is not a 32-bit floating-point image buffer.

This control type is useful when you are performing several of these operations and want to ensure that the same factor is used to remap the results of the operation from 32-bit floating-point data to the data type of the destination buffer (ensuring that the stored results are directly comparable).

If you specify M_USER_DEFINED, and set a remap factor using M_DRAW_REMAP_FACTOR_VALUE, the same remapping will be used to remap the result every time you perform one of the relevant operations. If you specify M_AUTO (or M_DEFAULT), a different remap factor is calculated each time, based on the maximum and minimum values in the result. With M_AUTO, the remap factor is automatically defined so that the entire range of the drawn image is represented.

You can retrieve the automatically defined remap factor value using MregGetResult() with M_RANGE_FACTOR_GAUSSIAN_CURVATURE, M_RANGE_FACTOR_LOCAL_SHAPE, or M_RANGE_FACTOR_MEAN_CURVATURE. INQ

Sets the remap factor value when M_DRAW_REMAP_FACTOR_MODE is set to M_USER_DEFINED and the destination is not a 32-bit floating-point image buffer.

Pixel intensities are multiplied by ((2 ⁿ - 1)/2) * M_DRAW_REMAP_FACTOR_VALUE , then offset by ((2 ⁿ - 1)/2); n is the number of bits per pixel.

When M_DRAW_REMAP_FACTOR_MODE is set to M_AUTO, this value isn't used.

To specify an appropriate remap factor value, it is recommended to obtain the automatically calculated remap factor (using MregGetResult() with M_RANGE_FACTOR_...) for some typical images. If the resulting output is satisfactory, set M_DRAW_REMAP_FACTOR_VALUE to the automatically calculated value. If not, you can try setting the remap factor to a higher value; this increases image contrast and helps to bring out smaller details in the resulting photometric stereo image. INQ

Stops the current photometric stereo calculation operation. You must call MregControl() with M_STOP_CALCULATE from another thread of higher priority. Results already available in the result buffer become invalid and will be discarded.

Sets the first component of the light vector for the specified registration element. When M_LIGHT_VECTOR_TYPE is set to M_SPHERICAL, this component is the polar (zenith) angle. When M_LIGHT_VECTOR_TYPE is set to M_CARTESIAN, this component is the vector's X-coordinate in pixel units. INQ

Sets the second component of the light vector for the specified registration element. When M_LIGHT_VECTOR_TYPE is set to M_SPHERICAL, this component is the azimuth angle. When M_LIGHT_VECTOR_TYPE is set to M_CARTESIAN, this component is the vector's Y-coordinate in pixel units. INQ

Sets the third component of the light vector for the specified registration element.

When M_LIGHT_VECTOR_TYPE is set to M_SPHERICAL, this component is the relative intensity of the light source. If relative light intensity is set to 1.0 for all light sources, each light provides the same intensity to the setup, which is the ideal arrangement. If equal light intensities are not possible, set the strongest light to 1.0 and set the other light intensity values relative to this.

When M_LIGHT_VECTOR_TYPE is set to M_CARTESIAN, this component is the vector's Z-coordinate, specified in a pixel unit equivalent. That is, specify the Z-distance in units equivalent to those used for the X- and Y-coordinates. By default, the Z-axis points downward, so the light source is usually in the negative Z-region of the relative coordinate system. Use an absolute value for this component. INQ

Sets the coordinate system in which the input light vector is represented. INQ

Sets the maximum radius of the circle of confusion (blurring circle), among the input images. If this control type is set incorrectly, the EDoF image might not be completely in focus, even if it should be possible given the input images. INQ

Sets the computation mode of the extended depth of field operation. INQ

Sets the maximum distance between a point of an object that is in focus in one image, and the same point in an image in which the object is out of focus, in pixels. If this control type is set incorrectly, the EDoF image might not be completely in focus, even if it should be possible given the input images. INQ

Sets the maximum difference between the intensity values for an object in an image. This value is used when performing the intensity component of an M_ADAPTIVE regularization. This determines whether neighboring pixels are considered part of the same object when using M_ADAPTIVE regularization mode. INQ

Sets which neighborhood pixels are given more weight when performing the smoothing component of the adaptive regularization. This determines how neighborhood pixels are weighted when using an M_ADAPTIVE regularization mode. INQ

Sets whether the confidence map is computed. INQ

Sets the number of images for a portion of the image to go from out of focus to in focus, to out of focus again. A larger number of images indicates a more precise operation, and a longer processing time. INQ

Sets whether the intensity map is computed. INQ

Sets the mode of regularization. The mode establishes how to adjust the coherency of neighboring pixels in the index map. INQ

Sets the neighborhood size when regularization is used. The neighborhood should be the size of the minimum texture pattern in an object in the image, but no larger than the smallest object dimension in the image. INQ

Sets the required coverage ratio for a successful merge of each source image into the intermediate, working HDR image. The specified value is the ratio between the number of selected pixels and the total number of usable pixels, from 0.0-1.0. The number of selected pixels is the calculated merge area where pixel values are non-saturated in the current source image and still being modified in the working HDR image; these areas are established with the limits set with M_FUSION_LOW_THRESHOLD and M_FUSION_HIGH_THRESHOLD. The total number of usable pixels equals the source image area (M_SIZE_X x M_SIZE_Y). The operation affects only those pixels that are within range.

The M_FUSION_COVERAGE ratio determines the number of pixels used to calculate the gain applied to the source image to successfully merge it with the intermediate, working HDR image. If the source image gives a calculated ratio that is below the specified ratio, the addition of this image to the final HDR image fails. INQ

Sets the threshold to filter out the saturated pixels (that is, the near maximum values) of the current source image. Specify the threshold as a percentage of the current working range of pixel values, which widens with each source image that is merged into the intermediate, working HDR image. This threshold is also used to establish which pixels are still being modified in the intermediate, working HDR image.

Note that, as the operation proceeds, the last images processed are those taken using the shortest exposures. These are the images with more detail evident in brighter areas, in which fewer saturated (overexposed) pixels fall above the high threshold for exclusion. The final HDR image can include pixels with a maximum intensity value. INQ

Sets the threshold to filter out the underexposed pixels (that is, the near 0 values) of the current source image. Specify the threshold as a percentage of the current working range of pixel values, which widens with each source image that is merged into the intermediate, working HDR image. This threshold is also used to establish which pixels are still being modified in the intermediate, working HDR image.

The first source image becomes the working HDR image; no thresholds are applied to this first image. Subsequent source images are evaluated using the limits set with M_FUSION_LOW_THRESHOLD and M_FUSION_HIGH_THRESHOLD.

Also note that the first images to which the operation applies are those taken with the longest exposures, where dark area details are visible, and bright area details are missing due to overexposure. For these images, the operation keeps non-saturated pixels in the darker areas. As the operation continues with subsequent images taken with shorter exposures, more darker pixels will fall below the low threshold and be excluded from the final HDR image. INQ

Sets the criteria by which source image pixels are selected for contribution to the HDR image calculation. Saturated and underexposed pixels are excluded, and the remaining pixels are then used to calculate the gain to apply to the source image to successfully merge it with the intermediate, working HDR image. INQ

Sets the tone mapping coefficient when calculating the tone-mapped HDR image.

The specified M_TONE_MAPPING_COEFFICIENT affects the pixel intensity distribution during the tone mapping between the HDR image and the end image. A higher value (closer to 1.0) gives a broader intensity range to bright areas, improving bright area detail and lowering the overall brightness of the final image. Conversely, a lower value (closer to 0.0), gives a broader intensity range to dark areas, improving dark area detail and increasing the overall brightness of the final image. INQ

Sets the tone mapping high threshold to use when calculating the tone-mapped HDR image. Specify the threshold as a percentage of the source image's pixel intensity levels. This removes unnecessary pixel intensity levels at the saturated end, and allows more intensity distribution elsewhere in the image.

For example, if you set the tone mapping high threshold to 90%, pixels in the raw HDR image with intensities in the brightest 10% are excluded. INQ

Sets the tone mapping low threshold to use when calculating the tone-mapped HDR image. Specify the threshold as a percentage of the source image's pixel intensity levels. This removes unnecessary pixel intensity levels at the near-zero end, and allows more intensity distribution elsewhere in the image.

For example, if you set the tone mapping low threshold to 10%, pixels in the raw HDR image with intensities in the darkest 10% are excluded. INQ

Sets the tone mapping mode to use when calculating the tone-mapped HDR image. Tone mapping distributes pixel intensity values within the specified range. You can also specify to disable tone mapping (M_DISABLE), in which case the raw HDR image is drawn into the destination buffer.

Note that, when writing results to a result buffer (using MregCalculate()), the raw HDR image is always available to draw (using MregDraw() with M_DRAW_HDR_FULL_IMAGE), whether or not tone mapping was applied. Use MregDraw() with M_DRAW_HDR_IMAGE to draw the tone-mapped HDR image.

When enabled, the tone mapping result is written to the result buffer or the image buffer passed to MregCalculate() or MregDraw(). INQ

Sets the timeout value for MregCalculate().