componentlist.convertshape

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

`which`	A vector of indices specifying the components to modify
	`Allowed:`	`A vector with indices between 1 and the list length`
	`Default:`	`no default`
`majoraxis`	The units to use on the larger axis
	`Allowed:`	`A string with angular units`
	`Default:`	`arcmin`
`minoraxis`	The units to use on the smaller axis
	`Allowed:`	`A string with angular units`
	`Default:`	`arcmin`
`positionangle`	The units to use for the rotation of these axes
	`Allowed:`	`A string with angular units`
	`Default:`	`deg`

Returns nothing

Example

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

This example converts the units for the majoraxis and minor axis widths to arc-seconds. Assuming they where originally set to 45mas, as is done in the example for the setshape function, the value printed would be [value=0.045, unit=arcsec].

Next: componentlist.spectrumtype - Function Up: componentlist - Tool Previous: componentlist.setshape - Function Contents Index

	`Package`	`synthesis`
	`Module`	`componentmodels`
	`Tool`	`componentlist`

componentlist.convertshape - Function