Description

A read-write property giving the number of sample sections each line is to be broken into when the SampleMode is mclpsmFixedNumberOfSamples.

Property type

A Long value.  

Syntax

object.NumberOfSamplesDesired [= value]

The NumberOfSamplesDesired Property syntax has these parts:

PartDescription
objectAn expression evaluating to an object of type McLineProfiles.
valueA Long value.

Remarks

When SampleMode is mclpsmFixedNumberOfSamples, then each line feature is broken into NumberOfSamplesDesired sections, each of equal length along the line. The ProfileValues array for each channel of each line feature will be NumberOfSamplesDesired in length, and the NumberOfSamples property will be an array showing this number for each line feature. The LengthPerSample property array values will vary depending on the total length of each line feature.

Which ever SamplingMode is in force, the actual sampling algorithm for a single sampled segment is the same and depends only on its sampled length in pixel units. If the length of each sample, L, is greater than 1.0 pixels, then multiple luminance values are taken at equal intervals within the section and averaged. The number of values averaged is ceil(L). Luminance values are evenly placed about the center point of sections, and then each value is interpolated from the four nearest pixels (i.e., sub-pixel interpolation is used). If the VirtualWidth property is greater than 1.0, then each value will be made by averaging values along a perpendicular to the value point.

NumberOfSamplesDesired is 64 by default, but SampleMode is mclpsmFixedSampleLength by default so this setting will have no effect unless the SampleMode is changed.

Exceptions

Zero and negative values are illegal, but there is no upper limit. When SampleMode is mclpsmFixedNumberOfSamples the number of samples per line is limited only by memory resources.