Tool: image Operations on images
Method: image Construct an image tool from an \aipspp\ image file
infile string Input image file name
Method: addnoise Add noise to the image
type string Type of distribution, normal
pars doubleArray Parameters of distribution
region any Region of interest
zero bool Zero image first ?
Method: imagecalc Construct an \aipspp\ image via the image calculator
outfile string Output image file name
pixels string LEL expression
overwrite bool Overwrite (unprompted) pre-existing output file ?
Method: imageconcat Construct an \aipspp\ image by concatenating images
outfile string Output image file name
infiles stringArray List of input \aipspp\ image files to concatenate; wild cards accepted
axis int Concatenation pixel axis, spectral axis if there is one
relax bool Relax constraints that axis coordinate descriptors match
tempclose bool Keep all lattices closed until needed
overwrite bool Overwrite (unprompted) pre-existing output file ?
Method: imagefromarray Construct an \aipspp\ image from a Glish array
outfile string Output image file name
pixels any Numeric array
csys any Coordinate System
linear bool Make a linear Coordinate System if csys not given
overwrite bool Overwrite (unprompted) pre-existing output file ?
log bool Write image creation messages to logger
Method: imagefromascii Construct an \aipspp\ image by conversion from an ascii file
outfile string Output image file name
infile string Input ascii disk file name
shape intArray Shape of image
sep string Separator in ascii file
csys any Coordinate System
linear bool Make a linear Coordinate System if csys not given
overwrite bool Overwrite (unprompted) pre-existing output file ?
Method: imagefromfits Construct an \aipspp\ image by conversion from a FITS image file
outfile string Output image file name
infile string Input FITS disk file name
whichrep int If this FITS file contains multiple coordinate representations, which one should we read
whichhdu int If this FITS file contains multiple images, which one should we read
zeroblanks bool If there are blanked pixels, set them to zero instead of NaN
overwrite bool Overwrite (unprompted) pre-existing output file ?
old bool Use old non-WCS based FITS parser?
Method: imagefromforeign Construct an \aipspp\ image from a foreign package image file
outfile string Output image file name
infile string Input foreign image disk file name
format string Format type, 'miriad or gipsy
overwrite bool Overwrite (unprompted) pre-existing output file ?
Method: imagefromimage Construct a (sub)image from a region of an \aipspp\ image
outfile string Output sub-image file name
infile string Input image file name
region any The region of interest
mask any OTF mask, Boolean LEL expression or mask region
dropdeg bool Drop degenerate axes
overwrite bool Overwrite (unprompted) pre-existing output file ?
Method: imagefromshape Construct an empty \aipspp\ image from a shape
outfile string Name of output image file
shape intArray Shape of image
csys any Coordinate System
linear bool Make a linear Coordinate System if csys not given ?
overwrite bool Overwrite (unprompted) pre-existing output file ?
log bool Write image creation messages to logger
Method: imagemaketestimage Construct an \aipspp\ image from a test FITS file
outfile unknown Output image file name
Method: adddegaxes Add degenerate axes of the specified type to the image
outfile string Output image file name
direction bool Add direction axes ?
spectral bool Add spectral axis ?
stokes string Add Stokes axis ?, Stokes
linear bool Add linear axis ?
tabular bool Add tabular axis ?
overwrite bool Overwrite (unprompted) pre-existing output file ?
Method: convolve Convolve image with a Glish array or another image
outfile string Output image file name
kernel any Convolution kernel - array or image filename
scale double Scale factor
region any Region of interest
mask any OTF mask, Boolean LEL expression or mask region
overwrite bool Overwrite (unprompted) pre-existing output file ?
async bool Run asynchronously?
Method: boundingbox Get the bounding box of the specified region
region any The region of interest
Method: brightnessunit Get the image brightness unit
Method: calc Image calculator
pixels string LEL expression
Method: calcmask Image mask calculator
mask any Boolean LEL expression or mask region
name string Mask name
asdefault bool Make specified mask the default mask ?
Method: close Close the image tool
Method: continuumsub Image plane continuum subtraction
outline string Output line image filename
outcont string Output continuum image filename
region any Region over which continuum subtraction is desired
channels intArray Channels to use for continuum estimation
pol string Polarization to process
fitorder int Polynomial order for continuum estimation
overwrite bool Auto-overwrite output files if they exist?
Method: convertflux Convert flux density between peak and integral
value double Flux density to convert
major double Major axis of component
minor double Minor axis of component
type string Type of component
topeak bool Convert to peak or integral flux desnity
Method: convertsm Convert image for older versions
outfile string Output file name
overwrite bool Overwrite output file if already exists ?
Method: convolve2d Convolve image by a 2D kernel
outfile string Output image file name
axes intArray Axes to convolve
type string Type of convolution kernel
major double Major axis, Quantity, string, numeric
minor double Minor axis, Quantity, string, numeric
pa double Position Angle, Quantity, string, numeric
scale double Scale factor
region any Region of interest
mask any OTF mask, Boolean LEL expression or mask region
overwrite bool Overwrite (unprompted) pre-existing output file ?
async bool Run asynchronously?
Method: coordsys Get the Coordinate System of the image
axes intArray Axes to which the Coordinate System pertains
Method: csys Get the Coordinate System of the image
axes intArray Axes to which the Coordinate System pertains
Method: coordmeasures Convert from pixel to world coordinate wrapped as Measures
intensity double Returned intensity quantity for pixel
direction any Returned direction measure for pixel
frequency double Returned frequency measure for pixel
velocity string Returned radial velocity measure for pixel
pixel doubleArray Absolute pixel coordinate
Method: decompose Separate a complex image into individual components
region any
mask any Boolean LEL expression or mask region
simple bool Skip contour deblending and scan for local maxima
threshold double Value of minimum contour, > 0.0
ncontour int Number of contours to use in deblending, >= 2
minrange int Minimum number of closed contours in a component, > 0
naxis int Max number of perpendicular steps between contiguous pixels
fit bool Fit to the components after deblending?
maxrms double Maximum RMS of fit residuals to not retry fit, > 0
maxretry int Maximum number of times to retry the fit; >= 0
maxiter int Maximum number of iterations allowed in a single fit, > 0
convcriteria double Criterion to establish convergence, >=0
Method: deconvolvecomponentlist Deconvolve a componentlist from the restoring beam
complist any Componentlist to deconvolve
Method: remove Delete the image file associated with this image tool
done bool Destroy this tool after deletion
Method: done Destroy this image tool
remove bool Delete disk file as well ?
Method: fft FFT the image
real string Output real image file name
imag string Output imaginary image file name
amp string Output amplitude image file name
phase string Output phase image file name
axes intArray Specify pixel axes to FFT
region any The region of interest
mask any OTF mask, Boolean LEL expression or mask region
Method: findsources Find point sources in the sky
nmax int Maximum number of sources to find, > 0
cutoff double Fractional cutoff level
region any The 2-D region of interest to fit
mask any OTF mask, Boolean LEL expression or mask region
point bool Find only point sources ?
width int Half-width of fit grid when point=F
negfind bool Find negative sources as well as positive ?
Method: fitallprofiles Fit all 1-dimensional profiles in a region
region any The region of interest
axis int The profile axis, default is spectral axis
mask any OTF mask, Boolean LEL expression or mask region
ngauss int Number of Gaussian elements
poly int Order of polynomial element
sigma string Weights image
fit string Output fitted image file name
resid string Output fitted residuals image file name
Method: fitprofile Fit 1-dimensional profile with functional forms
values doubleArray Output fitted or estimated profile
resid doubleArray Output residual profile
region any The region of interest
axis int The profile axis, spectral axis is default
mask any OTF mask, Boolean LEL expression or mask region
estimate any Initial estimate
ngauss int Number of Gaussian elements
poly int Order of polynomial element
fit bool Do fit or get estimate
sigma string Weights image
Method: fitpolynomial Fit 1-dimensional polynomials to profiles
residfile string Output fitted residuals image file name
fitfile string Output fitted image file name
sigmafile string Input weights image for fitting
axis int The profile axis to fit, Spectral axis if exists else last
order int The order of the polynomial
region any The region of interest
mask any OTF mask, Boolean LEL expression or mask region
overwrite bool Overwrite (unprompted) pre-existing output files ?
Method: fitsky Fit 2-dimensional models to the sky
pixels any Output residual pixels
pixelmask any Output mask of region
converged bool Did the fit converge ?
region any The 2-D region of interest to fit
mask any OTF mask, Boolean LEL expression or mask region
models stringArray The model types to fit simultaneously, gaussian
estimate any Initial estimate for the model, componetlist
fixedparams stringArray Parameters to hold fixed per model, String or vector of strings, one per model. Choose from ``fxyabp''
includepix doubleArray Range of pixel values to include
excludepix doubleArray Range of pixel values to exclude
fit bool Do fit or get estimate
deconvolve bool Deconvolve from restoring beam
list bool List informative messages to the logger
Method: getchunk Get the pixel values from a regular region of the image into a Glish array
blc intArray Bottom-Left-Corner (beginning) of pixel section
trc intArray Top-Right-Corner (end) of pixel section
inc intArray increment (stride) along axes
axes intArray Axes to average over, > 0
list bool List bounding box to logger ?
dropdeg bool Drop degenerate axes ?
getmask bool Get the pixel mask as well
Method: getregion Get pixels and mask from a region-of-interest of the image
region any The region of interest
axes intArray Axes to average over, > 0
mask any OTF mask, Boolean LEL expression or mask region
list bool List the bounding box to the logger
dropdeg bool Drop degenerate axes
getmask bool Get the pixel mask as well
Method: getslice Get 1-D slice from the image
x doubleArray Polyline x vertices in absolute pixel coordinates
y doubleArray Polyline y vertices in absolute pixel coordinates
axes intArray Pixel axes of plane holding slice
coord intArray Specify pixel coordinate for other axes
npts int Number of points in slice
method string The interpolation method, String from 'nearest', 'linear', 'cubic'
Method: hanning Convolve one axis of image with a Hanning kernel
outfile string Output image file name
region any Region of interest
mask any OTF mask, Boolean LEL expression or mask region
axis int Axis to convolve, > 0, spectral axis if there is one is default
drop bool Drop every other pixel on output ?
overwrite bool Overwrite (unprompted) pre-existing output file ?
async bool Run asynchronously?
Method: haslock Does this image have any locks set ?
Method: histograms Compute histograms from the image
histout any record containing the histograms
axes intArray List of axes to compute histograms over
region any Region of interest
mask any OTF mask, Boolean LEL expression or mask region
nbins int Number of bins in histograms, > 0
includepix doubleArray Range of pixel values to include
gauss bool If T overlay a Gaussian on each histogram
cumu bool If T plot cumulative histograms, otherwise plot non-cumulatively
log bool If T plot the ordinate logarithmically, otherwise plot linearly
list bool If T then list some statistics as well
plotter string The PGPLOT device name to make plots on
nx int The number of subplots per page in the x direction, > 1
ny int The number of subplots per page in the y direction; > 0
size intArray Size of plotter
force bool If T then force the stored statistical accumulations to be regenerated
disk bool If T then force the storage image to disk
async bool Run asynchronously?
Method: history Recover and/or list the history file
list bool List history to the logger ?
browse bool Browse history with table browser?
Method: insert Insert specified image into this image
infile string Image file name or Image tool to insert
region any The region of interest of the input image
locate doubleArray Location of input image in output image
Method: isopen Is this Image \tool\ open ?
Method: ispersistent Is the image persistent ?
Method: lock Acquire a lock on the image
writelock bool Acquire a read/write (T) or a readonly (F) lock
nattempts int Number of attempts, > 0
Method: makecomplex Make a complex image
outfile string Output Complex (disk) image file name
imag string Imaginary image file name
region any The region of interest
overwrite bool Overwrite (unprompted) pre-existing output file ?
Method: maskhandler Handle pixel masks
op string The operation
name stringArray Name of mask or masks
Method: miscinfo Get the miscellaneous information record from an image
Method: modify Modify image with a model
model any The model ComponentList
region any The 2-D region of interest
mask any OTF mask, Boolean LEL expression or mask region
subtract bool Subtract or add the model
list bool List informative messages to the logger
async bool Run asynchronously?
Method: maxfit Find maximum and do parabolic fit in the sky
region any The 2-D region of interest to fit
point bool Find only point sources ?
width int Half-width of fit grid when point=F
negfind bool Find negative sources as well as positive ?
list bool List the fitted parameters to the logger ?
Method: moments Compute moments from an image
moments intArray List of moments that you would like to compute
axis int The moment axis, > 0
region any Region of interest
mask any OTF mask, Boolean LEL expression or mask region
method stringArray List of windowing and/or fitting functions you would like to invoke Don't invoke the window or fit functions, and don't invoke any interactive functions
smoothaxes intArray List of axes to smooth
smoothtypes stringArray List of smoothing kernel types, one for each axis to smooth
smoothwidths double List of widths (full width for boxcar, full width at half maximum for gaussian, 3 for Hanning) in pixels for the smoothing kernels Vector of numeric, quantity or string
includepix doubleArray Range of pixel values to include
excludepix doubleArray Range of pixel values to exclude
peaksnr double The SNR ratio below which the spectrum will be rejected as noise (used by the window and fit functions only)
stddev double Standard deviation of the noise signal in the image (used by the window and fit functions only), > 0
doppler string Velocity doppler definition for velocity computations along spectral axes
outfile string Output image file name (or root for multiple moments)
smoothout string Output file name for convolved image
plotter string The PGPLOT device name to make plots on
nx int The number of subplots per page in the x direction; > 0
ny int The number of subplots per page in the y direction, > 0
yind bool Scale the y axis of the profile plots independently
overwrite bool Overwrite (unprompted) pre-existing output file ?
drop bool Drop moments axis from output images ?
async bool Run asynchronously?
Method: name Name of the image file this tool is attached to
strippath bool Strip off the path before the actual file name ?
Method: open Open a new image file with this image tool
infile string image file name
Method: pixelvalue Get value of image and mask at specified pixel coordinate
pixel intArray Pixel coordinate
Method: putchunk Put pixels from a Glish array into a regular region of the image
pixels any Numeric array
blc intArray Bottom-Left-Corner (start) of location in image
inc intArray increment (stride) along axes
list bool List bounding box to logger ?
locking bool Unlock image after use ?
replicate bool Replicate array through image
Method: putregion Put pixels and mask into a region-of-interest of the image
pixels any The pixel values
pixelmask any The pixel mask values
region any The region of interest
list bool List the bounding box and any mask creation to the logger
usemask bool Honour the mask when putting pixels
locking bool Unlock image after use ?
replicate bool Replicate array through image
Method: rebin rebin the image by the specified factors
outfile string Output image file name
bin intArray Binning factors for each axis
region any The region of interest
mask any OTF mask, Boolean LEL expression or mask region
dropdeg bool Drop degenerate axes
overwrite bool Overwrite (unprompted) pre-existing output file ?
async bool Run asynchronously?
Method: regrid regrid this image to the specified Coordinate System
outfile string Output image file name
shape intArray Shape of output image
csys any Coordinate System for output image
axes intArray The output pixel axes to regrid
region any The region of interest
mask any OTF mask, Boolean LEL expression or mask region
method string The interpolation method
decimate int Decimation factor for coordinate grid computation
replicate bool Replicate image rather than regrid ?
doref bool Turn on reference frame changes
dropdeg bool Drop degenerate axes
overwrite bool Overwrite (unprompted) pre-existing output file ?
force bool Force specified axes to be regridded
async bool Run asynchronously?
Method: rotate rotate the direction coordinate axes attached to the image and regrid the image to the rotated Coordinate System
outfile string Output image file name
shape intArray Shape of output image
pa double Angle by which to rotate
region any The region of interest
mask any OTF mask, Boolean LEL expression or mask region
method string The interpolation method
decimate int Decimation factor for coordinate grid computation
replicate bool Replicate image rather than regrid ?
overwrite bool Overwrite (unprompted) pre-existing output file ?
async bool Run asynchronously?
Method: rename Rename the image file associated with this image tool
name string The new image file name
overwrite bool Overwrite target file if it already exists
Method: replacemaskedpixels replace the values of pixels which are masked bad
pixels any The new value(s), Numeric scalar or LEL expression
region any The region of interest
mask any OTF mask, Boolean LEL expression or mask region
update bool Update mask as well ?
list bool List the bounding box to the logger
Method: restoringbeam Get the restoringbeam
Method: sepconvolve Separable convolution
outfile string Output image file name
axes intArray Axes to convolve
types stringArray Type of convolution kernel
widths double Convolution kernel widths, Vector of numeric, quantity or string
scale double Scale factor
region any Region of interest
mask any OTF mask, Boolean LEL expression or mask region
overwrite bool Overwrite (unprompted) pre-existing output file ?
async bool Run asynchronously?
Method: set Set pixel and/or mask values with a scalar in a region-of-interest of the image
pixels any The pixel value, LEL scalar expression or numeric scalar
pixelmask int The pixel mask value
region any The region of interest
list bool List the bounding box and any mask creation to the logger
Method: setbrightnessunit Set the image brightness unit
unit string New brightness unit
Method: setcoordsys Set new Coordinate System
csys any Coordinate System
Method: sethistory Set the history for an image
history stringArray New history
Method: setmiscinfo Set the miscellaneous information record for an image
info any Miscellaneous REPLACEMENT header
Method: shape Length of each axis in the image
Method: setrestoringbeam Set the restoringbeam
major any Major axis FWHM, Quantity or float
minor any Minor axis FWHM, Quantity or float
pa any Position angle, Quantity or float
beam any The complete restoring beam
remove bool Delete the restoring beam
log bool Write new beam values to the logger
Method: statistics Compute statistics from the image
statsout any record containing all statistics
axes intArray List of axes to evaluate statistics over
region any Region of interest
mask any OTF mask, Boolean LEL expression or mask region
plotstats stringArray List of statistics to plot String containing any combination of 'npts', 'sum', 'flux', 'sumsq', 'min', 'max', 'mean', 'sigma' (or 'stddev'), 'rms', 'median', 'medabsdevmed', 'quartile'
includepix doubleArray Range of pixel values to include
excludepix doubleArray Range of pixel values to exclude
plotter string The PGPLOT device name to make plots on
nx int The number of subplots per page in the x direction, > 0
ny int The number of subplots per page in the y direction, > 0
list bool If T then list the statistics as well
force bool If T then force the stored statistical accumulations to be regenerated
disk bool If T then force the storage image to disk
robust bool If T then compute robust statistics as well
verbose bool If T then print useful messages to the logger
async bool Run asynchronously?
Method: twopointcorrelation Compute two point correlation function from the image
outfile string Output image file name
region any The region of interest
mask any OTF mask, Boolean LEL expression or mask region
axes intArray The pixel axes to compute structure function over
method string The method of computation
overwrite bool Overwrite (unprompted) pre-existing output file ?
Method: subimage Create a (sub)image from a region of the image
outfile string Output image file name
region any Region of interest
mask any OTF mask, Boolean LEL expression or mask region
dropdeg bool Drop degenerate axes
overwrite bool Overwrite (unprompted) pre-existing output file ?
list bool List informative messages to the logger
Method: summary Summarize basic information about the image
header any Header information
doppler string If there is a spectral axis, list velocity too, with this doppler definition
list bool List the summary to the logger
pixelorder bool List axis descriptors in pixel or world axis order
Method: tofits Convert the image to a FITS file
outfile string FITS file name
velocity bool prefer velocity (rather than frequency) as primary spectral axis?
optical bool use the optical (rather than radio) velocity convention?
bitpix int Bits per pixel, -32 (floating point) or 16 (integer)
minpix double Minimum pixel value for BITPIX=16, -1 autoscales
maxpix double Maximum pixel value for BITPIX=16, -1 autoscales
region any The region of interest
mask any OTF mask, Boolean LEL expression or mask region
overwrite bool Overwrite (unprompted) pre-existing output file ?
dropdeg bool Drop degenerate axes ?
deglast bool Put degenerate axes last in header ?
async bool Run asynchronously?
Method: toASCII Convert the image to an ascii file
outfile string Ascii file name
region any The region of interest
mask any OTF mask, Boolean LEL expression or mask region
sep string Separator of data in ascii file
format string Format of data in ascii file
maskvalue double Value to replace masked pixels by, -999 is unset
overwrite bool Overwrite (unprompted) pre-existing output file ?
Method: type Return the type of this tool
Method: topixel Convert from world to pixel coordinate
value any Absolute world coordinate, Numeric vector, vector of quantities or record
Method: toworld Convert from pixel to world coordinate
value doubleArray Absolute pixel coordinate
format string What type of formatting ? String from combination of 'n' (numeric), 'q' (quantity), 'm' (measure), 's' (string)
Method: unlock Release any lock on the image

-- WesYoung - 17 Jul 2006
Topic revision: r1 - 2006-07-17, WesYoung
This site is powered by FoswikiCopyright © by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding NRAO Public Wiki? Send feedback