gen_random_regionsgen_random_regionsGenRandomRegionsGenRandomRegionsgen_random_regions (Operator)
Name
gen_random_regionsgen_random_regionsGenRandomRegionsGenRandomRegionsgen_random_regions
— Create random regions like circles, rectangles and ellipses.
Signature
Herror gen_random_regions(Hobject* Regions, const char* Type, double WidthMin, double WidthMax, double HeightMin, double HeightMax, double PhiMin, double PhiMax, const Hlong NumRegions, const Hlong Width, const Hlong Height)
Herror T_gen_random_regions(Hobject* Regions, const Htuple Type, const Htuple WidthMin, const Htuple WidthMax, const Htuple HeightMin, const Htuple HeightMax, const Htuple PhiMin, const Htuple PhiMax, const Htuple NumRegions, const Htuple Width, const Htuple Height)
void GenRandomRegions(HObject* Regions, const HTuple& Type, const HTuple& WidthMin, const HTuple& WidthMax, const HTuple& HeightMin, const HTuple& HeightMax, const HTuple& PhiMin, const HTuple& PhiMax, const HTuple& NumRegions, const HTuple& Width, const HTuple& Height)
void HRegion::GenRandomRegions(const HString& Type, const HTuple& WidthMin, const HTuple& WidthMax, const HTuple& HeightMin, const HTuple& HeightMax, const HTuple& PhiMin, const HTuple& PhiMax, Hlong NumRegions, Hlong Width, Hlong Height)
void HRegion::GenRandomRegions(const HString& Type, double WidthMin, double WidthMax, double HeightMin, double HeightMax, double PhiMin, double PhiMax, Hlong NumRegions, Hlong Width, Hlong Height)
void HRegion::GenRandomRegions(const char* Type, double WidthMin, double WidthMax, double HeightMin, double HeightMax, double PhiMin, double PhiMax, Hlong NumRegions, Hlong Width, Hlong Height)
void HRegion::GenRandomRegions(const wchar_t* Type, double WidthMin, double WidthMax, double HeightMin, double HeightMax, double PhiMin, double PhiMax, Hlong NumRegions, Hlong Width, Hlong Height)
(Windows only)
static void HOperatorSet.GenRandomRegions(out HObject regions, HTuple type, HTuple widthMin, HTuple widthMax, HTuple heightMin, HTuple heightMax, HTuple phiMin, HTuple phiMax, HTuple numRegions, HTuple width, HTuple height)
void HRegion.GenRandomRegions(string type, HTuple widthMin, HTuple widthMax, HTuple heightMin, HTuple heightMax, HTuple phiMin, HTuple phiMax, int numRegions, int width, int height)
void HRegion.GenRandomRegions(string type, double widthMin, double widthMax, double heightMin, double heightMax, double phiMin, double phiMax, int numRegions, int width, int height)
def gen_random_regions(type: str, width_min: Union[float, int], width_max: Union[float, int], height_min: Union[float, int], height_max: Union[float, int], phi_min: Union[float, int], phi_max: Union[float, int], num_regions: int, width: int, height: int) -> HObject
Description
The operator gen_random_regionsgen_random_regionsGenRandomRegionsGenRandomRegionsGenRandomRegionsgen_random_regions
generates circles, rectangles
and ellipses whose parameters are determined at random.
In each case only one lower, upper limit respectively, is given.
The position is always random and cannot be determined by parameters.
The parameter NumRegionsNumRegionsNumRegionsNumRegionsnumRegionsnum_regions
indicates how many regions
shall be created.
Execution Information
- Multithreading type: reentrant (runs in parallel with non-exclusive operators).
- Multithreading scope: global (may be called from any thread).
- Processed without parallelization.
Parameters
RegionsRegionsRegionsRegionsregionsregions
(output_object) region-array →
objectHRegionHObjectHRegionHobject *
Created regions.
TypeTypeTypeTypetypetype
(input_control) string →
HTuplestrHTupleHtuple (string) (string) (HString) (char*)
Type of regions to be created.
Default value:
'circle'
"circle"
"circle"
"circle"
"circle"
"circle"
List of values: 'circle'"circle""circle""circle""circle""circle", 'ellipse'"ellipse""ellipse""ellipse""ellipse""ellipse", 'rectangle1'"rectangle1""rectangle1""rectangle1""rectangle1""rectangle1", 'rectangle2'"rectangle2""rectangle2""rectangle2""rectangle2""rectangle2", 'ring'"ring""ring""ring""ring""ring"
WidthMinWidthMinWidthMinWidthMinwidthMinwidth_min
(input_control) number →
HTupleUnion[float, int]HTupleHtuple (real / integer) (double / int / long) (double / Hlong) (double / Hlong)
Minimum width of the region.
Default value: 10.0
Suggested values: 1.0, 3.0, 5.0, 10.0, 20.0, 40.0, 80.0
Typical range of values: 1.0
≤
WidthMin
WidthMin
WidthMin
WidthMin
widthMin
width_min
≤
511.0
(lin)
Minimum increment: 1.0
Recommended increment: 10.0
Restriction: WidthMin > 0
WidthMaxWidthMaxWidthMaxWidthMaxwidthMaxwidth_max
(input_control) number →
HTupleUnion[float, int]HTupleHtuple (real / integer) (double / int / long) (double / Hlong) (double / Hlong)
Maximum width of the region.
Default value: 20.0
Suggested values: 1.0, 3.0, 5.0, 10.0, 20.0, 40.0, 80.0
Typical range of values: 1.0
≤
WidthMax
WidthMax
WidthMax
WidthMax
widthMax
width_max
≤
511.0
(lin)
Minimum increment: 1.0
Recommended increment: 10.0
Restriction: WidthMax > 0
HeightMinHeightMinHeightMinHeightMinheightMinheight_min
(input_control) number →
HTupleUnion[float, int]HTupleHtuple (real / integer) (double / int / long) (double / Hlong) (double / Hlong)
Minimum height of the region.
Default value: 10.0
Suggested values: 1.0, 3.0, 5.0, 10.0, 20.0, 40.0, 80.0
Typical range of values: 1.0
≤
HeightMin
HeightMin
HeightMin
HeightMin
heightMin
height_min
≤
511.0
(lin)
Minimum increment: 1.0
Recommended increment: 10.0
Restriction: HeightMin > 0
HeightMaxHeightMaxHeightMaxHeightMaxheightMaxheight_max
(input_control) number →
HTupleUnion[float, int]HTupleHtuple (real / integer) (double / int / long) (double / Hlong) (double / Hlong)
Maximum height of the region.
Default value: 30.0
Suggested values: 1.0, 3.0, 5.0, 10.0, 20.0, 40.0, 80.0
Typical range of values: 1.0
≤
HeightMax
HeightMax
HeightMax
HeightMax
heightMax
height_max
≤
511.0
(lin)
Minimum increment: 1.0
Recommended increment: 10.0
Restriction: HeightMax > 0
PhiMinPhiMinPhiMinPhiMinphiMinphi_min
(input_control) number →
HTupleUnion[float, int]HTupleHtuple (real / integer) (double / int / long) (double / Hlong) (double / Hlong)
Minimum rotation angle of the region.
Default value: -0.7854
Suggested values: 0.0, 0.1, 0.3, 0.6, 0.9, 1.2, 1.5
Typical range of values: 0.0
≤
PhiMin
PhiMin
PhiMin
PhiMin
phiMin
phi_min
≤
6.28
(lin)
Restriction: PhiMin > 0
PhiMaxPhiMaxPhiMaxPhiMaxphiMaxphi_max
(input_control) number →
HTupleUnion[float, int]HTupleHtuple (real / integer) (double / int / long) (double / Hlong) (double / Hlong)
Maximum rotation angle of the region.
Default value: 0.7854
Suggested values: 0.0, 0.1, 0.3, 0.6, 0.9, 1.2, 1.5
Typical range of values: 0.0
≤
PhiMax
PhiMax
PhiMax
PhiMax
phiMax
phi_max
≤
6.28
(lin)
Restriction: PhiMax > 0
NumRegionsNumRegionsNumRegionsNumRegionsnumRegionsnum_regions
(input_control) integer →
HTupleintHTupleHtuple (integer) (int / long) (Hlong) (Hlong)
Number of regions.
Default value: 100
Suggested values: 1, 5, 20, 100, 200, 500, 1000, 2000
Typical range of values: 1
≤
NumRegions
NumRegions
NumRegions
NumRegions
numRegions
num_regions
≤
2000
(lin)
Minimum increment: 1
Recommended increment: 10
Restriction: NumRegions > 0
WidthWidthWidthWidthwidthwidth
(input_control) integer →
HTupleintHTupleHtuple (integer) (int / long) (Hlong) (Hlong)
Maximum horizontal expansion.
Default value: 512
Suggested values: 128, 256, 512, 1024
Typical range of values: 1
≤
Width
Width
Width
Width
width
width
≤
1024
(lin)
Minimum increment: 1
Recommended increment: 10
Restriction: Width > 0
HeightHeightHeightHeightheightheight
(input_control) integer →
HTupleintHTupleHtuple (integer) (int / long) (Hlong) (Hlong)
Maximum vertical expansion.
Default value: 512
Suggested values: 128, 256, 512, 1024
Typical range of values: 1
≤
Height
Height
Height
Height
height
height
≤
1024
(lin)
Minimum increment: 1
Recommended increment: 10
Restriction: Height > 0
Result
If the parameter values are correct gen_random_regionsgen_random_regionsGenRandomRegionsGenRandomRegionsGenRandomRegionsgen_random_regions
returns
the value TRUE.
Otherwise an exception is raised.
The clipping according to the current image format is determined by
the operator set_system('clip_region',<'2 (H_MSG_TRUE)'/'3 (H_MSG_FALSE)'>)set_system("clip_region",<"2 (H_MSG_TRUE)"/"3 (H_MSG_FALSE)">)SetSystem("clip_region",<"2 (H_MSG_TRUE)"/"3 (H_MSG_FALSE)">)SetSystem("clip_region",<"2 (H_MSG_TRUE)"/"3 (H_MSG_FALSE)">)SetSystem("clip_region",<"2 (H_MSG_TRUE)"/"3 (H_MSG_FALSE)">)set_system("clip_region",<"2 (H_MSG_TRUE)"/"3 (H_MSG_FALSE)">)
.
Possible Successors
paint_regionpaint_regionPaintRegionPaintRegionPaintRegionpaint_region
Module
Foundation