1.1.1.0 image.rebin

NRAO Home > CASA > CasaDocument

image.rebin - Function

1.1.1 rebin the image by the specified factors
Description

This function rebins the current image by the specified integer binning factors for each axis. The output pixel value is just the average of the input pixel values. The output pixel will be masked bad if there were no good input pixels. You cannot rebin a Stokes axis.

If outfile is given, the image is written to the specified disk file. If outfile is unset, the Image tool is associated with a temporary image. This temporary image may be in memory or on disk, depending on its size. When you destroy the on-the-fly Image tool returned by this function (with the done function) this temporary image is deleted.

Sometimes it is useful to drop axes of length one (degenerate axes). Use the dropdeg argument if you want to do this. It will discard the axes from the input image. Therefore the output shape and Coordinate System that you supply must be consistent with the input image after the degenerate axes are dropped.

Arguments


Inputs
outfile	Output image file name. Default is unset.
	allowed:	string
	Default:
bin	Binning factors for each axis
	allowed:	intArray
	Default:
region	The region of interest. Default is whole image.
	allowed:	any
	Default:	record
mask	OTF mask, Boolean LEL expression or mask region. Default is none.
	allowed:	any
	Default:	variant
dropdeg	Drop degenerate axes
	allowed:	bool
	Default:	false
overwrite	Overwrite (unprompted) pre-existing output file?
	allowed:	bool
	Default:	false
async	Run asynchronously?
	allowed:	bool
	Default:	false

Returns
casaimage

Example

"""
#
print "\t----\t rebin Ex 1 \t----"
ia.maketestimage();
im2 = ia.rebin(bin=[2,3]);
im2.done()
ia.close()
#
"""

[next] [prev] [prev-tail] [front] [up]

Please send any comments or questions about CASA or AIPS++ to aips2-requests@nrao.edu

This code is available under the terms of the GNU General Public Lincense