reduce_domainReduceDomainReduceDomainreduce_domainreduce_domain
Short description
reduce_domainReduceDomainReduceDomainreduce_domainreduce_domain — Reduce the domain of an image.
Signature
reduce_domain( image Image, region Region, out image ImageReduced )void ReduceDomain( const HObject& Image, const HObject& Region, HObject* ImageReduced )static void HOperatorSet.ReduceDomain( HObject image, HObject region, out HObject imageReduced )def reduce_domain( image: HObject, region: HObject ) -> HObject
Herror reduce_domain( const Hobject Image, const Hobject Region, Hobject* ImageReduced )
Herror T_reduce_domain( const Hobject Image, const Hobject Region, Hobject* ImageReduced )
HImage HImage::ReduceDomain( const HRegion& Region ) const
HImage HImage.ReduceDomain( HRegion region )
Description
The operator reduce_domainReduceDomain reduces the definition domain of the given image
to the indicated region. The new definition domain is calculated as
the intersection of the old definition domain with the region.
Thus, the new definition domain can be a subset of the region. The
size of the matrix is not changed.
Execution information
-
Supports objects on compute devices.
-
Multithreading type: reentrant (runs in parallel with non-exclusive operators).
-
Multithreading scope: global (may be called from any thread).
Parameters
Imageimageimage (input_object) (multichannel-)image(-array) → object (byte / direction / cyclic / int1 / int2 / uint2 / int4 / int8 / real / complex / vector_field)HObject (byte / direction / cyclic / int1 / int2 / uint2 / int4 / int8 / real / complex / vector_field)HImage (byte / direction / cyclic / int1 / int2 / uint2 / int4 / int8 / real / complex / vector_field)HObject (byte / direction / cyclic / int1 / int2 / uint2 / int4 / int8 / real / complex / vector_field)Hobject (byte / direction / cyclic / int1 / int2 / uint2 / int4 / int8 / real / complex / vector_field)
Input image.
Regionregionregion (input_object) region → objectHObjectHRegionHObjectHobject
New definition domain.
ImageReducedimageReducedimage_reduced (output_object) image(-array) → object (byte / direction / cyclic / int1 / int2 / uint2 / int4 / int8 / real / complex / vector_field)HObject (byte / direction / cyclic / int1 / int2 / uint2 / int4 / int8 / real / complex / vector_field)HImage (byte / direction / cyclic / int1 / int2 / uint2 / int4 / int8 / real / complex / vector_field)HObject (byte / direction / cyclic / int1 / int2 / uint2 / int4 / int8 / real / complex / vector_field)Hobject * (byte / direction / cyclic / int1 / int2 / uint2 / int4 / int8 / real / complex / vector_field)
Image with reduced definition domain.
Combinations with other operators
Combinations
Possible predecessors
get_domainGetDomain
Alternatives
change_domainChangeDomain, rectangle1_domainRectangle1Domain, add_channelsAddChannels
See also
full_domainFullDomain, get_domainGetDomain, intersectionIntersection
Module
Foundation