← Back to branch summary

~ubuntu-branches/debian/jessie/eso-midas/jessie

« back to all changes in this revision

Viewing changes to prim/help/subtratemp.hlq

  • Committer: Package Import Robot
  • Author(s): Ole Streicher
  • Date: 2014-04-22 14:44:58 UTC
  • Revision ID: package-import@ubuntu.com-20140422144458-okiwi1assxkkiz39
Tags: upstream-13.09pl1.2+dfsg
Import upstream version 13.09pl1.2+dfsg

Show diffs side-by-side

added added

removed removed

Lines of Context:
prim/help/subtratemp.hlq
 
1
%++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 
2
%.COPYRIGHT  (c)  1990-2007 European Southern Observatory
 
3
%.IDENT      subtratemp.hlq
 
4
%.AUTHOR     KB, IPG/ESO
 
5
%.KEYWORDS   MIDAS, help files, SUBTRACT/TEMPLATE
 
6
%.PURPOSE    On-line help file for the command: SUBTRACT/TEMPLATE
 
7
%.VERSION    1.0  29-JUN-2007 : Creation, KB (for DB, 20.2.1990)
 
8
%----------------------------------------------------------------
 
9
\se
 
10
SECTION./TEMP
 
11
\es\co
 
12
SUBTRACT/TEMPLATE                               29-JUN-2007 DB
 
13
\oc\su
 
14
SUBTRACT/TEMPLATE in out template coords scale
 
15
        subtract a properly shifted and resampled template pattern
 
16
        from an image
 
17
\us\pu
 
18
Purpose:  
 
19
           Resample and shift a template pattern, scale it in intensity,
 
20
           and subtract it from a given image.
 
21
\up\sub
 
22
Subject: 
 
23
           Cleaning
 
24
\bus\sy
 
25
Syntax: 
 
26
           SUBTRACT/TEMPLATE in out template coords scale
 
27
\ys\pa
 
28
           in       = 2-dim input image
 
29
\ap\pa
 
30
           out      = result image
 
31
\ap\pa
 
32
           template = image with template pattern
 
33
\ap\pa
 
34
           coords   = world coords (x,y) to which origin of coordinate
 
35
                      frame (0,0) of template pattern shall be shifted
 
36
\ap\pa
 
37
           scale    = flux scaling factor applied to template before
 
38
                      subtraction
 
39
\ap\no
 
40
Note:      
 
41
           OJO: Input and template mages must have "same" stepsize, i.e. 
 
42
           within 0.001 of a step.
 
43
           The center of the template (peak) should be located at world
 
44
           coords (0,0).
 
45
           This command is useful for, e.g. the PSF subtraction of stars
 
46
           or other point sources from 2-dim images.
 
47
           If, in that example, a star is located at coord (x,y), 
 
48
           the point spread function must be located at (0,0) in the 
 
49
           template image.
 
50
\on\sa
 
51
See also:
 
52
           COMPUTE/IMAGE
 
53
\as\exs
 
54
Examples:
 
55
\ex
 
56
           SUBTRACT/TEMPLATE contam decontam psf -312.81,18.324 17.86
 
57
             Shift and resample image `psf.bdf' such that coords (0,0) 
 
58
             become (-312.81,18.324), scale intensity by factor 17.86, and
 
59
             subtract from input image `contam.bdf'.
 
60
             Result will be in `decontam.bdf'.
 
61
\xe \sxe