crop_domain_relcrop_domain_relCropDomainRelCropDomainRelcrop_domain_rel (Operator)
Name
crop_domain_relcrop_domain_relCropDomainRelCropDomainRelcrop_domain_rel — Cut out an image area relative to the domain.
Signature
Herror crop_domain_rel(const Hobject Image, Hobject* ImagePart, const Hlong Top, const Hlong Left, const Hlong Bottom, const Hlong Right)
Herror T_crop_domain_rel(const Hobject Image, Hobject* ImagePart, const Htuple Top, const Htuple Left, const Htuple Bottom, const Htuple Right)
Description
crop_domain_relcrop_domain_relCropDomainRelCropDomainRelcrop_domain_rel cuts a rectangular area from the input
images. The area is determined by the surrounding rectangle of the
domain of the input image. The rectangle can be influenced by the
control parameters to modify at the top (TopTopToptoptop), at the left
(LeftLeftLeftleftleft), at the bottom (BottomBottomBottombottombottom), and at the right
(RightRightRightrightright). Positive values results in a smaller, negative
values in a larger size. If all parameters are set to zero, the
region remains unchanged.
Execution Information
- Multithreading type: reentrant (runs in parallel with non-exclusive operators).
- Multithreading scope: global (may be called from any thread).
- Automatically parallelized on tuple level.
- Automatically parallelized on channel level.
Parameters
ImageImageImageimageimage (input_object) (multichannel-)image(-array) → objectHImageHObjectHObjectHobject (byte / direction / cyclic / int1 / int2 / uint2 / int4 / real)
Input image.
ImagePartImagePartImagePartimagePartimage_part (output_object) (multichannel-)image(-array) → objectHImageHObjectHObjectHobject * (byte / direction / cyclic / int1 / int2 / uint2 / int4 / real)
Image area.
TopTopToptoptop (input_control) integer → HTupleintHTupleHtuple (integer) (int / long) (Hlong) (Hlong)
Number of rows clipped at the top.
Default:
-1
Suggested values:
-20, -10, -5, -3, -2, -1, 0, 1, 2, 3, 4, 5, 10, 20
LeftLeftLeftleftleft (input_control) integer → HTupleintHTupleHtuple (integer) (int / long) (Hlong) (Hlong)
Number of columns clipped at the left.
Default:
-1
Suggested values:
-20, -10, -5, -3, -2, -1, 0, 1, 2, 3, 4, 5, 10, 20
BottomBottomBottombottombottom (input_control) integer → HTupleintHTupleHtuple (integer) (int / long) (Hlong) (Hlong)
Number of rows clipped at the bottom.
Default:
-1
Suggested values:
-20, -10, -5, -3, -2, -1, 0, 1, 2, 3, 4, 5, 10, 20
RightRightRightrightright (input_control) integer → HTupleintHTupleHtuple (integer) (int / long) (Hlong) (Hlong)
Number of columns clipped at the right.
Default:
-1
Suggested values:
-20, -10, -5, -3, -2, -1, 0, 1, 2, 3, 4, 5, 10, 20
Result
crop_domain_relcrop_domain_relCropDomainRelCropDomainRelcrop_domain_rel returns 2 (
H_MSG_TRUE)
if all parameters are
correct. The behavior in case of empty input (no regions given) can
be set via set_system('no_object_result',<Result>)set_system("no_object_result",<Result>)SetSystem("no_object_result",<Result>)SetSystem("no_object_result",<Result>)set_system("no_object_result",<Result>)
and the behavior in case of an empty input region via
set_system('empty_region_result',<Result>)set_system("empty_region_result",<Result>)SetSystem("empty_region_result",<Result>)SetSystem("empty_region_result",<Result>)set_system("empty_region_result",<Result>).
If necessary, an exception is raised.
Possible Predecessors
reduce_domainreduce_domainReduceDomainReduceDomainreduce_domain,
thresholdthresholdThresholdThresholdthreshold,
connectionconnectionConnectionConnectionconnection,
regiongrowingregiongrowingRegiongrowingRegiongrowingregiongrowing,
pouringpouringPouringPouringpouring
Alternatives
crop_domaincrop_domainCropDomainCropDomaincrop_domain,
crop_rectangle1crop_rectangle1CropRectangle1CropRectangle1crop_rectangle1
See also
smallest_rectangle1smallest_rectangle1SmallestRectangle1SmallestRectangle1smallest_rectangle1,
intersectionintersectionIntersectionIntersectionintersection,
gen_rectangle1gen_rectangle1GenRectangle1GenRectangle1gen_rectangle1,
clip_regionclip_regionClipRegionClipRegionclip_region
Module
Foundation