1.2.1.0 componentlist.convertshape

NRAO Home > CASA > CASA Toolkit Reference Manual

componentlist.convertshape - Function

1.2.1 Change the units of the shape parameters (Not implemented yet)

Description

The convertshape function changes the units of the specified shape parameters on the specified components. When changing the units it also converts the values so that overall the angle has not changed.

Depending on the component shape some arguments of this function are ignored. If the shape type is ’point’, then all but the which argument are ignored. This function is useless for points.

If the shape is a ’gaussian’ or ’disk’ then this will modify the units of the major and minor axes and the positionangle. Use the getshape function to see these parameters using the new units.

Arguments


Inputs
which	A vector of indices specifying the components to modify. A vector with indices between 0 and one less than the list length, inclusively
	allowed:	int
	Default:
majoraxis	The units to use on the larger axis. A string with angular units
	allowed:	string
	Default:	rad deg mas arcsec arcmin
minoraxis	The units to use on the smaller axis. A string with angular units
	allowed:	string
	Default:	rad deg mas arcsec arcmin
positionangle	The units to use for the rotation of these axes. A string with angular units
	allowed:	string
	Default:	rad deg

Returns
bool

Example

      include ’componentlist.g’
      cl := componentlist(’crux.cl’);
      cl.convertshape(3, ’arcsec’, ’arcsec’);
      print cl.getshape(3).minoraxis;

__________________________________________________________________

[next] [prev] [prev-tail] [front] [up]

More information about CASA may be found at the CASA web page

This code is available under the terms of the GNU General Public Lincense