IMcImageSetActiveRegion Property
|
|
Returns the region describing the active portion of the set.
Namespace:
MediaCy.IQL.Sets
Assembly:
MediaCy.IQL.Sets (in MediaCy.IQL.Sets.dll) Version: 10.0.6912.0
SyntaxProperty ActiveRegion As McImageSetRegion
Get
Set
Property Value
Type:
McImageSetRegion
RemarksReturns a McImageSetRegion object that defines the active portion of the set, which is the area of the set that
will be processed by operations. When the active region is set, the extents specified by the supplied McImageSetRegion
are copied into the active region maintained by the McImageSet. The default active region is the entire extent of the
set.
Until the active region is set, the region will be updated for any changes to the set dimensionality. However, after the
application has set the region, the region will only be updated to assure that it does not include portions of the set
that were removed by edits to the set's dimensionality. The ActiveRegion can be set to Nothing or to an empty region to
remove any previously established region.
Except for the mcisdResolution dimension, any dimension that is omitted from the provided region will be defaulted to
use the entire extent of that dimension. This can also be specified by using an Extent of -1, so the full extent of any
dimension can be specified by a Location of 0 (zero) and an Extent of -1.
An omitted mcisdResolution dimension results in only the 0th position along the mcisdResolution dimension being included
in the region.
Note that the active region's Sections will always be ordered by the set dimensions, so that a statement such as:
theSet.ActiveRegion.Sections(mcisdZ)
will access the active region for the specified dimension (in this example, the Z dimension).
The returned McImageSetRegion is not an independent copy of the active region, so changing its contents changes the
actual active region. Note that GetRegionToProcess does return an independent copy/.
See Also