Getting Started

Documentation

Glish

Learn More

Programming

Contact Us

Version 1.9 Build 1556

News	FAQ
Search	Home

componentlist.convertrefdir - Function

	Package	synthesis
	Module	componentmodels
	Tool	componentlist

Convert the reference direction to a new frame

Synopsis
convertrefdir(which, frame)

Description
The convertrefdir function changes the specified components to use a new direction reference frame. Using this function will change the right-ascension and declination of the component(s), unlike the setrefdirframe which does not.

Please see the setrefdirframe function for a description of what frames are allowed.

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

Returns
nothing

Example

      include 'componentlist.g'
      cl := componentlist('crux.cl');
      cl.convertrefdirframe(cl.indices(), 'J2000');

This example illustrates what you would do if you had a list where all the directions were in the B1950 reference frame but you needed the coordinates in the J2000 reference frame. Unlike the setrefdirframe function this one adjusts the right ascension and declination values.