componentlist.setlabel

Set the label of the specified components

Synopsis setlabel(which, value, log)

Description The setlabel function is used to reassign the label (an arbitrary text string) of the specified components to a new value.

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`
`value`	The label for the specified components
	`Allowed:`	`A string`
	`Default:`	`no default`
`log`	Send a message to the logger
	`Allowed:`	`Boolean`
	`Default:`	`T`

Returns nothing

Example

      include 'componentlist.g'
      cl := componentlist('centarusA.cl');
      cl.setlabel(1, 'Core')
      cl.setlabel(2:10, 'Left Lobe')
      cl.setlabel(11:23, 'Right Lobe')

This example reads a model of Centarus A which contains at least 23 components. It then marks the first one as the core, the next nine as the left lobe, and the next thirteen as the right lobe. The lobes may, for example, be modelled using a collection of Gaussian shaped components.

Next: componentlist.getfluxvalue - Function Up: componentlist - Tool Previous: componentlist.getlabel - Function Contents Index

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

componentlist.setlabel - Function