Getting Started Documentation Glish Learn More Programming Contact Us
Version 1.9 Build 1556
News FAQ
Search Home


next up previous contents index
Next: componentlist.convertshape - Function Up: componentlist - Tool Previous: componentlist.getshape - Function


componentlist.setshape - Function



Package synthesis
Module componentmodels
Tool componentlist


Change the shape of the component


Synopsis
setshape(which, type, majoraxis, minoraxis, positionangle, log)


Description
The setshape function changes the shape of the specified components to the user specified shape.

The type argument defines what the sort of new shape to use. This can be either 'point', 'Gaussian' or 'disk'. The parsing of this string is case insensitive.

If the shape type is 'point' then the remaining arguments in this function are ignored. There are no other parameters needed to specify a point shape.

But if the shape is 'Gaussian' or 'disk', the remaining arguments are needed to fully specify the shape. The majoraxis, minoraxis and positionangle arguments are quantities (see the quanta module for a definition of a quantity). Hence they can be specified either as with string eg., '1arcsec' or with a record eg., [value=1, unit='deg'].

The major axis is the width of the larger axis. For the Gaussian shape this is the full width at half maximum. And the minor axis is the width of the orthogonal axis. The positionangle is the specifies the rotation of these two axes with respect to a line connecting the poles of the current direction reference frame. If the angle is positive the the north point of the component moves in the eastern direction.



Arguments

which A vector of indices specifying the components to modify
Allowed: A vector with indices between 1 and the list length
Default: no default
type The new shape type
Allowed: A string that is either 'point', 'Gaussian' or 'disk'
Default: Point
majoraxis The width of the larger axis
Allowed: A quantity with angular units
Default: 1arcmin
minoraxis The width of the smaller axis
Allowed: A quantity with angular units
Default: 1arcmin
positionangle The rotation of the axes with respect to the reference frame
Allowed: A quantity with angular units
Default: 0deg
log Send a message to the logger
Allowed: Boolean
Default: T


Returns
nothing


Example
      include 'componentlist.g'
      cl := componentlist('crux.cl', readonly=F);
      cl.setshape(3, 'disk',  '45mas', '45mas');
      print cl.getshape(3).majoraxis;
This example revises the model for Gamma-Crux changing its shape from a point to a circular disk of diameter 45mas. The output from the print statement is [value=45, unit=mas].



next up previous contents index
Next: componentlist.convertshape - Function Up: componentlist - Tool Previous: componentlist.getshape - Function   Contents   Index
Please send questions or comments about AIPS++ to aips2-request@nrao.edu.
Copyright © 1995-2000 Associated Universities Inc., Washington, D.C.

Return to AIPS++ Home Page
2006-10-15