mcMeasurementAttributeID Enumeration

Values that select what information is returned from a measurement Attributes property.

Namespace: MediaCy.IQL.Features
Assembly: MediaCy.IQL.Features (in MediaCy.IQL.Features.dll) Version: 10.0.6912.0

Syntax

Copy

Public Enumeration mcMeasurementAttributeID

Members

Member name	Value	Description
mcmaidID	0	As Long. For built-inmeasurements, the TagNumber (DISPID) of the measurement. Zero for all custom measurements.
mcmaidName	1	As String. Parseable name of the measurement.
mcmaidAllowedParent	2	As mcMeasurementParent. Theallowed parent of the measurement.
mcmaidParent	3	As mcMeasurementParent. Theactual parent of the measurement instance.
mcmaidCategories	4	As mcMeasurementCategoryFlags.The categories that the measurement is part of. Category flags are Or'ed together.
mcmaidPerFeatureMeasurement	5	As Boolean. True (the usualcase) if the measurement is computed on a per-feature basis of the ancestor McFeatures (e.g., the Area of each region). False if only one measurement is computed for all features (e.g., a count of the number of regions that overlap other regions), or if the measurements do not correspond one-to-one to the associated feature index. Note that non-numeric measurements, where Attributes(mcmaidResultType) is something other than mcmrtNumeric, can also have this Attribute True if the measurement Value McFeatures has features that correspond one-to-one to the ancestor McFeatures (e.g., mpRgnCentroidAsPoint); this is the usual case for non-numeric measurements.
mcmaidNofDimensions	6	As Long. Number of dimensionsfor the measurement Value property. Zero indicates that the Value is a scalar. One indicates that the measurement result is a 1-dimensional array (which under some circumstances might be a length-1 or even length-0 array). Two indicates that the Value is a two-dimensional array and so on. The "shape" of array results is given by the mcmaidShape AttributeID. The measurement Value is one result per-feature if mcmaidPerFeatureMeasurement AttributeID is True, so in this case, the number of dimensions will always be 1 or more. The number of dimensions will always be 4 or less.
mcmaidShape	7	Array As Long. The "shape"(e.g., size of each dimension) of the entire measurement Value. Sizes of all dimensions are returned encoded in a a 1-D array with a length given by mcmaidNofDimensions, with element zero representing Dim1 (the slowest moving). Sizes of fixed dimensions are returned as positive numbers, while sizes of variable dimensions are returned as zero. Variable dimensions beyond the first will be represented in the Value property as an array of Variant, with each Variant itself holding an array. Note that if the Value property is a scalar [i.e., Attributes(mcmaidNofDimensions) equal to 0], this array will be zero-length. For example, in the usual case of a single value per-feature measurement, mcmaidNofDimensions will be 1, while mcmaidShape will return a length-1 array with 0 (a variable size) as the value.
mcmaidResultMcObjectType	8	As mcobjTypeEnum. The Type of theValueMcObject property. The VARTYPE of the McMeasure.ValueMcObject property can be determined by getting the McObject.ValueType property. Use McMeasure.Attributes(mcmaidResultValueType) to get the result McMeasure.Value property's type.
mcmaidDependencies	9	As mcMeasurementDependencyFlags.Determines under what conditions the measurement becomes "stale" (i.e., the McMeasure.IsValueStale property goes True). The McMeasure.Value property and statistics are only recomputed when accessed if some dependency of the measurement has changed since the last access.
mcmaidCanBeEnabled	10	As Boolean. True if the measurementcan be Enabled for computation. This will usually be True, but a McMeasure instance without an ancestor McImage cannot perform any luminance-related measurements (ones with a mcmdfImageLuminance dependency) and some measurements require multi-channel or 3-channel color images. Some measurements may require other properties to be set before a measurement can be made. For example, most measurements for McRefFeatures objects require that the McRefFeatures.ReferenceFeature property be assigned before the measurement's Value property can be accessed..
mcmaidResultType	11	As mcMeasurementResultType. Theoverall type of the measurement Value. Most measurement results are numeric (mcmrtNumeric), but some results are a McFeatures-derived object (McPoints, McLines or McRegions). Use McMeasure.Attributes(mcmaidResultValueType) to get the result McMeasure.Value property's type. Use McMeasure.Attributes(mcmaidResultMcObjectType) to get the result McMeasure.ValueMcObject type; note that only mcmrtNumeric results expose a McMeasure.ValueMcObject property.
mcmaidIllustration	12	As a Picture object. If not Nothing,an 80 by 60 pixel illustration suitable for accompanying the DisplayName and Description. The program must handle the case where Nothing is returned; that is, where there is no illustration for the measurement.
mcmaidOneDimPerFeature	13	As Boolean. True (the usualcase) if Attributes(mcmaidPerFeatureMeasurement) is True, Attributes(mcmaidResultType)=mcmrtNumeric and Attributes(mcmaidNofDimensions) equals 1. Only for measurements where Attributes(mcmaidOneDimPerFeature) is True will the Filter method or any of the statistical methods succeed.
mcmaidCanFilter	14	As Boolean. True (the usualcase) if the McMeasure.Filter method can be called. This will usually be the same as Attributes(mcmaidOneDimPerFeature).
mcmaidCanGetStatistics	15	As Boolean. True (the usualcase) if the McMeasure.Count, McMeasure.Min, McMeasure.Max, McMeasure.Mean, and so on statistical properties can be accessed. This will usually be the same as Attributes(mcmaidOneDimPerFeature).
mcmaidResultValueType	16	As VARTYPE (unsigned shortinterger); this is a value from the VariantType Enum in the Microsoft.VisualBasic namespace. The Vartype of the McMeasure.Value property variant. For standard numeric results this will be vbDouble (VariantType.Double).
mcmaidDefaultRangeMin	17	As Double. The default for theMcMeasure.RangeMin property. This property is only useful if Attributes(mcmaidCanFilter) returns True.
mcmaidDefaultRangeMax	18	As Double. The default for theMcMeasure.RangeMax property. This property is only useful if Attributes(mcmaidCanFilter) returns True.
mcmaidSpatialUnitExponent	19	As Long. If no spatialcalibration unit applies to this measurement result, then this value is zero. For example, Attributes(mcmaidSpatialUnitExponent) mRgnHeterogeneity is unitless, so the value is zero; mRgnDensity has no spatial dependence, so its value is also zero; for mLnLength the value is 1; for mRgnArea the value is 2, and for mRgnIntegratedOD (density/area) the value is -2. The value of Attributes(mcmaidIntensityUnitExponent) for these measurements are zero, 1, 0, 0 and 1, respectively. The value for measurements that return angle results is zero, but in this case Attributes(mcmaidCategories) will have the mcmcfAngleResult bit set. Note that Attributes(mcmaidUnitsAbbrev) or Attributes(mcmaidUnitsName) can be used to get the units as a string.
mcmaidIntensityUnitExponent	20	As Long. If no intensitycalibration unit applies to this measurement result, then this value is zero. Otherwise this is the exponent to apply to the IntensityCalibration.UnitAbbrev or UnitName (or raw pixel luminance values if the mcmcfUncalibratedResult bit of Attributes(mcmaidCategories) is set). For example, Attributes(mcmaidIntensityUnitExponent) mRgnHeterogeneity is unitless, so the value is 0; mLnLength has no intensity dependence, so its value is zero; for mRgnDensity the value is 1, and for mRgnIntegratedOD (density/area) the value is 1. The value of Attributes(mcmaidSpatialUnitExponent) for these measurements are zero, 1, 0, -2, respectively. The value for measurements that return angle results is zero, but in this case Attributes(mcmaidCategories) will have the mcmcfAngleResult bit set.
mcmaidUnitsAbbrev	21	As String. A localizedabbreviation for the measurement units. This string will be empty if the measurement result is unitless (e.g., a ratio). The units will be based on the current SpatialCalibration and/or IntensityCalibration applied to the measurement.
mcmaidUnitsName	22	As String. A localized name forthe measurement units. This string will be empty if the measurement result is unitless (e.g., a ratio). The units will be based on the current SpatialCalibration and/or IntensityCalibration applied to the measurement.
mcmaidAbbreviation	23	As String. A localizedabbreviation for the measurement name. This abbreviation is usually 5 characters or less and is suitable for labeling measurement values on an image. The more common measurements have very short abbreviations; for example, mRgnArea's is "A" and mRgnCentroidX's is "X". Those for less common measurements are a little longer; e.g., mRgnMassCentroidX is "MassX".
mcmaidParameterCount	24	As Long. Count of optionalmeasurement parameters. This value is zero for most measurements. If this value is zero, then the value returned from all of the Attribute calls that return an array of length-Attributes(mcmaidParameterCount) will be vbEmpty.
mcmaidParameterValueTypes	25	As anAttributes(mcmaidParameterCount)-length array of VARTYPE (unsigned short interger, VT_I2; this is a value from the VariantType Enum in the Microsoft.VisualBasic namespace). Each element of the array gives the basic type of the corresponding parameter. A type of vbVariant (VT_VARIANT) is allowed, in which case no type conversion or range checking of parameter values will be done. Otherwise, the type must be a numeric type which can be cast to from a Double value. The McMeasure.GetParameter method will return a Variant this type.
mcmaidParameterDisplayNames	26	As anAttributes(mcmaidParameterCount)-length array of String. Each element of the array gives the localized display name of the corresponding parameter suitable for a tool-tip title.
mcmaidParameterShortNames	27	As anAttributes(mcmaidParameterCount)-length array of String. Each element of the array gives a short localized name of the corresponding parameter suitable for listing the parameter in a constrained space.
mcmaidParameterDescriptions	28	As anAttributes(mcmaidParameterCount)-length array of String. Each element of the array gives a localized description of the corresponding parameter suitable for a tool-tip.
mcmaidParameterDefaultValues	29	As anAttributes(mcmaidParameterCount)-length array of Variant. Each element of the array is a Variant the type for this parameter [see Attributes(mcmaidParameterValueTypes)] specifying the default value of the corresponding parameter. For parameters of type vtVariant, this will be an Double value of zero. For enumerated parameters (see mcmaidParameterEnumCounts), the value will be an index into the list of enumeration values and strings (see mcmaidParameterEnumValues and mcmaidParameterEnumStrings).
mcmaidParameterAllowedRange	30	IfAttributes(mcmaidParameterCount) is greater than one, CommandData is examined and if it is an Integer scalar within the allowed range, then its value is used as the parameter index for the results to be returned; otherwise the results for the first parameter is returned. For enumerated parameters or ones of type vtVariant or vtBoolean, the result will be a length-2 array of Double, with both values zero. Otherwise the result is returned as a length-2 array of the Attributes(mcmaidParameterValueTypes) type specifying the allowed range for values assigned to the specified parameter.
mcmaidParameterEnumCounts	31	As anAttributes(mcmaidParameterCount)-length array of vtInteger (VT_I4). Each element of the array gives plus or minus the number of enumeration values associated with each parameter. If the value is zero, then the parameter is not enumerated. If the value is positive, then the parameter is a single choice among the enumerated values (i.e., suitable for selection in a combo box). If the value is negative, then the parameter is one in which enumerated values may be ORed together (i.e., suitable for a list of check boxes). Only parameters with Attributes(mcmaidParameterValueTypes) of vtBoolean (VT_BOOL) or vtInteger (VT_I4) will potentially have enumerated values. For vtBoolean type parameters the enumeration count will be 2 (0: False and -1: True). Call Attributes(mcmaidParameterEnumValues) and Attributes(mcmaidParameterEnumStrings) to get the specific enumerated values and an associated identifying localized strings for those parameters that can be enumerated.
mcmaidParameterEnumValues	32	IfAttributes(mcmaidParameterCount) is greater than one, CommandData is examined and if it is an Integer scalar within the allowed range, then its value is used as the parameter index for the results to be returned; otherwise the results for the first parameter is returned. The returned result is either vtEmpty or an vtInteger (VT_I4) array of length equal to the absolute value of the number of enumerated values for the selected parameter, as given in the array returned by Attributes(mcmaidParameterEnumCounts). The arrays returned by this call are paralleled with corresponding String arrays accessed via Attributes(mcmaidParameterEnumStrings).
mcmaidParameterEnumStrings	33	IfAttributes(mcmaidParameterCount) is greater than one, CommandData is examined and if it is an Integer scalar within the allowed range, then its value is used as the parameter index for the results to be returned; otherwise the results for the first parameter is returned. The returned result is either vtEmpty or a String (VT_BSTR) array of length equal to the absolute value of the number of enumerated values for the selected parameter, as given in the array returned by Attributes(mcmaidParameterEnumCounts). The strings in these arrays are localized and suitable for a list of enumerated parameter value choices. The arrays returned by this call are paralleled with corresponding vtInteger arrays accessed via Attributes(mcmaidParameterEnumValues).
mcmaidDisconnectMeasure	100	Returns Empty. Used internallyto give McUserMeasure instances an opportunity to free up per-McMeasure data.

Reference

MediaCy.IQL.Features Namespace