Tool: imager |
tool for synthesis imaging |
|
Method: imager |
Construct an imager tool |
filename |
string |
MeasurementSet to be imaged |
compress |
bool |
Compress calibration columns? |
host |
string |
Host on which to run imager |
forcenewserver |
bool |
Flag to force a new imager client |
|
|
Method: advise |
Advise (and optionally use) parameter values |
pixels |
int |
Number of pixels on a side |
cell |
double |
Recommended maximum cellsize |
facets |
int |
Recommended number of facets on one axis |
phasecenter |
MDirection |
Direction of phase center as a measure |
takeadvice |
bool |
Use the advised values? |
amplitudeloss |
double |
Maximum fractional amplitude loss due to faceting |
fieldofview |
double |
Desired field of view |
|
|
Method: approximatepsf |
Calculate approximate point spread functions |
model |
stringArray |
Names of input models |
psf |
stringArray |
Names of output point spread functions |
async |
bool |
Run asynchronously in the background |
|
|
Method: boxmask |
Construct a mask image from blc, trc |
mask |
string |
name of mask image |
blc |
intArray |
Bottom left corner |
trc |
intArray |
Top right corner, should be image shape |
value |
double |
Value to fill in |
|
|
Method: clean |
Calculate a deconvolved image with selected clean algorithm |
algorithm |
string |
Algorithm to use |
niter |
int |
Number of Iterations, set to zero for no CLEANing |
gain |
double |
Loop Gain for CLEANing |
threshold |
double |
Flux level at which to stop CLEANing |
displayprogress |
bool |
Display the progress of the cleaning? |
model |
stringArray |
Names of clean model images |
keepfixed |
boolArray |
Keep one or more models fixed |
complist |
string |
Name of component list |
mask |
stringArray |
Names of mask images used for CLEANing |
image |
stringArray |
Names of restored images |
residual |
stringArray |
Names of residual images |
interactive |
bool |
whether to stop clean and interactively mask |
npercycle |
int |
If interactive is 'T', then no of iter of clean before stopping, usually a fraction of niter |
masktemplate |
string |
If non empty then will use this image to make the mask the first time |
async |
bool |
Run asynchronously in the background? |
|
|
Method: clipimage |
Zero all pixels where Stokes I is below a threshold |
image |
string |
name of image |
threshold |
double |
Threshold |
|
|
Method: clipvis |
Flag visibilities where residual exceeds a threshold |
threshold |
double |
Threshold |
|
|
Method: close |
Close the imager tool, with data written on disk, keeping imager process running for future use |
|
|
Method: correct |
Correct the MeasurementSet for correctable effects |
doparallactic |
bool |
Do the correction for parallactic angle? |
timestep |
double |
Time step for corrections |
|
|
Method: done |
Terminate the imager process |
|
|
Method: exprmask |
Construct a mask image from a LEL expression |
mask |
string |
name of mask image |
expr |
double |
Value to set the mask to. Any scalar or LEL expression |
|
|
Method: feather |
Feather together an interferometer and a single dish image in the Fourier plane |
image |
string |
Name of output feathered image |
highres |
string |
Name of high resolution (interferometer) image |
lowres |
string |
Name of low resolution (single dish) image |
lowpsf |
string |
Name of optional low resolution point spread function |
async |
bool |
Run asynchronously in the background |
|
|
Method: filter |
Apply additional weighting by filtering (u-v taper) |
type |
string |
Type of filtering or u-v tapering |
bmaj |
double |
Major axis of filter |
bmin |
double |
Minor axis of filter |
bpa |
double |
Position angle of filter |
async |
bool |
Run asynchronously in the background |
|
|
Method: fitpsf |
Fit the point spread function, making psf image first if needed |
bmaj |
double |
Major axis of beam |
bmin |
double |
Minor axis of beam |
bpa |
double |
Position angle of beam |
psf |
string |
Name of input psf |
async |
bool |
Run asynchronously in the background |
|
|
Method: ft |
Fourier transform the specified model and componentlist |
model |
stringArray |
Name of image |
complist |
string |
Name of component list |
incremental |
bool |
Add to the existing MODEL\_DATA column? |
async |
bool |
Run asynchronously in the background? |
|
|
Method: linearmosaic |
Make a linear mosaic of several images |
images |
stringArray |
Input images to be mosaiced |
mosaic |
string |
Output mosaic image |
fluxscale |
string |
Fluxscale image |
sensitivity |
string |
Sensitivity image |
fieldids |
intArray |
output component list after PB has been applied [optional] |
usedefaultvp |
bool |
Use the default vp type? |
vptable |
string |
Voltage pattern table from the vpmanager for detailed specification |
async |
bool |
Run asynchronously in the background |
|
|
Method: make |
Make an empty (i.e. blank) image |
image |
string |
name of output image |
async |
bool |
Run asynchronously in the background |
|
|
Method: makeimage |
Calculate images by gridding, etc. |
type |
string |
Type of output image |
image |
string |
Name of output image |
compleximage |
string |
Name of output complex image |
async |
bool |
Run asynchronously in the background |
|
|
Method: makemodelfromsd |
Make stating model image from a Single Dish image |
sdimage |
string |
Single Dish image |
modelimage |
string |
Name of output image to be used as model |
sdpsf |
string |
PSF of Single Dish if needed |
maskimage |
string |
mask image |
|
|
Method: mask |
Construct a mask image by thresholding an image |
image |
string |
name of template image |
mask |
string |
name of mask image |
threshold |
double |
threshold for mask |
async |
bool |
Run asynchronously in the background |
|
|
Method: mem |
Calculate a deconvolved image with selected mem (maximum entropy) algorithm |
algorithm |
string |
Algorithm to use |
niter |
int |
Number of Iterations |
sigma |
double |
Image sigma to try to achieve |
targetflux |
double |
Target flux for final image |
constrainflux |
bool |
Constrain image to match target flux? else targetflux used only to initialize model |
displayprogress |
bool |
Display the progress of the cleaning? |
model |
stringArray |
Names of model images |
keepfixed |
boolArray |
Keep model fixed |
complist |
string |
Name of component list |
prior |
stringArray |
Names of mem prior images |
mask |
stringArray |
Names of mask images (0=>no emission, 1=>emission permitted |
image |
stringArray |
Names of restored images |
residual |
stringArray |
Names of residual images |
async |
bool |
Run asynchronously in the background? |
|
|
Method: nnls |
Calculate a deconvolved image using the NNLS algorithm |
model |
stringArray |
Name of image |
keepfixed |
boolArray |
Keep model fixed |
complist |
string |
Name of component list |
niter |
int |
Number of Iterations, set to zero for no NNLS |
tolerance |
double |
Tolerance for solution |
fluxmask |
stringArray |
Name of mask for allowed flux |
datamask |
stringArray |
Name of mask for constraint pixels in dirty image |
image |
stringArray |
Names of restored images |
residual |
stringArray |
Names of restored images |
async |
bool |
Run asynchronously in the background |
|
|
Method: open |
Open a new MeasurementSet, for processing, closing current MeasurementSet |
thems |
string |
New MeasurementSet to be processed |
compress |
bool |
Compress calibration columns? |
|
|
Method: pb |
Applies or corrects for a primary beam |
inimage |
string |
Input image to apply beam to |
outimage |
string |
Output image after beam is applied |
incomps |
string |
Input Componentlist table name |
outcomps |
string |
Output Componentlist table name |
operation |
string |
Operation |
pointingcenter |
MDirection |
Pointing center for primary beam application |
parangle |
double |
Parallactic angle for calculation |
pborvp |
string |
Primary Beam or Voltage Pattern |
async |
bool |
Run asynchronously in the background |
|
|
Method: pixon |
Calculate a deconvolved image with the pixon algorithm ({\em experimental |
algorithm |
string |
Algorithm to use |
sigma |
double |
Image sigma to try to achieve |
model |
string |
Name of model image |
async |
bool |
Run asynchronously in the background? |
|
|
Method: plotsummary |
Plot a summary of field and spectral window ids |
|
|
Method: plotuv |
Plot the uv coverage |
rotate |
bool |
Rotate uvw coordinates to specified phase center? |
|
|
Method: plotvis |
Plot the visibility amplitudes as a function of u-v radius (also, see visplot tool |
type |
string |
Type of plot: can contain all, observed, corrected, model, residual |
increment |
int |
Increment in points to plot |
|
|
Method: plotweights |
Plot the visibility weights as a function of u-v radius |
gridded |
bool |
Do gridded plot? |
increment |
int |
Increment in points to plot |
|
|
Method: regionmask |
Construct a mask image from a region |
mask |
string |
name of mask image |
region |
Region |
Region |
value |
double |
Value to set the mask to |
|
|
Method: residual |
Calculate the residual image with respect to current model and component list |
model |
stringArray |
Names of input models |
complist |
string |
Name of component list |
image |
stringArray |
Names of output residual images |
async |
bool |
Run asynchronously in the background |
|
|
Method: restore |
Calculate the restored image with restored model, component list, and residuals |
model |
stringArray |
Names of input model |
complist |
string |
Name of component list |
image |
stringArray |
Names of output restored images |
residual |
stringArray |
Names of residual images |
async |
bool |
Run asynchronously in the background |
|
|
Method: sensitivity |
Calculate rms sensitivity |
pointsource |
double |
Calculated point source sensitivity (Jy/beam) |
relative |
double |
Calculated relative sensitivity |
sumweights |
double |
Calculated sum of weights |
async |
bool |
Run asynchronously in the background |
|
|
Method: setbeam |
Set the beam parameters for clean restoration |
bmaj |
double |
Major axis of beam |
bmin |
double |
Minor axis of beam |
bpa |
double |
Position angle of beam |
async |
bool |
Run asynchronously in the background |
|
|
Method: setdata |
Set the data parameters selection for subsequent processing |
mode |
string |
Type of processing: channel or velocity |
nchan |
intArray |
Number of channels to select |
start |
intArray |
Start channels (0-relative) |
step |
intArray |
Step in channel number |
mstart |
double |
Start velocity (e.g. '20Km/s') |
mstep |
double |
Step in velocity (e.g. '100m/s' |
spwid |
intArray |
Spectral Window Ids (0 relative) to select |
fieldid |
intArray |
Field Ids (0 relative) to select |
msselect |
string |
TQL select string applied as a logical "and" with the other selections |
async |
bool |
Run asynchronously in the background? |
|
|
Method: setimage |
Set the image parameters for subsequent processing |
nx |
int |
Total number of spatial pixels in x |
ny |
int |
Total number of spatial pixels in y |
cellx |
double |
Cellsize in x (e.g. '1arcsec') |
celly |
double |
Cellsize in y (e.g. '1arcsec') |
stokes |
string |
Stokes parameters to image (e.g. 'IQUV') |
doshift |
bool |
Use the specified phase center? T or F |
phasecenter |
MDirection |
Direction of phase center as a measure |
shiftx |
double |
Shift in x (e.g. '23.7arcsec') |
shifty |
double |
Shift in y (e.g. '-54.2arcsec') |
mode |
string |
Type of processing |
nchan |
int |
Number of channels |
start |
int |
Start channel (0-relative) |
step |
int |
Step in channel |
mstart |
MRadialVelocity |
Start velocity |
mstep |
MRadialVelocity |
Step in velocity |
spwid |
intArray |
Spectral Window Ids (0 relative) |
fieldid |
int |
Field Id (0 relative) |
facets |
int |
Number of facets on each axis |
distance |
double |
Distance to object: usually ignore this! (m) |
|
|
Method: setjy |
Compute the model visibility for a specified source flux density |
fieldid |
int |
Field Id (0-relative) |
spwid |
int |
Spectral Window Id. (0-relative) |
fluxdensity |
doubleArray |
Specified flux density (I,Q,U,V) in Jy (lookup the value; use 1.0 if not found) |
standard |
string |
Flux density standard |
|
|
Method: setmfcontrol |
Set various cycle control parameters for multi-field and wide-field imageing. |
cyclefactor |
double |
Cycle threshold = this * max sidelobe * max resid |
cyclespeedup |
double |
Cycle threshold doubles in this number of iterations |
stoplargenegatives |
int |
Stop the multiscale cycle for the first n cycles when a negative comp is found on the largest scale |
stoppointmode |
int |
Stop multiscale altogether if the smallest scale recieves this many consecutive components |
minpb |
double |
Minimum PB level to use |
scaletype |
string |
Image plane flux scale type |
constpb |
double |
In Sault weighting the flux scale is constant above this PB level |
fluxscale |
stringArray |
Names of flux scale images for mosaicing |
|
|
Method: setoptions |
Set some general options for subsequent processing |
ftmachine |
string |
Fourier transform machine |
cache |
int |
Size of gridding cache in complex pixels |
tile |
int |
Size of a gridding tile in pixels (in 1 dimension) |
gridfunction |
string |
Gridding function |
location |
MPosition |
Location used in phase rotations |
padding |
double |
Padding factor in image plane (>=1.0) |
usemodelcol |
bool |
use MODEL\_DATA column or not |
wprojplanes |
int |
No of gridding convolution functions used in wproject-ft machine |
|
|
Method: setscales |
Set the scale sizes for MultiScale Clean |
scalemethod |
string |
Method by which scales are set |
nscales |
int |
Number of scales |
uservector |
doubleArray |
Vector of scale sizes in pixels to use, defaults should be 0,3,10 0.0 3.0 10.0 |
|
|
Method: setsdoptions |
Set some options for single dish processing |
scale |
double |
Scaling applied to single dish data |
weight |
double |
Weights applied to single dish data |
convsupport |
int |
number of pixel for convolution support |
|
|
Method: setvp |
Set the voltage pattern model for subsequent processing |
dovp |
bool |
Do voltage pattern (ie, primary beam) correction |
usedefaultvp |
bool |
Look up the default VP for this telescope and frequency? |
vptable |
string |
If usedefaultvp is false, provide a VP Table made with vpmanager |
dosquint |
bool |
Activate the beam squint in the VP model |
parangleinc |
double |
Parallactice angle increment for squint application |
skyposthreshold |
double |
Sky position threshold |
telescope |
string |
Which default telescope to use; if empty use the one in encoded in MS |
|
|
Method: smooth |
Calculate an image smoothed with a Gaussian beam |
model |
stringArray |
Name of input model |
image |
stringArray |
Name of output smoothed images |
usefit |
bool |
Use the fitted value (rather than that specified |
bmaj |
double |
Major axis of beam |
bmin |
double |
Minor axis of beam |
bpa |
double |
Position angle of beam |
normalize |
bool |
Normalize volume of psf to unity |
async |
bool |
Run asynchronously in the background |
|
|
Method: stop |
stop the currently executing function asap |
|
|
Method: summary |
Summarize the current state of the imager tool |
|
|
Method: uvrange |
Select data within the limit of a given range |
uvmin |
double |
Minimum uv distance allowed (wavelengths) |
uvmax |
double |
Maximum uv distance allowed (wavelengths) |
|
|
Method: weight |
Apply additional weighting to the visibility weights |
type |
string |
Type of weighting |
rmode |
string |
Mode of briggs weighting |
noise |
double |
Noise used in absolute briggs weighting |
robust |
double |
Parameter in briggs weighting |
fieldofview |
double |
Field of view for uniform weighting |
npixels |
int |
Number of pixels in the u and v directions |
mosaic |
bool |
Individually weight the fields of a mosaic |
async |
bool |
Run asynchronously in the background |
|
|