Getting Started

Documentation

Glish

Learn More

Programming

Contact Us

Version 1.9 Build 1556

News	FAQ
Search	Home

componentlist.setrefdirframe - Function

	Package	synthesis
	Module	componentmodels
	Tool	componentlist

Set the reference frame for the direction

Synopsis
setrefdirframe(which, frame, log)

Description

The setrefdirframe function sets the reference frame for the reference direction of the specified components (what a mouthful)!

Currently the reference frame does not include additional information like when are where the observation took place. Hence only reference frames that are independent of this information can be used. This includes the common ones of 'J2000', 'B1950', and 'Galactic'. The measures module contains a complete listing of all possible reference frames. The parsing of the reference frame string is case-insensitive.

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
frame		The new reference frame
		Allowed:	A string like 'B1950', 'J2000' or 'galactic'
		Default:	no default
log		Send a message to the logger
		Allowed:	Boolean
		Default:	T

Returns
nothing

Example

      include 'componentlist.g'
      cl := componentlist('crux.cl');
      cl.setrefdirframe(cl.indices(), 'B1950');

This example sets the reference frame for all the components in the list to the B1950 reference frame. You would use this example if you had entered the B1950 coordinates for the direction of all the components in the list but had forgotten that the default reference frame was J2000 for newly created components.