Inheritance diagram for asap.asapgrid.asapgrid_base:

Public Member Functions
def	__init__
def	setData
def	setIF
def	setPolList
def	setScanList
def	defineImage
def	setFunc
def	setWeight
def	enableClip
def	disableClip
def	grid
def	plotFunc
def	save
def	plot
def	getResult
Public Attributes
	outfile
	ifno
	gridder
	infile
	scantab

Detailed Description

Definition at line 9 of file asapgrid.py.

Constructor & Destructor Documentation

def asap.asapgrid.asapgrid_base.__init__ ( self )

Definition at line 10 of file asapgrid.py.

Member Function Documentation

def asap.asapgrid.asapgrid_base.defineImage	(	self,
		nx = `-1`,
		ny = `-1`,
		cellx = `''`,
		celly = `''`,
		center = `''`
	)

Define spatial grid.

First two parameters, nx and ny, define number of pixels of
the grid. If which of those is not specified, it will be set
to the same value as the other. If none of them are specified,
it will be determined from map extent and cell size.

Next two parameters, cellx and celly, define size of pixel.
You should set those parameters as string, which is constructed
numerical value and unit, e.g. '0.5arcmin', or numerical value.
If those values are specified as numerical value, their units
will be assumed to 'arcsec'. If which of those is not specified,
it will be set to the same value as the other. If none of them
are specified, it will be determined from map extent and number
of pixels, or set to '1arcmin' if neither nx nor ny is set.

The last parameter, center, define the central coordinate of
the grid. You should specify its value as a string, like,

   'J2000 05h08m50s -16d23m30s'

or 

   'J2000 05:08:50 -16.23.30'

You can omit equinox when you specify center coordinate. In that
case, J2000 is assumed. If center is not specified, it will be
determined from the observed positions of input data.

nx -- number of pixels along x (R.A.) direction.
ny -- number of pixels along y (Dec.) direction.
cellx -- size of pixel in x (R.A.) direction.
celly -- size of pixel in y (Dec.) direction.
center -- central position of the grid.

Definition at line 50 of file asapgrid.py.

def asap.asapgrid.asapgrid_base.disableClip ( self )

Disable min/max clipping.

Definition at line 186 of file asapgrid.py.

def asap.asapgrid.asapgrid_base.enableClip ( self )

Enable min/max clipping.

By default, min/max clipping is disabled so that you should
call this method before actual gridding if you want to do
clipping.

Definition at line 176 of file asapgrid.py.

def asap.asapgrid.asapgrid_base.getResult ( self )

Reimplemented in asap.asapgrid.asapgrid2.

Definition at line 220 of file asapgrid.py.

def asap.asapgrid.asapgrid_base.grid ( self )

Actual gridding which will be done based on several user inputs.

Definition at line 192 of file asapgrid.py.

def asap.asapgrid.asapgrid_base.plot	(	self,
		plotchan = `-1`,
		plotpol = `-1`,
		plotobs = `False`,
		plotgrid = `False`
	)

Reimplemented in asap.asapgrid.asapgrid.

Definition at line 217 of file asapgrid.py.

def asap.asapgrid.asapgrid_base.plotFunc	(	self,
		clear = `True`
	)

Support function to see the shape of current grid function.

clear -- clear panel if True. Default is True.

Definition at line 198 of file asapgrid.py.

def asap.asapgrid.asapgrid_base.save	(	self,
		outfile = `''`
	)

Reimplemented in asap.asapgrid.asapgrid.

Definition at line 214 of file asapgrid.py.

def asap.asapgrid.asapgrid_base.setData	(	self,
		infile
	)

Reimplemented in asap.asapgrid.asapgrid2, and asap.asapgrid.asapgrid.

Definition at line 17 of file asapgrid.py.

def asap.asapgrid.asapgrid_base.setFunc	(	self,
		func = `'box'`,
		convsupport = `-1`,
		truncate = `"-1"`,
		gwidth = `"-1"`,
		jwidth = `"-1"`
	)

Set convolution function. Possible options are 'box' (Box-car,
default), 'sf' (prolate spheroidal), 'gauss' (Gaussian), and 
'gjinc' (Gaussian * Jinc).
Width of convolution function can be set using several parameters.
For 'box' and 'sf', we have one parameter, convsupport, that
specifies a cut-off radius of the convlolution function. By default
(-1), convsupport is automatically set depending on each convolution
function. Default values for convsupport are:

   'box': 1 pixel
   'sf': 3 pixels

For 'gauss', we have two parameters for convolution function,
truncate and gwidth. The truncate is similar to convsupport
except that truncate allows to specify its value as float or
string consisting of numeric and unit (e.g. '10arcsec' or
'3pixel'). Available units are angular units ('arcsec', 'arcmin',
'deg', etc.) and 'pixel'. Default unit is 'pixel' so that if
you specify numerical value or string without unit to gwidth,
the value will be interpreted as 'pixel'. gwidth is an HWHM of
gaussian. It also allows string value. Interpretation of the
value for gwidth is same as truncate. Default value for 'gauss'
is

      gwidth: '-1' ---> sqrt(log(2.0)) pixel
    truncate: '-1' ---> 3*gwidth pixel

For 'gjinc', there is an additional parameter jwidth that
specifies a width of the jinc function whose functional form is

    jinc(x) = J_1(pi*x/jwidth) / (pi*x/jwidth)

Default values for 'gjinc' is

      gwidth: '-1' ---> 2.52*sqrt(log(2.0)) pixel
      jwidth: '-1' ---> 1.55
    truncate: '-1' ---> automatically truncate at first null

Default values for gwidth and jwidth are taken from Mangum et al.
(2007).

func -- Function type ('box', 'sf', 'gauss', 'gjinc').
convsupport -- Width of convolution function. Default (-1) is
       to choose pre-defined value for each convolution
       function. Effective only for 'box' and 'sf'.
truncate -- Truncation radius of the convolution function.
    Acceptable value is an integer or a float in units of
    pixel, or a string consisting of numeric plus unit.
    Default unit for the string is 'pixel'. Default (-1)
    is to choose pre-defined value for each convolution
    function. Effective only for 'gauss' and 'gjinc'.
gwidth -- The HWHM of the gaussian. Acceptable value is an integer
  or a float in units of pixel, or a string consisting of
  numeric plus unit. Default unit for the string is 'pixel'.
  Default (-1) is to choose pre-defined value for each
  convolution function. Effective only for 'gauss' and
  'gjinc'.
jwidth -- The width of the jinc function. Acceptable value is an
  integer or a float in units of pixel, or a string
  consisting of numeric plus unit. Default unit for the
  string is 'pixel'. Default (-1) is to choose pre-defined
  value for each convolution function. Effective only for
  'gjinc'.

Definition at line 93 of file asapgrid.py.

def asap.asapgrid.asapgrid_base.setIF	(	self,
		ifno
	)

Set IFNO to be processed. Currently, asapgrid allows to process
only one IFNO for one gridding run even if the data contains
multiple IFs. If you didn't specify IFNO, default value, which
is IFNO in the first spectrum, will be processed.

ifno -- IFNO to be processed.

Definition at line 20 of file asapgrid.py.

References asap.asapgrid.asapgrid_base.ifno.

def asap.asapgrid.asapgrid_base.setPolList	(	self,
		pollist
	)

Set list of polarization components you want to process.
If not specified, all POLNOs will be processed.

pollist -- list of POLNOs.

Definition at line 32 of file asapgrid.py.

def asap.asapgrid.asapgrid_base.setScanList	(	self,
		scanlist
	)

Set list of scans you want to process. If not specified, all
scans will be processed.

scanlist -- list of SCANNOs.

Definition at line 41 of file asapgrid.py.

Referenced by tests.test_partitionHelper.PartitionHelperTest.testDefaultSeparationCommands(), and tests.test_partitionHelper.PartitionHelperTest.testSpwSeparationCommands().

def asap.asapgrid.asapgrid_base.setWeight	(	self,
		weightType = `'uniform'`
	)

Set weight type. Possible options are 'uniform' (default),
'tint' (weight by integration time), 'tsys' (weight by
Tsys: 1/Tsys**2), and 'tintsys' (weight by integration time
as well as Tsys: tint/Tsys**2).

weightType -- weight type ('uniform', 'tint', 'tsys', 'tintsys')

Definition at line 165 of file asapgrid.py.