Click or drag to resize

mcAdjustPropertiesByExampleFlags Enumeration

Allowed values for the McProfilesEdges.AdjustPropertiesByExampleAdjustFlags argument.

Namespace:  MediaCy.IQL.Features
Assembly:  MediaCy.IQL.Features (in MediaCy.IQL.Features.dll) Version: 10.0.6912.0
Syntax
VB
Public Enumeration mcAdjustPropertiesByExampleFlags
Members
  Member nameValueDescription
mcapbefNoAdjustFlags0No flags
mcapbefMakeRoughGuess1Normally,AdjustPropertiesByExample assumes that you have placed edges along the test profile at all positions where they are desired and have removed any edges from positions where they are not desired. However when the mcapbefMakeRoughGuess flag is set, the Pattern and other edge detection properties are computed based only on egdes that are present without trying to make adjustments for sections of the test profile where edges are missing. That is, no assumption is made that all good edges along the test profile have been identified. This allows you to quickly set up edge detection by just going through the following sequence: 1) place one or two good edges, 2) call AdjustPropertiesByExample with the mcapbefMakeRoughGuess, 3) call FindEdges, 4) correct missplaced edges by removing extra ones and/or adding missed ones (see McEditEdgesTool), and 5) call AdjustPropertiesByExample without the mcapbefMakeRoughGuess flag to do a more complete property analysis.
mcapbefResetHotspot2When clear, theMatchHotspot property is not changed. If this flag is set, then the MatchHotspot is always reset to 50 (at the midpoint of the Pattern). If the mcapbefKeepPattern flag is set, then this flag is forced off (that is, when the Pattern is not allowed to change, neither is the MatchHotspot). By default this flag is clear so that the detected Pattern will be relative to the current MatchHotspot.
mcapbefKeepPattern4When set, the Patternproperty is not changed. If this flag is set, then the mcapbefResetHotspot flag is forced off. By default this flag is clear, so that AdjustPropertiesByExample will automatically set the pattern. You will usually not want to set this flag, since one of the most useful adjustments that the McProfilesEdges.AdjustPropertiesByExample method performs is to automatically set the Pattern based on where edges have been placed. The exceptional situation where you would want to set this flag is where you know what sort of pattern you are looking for (e.g., a rising or falling edge). In this situation, by setting this flag you confine the AdjustPropertiesByExample to only adjust other parameters.
mcapbefSetPointsForSameSize8When clear, themcpewfPointsForSameSize bit of the WeightingFlags property is not changed. By default this flag is clear, so that whether size-missmatch weighting is done will not be changed. If the flag is set, then an analysis is made of whether fitting is substantially improved on the test profile by enabling size-missmatch weighting. If so then the mcpewfPointsForSameSize is set in the WeightingFlags property, otherwise it is cleared.
mcapbefSetPointsForSameOffset16When clear, themcpewfPointsForSameOffset bit of the WeightingFlags property is not changed. By default this flag is clear, so that whether weighting is done will not be changed. If the flag is set, then an analysis is made of whether fitting is substantially improved on the test profile by enabling offset weighting. If so then the mcpewfPointsForSameOffset is set in the WeightingFlags property, otherwise it is cleared.
mcapbefKeepSizeWeighting32When set, theSizeWeighting property is not changed. By default this flag is clear, since you will almost always want to allow the AdjustPropertiesByExample method to be able to set the SizeWeighting property as part of its adjustments.
mcapbefKeepThresholdForEdge64When set, theThresholdForEdge property is not changed. By default this flag is clear, since you will almost always want to allow the AdjustPropertiesByExample method to be able to set the ThresholdForEdge property as part of its adjustments.
mcapbefAnalyzeOnly128When set, noproperties are changed, but the analysis results are returned as if they had been (except that the count of changed properties will be zero). You would usually combine this flag with the mcapbefKeepPattern flag, since without that the results relate to the automatically detected Pattern property, to which you will have no access (since the Pattern property will not be changed). You would often also want to set the mcapbefPreserveBadEdges flag, so that poor test edges are not automatically removed.
mcapbefPreserveBadEdges256Normally, anytest edge that is especially poorly correlated with the Pattern or that marks a section of the test profile that has exceptionally small variation will be removed from the test set and so removed from consideration when setting the edge detection properties. This is appropriate, because such edges were almost certainly missplaced by the user (test edges must mark a consistent pattern on the test profile for the property adjustment to be successful). But when the mcapbefPreserveBadEdges flag is set, bad edges are not removed and the operation proceeds in spite of them. You might wish to set this flag along with the mcapbefAnalyzeOnly (and possibly the mcapbefKeepPattern flag) to use the returned results array to analyze a set of edges.
mcapbefDefault0By default all flags areclear. This allows the Pattern, SizeWeighting and ThresholdForEdge properties to be adjusted to allow FindEdges to best match the current set of edges while avoiding finding edges that are not present. The MatchHotspot and size and offset weighting are not changed. If there are any bad edges, they are removed.
Remarks
These flags control whether certain properties are allowed to change when the McProfilesEdges.AdjustPropertiesByExample method is called. Flags for may be OR'ed together.
See Also