|
casa
$Rev:20696$
|
|
casa
$Rev:20696$
|
Public Member Functions | |
| def | __init__ |
| def | open |
| def | reopen |
| def | close |
| def | done |
| def | summary |
| def | boxmask |
| def | regionmask |
| def | clipimage |
| def | clarkclean |
| def | fullclarkclean |
| def | dirtyname |
| def | psfname |
| def | make |
| def | convolve |
| def | makegaussian |
| def | state |
| def | updatestate |
| def | clean |
| def | setscales |
| def | ft |
| def | restore |
| def | residual |
| def | smooth |
| def | mem |
| def | makeprior |
| def | mtopen |
| def | mtclean |
| def | mtrestore |
| def | mtcalcpowerlaw |
Public Attributes | |
| this | |
Static Private Attributes | |
| dictionary | __swig_setmethods__ |
| tuple | __setattr__ |
| dictionary | __swig_getmethods__ |
| tuple | __getattr__ |
| __repr__ | |
| __swig_destroy__ | |
| __del__ | |
Proxy of C++ casac::deconvolver class
Definition at line 70 of file deconvolver.py.
| def __casac__.deconvolver.deconvolver.__init__ | ( | self | ) |
__init__(self) -> deconvolver
Definition at line 77 of file deconvolver.py.
| def __casac__.deconvolver.deconvolver.boxmask | ( | self, | |
| args, | |||
| kwargs | |||
| ) |
boxmask(self, mask=string(""), blc=initialize_vector(1, (int)-1), trc=initialize_vector(1, (int)-1),
fillvalue=initialize_variant("1.0Jy"), outsidevalue=initialize_variant("0.0Jy")) -> bool
Summary
Construct a mask from blc, trc
Input Parameters:
mask name of mask image
blc Bottom left corner -1
trc Top right corner -1
fillvalue Value to fill in 1.0Jy
outsidevalue outside value 0.0Jy
--------------------------------------------------------------------------------Definition at line 145 of file deconvolver.py.
| def __casac__.deconvolver.deconvolver.clarkclean | ( | self, | |
| args, | |||
| kwargs | |||
| ) |
clarkclean(self, niter=1000, gain=0.1, threshold=initialize_variant("0Jy"), displayprogress=False,
model=string(""), mask=string(""), histbins=500, psfpatchsize=initialize_vector(2,(int)51, (int)51),
maxextpsf=0.2, speedup=0.0, maxnumpix=10000, maxnummajcycles=-1,
maxnumminoriter=-1) -> bool
Summary
Make a clean image using the Clark Clean
a threshold
Input Parameters:
niter Number of iterations 1000
gain Loop Gain for CLEANing 0.1
threshold Flux level at which to stop CLEANing 0Jy
displayprogress Display the progress of the cleaning? false
model Name of images
mask Name of mask images used for CLEANing
histbins Number of bins in the pixel-flux histogram 500
psfpatchsize Size of PSF for minor cycle 51 51
maxextpsf maximum external sidelobe, used to set depth of minor cycle clean 0.2
speedup Cleaning speedup exponent 0.0
maxnumpix Maximum number of pixels used in each minor cycle 10000
maxnummajcycles Max number of major cycles; -1 = no restrictions -1
maxnumminoriter Max number of minor iterations; -1 = no restrictions -1
--------------------------------------------------------------------------------Definition at line 201 of file deconvolver.py.
| def __casac__.deconvolver.deconvolver.clean | ( | self, | |
| args, | |||
| kwargs | |||
| ) |
clean(self, algorithm=string("hogbom"), niter=1000, gain=0.1, threshold=initialize_variant("0Jy"),
displayprogress=False, model=string(""), mask=string(""), async=False) -> record *
Summary
Make a clean image with Hogbom or MultiScale Clean
Input Parameters:
algorithm Algorithm to use fullmsclean msclean hogbom
niter Number of Iterations, set to zero for no CLEANing 1000
gain Loop Gain for CLEANing, try 0.7 for msclean or fullmsclean 0.1
threshold Flux level at which to stop CLEANing 0Jy
displayprogress Display progress false
model Name of images
mask Name of mask images used for CLEANing
async Run asynchronously in the background? false
--------------------------------------------------------------------------------Definition at line 357 of file deconvolver.py.
| def __casac__.deconvolver.deconvolver.clipimage | ( | self, | |
| args, | |||
| kwargs | |||
| ) |
clipimage(self, clippedimage=string(""), inputimage=string(""), threshold=initialize_variant("0.0Jy")) -> bool
Summary
Zero all pixels where Stokes I is below
a threshold
Input Parameters:
clippedimage name of clipped image
inputimage name of input image
threshold Threshold 0.0Jy
--------------------------------------------------------------------------------Definition at line 183 of file deconvolver.py.
| def __casac__.deconvolver.deconvolver.close | ( | self | ) |
close(self) -> bool Summary Close the deconvolver tool --------------------------------------------------------------------------------
Definition at line 112 of file deconvolver.py.
| def __casac__.deconvolver.deconvolver.convolve | ( | self, | |
| args, | |||
| kwargs | |||
| ) |
convolve(self, convolvemodel=string(""), model=string("")) -> bool
Summary
Convolves an image with the PSF
Input Parameters:
convolvemodel Name of the output image on the disk to hold the result of the convolution
model The input image to be convolved with the PSF
--------------------------------------------------------------------------------Definition at line 292 of file deconvolver.py.
| def __casac__.deconvolver.deconvolver.dirtyname | ( | self | ) |
dirtyname(self) -> string Summary Return the name of the dirty-image table --------------------------------------------------------------------------------
Definition at line 254 of file deconvolver.py.
| def __casac__.deconvolver.deconvolver.done | ( | self | ) |
done(self) -> bool Summary Terminate the deconvolver process --------------------------------------------------------------------------------
Definition at line 123 of file deconvolver.py.
| def __casac__.deconvolver.deconvolver.ft | ( | self, | |
| args, | |||
| kwargs | |||
| ) |
ft(self, model=string(""), transform=string(""), async=False) -> bool
Summary
Fourier transform the specified model
Input Parameters:
model Name of image
transform Name of transform image
async Run asynchronously in the background? false
--------------------------------------------------------------------------------Definition at line 397 of file deconvolver.py.
| def __casac__.deconvolver.deconvolver.fullclarkclean | ( | self, | |
| args, | |||
| kwargs | |||
| ) |
fullclarkclean(self, niter=1000, gain=0.1, threshold=initialize_variant("0Jy"), model=string(""), mask=string(""),
cyclefactor=1.5) -> record *
Summary
Make a clean image using the Clark Clean
a threshold
Input Parameters:
niter Number of iterations 1000
gain Loop Gain for CLEANing 0.1
threshold Flux level at which to stop CLEANing 0Jy
model Name of model image that will contain the clean components
mask Name of mask image used for CLEANing
cyclefactor Factor to determine how deep to go in a Clark minor cycle 1.5
--------------------------------------------------------------------------------Definition at line 232 of file deconvolver.py.
| def __casac__.deconvolver.deconvolver.make | ( | self, | |
| args, | |||
| kwargs | |||
| ) |
make(self, image=string(""), async=False) -> bool
Summary
Make an empty image
Input Parameters:
image Name of the new image on the disk
async Run asynchronously in the background? false
--------------------------------------------------------------------------------Definition at line 276 of file deconvolver.py.
| def __casac__.deconvolver.deconvolver.makegaussian | ( | self, | |
| args, | |||
| kwargs | |||
| ) |
makegaussian(self, gaussianimage=string(""), bmaj=initialize_variant("0rad"), bmin=initialize_variant("0rad"),
bpa=initialize_variant("0deg"), normalize=True, async=False) -> bool
Summary
Make an image with a single gaussian
component
Input Parameters:
gaussianimage Name of the output image on the disk
bmaj The major axis of the gaussian 0rad
bmin The minor axis of the gaussian 0rad
bpa The Position Angle of the gaussian 0deg
normalize Normalize the area under the gaussian to 1.0? true
async Run asynchronously in the background? false
--------------------------------------------------------------------------------Definition at line 308 of file deconvolver.py.
| def __casac__.deconvolver.deconvolver.makeprior | ( | self, | |
| args, | |||
| kwargs | |||
| ) |
makeprior(self, prior=string(""), templateimage=string(""), lowclipfrom=initialize_variant("0.0Jy"),
lowclipto=initialize_variant("0.0Jy"), highclipfrom=initialize_variant("9e20Jy"),
highclipto=initialize_variant("9e20Jy"), blc=initialize_vector(1, (int)-1),
trc=initialize_vector(1, (int)-1), async=False) -> bool
Summary
Make the mem's prior image, or make a mask
Input Parameters:
prior output prior image
templateimage starting point for prior image
lowclipfrom Clip any pixel below this level 0.0Jy
lowclipto Any clipped pixel will be given this value 0.0Jy
highclipfrom Clip any pixel above this level 9e20Jy
highclipto Any clipped pixel will be given this value 9e20Jy
blc Bottom left hand corner for box; outside box is clipped -1
trc Top right hand corner for box; outside box is clipped -1
async Run asynchronously in the background? false
--------------------------------------------------------------------------------Definition at line 501 of file deconvolver.py.
| def __casac__.deconvolver.deconvolver.mem | ( | self, | |
| args, | |||
| kwargs | |||
| ) |
mem(self, entropy=string("entropy"), niter=20, sigma=initialize_variant("0.001Jy"), targetflux=initialize_variant("1.0Jy"),
constrainflux=False, displayprogress=False,
model=string(""), prior=string(""), mask=string(""), imageplane=False, async=False) -> bool
Summary
Make the mem image
Input Parameters:
entropy entropy to use emptiness entropy
niter Number of Iterations, set to zero for no MEMing 20
sigma Noise level to try to achieve 0.001Jy
targetflux Total image flux to try to achieve 1.0Jy
constrainflux Use targetflux as a constraint? (or starting flux) false
displayprogress Display progress false
model Name of input/output model image
prior Name of prior (default) image used for mem
mask Mask image restricting emission (all pixels 0 or 1)
imageplane Is this an image plane problem (like single dish)? false
async Run asynchronously in the background? false
--------------------------------------------------------------------------------Definition at line 474 of file deconvolver.py.
| def __casac__.deconvolver.deconvolver.mtcalcpowerlaw | ( | self, | |
| args, | |||
| kwargs | |||
| ) |
mtcalcpowerlaw(self, images=std::vector< string >(1, ""), residuals=std::vector< string >(1, ""), alphaname=string(""),
betaname=string(""), threshold=initialize_variant("0.0Jy"),
calcerror=False, async=False) -> bool
Summary
Interpret Taylor coefficients as a power law, and compute spectral index
Input Parameters:
images Input : Names of input restored images
residuals Input : Names of input residuals images ( for error calcs )
alphaname Output : Name of output spectral-index image
betaname Output : Name of output spectral-curvature image
threshold Threshold 0.0Jy
calcerror Calculate an error image for spectral index false
async Run asynchronously in the background false
--------------------------------------------------------------------------------Definition at line 593 of file deconvolver.py.
| def __casac__.deconvolver.deconvolver.mtclean | ( | self, | |
| args, | |||
| kwargs | |||
| ) |
mtclean(self, residuals=std::vector< string >(1, ""), models=std::vector< string >(1, ""), niter=1000,
gain=0.1, threshold=initialize_variant("0Jy"), displayprogress=False,
mask=string(""), async=False) -> record *
Summary
Make a series of images using a Multi-Term Clean algorithm
Input Parameters:
residuals Input : List of names of N residual images
models Output : List of names of N model images
niter Number of Iterations, set to zero for no CLEANing 1000
gain Loop Gain for CLEANing, try 0.7 for msclean or fullmsclean 0.1
threshold Flux level at which to stop CLEANing 0Jy
displayprogress Display progress false
mask Name of mask images used for CLEANing
async Run asynchronously in the background? false
--------------------------------------------------------------------------------Definition at line 546 of file deconvolver.py.
| def __casac__.deconvolver.deconvolver.mtopen | ( | self, | |
| args, | |||
| kwargs | |||
| ) |
mtopen(self, ntaylor=2, scalevector=initialize_vector(3,(double)0.0, (double)3.0, (double)10.0),
psfs=std::vector< string >(1, ""), async=False) -> bool
Summary
Init : Make a series of images using a Multi-Term Clean algorithm
Input Parameters:
ntaylor Number of terms in the taylor polynomial 2
scalevector Vector of scale sizes to use 0.0 3.0 10.0
psfs Intpu : List of names of 2N-1 psfs. This is valid only for a Taylor-polynomial model.
async Run asynchronously in the background? false
--------------------------------------------------------------------------------Definition at line 527 of file deconvolver.py.
| def __casac__.deconvolver.deconvolver.mtrestore | ( | self, | |
| args, | |||
| kwargs | |||
| ) |
mtrestore(self, models=std::vector< string >(1, ""), residuals=std::vector< string >(1, ""), images=std::vector< string >(1, ""),
bmaj=initialize_variant("0rad"), bmin=initialize_variant("0rad"),
bpa=initialize_variant("0deg"), async=False) -> bool
Summary
Restore the Multi-Term residuals
Input Parameters:
models Input : Name of input model
residuals Input : Name of residual image
images Output : Name of output restored image
bmaj Major axis of beam 0rad
bmin Minor axis of beam 0rad
bpa 0deg Position angle of beam
async Run asynchronously in the background false
--------------------------------------------------------------------------------Definition at line 570 of file deconvolver.py.
| def __casac__.deconvolver.deconvolver.open | ( | self, | |
| args, | |||
| kwargs | |||
| ) |
open(self, dirty=string(""), psf=string(""), warn=True) -> bool
Summary
Open a new dirty image and PSF
Input Parameters:
dirty Dirty image to be processed
psf point spread function to be processed
warn Produce warning messages if psf is not provided true
--------------------------------------------------------------------------------Definition at line 84 of file deconvolver.py.
| def __casac__.deconvolver.deconvolver.psfname | ( | self | ) |
psfname(self) -> string Summary Return the name of the PSF-image table --------------------------------------------------------------------------------
Definition at line 265 of file deconvolver.py.
| def __casac__.deconvolver.deconvolver.regionmask | ( | self, | |
| args, | |||
| kwargs | |||
| ) |
regionmask(self, mask=string(""), region=initialize_record(""), boxes=initialize_variant(""), value=1.0) -> bool
Summary
Construct a mask image from a region
Input Parameters:
mask name of mask image
region Region record usually from regionmanager unset
boxes list of 4 elements lists e.g [[xblc1, yblc1, xtrc1, ytrc1], [[xblc2, yblc2, xtrc2, ytrc2]]
value Value to set the mask to 1.0
--------------------------------------------------------------------------------Definition at line 165 of file deconvolver.py.
| def __casac__.deconvolver.deconvolver.reopen | ( | self | ) |
reopen(self) -> bool Summary Reopen the dirty image and PSF --------------------------------------------------------------------------------
Definition at line 101 of file deconvolver.py.
| def __casac__.deconvolver.deconvolver.residual | ( | self, | |
| args, | |||
| kwargs | |||
| ) |
residual(self, model=string(""), image=string(""), async=False) -> bool
Summary
Find the residuals
Input Parameters:
model Names of input models
image Names of output residual images
async Run asynchronously in the background false
--------------------------------------------------------------------------------Definition at line 435 of file deconvolver.py.
| def __casac__.deconvolver.deconvolver.restore | ( | self, | |
| args, | |||
| kwargs | |||
| ) |
restore(self, model=string(""), image=string(""), bmaj=initialize_variant("0rad"), bmin=initialize_variant("0rad"),
bpa=initialize_variant("0deg"), async=False) -> bool
Summary
Restore the residuals
Input Parameters:
model Name of input model
image Name of output restored image
bmaj Major axis of beam 0rad
bmin Minor axis of beam 0rad
bpa 0deg Position angle of beam
async Run asynchronously in the background false
--------------------------------------------------------------------------------Definition at line 414 of file deconvolver.py.
Referenced by sdutil.scantable_restore_impl.__del__().
| def __casac__.deconvolver.deconvolver.setscales | ( | self, | |
| args, | |||
| kwargs | |||
| ) |
setscales(self, scalemethod=string("nscales"), nscales=5, uservector=initialize_vector(3,(double)0.0, (double)3.0, (double)10.0)) -> bool
Summary
Set the scale sizes for MultiScale Clean
Input Parameters:
scalemethod Method by which scales are set uservector nscales
nscales Number of scales 5
uservector Vector of scale sizes to use 0.0 3.0 10.0
--------------------------------------------------------------------------------Definition at line 380 of file deconvolver.py.
| def __casac__.deconvolver.deconvolver.smooth | ( | self, | |
| args, | |||
| kwargs | |||
| ) |
smooth(self, model=string(""), image=string(""), bmaj=initialize_variant("0rad"), bmin=initialize_variant("0rad"),
bpa=initialize_variant("0deg"), normalize=True, async=False) -> bool
Summary
smooth the image
Input Parameters:
model Name of input model
image Name of output smoothed image
bmaj Major axis of beam 0rad
bmin Minor axis of beam 0rad
bpa Position angle of beam 0deg
normalize Normalize volume of psf to unity true
async Run asynchronously in the background false
--------------------------------------------------------------------------------Definition at line 452 of file deconvolver.py.
| def __casac__.deconvolver.deconvolver.state | ( | self | ) |
state(self) -> bool Summary Return the ``state'' of the tool --------------------------------------------------------------------------------
Definition at line 330 of file deconvolver.py.
| def __casac__.deconvolver.deconvolver.summary | ( | self | ) |
summary(self) -> bool Summary Summarize the current state --------------------------------------------------------------------------------
Definition at line 134 of file deconvolver.py.
| def __casac__.deconvolver.deconvolver.updatestate | ( | self, | |
| args, | |||
| kwargs | |||
| ) |
updatestate(self, f=string(""), method=string("INIT")) -> bool
Summary
[A GUI builders related function]Update the GUI to reflect the currect state
Input Parameters:
f Glish variable for the GUI to be updated
method The method to be used for updating DONE close INIT
--------------------------------------------------------------------------------Definition at line 341 of file deconvolver.py.
__casac__.deconvolver.deconvolver.__del__ [static, private] |
Definition at line 83 of file deconvolver.py.
tuple __casac__.deconvolver.deconvolver.__getattr__ [static, private] |
Definition at line 75 of file deconvolver.py.
__casac__.deconvolver.deconvolver.__repr__ [static, private] |
Definition at line 76 of file deconvolver.py.
tuple __casac__.deconvolver.deconvolver.__setattr__ [static, private] |
Definition at line 73 of file deconvolver.py.
__casac__.deconvolver.deconvolver.__swig_destroy__ [static, private] |
Definition at line 82 of file deconvolver.py.
dictionary __casac__.deconvolver.deconvolver.__swig_getmethods__ [static, private] |
Definition at line 74 of file deconvolver.py.
dictionary __casac__.deconvolver.deconvolver.__swig_setmethods__ [static, private] |
Definition at line 72 of file deconvolver.py.
Definition at line 81 of file deconvolver.py.
1.8.0