Syntax
Document.Bin ( Factor )
Parameters
Short Factor - specifies binning to be applied. This parameter must be either 2 or 3.
Returns
Nothing
Remarks
Decreases the size of an image by the specified factor in each dimension by subdividing the original image into two-by-two or three-by-three blocks of pixels, the average of each of which becomes a single pixel in the result. The dimensions of the result image are those of the input image divided by Factor using integer arithmetic.
If values exist for the FITS keywords XBINNING and YBINNING, they are multiplied by Factor. If they did not exist, they are created with value Factor.
This method is equivalent to the Bin 2x2 or Bin 3x3 command, depending on the value of Factor.