casa  $Rev:20696$
 All Classes Namespaces Files Functions Variables
Functions
imreframe Namespace Reference

Functions

def imreframe

Function Documentation

def imreframe.imreframe (   imagename = '',
  output = '',
  outframe = 'lsrk',
  epoch = '',
  restfreq = '' 
)
Change the frame in which the image reports its spectral values

    imagename -- name of casa image file to process on
    output         -- name of output image  '' means modify the input image itself
         default: '';           
    outframe     -- new spectral frame in which the frequency or 
                          velocity will be reported for.  
         Options: 'lsrk','lsrd','bary','geo','topo','galacto',
                  'lgroup','cmb'
         default: 'lsrk'
    >>> 
         epoch    -- when outframe is 'topo' or 'geo' a time in UTC is needed
                         to decide when to do the frequency conversion. '' is to use 
                         the epoch of the input image
               default= '' 

    restfreq -- Specify rest frequency to use for output image
       default=''; '' means use the restfrequency already in input image
       For example for
       NH_3 (1,1) put restfreq='23.694496GHz'

Definition at line 13 of file imreframe.py.