AIPS NRAO AIPS HELP file for RM2PL in 31DEC18



As of Sat Jan 20 7:56:42 2018


RM2PL: Plots spectrum of a pixel with RMFIT fit

INPUTS

INNAME                             Input Q image name (name)
INCLASS                            Input Q image name (class)
INSEQ             0.0     9999.0   Input Q image name (seq. #)
INDISK            0.0        9.0   Input Q image disk unit #
IN2NAME                            Input U image name (name)
IN2CLASS                           Input U image name (class)
IN2SEQ            0.0     9999.0   Input U image name (seq. #)
IN2DISK           0.0        9.0   Input U image disk unit #
INVERS            0.0              RM table version
APARM                              (1,2) RA, Dec pixel
                                   (3,4) Q/P value range
                                   (5,6) U/A value range
                                   (7,8) Average box size in
                                      Ra, Dec
                                   (9) > 0 average even if no
                                      model
                                   (10) > 0 => plot total
                                      polarization and angle
BPARM                              (1) > 0 plot Q/P data
                                   (2) > 0 plot Q/P model
                                   (3) > 0 plot Q/P residual
                                   (4) > 0 plot Q/P model comps
                                   (6) > 0 plot U/A data
                                   (7) > 0 plot U/A model
                                   (8) > 0 plot U/A residual
                                   (9) > 0 plot U/A model comps
CPARM                              (1) Plot begin channel
                                   (2) Plot end channel
                                   (3) Fraction of plot for U
                                   (4) X axis type: 0 channels
                                       1 freq, 2 lambda,
                                       3 lambda^2
                                   (5) > 0 plot X axis reversed
                                   (6) > 0 plot Q/P and U/A with
                                       directly connected points
OUTTEXT
                                   Text file to contain data,
                                   model sum and model comps
                                   plus fit parameters at each
                                   pixel
XYRATIO         0.0                X to Y ratio of plot: 0 ->
                                      1 or fit to TV
LTYPE        -410.0       410.0    Type of labeling: 1 border,
                                   2 no ticks, 3 standard, 4 rel
                                   to center, 5 rel to subim cen
                                   6 pixels, 7-10 as 3-6 with
                                   only tick labels
                                   <0 -> no date/time
DOTV           -1.0                > 0 Do plot on the TV, else
                                   make a plot file
GRCHAN          0.0         8.0    Graphics channel 0 => 1.

HELP SECTION

RM2PL
Task:  Makes a plot as a plot file or on the TV of the spectrum taken
       from a transposed image cube.  It plots the data from a single
       pixel or the average of a rectangular or circular region
       centered on the pixel.  It will normally be used after running
       RMFIT.  The plot consists of an upper part with the Q
       polarization parts of the plot ("Q") and a lower part with the
       U/A polarization parts.  If the U image is not specified, or no U
       plot types are requested, then the lower portion is omitted.
       The "Q" image must be present, but if no Q/P plot types are
       selected, then the Q/P portion of the plot is omitted.  The U
       image must be present or the APARM(10) option to plot total
       polarization and polarization angle will be supressed.

       See also AIPS Memo 118, "Modeling spectral cubes in AIPS",
       January 2016 for a more detailed description of the use of this
       task.
Adverbs:
  INNAME.....Transposed Q image name (name).       Standard defaults.
  INCLASS....Transposed Q image name (class).      Standard defaults.
  INSEQ......Transposed Q image name (seq. #).     0 => highest.
  INDISK.....Transposed Q image disk #.   0 => any.
  IN2NAME....Transposed U image name (name).       Standard defaults.
  IN2CLASS...Transposed U image name (class).      Standard defaults.
  IN2SEQ.....Transposed U image name (seq. #).     0 => highest.
  IN2DISK....Transposed U image disk #.   0 => any.
  INVERS.....RM table version: 0 => highest
  APARM......(1,2) RA, Dec pixel  NO DEFAULT
             (3,4) Q value plot range, min to max.  If max <= min,
                   self-scale Q plot
             (5,6) U value plot range, min to max.  If max <= min,
                   self-scale Q plot
             (7,8) Average over a box 2*APARM(7)+1 by 2+APARM(8)+1
                   in the RA, Dec coordinates around APARM(1,2)
                   If APARM(7) < 0, use APARM(8) as a radius in pixels
                   of a circle surrounding APARM(1,2).
             (9) > 0 => include pixels in average even if no model
             (10) > 0 => plot/print total polarization and
                   polarization angle instead of Q and U - but only if
                   both images are specified.
  BPARM......(1) > 0 plot Q data from INNAME at the pixel given by
                   APARM(1) and APARM(2) (axes 2 and 3 in the
                   transposed image)
             (2) > 0 plot Q model sum at the pixel from XG table
                   INVERS
             (3) > 0 plot Q data minus model
             (4) > 0 plot Q model individual components from XG table
                   INVERS at the pixel
             (6) > 0 plot U data from IN2NAME at the pixel given by
                   APARM(1) and APARM(2) (axes 2 and 3 in the
                   transposed image)
             (7) > 0 plot U model sum at the pixel from the XG and ZE
                   tables
             (8) > 0 plot U data - model
             (9) > 0 plot U model individual components from the XG
                   and ZE tables
  CPARM......(1) The data are computed and printed over all spectral
                 channels in the image (first axis).  Those plotted
                 may be restricted to a smaller range from CPARM(1)
                 through CPARM(2).  Default is full range.
             (2) Highest channel plotted.
             (3) Fraction of vertical axis for the U plot.  0 -> 0.5.
             (4) type of X axis label: 1 frequency, 2  wavelength, 3
                 wavelength squared, else channels
             (5) > 0 => plot data in reverse order (on X axis)
             (6) <= 0 => Q and U data are plotted with step lines
                 > 0  => Q and U points are directly connected
                 Models, resduals, and model components are all
                 plotted with directconnections.
  OUTTEXT....If not blank, print the model values at each pixel
             included in the average.  Then print a table of the Q
             spectrum and model followed by a table of the U data
             and model.  The columns in the table are the channel
             number, the wavelength squared times 1000, the input
             data, the sum of the model components, the difference of
             the data and the model, and the Stokes amplitude of each
             of the model components.
  XYRATIO....Scale the X axis relative to the Y by XYRATIO.
                If DOTV >  0, 0 -> fit to the TV window
                If DOTV <= 0, 0 -> 1.
  LTYPE......Labelling type, see HELP LTYPE for details:
             1 = border, 2 = no ticks, 3 or 7 = standard, 4 or 8 =
             relative to ref. pixel, 5 or 9 = relative to subimage
             (BLC, TRC) center, 6 or 10 = pixels.  7-10 all labels
             other than tick numbers and axis type are omitted.
             Less than 0 is the same except that the plot file
             version number and create time are omitted.
             Add n * 100 to alter the metric scaling.
  DOTV.......> 0 => plot directly on the TV device, otherwise
             make a plot file for later display on one or
             more devices (including the TV if desired).
  GRCHAN.....Graphics channel (1 - 7) to use for line drawing.
             0 => use 1 for labeling and model, 2 for data, 3 for
             residual, and 4 for components.  In this way color will
             help you separate the various types of plot.

EXPLAIN SECTION


AIPS