Click or drag to resize

IMcCompositeHostConvertSetLocationToIndex Method

Converts a location in the SourceImageSet into a frame index within the hosted composite or alternately, reports the currently displayed preview frame index.

Namespace:  MediaCy.IQL.Operations
Assembly:  MediaCy.IQL.Operations (in MediaCy.IQL.Operations.dll) Version: 10.0.6912.0
Syntax
VB
Copy
Function ConvertSetLocationToIndex ( 
	<OptionalAttribute> SourceImageSetLocation As McImageSetLocations
) As Integer

Parameters

SourceImageSetLocation (Optional)
Type: MediaCy.IQL.SetsMcImageSetLocations
If given, an IMcImageSetLocations instance specifying one source within the current SourceImageSet McImageSet instance; if not given or Nothing is supplied and SourceImageSet is not Nothing, then the the current location of the SourceImageSet is used. Only dimensions other than the Channel dimension in the SourceImageSetLocation are significant in converting the specified location into a composite frame index. If not given or Nothing is supplied and the SourceImageSet is Nothing or tracking is not enabled, then the currently displayed preview frame index is returned.

Return Value

Type: Int32
The composite frame index corresponding to the location along all channels specified by the given or default SourceImageSetLocation.
Remarks
If a SourceImageSetLocation is given, then the SourceImageSet property must not be Nothing and the mcchsfTrackSourceImageSet Status bit must be set. If no SourceImageSetLocation is supplied, then if SourceImageSet is not Nothing, the SourceImageSet current location is assumed; if SourceImageSet is Nothing or tracking is not enabled, the currentlty displayed preview frame is returned. The composite frame index computed from the given image set location is computed ignoring any SourceStartingFrame (that is computed assuming that SourceStartingFrame for all channels is zero). The caller is responsible for applying any SourceStartingFrame offset to the returned index if they wish to get the composite frame index that is showing a particular location in a particular image set channel.
See Also