Filters
Filter values by
Measurement object type
  • Measurement context
  • Result buffer
  • General measurement marker
  • Stripe measurement marker
  • Point measurement marker
  • Edge measurement marker
  • Circle measurement marker
| Customize Help
| Save Settings

MmeasInquire



Function Map
Synopsis
Inquire about a measurement context, marker, or result buffer.
Syntax
MIL_INT MmeasInquire(
MIL_ID MeasId, //in
MIL_INT64 InquireType, //in
void *FirstUserVarPtr, //out
void *SecondUserVarPtr //out
)
Description

This function inquires information about an expected marker characteristic, context setting, or measurement result buffer setting. To specify a marker characteristic, use MmeasSetMarker(); to specify settings for a measurement context or measurement result buffer, use MmeasControl(). To retrieve the results of a measurement operation (MmeasFindMarker() or MmeasCalculate()), use MmeasGetResult() or MmeasGetResultSingle().

If the inquired setting is set to M_DEFAULT (for example, in MmeasControl()), MmeasInquire() will return M_DEFAULT. To inquire the actual default value, add M_DEFAULT to the InquireType parameter.

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
MeasId

Specifies the identifier of the marker, measurement context, or measurement result buffer about which to inquire information.

function map For specifying the measurement object identifier
Click to summarizeValue Description
Click to summarize M_DEFAULT

Specifies the default measurement context of the current MIL application.

Click to summarize Measurement context ID

Specifies a measurement context.

Click to summarize Measurement marker ID

Specifies a measurement marker.

Click to summarize Measurement result buffer ID

Specifies a measurement result buffer.

InquireType

Specifies the type of setting about which to inquire.

For certain inquire types, two values can be returned for a stripe marker (one for each of the edges). In these cases, the value for the first edge is returned to FirstUserVarPtr and that of the second edge to SecondUserVarPtr. For an edge or circle marker, all results are returned to FirstUserVarPtr. Inquire types which return a position always return the X-coordinate to FirstUserVarPtr and the Y-coordinate to SecondUserVarPtr.

See the Parameter associations section for possible values that can be specified.

FirstUserVarPtr
Accepts the address of one of the following (see the Parameter associations section for specifics on which is expected):
  • MIL_DOUBLE
  • MIL_ID
  • MIL_INT
  • MIL_INT32
  • MIL_INT64

Specifies the address in which to write the requested information. Since the MmeasInquire() function also returns the requested information, you can set this parameter to M_NULL.

See the Parameter associations section for possible values that can be returned.

SecondUserVarPtr
Accepts the address of one of the following (see the Parameter associations section for specifics on which is expected):
  • M_NULL
  • MIL_DOUBLE
  • MIL_ID
  • MIL_INT
  • MIL_INT32
  • MIL_INT64

Specifies the address in which to write the requested information. Since the MmeasInquire() function also returns the requested information, you can set this parameter to M_NULL. If only one value is to be returned, it will be returned to FirstUserVarPtr and SecondUserVarPtr should be set to M_NULL.

See the Parameter associations section for possible values that can be returned.

For point, edge, and stripe markers, and for measurement result buffers, the InquireType parameter can be set to one of the following:

function map For point, edge, stripe, and circle markers, and for a measurement result buffer
Click to summarize
InquireType
Description
FirstUserVarPtr
- Possible values returned
SecondUserVarPtr
- Possible values returned
Click to summarize M_RESULT_OUTPUT_UNITS +

Inquires whether results are returned in pixel or world units. SET SET

(summarize)
Click to summarize FirstUserVarPtr
Data type info: Data type: address of a MIL_DOUBLE MORE

Returns one of the following.

(summarize)
Click to summarize M_ACCORDING_TO_CALIBRATION

Specifies that results are returned in world units if the result was calculated on an image associated with a camera calibration context; otherwise, specifies that results are returned in pixel units.

Click to summarize M_PIXEL

Specifies that results are returned in pixel units, according to the pixel coordinate system.

Click to summarize M_WORLD

Specifies that results are returned in world units, according to the relative coordinate system. INFO

Click to summarize SecondUserVarPtr
Data type info: Data type: Set this parameter to M_NULL

For point, edge, stripe, and circle markers, the InquireType parameter can be set to one of the following:

function map For point, edge, stripe, and circle markers
Click to summarize
InquireType
Description
FirstUserVarPtr
- Possible values returned
SecondUserVarPtr
- Possible values returned
Click to summarize M_MARKER_REFERENCE +

Inquires the offset with which to establish the marker's reference position, relative to the marker's actual position. SET

(summarize)
Click to summarize FirstUserVarPtr
Data type info: Data type: address of a MIL_DOUBLE

Returns the X-offset value, in the units of the input coordinate system specified using M_MARKER_REFERENCE_INPUT_UNITS.

Click to summarize SecondUserVarPtr
Data type info: Data type: address of a MIL_DOUBLE

Returns the Y-offset value, in the units of the input coordinate system specified using M_MARKER_REFERENCE_INPUT_UNITS.

Click to summarize M_MARKER_REFERENCE_INPUT_UNITS +

Inquires the units with which to interpret the M_MARKER_REFERENCE inquire type. SET

(summarize)
Click to summarize FirstUserVarPtr
Data type info: Data type: address of a MIL_DOUBLE MORE

Returns one of the following.

(summarize)
Click to summarize M_PIXEL

Specifies to interpret the value in pixel units, according to the pixel coordinate system.

Click to summarize M_WORLD

Specifies to interpret the value in world units, according to the relative coordinate system. INFO

Click to summarize SecondUserVarPtr
Data type info: Data type: address of a MIL_DOUBLE
Click to summarize M_MARKER_TYPE +

Inquires the type of marker. SET

(summarize)
Click to summarize FirstUserVarPtr
Data type info: Data type: address of a MIL_DOUBLE MORE

Returns one of the following.

(summarize)
Click to summarize M_CIRCLE

Specifies a circle marker buffer.

Click to summarize M_EDGE

Specifies an edge marker buffer.

Click to summarize M_POINT

Specifies a point marker buffer.

Click to summarize M_STRIPE

Specifies a stripe marker buffer.

Click to summarize SecondUserVarPtr
Data type info: Data type: address of a MIL_DOUBLE

For point, edge, and stripe markers, the InquireType parameter can be set to one of the following:

function map For point, edge, and stripe markers
Click to summarize
InquireType
Description
FirstUserVarPtr
- Possible values returned
SecondUserVarPtr
- Possible values returned
Click to summarize M_NUMBER +

Inquires the number of edges or stripes to locate, or point markers defined. SET

(summarize)
Click to summarize FirstUserVarPtr
Data type info: Data type: address of a MIL_DOUBLE MORE

Returns one of the following.

(summarize)
Click to summarize M_ALL

Specifies that the search should locate all edges or stripes in the box search region. INFO

Click to summarize Value

Specifies the number of edges or stripes to locate, or point markers to define.

Click to summarize SecondUserVarPtr
Data type info: Data type: Set this parameter to M_NULL

For edge, stripe, and circle markers, the InquireType parameter can be set to one of the following:

function map For edge, stripe, and circle markers
Click to summarize
InquireType
Description
FirstUserVarPtr
- Possible values returned
SecondUserVarPtr
- Possible values returned
Click to summarize M_EDGEVALUE_MIN +

Inquires the minimum edgevalue required for it to be considered an occurrence of the marker. SET

(summarize)
Click to summarize FirstUserVarPtr
Data type info: Data type: address of a MIL_DOUBLE

Returns the following.

(summarize)
Click to summarize 0.0 <= Value <= 100.0

Specifies the minimum edgevalue. INFO

Click to summarize SecondUserVarPtr
Data type info: Data type: address of a MIL_DOUBLE
Click to summarize M_EDGEVALUE_VAR_MIN +

Inquires the minimum prominence required for an edge peak, for it to be considered an occurrence of the marker. SET

(summarize)
Click to summarize FirstUserVarPtr
Data type info: Data type: address of a MIL_DOUBLE

Returns the following.

(summarize)
Click to summarize 0.0 <= Value <= 100.0

Specifies the minimum prominence. INFO

Click to summarize SecondUserVarPtr
Data type info: Data type: address of a MIL_DOUBLE
Click to summarize M_FILTER_SMOOTHNESS +

Inquires the degree of smoothness (strength of denoising) applied to the internal projection buffer of the search region during the edge extraction. SET

(summarize)
Click to summarize FirstUserVarPtr
Data type info: Data type: address of a MIL_DOUBLE

Returns the following.

(summarize)
Click to summarize 0.0 <= Value <= 100.0

Specifies the smoothness value. INFO

Click to summarize SecondUserVarPtr
Data type info: Data type: address of a MIL_DOUBLE
Click to summarize M_FILTER_TYPE +

Inquires the type of the first derivative filter with which to perform the edge extraction. SET

(summarize)
Click to summarize FirstUserVarPtr
Data type info: Data type: address of a MIL_DOUBLE MORE

Returns one of the following.

(summarize)
Click to summarize M_EULER

Specifies an Euler FIR filter. INFO

Click to summarize M_PREWITT

Specifies a Prewitt FIR filter. INFO

Click to summarize M_SHEN

Specifies a Shen-Castan Infinite Support Exponential filter. INFO

Click to summarize SecondUserVarPtr
Data type info: Data type: address of a MIL_DOUBLE
Click to summarize M_MAX_ASSOCIATION_DISTANCE +

Inquires the maximum distance between an edge (either straight or circular) and its associated subedges. SET

(summarize)
Click to summarize FirstUserVarPtr
Data type info: Data type: address of a MIL_DOUBLE

Returns the distance, in the units of the input coordinate system specified using M_MAX_ASSOCIATION_DISTANCE_INPUT_UNITS.

Click to summarize SecondUserVarPtr
Data type info: Data type: address of a MIL_DOUBLE
Click to summarize M_MAX_ASSOCIATION_DISTANCE_INPUT_UNITS +

Inquires the units with which to interpret the M_MAX_ASSOCIATION_DISTANCE inquire type. SET

(summarize)
Click to summarize FirstUserVarPtr
Data type info: Data type: address of a MIL_DOUBLE MORE

Returns one of the following.

(summarize)
Click to summarize M_PIXEL

Specifies to interpret the value in pixel units, according to the pixel coordinate system.

Click to summarize M_WORLD

Specifies to interpret the value in world units, according to the relative coordinate system. INFO

Click to summarize SecondUserVarPtr
Data type info: Data type: address of a MIL_DOUBLE
Click to summarize M_POLARITY +

Inquires the polarity of the marker. SET

(summarize)
Click to summarize FirstUserVarPtr
Data type info: Data type: address of a MIL_DOUBLE MORE

Returns the polarity of the edge. For stripe markers, this is the polarity of the first edge.

(summarize)
Click to summarize M_NEGATIVE

Specifies that the polarity of the edge is negative (falling edge). INFO

Click to summarize M_POSITIVE

Specifies that the polarity of the edge is positive (rising edge). INFO

Click to summarize SecondUserVarPtr
Data type info: Data type: address of a MIL_DOUBLE MORE

Returns the polarity of the second edge of a stripe marker. For edge and circle markers, set this parameter to M_NULL.

(summarize)
Click to summarize M_ANY

Specifies that the polarity is not considered.

Click to summarize M_NEGATIVE

Specifies that the polarity of the second edge is negative (falling edge).

Click to summarize M_OPPOSITE

Specifies that the polarity of the second edge of a stripe marker is the opposite of that of the first edge.

Click to summarize M_POSITIVE

Specifies that the polarity of the second edge is positive (rising edge).

Click to summarize M_SAME

Specifies that the polarity of the second edge of a stripe marker is the same as that of the first edge.

Click to summarize M_SEARCH_REGION_ANGLE_INTERPOLATION_MODE +

Inquires the type of interpolation to use. SET

(summarize)
Click to summarize FirstUserVarPtr
Data type info: Data type: address of a MIL_DOUBLE MORE

Returns one of the following.

(summarize)
Click to summarize M_BICUBIC

Specifies bicubic interpolation. INFO

Click to summarize M_BILINEAR

Specifies bilinear interpolation. INFO

Click to summarize M_NEAREST_NEIGHBOR

Specifies nearest neighbor interpolation. INFO

Click to summarize SecondUserVarPtr
Data type info: Data type: address of a MIL_DOUBLE
Click to summarize M_SEARCH_REGION_CLIPPING +

Inquires whether MIL can automatically clip the search region (box or ring) when it falls outside the image. SET

(summarize)
Click to summarize FirstUserVarPtr
Data type info: Data type: address of a MIL_DOUBLE MORE

Returns one of the following.

(summarize)
Click to summarize M_DISABLE

Specifies that the search region cannot be automatically clipped. INFO

Click to summarize M_MAXIMIZE_AREA

Specifies that, if the search region falls outside the image, MIL can automatically clip the region according to the best valid area in which to search, and the marker can still be found. INFO

Click to summarize SecondUserVarPtr
Data type info: Data type: address of a MIL_DOUBLE
Click to summarize M_SEARCH_REGION_CLIPPING_MIN_AREA +

Inquires the minimum area requirement for the clipped region (area that MIL searches for a marker) that can be internally created when using M_SEARCH_REGION_CLIPPING with M_MAXIMIZE_AREA. SET

(summarize)
Click to summarize FirstUserVarPtr
Data type info: Data type: address of a MIL_DOUBLE

Returns the following.

(summarize)
Click to summarize Value >= 0.0

Specifies the minimum area required for the clipped region, in pixels.

Click to summarize SecondUserVarPtr
Data type info: Data type: address of a MIL_DOUBLE
Click to summarize M_SEARCH_REGION_CLIPPING_MIN_HEIGHT +

Inquires the minimum height requirement for the clipped region (area that MIL searches for a marker) that can be internally created when using M_SEARCH_REGION_CLIPPING with M_MAXIMIZE_AREA. SET

(summarize)
Click to summarize FirstUserVarPtr
Data type info: Data type: address of a MIL_DOUBLE

Returns the following.

(summarize)
Click to summarize Value >= 0.0

Specifies the minimum height required for the clipped region, in pixels.

Click to summarize SecondUserVarPtr
Data type info: Data type: address of a MIL_DOUBLE
Click to summarize M_SEARCH_REGION_CLIPPING_MIN_WIDTH +

Inquires the minimum width requirement for the clipped region (area that MIL searches for a marker) that can be internally created when using M_SEARCH_REGION_CLIPPING with M_MAXIMIZE_AREA. SET

(summarize)
Click to summarize FirstUserVarPtr
Data type info: Data type: address of a MIL_DOUBLE

Returns the following.

(summarize)
Click to summarize Value >= 0.0

Specifies the minimum width required for the clipped region, in pixels.

Click to summarize SecondUserVarPtr
Data type info: Data type: address of a MIL_DOUBLE
Click to summarize M_SEARCH_REGION_CLIPPING_PRESERVE_CENTER +

Inquires the center requirement for the clipped region (area that MIL searches for a marker) that can be internally created when using M_SEARCH_REGION_CLIPPING with M_MAXIMIZE_AREA. SET

(summarize)
Click to summarize FirstUserVarPtr
Data type info: Data type: address of a MIL_DOUBLE MORE

Returns one of the following.

(summarize)
Click to summarize M_ALONG_HEIGHT

Specifies that the center, along the height of the defined search region, must be preserved in the clipped region. INFO

Click to summarize M_ALONG_WIDTH

Specifies that the center, along the width of the defined search region, must be preserved in the clipped region. INFO

Click to summarize M_AUTO

Specifies that MIL will determine how the center of the defined search region will be preserved in the clipped region. INFO

Click to summarize M_NONE

Specifies that the clipped region need not preserve the center of the defined search region. INFO

Click to summarize SecondUserVarPtr
Data type info: Data type: address of a MIL_DOUBLE
Click to summarize M_SEARCH_REGION_INPUT_UNITS +
Click to summarize FirstUserVarPtr
Data type info: Data type: address of a MIL_DOUBLE MORE

Returns one of the following.

(summarize)
Click to summarize M_PIXEL

Specifies to interpret the values in pixel units, according to the pixel coordinate system.

Click to summarize M_WORLD

Specifies to interpret the values in world units, according to the relative coordinate system. INFO

Click to summarize SecondUserVarPtr
Data type info: Data type: address of a MIL_DOUBLE
Click to summarize M_SUB_REGIONS_NUMBER +

Inquires the number of sections (subregions) in which to divide the search region. SET

(summarize)
Click to summarize FirstUserVarPtr
Data type info: Data type: address of a MIL_DOUBLE MORE

Returns one of the following.

(summarize)
Click to summarize 1 <= Value < 8

Specifies a number of sections (subregions) that can only be used for edge and stripe markers.

Click to summarize Value >= 8

Specifies a number of sections (subregions) that can be used for edge, stripe, and circle markers.

Click to summarize SecondUserVarPtr
Data type info: Data type: address of a MIL_DOUBLE
Click to summarize M_SUBPIXEL_MODE +

Inquires how MIL calculates subpixel positions. SET

(summarize)
Click to summarize FirstUserVarPtr
Data type info: Data type: address of a MIL_DOUBLE MORE

Returns one of the following.

(summarize)
Click to summarize M_GLOBAL

Specifies that MIL calculates subpixel positions based on the entire region within which the edge is found. INFO

Click to summarize M_LOCAL

Specifies that MIL calculates subpixel positions based on the immediate neighborhood within which the edge's maximum edgevalue is found. INFO

Click to summarize SecondUserVarPtr
Data type info: Data type: address of a MIL_DOUBLE

For edge and stripe markers, the InquireType parameter can be set to one of the following:

function map For edge and stripe markers
Click to summarize
InquireType
Description
FirstUserVarPtr
- Possible values returned
SecondUserVarPtr
- Possible values returned
Click to summarize M_BOX_ANGLE +

Inquires the angle of the box search region.

An angle interpreted according to the pixel coordinate system is always measured counter-clockwise. For information on the angle's direction of rotation when interpreting the angle with respect to the relative coordinate system, see the Angle convention in MIL subsection of the Working with real-world units section of Chapter 26: Calibrating your camera setup. SET

(summarize)
Click to summarize FirstUserVarPtr
Data type info: Data type: address of a MIL_DOUBLE

Returns one of the following.

(summarize)
Click to summarize M_ANY

Specifies that the content of the box search region is analyzed to automatically determine the angle of the marker.

Click to summarize 0 <= Value <= 360

Specifies the angle of the box search region, in degrees, in the units of the input coordinate system specified using M_SEARCH_REGION_INPUT_UNITS. INFO

Click to summarize SecondUserVarPtr
Data type info: Data type: address of a MIL_DOUBLE
Click to summarize M_BOX_ANGLE_ACCURACY +

Inquires the accuracy of the angular search. SET

(summarize)
Click to summarize FirstUserVarPtr
Data type info: Data type: address of a MIL_DOUBLE

Returns one of the following.

(summarize)
Click to summarize M_DISABLE

Specifies the angle of accuracy to be equal to the angle of tolerance.

Click to summarize 0.1 <= Value <= 180.0

Specifies the accuracy of the angular search, in degrees, in the units of the input coordinate system specified using M_SEARCH_REGION_INPUT_UNITS.

Click to summarize SecondUserVarPtr
Data type info: Data type: address of a MIL_DOUBLE
Click to summarize M_BOX_ANGLE_DELTA_NEG +

Inquires the negative range of angles within which to search for the marker. SET

(summarize)
Click to summarize FirstUserVarPtr
Data type info: Data type: address of a MIL_DOUBLE

Returns one of the following.

(summarize)
Click to summarize M_DEFAULT

Specifies the default negative range of angles, in degrees. INFO

Click to summarize 0.1 <= Value <= 360.0

Specifies the negative range of angles, in degrees, in the units of the input coordinate system specified using M_SEARCH_REGION_INPUT_UNITS.

Click to summarize SecondUserVarPtr
Data type info: Data type: address of a MIL_DOUBLE
Click to summarize M_BOX_ANGLE_DELTA_POS +

Inquires the positive range of angles within which to search for the marker. SET

(summarize)
Click to summarize FirstUserVarPtr
Data type info: Data type: address of a MIL_DOUBLE

Returns one of the following.

(summarize)
Click to summarize M_DEFAULT

Specifies the default positive range of angles, in degrees. INFO

Click to summarize 0.1 <= Value <= 360.0

Specifies the positive range of angles, in degrees, in the units of the input coordinate system specified using M_SEARCH_REGION_INPUT_UNITS.

Click to summarize SecondUserVarPtr
Data type info: Data type: address of a MIL_DOUBLE
Click to summarize M_BOX_ANGLE_MODE +

Inquires whether a angular search is enabled. SET

(summarize)
Click to summarize FirstUserVarPtr
Data type info: Data type: address of a MIL_DOUBLE MORE

Returns one of the following.

(summarize)
Click to summarize M_DISABLE

Specifies that the search should only be performed at the angle specified by M_BOX_ANGLE.

Click to summarize M_ENABLE

Specifies that multiple-angle search is enabled.

Click to summarize SecondUserVarPtr
Data type info: Data type: address of a MIL_DOUBLE
Click to summarize M_BOX_ANGLE_REFERENCE +

Inquires the center of rotation used when performing a search at an angle. SET

(summarize)
Click to summarize FirstUserVarPtr
Data type info: Data type: address of a MIL_DOUBLE MORE

Returns one of the following.

(summarize)
Click to summarize M_BOX_CENTER

Specifies the center of the box search region as the center of rotation. INFO

Click to summarize M_BOX_ORIGIN

Specifies the top-left corner of the box search region as the center of rotation. INFO

Click to summarize SecondUserVarPtr
Data type info: Data type: address of a MIL_DOUBLE
Click to summarize M_BOX_ANGLE_TOLERANCE +

Inquires the rotation tolerance of the marker. This is the full range of degrees within which a marker can be rotated from a box search region that is at a specific angle and still be found. This determines the step angle used for an angular search. SET

(summarize)
Click to summarize FirstUserVarPtr
Data type info: Data type: address of a MIL_DOUBLE

Returns the following.

(summarize)
Click to summarize 0.1 <= Value <= 360.0

Specifies the rotation tolerance, in degrees, in the units of the input coordinate system specified using M_SEARCH_REGION_INPUT_UNITS.

Click to summarize SecondUserVarPtr
Data type info: Data type: address of a MIL_DOUBLE
Click to summarize M_BOX_CENTER +

Inquires the coordinates of the center of the box search region. SET

(summarize)
Click to summarize FirstUserVarPtr
Data type info: Data type: address of a MIL_DOUBLE

Returns the X-coordinate of the center of the box search region.

(summarize)
Click to summarize M_DEFAULT

Specifies the default X-coordinate of the center of the box search region. INFO

Click to summarize Value

Specifies the X-coordinate of the center of the box search region, in the units of the input coordinate system specified using M_SEARCH_REGION_INPUT_UNITS.

Click to summarize SecondUserVarPtr
Data type info: Data type: address of a MIL_DOUBLE

Returns the Y-coordinate of the center of the box search region.

(summarize)
Click to summarize M_DEFAULT

Specifies the default Y-coordinate of the center of the box search region. INFO

Click to summarize Value

Specifies the Y-coordinate of the center of the box search region, in the units of the input coordinate system specified using M_SEARCH_REGION_INPUT_UNITS.

Click to summarize M_BOX_ORIGIN +

Inquires the coordinates of the origin of the box search region. SET

(summarize)
Click to summarize FirstUserVarPtr
Data type info: Data type: address of a MIL_DOUBLE

Returns the X-coordinate of the origin of the box search region.

Click to summarize SecondUserVarPtr
Data type info: Data type: address of a MIL_DOUBLE

Returns the Y-coordinate of the origin of the box search region.

Click to summarize M_BOX_SIZE +

Inquires the width and height of the box search region. SET

(summarize)
Click to summarize FirstUserVarPtr
Data type info: Data type: address of a MIL_DOUBLE

Returns the width of the box search region within the target image.

(summarize)
Click to summarize M_DEFAULT

Specifies the width of the entire target image. INFO

Click to summarize Value

Specifies the width of the box search region within the target image, in the units of the input coordinate system specified using M_SEARCH_REGION_INPUT_UNITS. INFO

Click to summarize SecondUserVarPtr
Data type info: Data type: address of a MIL_DOUBLE

Returns the height of the box search region within the target image.

(summarize)
Click to summarize M_DEFAULT

Specifies the height of the entire target image. INFO

Click to summarize Value

Specifies the height of the box search region within the target image, in the units of the input coordinate system specified using M_SEARCH_REGION_INPUT_UNITS. INFO

Click to summarize M_DRAW_PROFILE_SCALE_OFFSET +

Inquires the scale and offset used with M_DRAW_..._PROFILE. SET

(summarize)
Click to summarize FirstUserVarPtr
Data type info: Data type: address of a MIL_DOUBLE

Returns one of the following.

(summarize)
Click to summarize M_AUTO_SCALE_PROFILE

Specifies to automatically compute the greatest scale factor that will fit the entire drawing within the destination buffer (or within the area that corresponds to the search region, if M_DRAW_IN_BOX is combined when drawing) after the offset has been applied.

Click to summarize Value > 0.0

Specifies the scale multiplier.

Click to summarize SecondUserVarPtr
Data type info: Data type: address of a MIL_DOUBLE

Returns one of the following.

(summarize)
Click to summarize M_AUTO_OFFSET_PROFILE

Specifies to automatically compute the offset such that the maximum and minimum of the drawing are touching the ends of the destination buffer (or the area that corresponds to the search region, if M_DRAW_IN_BOX is combined when drawing). INFO

Click to summarize Value

Specifies the offset from the middle of the height of the destination buffer or the area corresponding to the search region. INFO

Click to summarize M_NUMBER_MIN +

Inquires the minimum number of edges or stripes to locate. SET

(summarize)
Click to summarize FirstUserVarPtr
Data type info: Data type: address of a MIL_DOUBLE MORE

Returns one of the following.

(summarize)
Click to summarize M_DEFAULT

Specifies the default value. INFO

Click to summarize Value

Specifies the minimum number of edges or stripes to locate.

Click to summarize SecondUserVarPtr
Data type info: Data type: address of a MIL_DOUBLE
Click to summarize M_ORIENTATION +

Inquires the orientation of the marker. SET

(summarize)
Click to summarize FirstUserVarPtr
Data type info: Data type: address of a MIL_DOUBLE MORE

Returns one of the following.

(summarize)
Click to summarize M_ANY

Specifies that the orientation of the marker is unknown; both horizontal and vertical orientations are searched.

Click to summarize M_HORIZONTAL

Specifies that the marker has a horizontal orientation.

Click to summarize M_VERTICAL

Specifies that the marker has a vertical orientation.

Click to summarize SecondUserVarPtr
Data type info: Data type: address of a MIL_DOUBLE
Click to summarize M_SUB_REGIONS_OFFSET +

Inquires the offset of the subregions, from the center point of each of their sections. SET

(summarize)
Click to summarize FirstUserVarPtr
Data type info: Data type: address of a MIL_DOUBLE

Returns the following.

(summarize)
Click to summarize -100 <= Value <= 100

Specifies the offset of the subregions.

Click to summarize SecondUserVarPtr
Data type info: Data type: address of a MIL_DOUBLE
Click to summarize M_SUB_REGIONS_SIZE +

Inquires the size of the subregions, as a percentage of their section. SET

(summarize)
Click to summarize FirstUserVarPtr
Data type info: Data type: address of a MIL_DOUBLE

Returns the following.

(summarize)
Click to summarize 0 <= Value <= 100

Specifies the size of the subregions, as a percentage. INFO

Click to summarize SecondUserVarPtr
Data type info: Data type: address of a MIL_DOUBLE

For point markers, the InquireType parameter can be set to one of the following:

function map For point markers
Click to summarize
InquireType
Description
FirstUserVarPtr
- Possible values returned
SecondUserVarPtr
- Possible values returned
Click to summarize M_MULTIPLE_POINT_ANGLE +

Inquires the angle of the theoretical line along which subsequent points are placed, for a multiple point marker.

An angle interpreted according to the pixel coordinate system is always measured counter-clockwise. For information on the angle's direction of rotation when interpreting the angle with respect to the relative coordinate system, see the Angle convention in MIL subsection of the Working with real-world units section of Chapter 26: Calibrating your camera setup. SET

(summarize)
Click to summarize FirstUserVarPtr
Data type info: Data type: address of a MIL_DOUBLE

Returns the following.

(summarize)
Click to summarize 0 <= Value <= 360

Specifies the angle for a multiple point marker, in degrees, in the units of the input coordinate system specified using M_POINT_INPUT_UNITS. INFO

Click to summarize SecondUserVarPtr
Data type info: Data type: address of a MIL_DOUBLE
Click to summarize M_POINT_INPUT_UNITS +

Inquires the units with which to interpret the M_POSITION, M_SPACING, and M_MULTIPLE_POINT_ANGLE inquire types. SET

(summarize)
Click to summarize FirstUserVarPtr
Data type info: Data type: address of a MIL_DOUBLE MORE

Returns one of the following.

(summarize)
Click to summarize M_PIXEL

Specifies to interpret the values in pixel units, according to the pixel coordinate system.

Click to summarize M_WORLD

Specifies to interpret the values in world units, according to the relative coordinate system. INFO

Click to summarize SecondUserVarPtr
Data type info: Data type: address of a MIL_DOUBLE
Click to summarize M_POSITION +

Inquires the coordinates of a point marker. SET

(summarize)
Click to summarize FirstUserVarPtr
Data type info: Data type: address of a MIL_DOUBLE

Returns the X-coordinate of the point marker.

(summarize)
Click to summarize M_ANY

Specifies that the position is invalid. INFO

Click to summarize Value

Specifies the X-coordinate of the point marker, in the units of the input coordinate system specified using M_POINT_INPUT_UNITS.

Click to summarize SecondUserVarPtr
Data type info: Data type: address of a MIL_DOUBLE

Returns the Y-coordinate of the point marker.

(summarize)
Click to summarize M_ANY

Specifies that the position is invalid. INFO

Click to summarize Value

Specifies the Y-coordinate of the point marker, in the units of the input coordinate system specified using M_POINT_INPUT_UNITS.

Click to summarize M_SPACING +

Inquires the spacing (distance) between consecutive points used as a multiple-occurrence marker. SET

(summarize)
Click to summarize FirstUserVarPtr
Data type info: Data type: address of a MIL_DOUBLE

Returns one of the following.

(summarize)
Click to summarize M_ANY

Specifies that the spacing between points has not been set. M_ANY is only valid if M_NUMBER is set to 1. Otherwise, M_ANY is an invalid value.

(summarize)
Click to summarize Value

Specifies the spacing, in the units of the input coordinate system specified using M_POINT_INPUT_UNITS.

Click to summarize SecondUserVarPtr
Data type info: Data type: address of a MIL_DOUBLE

For stripe markers, the InquireType parameter can be set to one of the following:

function map For stripe markers
Click to summarize
InquireType
Description
FirstUserVarPtr
- Possible values returned
SecondUserVarPtr
- Possible values returned
Click to summarize M_INCLUSION_POINT +

Inquires the position of the inclusion point. SET

(summarize)
Click to summarize FirstUserVarPtr
Data type info: Data type: address of a MIL_DOUBLE

Returns the inclusion point's X-coordinate.

(summarize)
Click to summarize M_ANY

Specifies no inclusion point. INFO

Click to summarize Value

Specifies the inclusion point's X-coordinate, in the units of the input coordinate system specified using M_INCLUSION_POINT_INPUT_UNITS.

Click to summarize SecondUserVarPtr
Data type info: Data type: address of a MIL_DOUBLE

Returns the inclusion point's Y-coordinate.

(summarize)
Click to summarize M_ANY

Specifies no inclusion point. INFO

Click to summarize Value

Specifies the inclusion point's Y-coordinate, in the units of the input coordinate system specified using M_INCLUSION_POINT_INPUT_UNITS.

Click to summarize M_INCLUSION_POINT_INPUT_UNITS +

Inquires the units with which to interpret the M_INCLUSION_POINT inquire type. SET

(summarize)
Click to summarize FirstUserVarPtr
Data type info: Data type: address of a MIL_DOUBLE MORE

Returns one of the following.

(summarize)
Click to summarize M_PIXEL

Specifies to interpret the value in pixel units, according to the pixel coordinate system.

Click to summarize M_WORLD

Specifies to interpret the value in world units, according to the relative coordinate system. INFO

Click to summarize SecondUserVarPtr
Data type info: Data type: address of a MIL_DOUBLE
Click to summarize M_INCLUSION_POINT_INSIDE_STRIPE +

Inquires whether the inclusion point must be inside the stripe. SET

(summarize)
Click to summarize FirstUserVarPtr
Data type info: Data type: address of a MIL_DOUBLE MORE

Returns one of the following.

(summarize)
Click to summarize M_ANY

Specifies that M_INCLUSION_POINT is ignored.

Click to summarize M_NO

Specifies that only stripes that have the inclusion point falling outside its two outer edges can be found.

Click to summarize M_YES

Specifies that only stripes that have the inclusion point falling between its two outer edges can be found.

Click to summarize SecondUserVarPtr
Data type info: Data type: address of a MIL_DOUBLE

For circle markers, the InquireType parameter can be set to one of the following:

function map For circle markers
Click to summarize
InquireType
Description
FirstUserVarPtr
- Possible values returned
SecondUserVarPtr
- Possible values returned
Click to summarize M_CIRCLE_ACCURACY +

Inquires the accuracy of the circle's fit operation. SET

(summarize)
Click to summarize FirstUserVarPtr
Data type info: Data type: address of a MIL_DOUBLE MORE

Returns one of the following.

(summarize)
Click to summarize M_HIGH

Specifies that the circle's fit operation will be performed with high accuracy. INFO

Click to summarize M_LOW

Specifies that the circle's fit operation will be performed with low accuracy. INFO

Click to summarize SecondUserVarPtr
Data type info: Data type: Set this parameter to M_NULL
Click to summarize M_CIRCLE_INSIDE_SEARCH_REGION +

Inquires whether the circle's fit operation can result in a circle that is outside the ring search region. SET

(summarize)
Click to summarize FirstUserVarPtr
Data type info: Data type: address of a MIL_DOUBLE MORE

Returns one of the following.

(summarize)
Click to summarize M_DISABLE

Specifies that the circle's fit operation can result in a circle that is outside the ring search region.

Click to summarize M_ENABLE

Specifies that the circle's fit operation cannot result in a circle that is outside the ring search region.

Click to summarize SecondUserVarPtr
Data type info: Data type: Set this parameter to M_NULL
Click to summarize M_RING_CENTER +

Inquires the coordinates of the center of the ring search region. SET

(summarize)
Click to summarize FirstUserVarPtr
Data type info: Data type: address of a MIL_DOUBLE

Returns the X-coordinate of the center of the ring search region.

(summarize)
Click to summarize M_DEFAULT

Specifies the default X-coordinate of the center of the ring search region. INFO

Click to summarize Value

Specifies the X-coordinate of the center of the ring search region, in the units of the input coordinate system specified using M_SEARCH_REGION_INPUT_UNITS.

Click to summarize SecondUserVarPtr
Data type info: Data type: address of a MIL_DOUBLE

Returns the Y-coordinate of the center of the ring search region.

(summarize)
Click to summarize M_DEFAULT

Specifies the default Y-coordinate of the center of the ring search region. INFO

Click to summarize Value

Specifies the Y-coordinate of the center of the ring search region, in the units of the input coordinate system specified using M_SEARCH_REGION_INPUT_UNITS.

Click to summarize M_RING_RADII +

Inquires the inner and outer radius of the circle marker's ring-shaped region. SET

(summarize)
Click to summarize FirstUserVarPtr
Data type info: Data type: address of a MIL_DOUBLE

Returns the inner radius.

(summarize)
Click to summarize M_DEFAULT

Specifies an inner radius of 0.0. INFO

Click to summarize Value >= 0

Specifies the inner radius, relative to the center of the ring search region, in the units specified using M_SEARCH_REGION_INPUT_UNITS.

Click to summarize SecondUserVarPtr
Data type info: Data type: address of a MIL_DOUBLE

Returns the outer radius.

(summarize)
Click to summarize M_DEFAULT

Specifies the default outer radius. INFO

Click to summarize Value > Inner radius

Specifies the outer radius, relative to the center of the ring search region, in the units specified using M_SEARCH_REGION_INPUT_UNITS.

Click to summarize M_SUB_REGIONS_CHORD_ANGLE +

Inquires the angle with which to set the ring search region's outer ring segment (chord).

An angle interpreted according to the pixel coordinate system is always measured counter-clockwise. For information on the angle's direction of rotation when interpreting the angle with respect to the relative coordinate system, see the Angle convention in MIL subsection of the Working with real-world units section of Chapter 26: Calibrating your camera setup. SET

(summarize)
Click to summarize FirstUserVarPtr
Data type info: Data type: address of a MIL_DOUBLE

Returns the following.

(summarize)
Click to summarize 0.0 < Value <= 45.0

Specifies the angle, in degrees, in the units of the input coordinate system specified using M_SEARCH_REGION_INPUT_UNITS. INFO

Click to summarize SecondUserVarPtr
Data type info: Data type: Set this parameter to M_NULL

When performing an inquiry on a measurement context buffer, InquireType can be set to one of the following values.

function map For a measurement context buffer
Click to summarize
InquireType
Description
FirstUserVarPtr
- Possible values returned
SecondUserVarPtr
- Possible values returned
Click to summarize M_PIXEL_ASPECT_RATIO +

Inquires the ratio of the width of the pixel to its height. SET

(summarize)
Click to summarize FirstUserVarPtr
Data type info: Data type: address of a MIL_DOUBLE

Returns the pixel width to pixel height ratio.

Click to summarize SecondUserVarPtr
Data type info: Data type: Set this parameter to M_NULL
Click to summarize M_PIXEL_ASPECT_RATIO_INPUT +

Inquires how the Measurement module interprets specified measurement characteristics relative to the pixel aspect ratio. SET

(summarize)
Click to summarize FirstUserVarPtr
Data type info: Data type: address of a MIL_DOUBLE MORE

Returns one of the following.

(summarize)
Click to summarize M_CORRECTED

Specifies to correct measurement inputs with the specified aspect ratio.

Click to summarize M_NORMAL

Specifies to not correct measurement inputs (ratio of 1.0).

Click to summarize SecondUserVarPtr
Data type info: Data type: Set this parameter to M_NULL
Click to summarize M_PIXEL_ASPECT_RATIO_OUTPUT +

Inquires how the Measurement module returns results relative to the pixel aspect ratio. SET

(summarize)
Click to summarize FirstUserVarPtr
Data type info: Data type: address of a MIL_DOUBLE MORE

Returns one of the following.

(summarize)
Click to summarize M_CORRECTED

Specifies to correct measurement results with the specified aspect ratio.

Click to summarize M_NORMAL

Specifies to not correct measurement results (ratio of 1.0).

Click to summarize SecondUserVarPtr
Data type info: Data type: Set this parameter to M_NULL

When performing an inquiry on a measurement result buffer, InquireType can be set to one of the following values.

function map For a measurement result buffer
Click to summarize
InquireType
Description
FirstUserVarPtr
- Possible values returned
SecondUserVarPtr
- Possible values returned
Click to summarize M_RESULT_TYPE +

Inquires the type of result buffer allocated. SET

(summarize)
Click to summarize FirstUserVarPtr
Data type info: Data type: address of a MIL_DOUBLE MORE

Returns the following.

(summarize)
Click to summarize M_CALCULATE

Specifies a result buffer for an MmeasCalculate() operation.

Click to summarize SecondUserVarPtr
Data type info: Data type: Set this parameter to M_NULL

To inquire the system on which the measurement context, marker, or result buffer was allocated, set the InquireType parameter to the following value.

function map For inquiring the system on which the measurement context, marker, or result buffer was allocated
Click to summarizeInquireType Description
FirstUserVarPtr
- Possible values returned
SecondUserVarPtr
- Possible values returned
Click to summarize M_OWNER_SYSTEM +

Inquires the identifier of the system on which the measurement context, marker, or result buffer has been allocated. SET SET SET

(summarize)
Click to summarize FirstUserVarPtr
Data type info: Data type: address of a MIL_DOUBLE MORE

Returns one of the following.

(summarize)
Click to summarize M_DEFAULT_HOST

Specifies the default Host system of the current MIL application.

Click to summarize MIL system identifier

Specifies a valid system identifier, previously allocated using MsysAlloc().

Click to summarize SecondUserVarPtr
Data type info: Data type: Set this parameter to M_NULL

You can add the following value to the above-mentioned values to determine the default value of an inquire type.

function map For inquiring the default value of an inquire type
Click to summarizeInquireType Description
FirstUserVarPtr
- Possible values returned
SecondUserVarPtr
- Possible values returned
Click to summarize M_DEFAULT

Inquires the default value of the specified inquire type, regardless of the current value of the inquire type.

(summarize)
Click to summarize FirstUserVarPtr
Data type info: Data type: address of a MIL_DOUBLE
Click to summarize SecondUserVarPtr
Data type info: Data type: Set this parameter to M_NULL

You can add the following value to the above-mentioned values to determine whether an inquire type is supported.

function map For inquiring whether an inquire type is supported
Click to summarizeInquireType Description
FirstUserVarPtr
- Possible values returned
SecondUserVarPtr
- Possible values returned
Click to summarize M_SUPPORTED

Inquires whether the specified inquire type is supported.

(summarize)
Click to summarize FirstUserVarPtr
Data type info: Data type: address of a MIL_DOUBLE

Returns one of the following.

(summarize)
Click to summarize 0

Specifies that the inquire type is not supported.

Click to summarize Value!=0

Specifies that the inquire type is supported.

You can add one of the following values to the above-mentioned values to cast the requested information to the required data type.

function map For specifying the data type
Click to summarizeInquireType Description
FirstUserVarPtr
- Possible values returned
SecondUserVarPtr
- Possible values returned
Click to summarize M_TYPE_MIL_DOUBLE

Casts the requested information to a MIL_DOUBLE.

(summarize)
Click to summarize FirstUserVarPtr
Data type info: Data type: address of a MIL_DOUBLE
Click to summarize SecondUserVarPtr
Data type info: Data type: address of a MIL_DOUBLE
Click to summarize M_TYPE_MIL_ID

Casts the requested information to a MIL_ID.

(summarize)
Click to summarize FirstUserVarPtr
Data type info: Data type: address of a MIL_ID
Click to summarize SecondUserVarPtr
Data type info: Data type: address of a MIL_ID
Click to summarize M_TYPE_MIL_INT

Casts the requested information to a MIL_INT.

(summarize)
Click to summarize FirstUserVarPtr
Data type info: Data type: address of a MIL_INT
Click to summarize SecondUserVarPtr
Data type info: Data type: address of a MIL_INT
Click to summarize M_TYPE_MIL_INT32

Casts the requested information to a MIL_INT32.

(summarize)
Click to summarize FirstUserVarPtr
Data type info: Data type: address of a MIL_INT32
Click to summarize SecondUserVarPtr
Data type info: Data type: address of a MIL_INT32
Click to summarize M_TYPE_MIL_INT64

Casts the requested information to a MIL_INT64.

(summarize)
Click to summarize FirstUserVarPtr
Data type info: Data type: address of a MIL_INT64
Click to summarize SecondUserVarPtr
Data type info: Data type: address of a MIL_INT64
Return value
The returned value is the requested information, typically returned to FirstUserVarPtr, cast to a MIL_INT. If the requested information does not fit into a MIL_INT, this function will return M_NULL or truncate the information.
Compilation information
Header Include mil.h.
Library Use mil.lib; milmeas.lib.
DLL Requires mil.dll; milmeas.dll.
DEFAULT RESULT OUTPUT UNITS ACCORDING TO CALIBRATION PIXEL WORLD MARKER REFERENCE MARKER REFERENCE INPUT UNITS PIXEL WORLD MARKER TYPE CIRCLE EDGE POINT STRIPE NUMBER ALL EDGEVALUE MIN EDGEVALUE VAR MIN FILTER SMOOTHNESS FILTER TYPE EULER PREWITT SHEN MAX ASSOCIATION DISTANCE MAX ASSOCIATION DISTANCE INPUT UNITS PIXEL WORLD POLARITY NEGATIVE POSITIVE ANY NEGATIVE OPPOSITE POSITIVE SAME SEARCH REGION ANGLE INTERPOLATION MODE BICUBIC BILINEAR NEAREST NEIGHBOR SEARCH REGION CLIPPING DISABLE MAXIMIZE AREA SEARCH REGION CLIPPING MIN AREA SEARCH REGION CLIPPING MIN HEIGHT SEARCH REGION CLIPPING MIN WIDTH SEARCH REGION CLIPPING PRESERVE CENTER ALONG HEIGHT ALONG WIDTH AUTO NONE SEARCH REGION INPUT UNITS PIXEL WORLD SUB REGIONS NUMBER SUBPIXEL MODE GLOBAL LOCAL BOX ANGLE ANY BOX ANGLE ACCURACY DISABLE BOX ANGLE DELTA NEG DEFAULT BOX ANGLE DELTA POS DEFAULT BOX ANGLE MODE DISABLE ENABLE BOX ANGLE REFERENCE BOX CENTER BOX ORIGIN BOX ANGLE TOLERANCE BOX CENTER DEFAULT DEFAULT BOX ORIGIN BOX SIZE DEFAULT DEFAULT DRAW PROFILE SCALE OFFSET AUTO SCALE PROFILE AUTO OFFSET PROFILE NUMBER MIN DEFAULT ORIENTATION ANY HORIZONTAL VERTICAL SUB REGIONS OFFSET SUB REGIONS SIZE MULTIPLE POINT ANGLE POINT INPUT UNITS PIXEL WORLD POSITION ANY ANY SPACING ANY INCLUSION POINT ANY ANY INCLUSION POINT INPUT UNITS PIXEL WORLD INCLUSION POINT INSIDE STRIPE ANY NO YES CIRCLE ACCURACY HIGH LOW CIRCLE INSIDE SEARCH REGION DISABLE ENABLE RING CENTER DEFAULT DEFAULT RING RADII DEFAULT DEFAULT SUB REGIONS CHORD ANGLE PIXEL ASPECT RATIO PIXEL ASPECT RATIO INPUT CORRECTED NORMAL PIXEL ASPECT RATIO OUTPUT CORRECTED NORMAL RESULT TYPE CALCULATE OWNER SYSTEM DEFAULT HOST DEFAULT SUPPORTED TYPE MIL DOUBLE TYPE MIL ID TYPE MIL INT TYPE MIL INT32 TYPE MIL INT64 STRIPE POINT EDGE CIRCLE