whist¶
Syntax: whist(input image, weight, histogram, bin starts, histogram minimum, histogram maximum, bin count, output file, block index)
Calculate weighted histogram of an image.
This command can be used in the distributed processing mode. Use distribute command to change processing mode from local to distributed.
Arguments¶
input image [input]¶
Data type: uint8 image, uint16 image, uint32 image, uint64 image, int8 image, int16 image, int32 image, int64 image, float32 image
Image whose histogram will be calculated.
weight [input]¶
Data type: float32 image
Weight image. This image must contain weight value for each pixel in the input images
histogram [output]¶
Data type: float32 image
Image that will contain the histogram on output. The number of pixels in this image will be set to match bin count.
bin starts [output]¶
Data type: float32 image
Image that will contain the histogram bin start coordinates when the function finishes.
histogram minimum [input]¶
Data type: real
Default value: 0
Minimum value to be included in the histogram. Values less than minimum are included in the first bin.
histogram maximum [input]¶
Data type: real(255), real(65535), real(4294967295), real(1.844674407370955e+19), real(127), real(32767), real(2147483647), real(9.223372036854776e+18), real(3.402823466385289e+38)
Default value: Shown along data types.
The end of the last bin. Values greater than maximum are included in the last bin.
bin count [input]¶
Data type: integer
Default value: 256
Count of bins. The output image will be resized to contain this many pixels.
output file [input]¶
Data type: string
Default value: “”
Name of file where the histogram data is to be saved. Specify empty string to disable saving. This argument is used internally in distributed processing, but can be used to (conveniently?) save the histogram in .raw format.
block index [input]¶
Data type: integer
Default value: -1
Index of image block that we are currently processing. This argument is used internally in distributed processing and should normally be set to negative value. If positive, this number is appended to output file name.