1.2.1.0 componentlist.getshape

NRAO Home > CASA > CASA Toolkit Reference Manual

componentlist.getshape - Function

1.2.1 Return the shape parameters the component

Description

The getshape function returns the shape parameters of a component in a record. As different shapes can have a differing number and type of parameters the shape parameters are returned in a record with fields that correspond to parameters relevant to the current shape.

For a point shape there are only two fields; type and direction. These are the shape type, and the reference direction. These values are also returned by the shapetype and getrefdir functions.

For both the Gaussian and disk shapes there are three additional fields; majoraxis, minoraxis & positionangle. These are angular quantities, and hence are records with a value and a unit.

Arguments


Inputs
which	An index specifying which component. An integer between 0 and one less than the list length, inclusively
	allowed:	int
	Default:

Returns
record

Example

    See the examples for the
    setshape \&
    convertshape
    functions.

__________________________________________________________________

[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