Getting Started Documentation Glish Learn More Programming Contact Us
Version 1.9 Build 1556
News FAQ
Search Home


next up previous contents index
Next: componentlist.setrefdirframe - Function Up: componentlist - Tool Previous: componentlist.getrefdirframe - Function


componentlist.setrefdir - Function



Package synthesis
Module componentmodels
Tool componentlist


Set the reference direction


Synopsis
setrefdir(which, ra, raunit, dec, decunit, log)


Description
The setrefdir function sets the reference direction of the specified components to a new value. The direction is defined by separately specifying the right ascension and the declination.

The right ascension is specified as a string or a real number (if raunit argument is not 'time' or 'angle').

The raunit argument is a string that indicates the units for the ra. It can be any angular unit eg., 'deg', 'rad', 'arcsec', 'mas', or it can be 'time' or 'angle'. If the raunit is 'time' then the ra argument must be a string in the format 'HH:MM:SS.sss' eg., '19:34:63.8'. If the raunit is 'angle' then the ra argument must be a string in the format '+DDD.MM.SS.sss' eg., '127.23.12.37'.

Similarly the declination is specified as a string or a real number and the decunit can be any angular unit or 'angle' or 'time'.



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
ra The RA of the new direction
Allowed: A formatted string or a number
Default: no default
raunit The units of the RA
Allowed: Any string containing an angular unit or 'angle' or 'time'
Default: no default
dec The declination of the new direction
Allowed: A formatted string or a number
Default: no default
decunit The units of the declination
Allowed: Any string containing an angular unit or 'angle' or 'time'
Default: no default
log Send a message to the logger
Allowed: Boolean
Default: T


Returns
nothing


Example
      include 'componentlist.g'
      cl := emptycomponentlist('crux.cl');
      cl.simulate(3);
      cl.setrefdir(1, '12:26:35.9', 'time', '-63.5.56', 'angle')
      cl.setrefdir(2, '12h26m35.9', 'time', '-63d5m56', 'angle')
      cl.setrefdir(3, -173.35, 'deg', '-1.10128', 'rad')
This example sets the reference direction for three newly created components to the same value.



next up previous contents index
Next: componentlist.setrefdirframe - Function Up: componentlist - Tool Previous: componentlist.getrefdirframe - Function   Contents   Index
Please send questions or comments about AIPS++ to aips2-request@nrao.edu.
Copyright © 1995-2000 Associated Universities Inc., Washington, D.C.

Return to AIPS++ Home Page
2006-10-15