MimHistogramEqualizeAdaptive

See also

User Guide:

Adjusting the intensity distribution

Reference:

MbufAlloc1d MbufAllocColor MbufInquire MbufSetRegion MimAlloc MimControl MimHistogramEqualize MimInquire

Availability

Not available in MIL-Lite

Available in MIL

Available on Windows

Available on Linux

Not supported on:

Not supported on Matrox Indio (Update 53 or Update 68) (w)

Not supported on Matrox Concord PoE with ToE (Update 82) (z)

Fully supported on:

Fully supported on Host system (a)

Fully supported on Matrox GigE Vision driver (MIL 10, Update 25, Update 54, or Update 85)* (c)

Fully supported on Matrox Morphis (g)

Fully supported on Matrox Morphis QxT (h)

Fully supported on Matrox Orion HD (i)

Fully supported on Matrox Radient eCL (j)

Fully supported on Matrox Radient eV-CXP (MIL 10 or Update 29)* (k)

Fully supported on Matrox Solios eA/XA (l)

Fully supported on Matrox Solios ecl/xcl/ev-cl (m)

Fully supported on Matrox USB3 Vision driver (Update 19) (o)

Fully supported on Matrox RadientPro-CL (Update 7) (p)

Fully supported on Matrox Radient eV-CL (Update 27 or 74) (r)

Fully supported on Matrox Iris GTR (Update 28 or Update 68) (t)

Fully supported on Matrox Clarity UHD (Update 36 or 76) (u)

Fully supported on Matrox GenTL driver (Update 34) (v)

Fully supported on Matrox Rapixo CXP (Update 75 or Update 84) (y)

Fully supported on Matrox Rapixo CL Pro (Update 96) (aa)

* Refer to the MIL system-specific information
in the MIL Reference for the minimum update required.

For any information regarding a MIL system added during a MIL Update, see the MIL system’s release note

Available on Non-Matrox computer

Available on Matrox 4Sight-X

Available on Matrox 4Sight GP/GPm

Available on Matrox Supersight

Function map

Examples

flatfieldcorrection.cpp
histogramequalizeadaptive.cpp
tirestringread.cpp

Function Map

- AdaptiveEqualizeContextImId

- SrcImageBufId

- DstImageBufId

- ControlFlag

Compilation information

Synopsis

Perform an adaptive histogram equalization on an image.

Syntax

void MimHistogramEqualizeAdaptive(

MIL_ID AdaptiveEqualizeContextImId,	//in
MIL_ID SrcImageBufId,	//in
MIL_ID DstImageBufId,	//in
MIL_INT64 ControlFlag	//in

)

Description

This function enhances the contrast of the specified source image by applying a Contrast Limited Adaptive Histogram Equalization (CLAHE). The resulting image is placed in the destination image buffer.

This function first partitions the specified source image into a set of rectangular sections of equal size, referred to as tiles, and calculates histograms for each one. The histograms are then used to transform the image and produce an enhanced (equalized) version of it. By default, MimHistogramEqualizeAdaptive() uses 8 tiles along the image's X- and Y-direction. To modify the number of tiles, call MimControl() with M_NUMBER_OF_TILES_X and M_NUMBER_OF_TILES_Y. Though MimHistogramEqualizeAdaptive() can take longer to execute than a conventional histogram equalization (MimHistogramEqualize()), it can help minimize the over-amplification of noise and the potential for saturation, particularly in images with inconsistent lighting where some sections are significantly brighter than others.

By default, the maximum percentage of pixels that can be represented by a histogram bin is limited to 1% of all the pixels in its respective tile. Exceeding values are distributed evenly among that histogram's other bins. To modify this behavior, use the M_CLIP_LIMIT control.

You can also modify the number of histogram bins for each tile, as well as the equalization operation performed, using the M_HIST_SIZE and M_OPERATION controls. By default, MimHistogramEqualizeAdaptive() determines the number of histogram bins automatically according to the specified source image and performs a uniform-type of equalization.

You can limit this function's results to a region of an image buffer using a region of interest (ROI) set using MbufSetRegion(). The ROI must be defined in raster format (M_RASTER or M_VECTOR_AND_RASTER). An error is generated if the ROI is only in vector format (M_VECTOR). If you specify multiple image buffers with an ROI, results are limited to the portion of the ROIs that intersect.

Note that this function reference has not been updated for a MIL system added during a MIL update. Refer to the MIL system's release note to see which MIL system’s documentation you should use in its place and any possible differences.

Parameters

This function is not supported on the selected boards.

This function reference has not been updated for the selected MIL system. To show the content of this page, choose a second MIL system; refer to the MIL system's release note to see which MIL system’s documentation to choose and any possible differences.

Parameters

AdaptiveEqualizeContextImId

Specifies the identifier of the adaptive histogram equalization context. The context must have been allocated using MimAlloc() with M_HISTOGRAM_EQUALIZE_ADAPTIVE_CONTEXT.

SrcImageBufId

Specifies the identifier of the source image buffer. The buffer must be a 1-band, 8- or 16-bit image buffer allocated using MbufAlloc...() with M_IMAGE + M_PROC. The type of the source image buffer must be the same as the destination image buffer. To inquire this information, use MbufInquire() with M_TYPE.

DstImageBufId

Specifies the identifier of the destination image buffer. The buffer must be a 1-band, 8- or 16-bit image buffer allocated using MbufAlloc...() with M_IMAGE + M_PROC. The type of the destination image buffer must be the same as the source image buffer. To inquire this information, use MbufInquire() with M_TYPE.

If you specify an image buffer that has an ROI associated with it, the ROI must be in raster format; otherwise, you will get an error.

ControlFlag

Reserved for future expansion and must be set to M_DEFAULT.

Compilation information

Header	Include mil.h.
Library	Use mil.lib; milim.lib.
DLL	Requires mil.dll; milim.dll.