MbufCopyCond

See also

User Guide:

Fast Fourier Transform Managing data buffers Using child buffers, ROIs, or a copy to manipulate specific data areas Working with 3D

Reference:

MbufInquire MbufSetRegion

Availability

Available in MIL-Lite

Available in MIL

Available on Windows

Available on Linux

Available on Non-Matrox computer

Available on Matrox 4Sight-X

Available on Matrox 4Sight GP/GPm

Available on Matrox Supersight

Function map

Examples

exampleinterface.cpp
mechanicalpartscan.cpp
morphology.cpp
simple3dbinpicking.cpp
stereocalibration.cpp

Function Map

- SrcBufId

- DestBufId

- CondBufId

- Condition

Table:

For specifying the condition for which the buffer is tested

- CondValue

Table:	For specifying a color value
Table:	For specifying a grayscale value to be used with all bands

Compilation information

Synopsis

Copy conditionally the source buffer to the destination buffer.

Syntax

void MbufCopyCond(

MIL_ID SrcBufId,	//in
MIL_ID DestBufId,	//in
MIL_ID CondBufId,	//in
MIL_INT64 Condition,	//in
MIL_DOUBLE CondValue	//in

)

Description

This function copies the source buffer data to the destination buffer, modifying only those entries of the destination buffer which have a corresponding entries in the condition buffer that satisfies the specified condition. Other entries are unchanged. If the source and destination buffers are of different data types, MIL converts the data automatically.

If the source buffer depth is greater than that of the destination, the most-significant bits are truncated when the data is copied to the destination. If the destination depth is greater than that of the source, the source data is zero or sign-extended (depending on the type of the source) when copied to the destination. For example, the data is zero-extended when copying an 8-bit unsigned buffer to a 16-bit unsigned buffer.

Note that if a 1-band condition buffer is used with a 3-band destination buffer, the one band of the condition buffer will be used for each destination band.

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 if there is complementary information.

Parameters

This function is not supported on the selected boards.

Parameters

SrcBufId

Specifies the identifier of the source data buffer.

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.

DestBufId

Specifies the identifier of the destination data buffer.

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.

CondBufId

Specifies the identifier of the condition buffer.

Condition

Specifies the condition for which the condition buffer is tested. This parameter can be set to one of the following:

For specifying the condition for which the buffer is tested
Value	Description
M_DEFAULT	Modify destination buffer entries corresponding to condition buffer entries that are non-zero.
M_EQUAL	Modify destination buffer entries corresponding to condition buffer entries that are equal to CondValue.
M_NOT_EQUAL	Modify destination buffer entries corresponding to condition buffer entries that are not equal to CondValue.

CondValue

Specifies the color value for the specified condition. Even though this value is of type MIL_DOUBLE, it is treated as if it had the same type and depth as the condition buffer. If the Condition parameter is set to M_DEFAULT, CondValue is ignored.

For a 3-band condition buffer, this parameter can be set to one of the following color values:

For specifying a color value
Value	Description
M_RGB888( MIL_INT Red, MIL_INT Green, MIL_INT Blue )	Specifies an RGB value when the source buffer, destination buffer, and condition buffer are 8-bit, and the condition buffer is a 3-band buffer. This allows you to compare each band of the condition buffer against a different value. (summarize) Specifies an RGB value when the source buffer, destination buffer, and condition buffer are 8-bit, and the condition buffer is a 3-band buffer. (more details...)
		Parameters
		Red Specifies the red component, as a value between 0 and 255.
		Green Specifies the green component, as a value between 0 and 255.
		Blue Specifies the blue component, as a value between 0 and 255.
M_COLOR_BLACK	Specifies the color black.
M_COLOR_BLUE	Specifies the color blue.
M_COLOR_BRIGHT_GRAY	Specifies the color bright gray.
M_COLOR_CYAN	Specifies the color cyan.
M_COLOR_DARK_BLUE	Specifies the color dark blue.
M_COLOR_DARK_CYAN	Specifies the color dark cyan.
M_COLOR_DARK_GREEN	Specifies the color dark green.
M_COLOR_DARK_MAGENTA	Specifies the color dark magenta.
M_COLOR_DARK_RED	Specifies the color dark red.
M_COLOR_DARK_YELLOW	Specifies the color dark yellow.
M_COLOR_GRAY	Specifies the color gray.
M_COLOR_GREEN	Specifies the color green.
M_COLOR_LIGHT_BLUE	Specifies the color light blue.
M_COLOR_LIGHT_GRAY	Specifies the color light gray.
M_COLOR_LIGHT_GREEN	Specifies the color light green.
M_COLOR_LIGHT_WHITE	Specifies the color light white.
M_COLOR_MAGENTA	Specifies the color magenta.
M_COLOR_RED	Specifies the color red.
M_COLOR_WHITE	Specifies the color white.
M_COLOR_YELLOW	Specifies the color yellow.

For a 1-band or 3-band condition buffer, you can set this parameter to the following grayscale value:

For specifying a grayscale value to be used with all bands
Value	Description
Value	Specifies a entries value. If the condition buffer is binary, this value must be set to 0 or 1. If the condition buffer is 3-band, this value will be used for each band individually. (summarize) Specifies a entries value. (more details...)

Compilation information

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