imregrid_pg.imregrid_pg_ Class Reference

List of all members.

Public Member Functions
def	__init__
def	__call__
Private Attributes
	__bases__
	__doc__
Static Private Attributes
string	__name__

---

Detailed Description

Definition at line 18 of file imregrid_pg.py.

---

Constructor & Destructor Documentation

def imregrid_pg.imregrid_pg_.__init__

(

self

)

Definition at line 21 of file imregrid_pg.py.

---

Member Function Documentation

def imregrid_pg.imregrid_pg_.__call__	(		self,
			imagename = None,
			template = None,
			output = None,
			asvelocity = None,
			axes = None,
			shape = None,
			async = None
	)

regrid an image onto a template image

imregrid: regrid an image to a new coordinate system.

Keyword arguments:
imagename   Name of the image that needs to be regridded
    default: none; example: imagename='orion.image'
template    Dictionary, reference code, or imagename defining the new
    shape and coordinate system, or 'get' to return the template
    dictionary for imagename.  Recognized reference codes are:
    'J2000', 'B1950', 'B1950_VLA', 'GALACTIC', 'HADEC', 'AZEL',
    'AZELSW', 'AZELNE', 'ECLIPTIC', 'MECLIPTIC', 'TECLIPTIC',
    and 'SUPERGAL'.
    default: 'get'; example: template='orion_j2000.im'
shape       Shape of the output image. Only used if template is an image.
    If not specified (-1), the output image shape is set equal to
    the input image shape.
output      Name for the regridded image
    default: imagename + '.regridded'; example: imagename='orion_shifted.im'
asvelocity  Regrid spectral axis with respect to velocity, not frequency?
    default: False
axes        The pixel axes to regrid. -1 => all.
async       Run task in a separate process (return CASA prompt)
    default: False; example: async=True

The new coordinate system is defined by the template parameter,
which can be:
    * a recognized reference code string (see below),
    * a {'csys': csys_record, 'shap': shape} dictionary,
    * 'get', which does not regrid but returns the template dictionary
      for imagename, suitable for modification and reuse, or
    * the name of an image to get the coordinate system and shape
      from.  The input and template images must have the same
      coordinate structure.
      
If one of the axes to be regridded is a spectral axis and asvelocity=T,
the axis will be regridded to match the velocity, not the frequency,
description of the template coordinate system. Thus the output pixel
values will correspond only to the velocity, not the frequency, of the
output axis.

If an image has per-plane beams and one attempts to regrid the spectral axis,
an exception is thrown.

Definition at line 26 of file imregrid_pg.py.

References vla_uvfits_line_sf.verify.

---

Member Data Documentation

imregrid_pg.imregrid_pg_.__bases__ [private]

Definition at line 22 of file imregrid_pg.py.

imregrid_pg.imregrid_pg_.__doc__ [private]

Definition at line 23 of file imregrid_pg.py.

string imregrid_pg.imregrid_pg_.__name__ [static, private]

Definition at line 19 of file imregrid_pg.py.

---

The documentation for this class was generated from the following file:

• imregrid_pg.py