Click or drag to resize

IMcImageSetGetSources Method

Gets the sources for a specified region

Namespace:  MediaCy.IQL.Sets
Assembly:  MediaCy.IQL.Sets (in MediaCy.IQL.Sets.dll) Version: 10.0.6912.0
Syntax
VB
Copy
Function GetSources ( 
	Region As McImageSetRegion,
	DesiredLength As McImageSetExtents,
	Optional LocationMatch As mcImageSetLocationMatchTypes = mcImageSetLocationMatchTypes.mcislmtDefault
) As McImageSetSources

Parameters

Region
Type: MediaCy.IQL.SetsMcImageSetRegion
The region of the set for which the sources should be returned. The order in which the individual McImageSetSection instances are added to the Region.Sections property is ignored unless the LocationMatch parameter is mcImageSetLocationMatchTypes.mcislmtHonorDimensionOrder. In that case the order determines the dimension ordering of the returned sources. For example, consider a 3-dimensional set of 2 channels, 2 Z and 2 Time. The standard ordering of mcisdChannel (0), mcisdZ (1), mcisdScan (2), mcisdSite (3), mcisdTime (4), mcisdResolution (5 AKA mcisdUser1) and mcisdUser2 (6) will result in C0Z0T0, C1Z0T0, C0Z1T0, C1Z1T0, C0Z0T1, C1Z0T1, C0Z1T1, C1Z1T1. However if the McImageSetSection instances are added to the McRegion.Sections in T, Z, C order and the LocationMatch parameter is mcislmtHonorDimensionOrder, then the sources will be returned as C0Z0T0, C0Z0T1, C0Z1T0, C0Z1T1, C1Z0T0, C1Z0T1, C1Z1T0, C1Z1T1 (i.e., with Time the fastest moving dimension).
DesiredLength
Type: MediaCy.IQL.SetsMcImageSetExtents
This parameter is Reserved. It should be supplied as Nothing. The number of sources returned along any dimension is determined by the McImageSetSection for that dimension in the supplied Region.Sections property.
LocationMatch (Optional)
Type: MediaCy.IQL.SetsmcImageSetLocationMatchTypes
If mcImageSetLocationMatchTypes.mcislmtHonorDimensionOrder then the order of sections in the Region.Sections determines the dimension ordering of the returned sources as explained above. Otherwise sources are always returned in the standard order.

Return Value

Type: McImageSetSources
A McImageSetSources collection holding copies of the sources at the locations specified in the Region parameter, optionally ordered by the order in which sections of the Region were added as it was constructed.
Remarks
Gets a McImageSetSources collection containing the sources for the specified Region of the set. The Region can be Nothing (or empty), in which case the sources for the entire set will be returned. Note that the source may be empty (image, frame, and file name all empty) at locations that correspond to an unused location of a sparse set. A sparse set is a set where the storage value is missing at some point(s) in the multi-dimensional storage space. Sparse (i.e., missing) location(s) are created when a value is added to the set at some location beyond the current end of one or more dimensions. At all "sparse" locations in the set storage, the storage at that location will have a NULL image/frame and an empty file name. It is the caller's responsibility to detect the case where a returned source is missing any frame information at that location and to decide what to do about it. The original role of the LocationMatch parameter is no longer supported and it is now used to control whether the dimension ordering of the returned sources is the default or can be controlled by how the Region argument is constructed. If the value of this argument is anything other than mcImageSetLocationMatchTypes.mcislmtHonorDimensionOrder, then the ordering of the returned dimensions is always a standard order: mcisdChannel (0), mcisdZ (1), mcisdScan (2), mcisdSite (3), mcisdTime (4), mcisdResolution (5 AKA mcisdUser1) and mcisdUser2 (6). The mcisdChannel dimension is the fastest moving: that is, each mcisdChannel in the Region is returned for each mcisdZ and so on.
See Also