AIPS NRAO AIPS HELP file for CMPLX in 31DEC22



As of Sun Jun 26 11:30:46 2022


CMPLX: Task to combine two overlapping complex images

INPUTS

INNAME                             First image name - real/amp
INCLASS                            First image class
INSEQ           0.0      9999.0    First image seq. #
INDISK          0.0         9.0    First image disk drive #
IN2NAME                            First image name - imag/phase
IN2CLASS                           First image class
IN2SEQ          0.0      9999.0    First image seq. #
IN2DISK         0.0         9.0    First image disk drive #
IN3NAME                            Second image name - real/amp
IN3CLASS                           Second image class
IN3SEQ          0.0      9999.0    Second image seq. #
IN3DISK         0.0         9.0    Second image disk #
IN4NAME                            Second image name - imag/phas
IN4CLASS                           Second image class
IN4SEQ          0.0      9999.0    Second image seq. #
IN4DISK         0.0         9.0    Second image disk #
DOALIGN        -2.0         1.0    Should images be coincident?
                                   (See HELP.)
OUTNAME                            Output image name - real/amp
OUTCLASS                           Output image class
OUTSEQ         -1.0      9999.0    Output image seq. #
OUTDISK         0.0         9.0    Output image disk drive #
OUT2NAME                           Output image name - imag/phas
OUT2CLAS                           Output image class
OUT2SEQ         -1.0      9999.0   Output image seq. #
OUT2DISK         0.0         9.0   Output image disk drive #
BLC             0.0      4096.0    Bottom left corner
TRC             0.0      4096.0    Top right corner
OPCODE                             Algorithm type: 'CONJ','SWAP'
                                   'SUM ','SUMC','SUMI','ISUM'
                                   'DIV ','DIVC','DIVI','MULT',
                                   'MULC','MULI'
APARM                              Parameters for algorithm:
                                     (1) - (4) scale and offset
                                     (8) > 0 input 1 rea/imag
                                     (9) > 0 input 2 real/imag
                                     (10) > 0 output real/imag
                                     see HELP CMPLX
DOHIST         -3.0         1.0    -2 => copy 1st HI only
                                   -3 => copy no HI files

HELP SECTION

CMPLX
Type: Task
      CMPLX is a generalized task which performs functions on one or two
      input complex images.  Note that a complex image is actually two
      images in AIPS.  The function is performed pixel by pixel to
      produce one output complex image.  Numerous mathematical methods for
      combining the images are provided.

      The two input maps should be coincident.  One may combine only
      subimages if desired.  CMPLX will combine two fully overlapping
      n-dimensional images and it can combine each n-m dimension "plane"
      of the first n-dimensional image with the single n-m dimension
      "plane" of an n-m dimensional second image.

      If the images are in JY/BEAM, CMPLX will scale images 2, 3, and 4
      to be in the same beam as that of image 1 before doing the
      combination.
Adverbs:
  INNAME......First image name - real or amplitude.   Standard defaults.
  INCLASS.....First image class.    Standard defaults.
  INSEQ.......First image seq. #.   0 => highest.
  INDISK......Disk drive # for the first image.  0 => any.
  IN2NAME.....First image name - imaginary or phase.  Standard defaults.
  IN2CLASS....First image class.   Standard defaults.
  IN2SEQ......First image seq. #.  0 => highest.
  IN2DISK.....Disk drive # for the first image.  0 => any.
  IN3NAME.....Second image name.     Standard defaults.
  IN3CLASS....Second image class.    Standard defaults.
  IN3SEQ......Second image seq. #.   0 => highest.
  IN3DISK.....Disk # for second image.  0 => any.
  IN4NAME.....Second image name.    Standard defaults.
  IN4CLASS....Second image class.   Standard defaults.
  IN4SEQ......Second image seq. #.  0 => highest.
  IN4DISK.....Disk # for second image.  0 => any.
  DOALIGN.....Controls how the four images are to be aligned (see HELP
              DOALIGN).  True (>.1) means that the images must agree in
              their coordinates, though not necessarily in the reference
              pixel position.  Alignment is by coordinate values (if
              DOALIGN > -0.1) or by offsets from the reference pixel
              positions (if DOALIGN <= -0.1).  NOTE: all real axes (>1
              point) are aligned.  If DOALIGN = -2, the headers are
              ignored and the images are aligned at pixel (1,1,...).
  OUTNAME.....Output image name - real or amplitude.  Standard defaults.
  OUTCLASS....Output image class.   Standard behavior with default =
              the type of file (Real or Amp) and the OPCODE
  OUTSEQ......Output image seq. #.  0 => highest unique.
  OUTDISK.....Output disk number. 0 => highest with space.
  OUT2NAME....Output image name - imaginary or phase. Standard defaults.
  OUT2CLAS....Output image class.   Standard behavior with default =
              the type of file (Imag or Phase) plus the OPCODE.
  OUT2SEQ.....Output image seq. #.  0 => highest unique.
  OUT2DISK....Output disk number. 0 => highest with space.
  BLC.........Bottom left corner of the 1st input image. The other
              images are aligned by coordinates (see DOALIGN) on all
              axes having > 1 point.  The other images may have fewer
              real axes than the 1st.  The 4 windows must have the same
              dimension on the first 2 axes, but the task will select a
              smaller window than was specified if needed to overlap the
              4 images.
  TRC.........Top right corner of input images. (See BLC.)
  OPCODE......The combination algorithm specification: (A=APARM)
              M(1) = the complex 1st image (in real/imaginary form)
              M(2) = the complex 2nd image (in real/imaginary form)
     1 input image options:
     ='CONJ': Conjugate    A(1)*Conj(M(1)) + A(2) + iA(3)
     ='SWAP': Swap type    A(1)*M(1) + a(2) + iA(3) with amp/phase
                           -> real/imag or real/imag -> amp/phase
     2 input image options:
     ='SUM ': Linear sum   A(1)*MAP(1) + A(2)*MAP(2) + A(3) + iA(4)
     ='SUMC': Conjugate sum A(1)*MAP(1) + A(2)*conj(MAP(2))+A(3)+iA(4)
     ='SUMI': i scale sum A(1)*MAP(1) + A(2)*(i*MAP(2))+A(3)+iA(4)
     ='ISUM': i times sum i*(A(1)*MAP(1) + A(2)*MAP(2)) + A(3) + iA(4)
     ='DIV ': Division     A(1)*MAP(1) / MAP(2) + A(2) + iA(3)
     ='DIVC': Conj Division A(1)*MAP(1) / conj(MAP(2)) + A(2) + iA(3)
     ='DIVI': i scale Division A(1)*MAP(1) / (i*MAP(2)) + A(2) + iA(3)
     ='IDIV': i timesDivision  i*A(1)*MAP(1) / MAP(2) + A(2) + iA(3)
     ='MULT': Multiplic.   A(1)*MAP(1)*MAP(2) + A(2) + iA(3)
     ='MULC': Conj mult    A(1)*MAP(1)*conj(MAP(2)) + A(2) + iA(3)
     ='MULI': i scale mult A(1)*MAP(1)*(i*MAP(2)) + A(2) + iA(3)
     ='IMUL': i * Multiplic. i*A(1)*MAP(1)*MAP(2) + A(2) + iA(3)
  APARM.......Parameters needed for algorithm:
     APARM(1), APARM(2), APARM(3), APARM(4) used as above.
          APARM(1) = 0 => APARM(1) = 1.0
          APARM(2) = 0 => APARM(2) = 1.0 (for 'SUM ', SUMC)
     APARM(8)  >  0  => Image 1 is real/imaginary
               <= 0  => Image 1 is amplitude/phase
     APARM(9)  >  0  => Image 2 is real/imaginary
               <= 0  => Image 2 is amplitude/phase
     APARM(10) >  0  => Output is real/imaginary
               <= 0  => Output is amplitude/phase
  DOHIST.......Normally the HI file of input 1 is copied to the output
               history file and the HI file of the second input is
               appended.  If you are doing many CMPLXs this can lead to
               immense history files of little use to anyone.  Thus,
               DOHIST=-2 => copy the first HI file only.
               DOHIST=-3 => copy no HI file, write CMPLX HI only.

EXPLAIN SECTION


AIPS