Getting Started

Documentation

Glish

Learn More

Programming

Contact Us

Version 1.9 Build 1556

News	FAQ
Search	Home

componentlist.getshape - Function

	Package	synthesis
	Module	componentmodels
	Tool	componentlist

Return the shape parameters the component

Synopsis
getshape(which)

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

which		An index specifying which component
		Allowed:	An integer between 1 and the list length
		Default:	no default

Returns
A record with fields that contain the parameters of the component shape.

Example
See the examples for the setshape & convertshape functions.