Remove d2im support from stwcs, since it is now part of pywcs.

git-svn-id: http://svn.stsci.edu/svn/ssb/stsci_python/stsci_python/trunk/stwcs@8151 fe389314-cf27-0410-b35b-8c050e845b92

1 files changed, 48 insertions, 178 deletions

diff --git a/wcsutil/__init__.py b/wcsutil/__init__.py
index 4b82173..fe2e8c8 100644
--- a/wcsutil/__init__.py
+++ b/wcsutil/__init__.py
@@ -23,7 +23,7 @@ class HSTWCS(WCS):
     =======
     Create a WCS object based on the instrument.
     It has all basic WCS kw as attribbutes (set by pywcs).
-    It also uses the primary and extension header to define 
+    It also uses the primary and extension header to define
     instrument specific attributes.
     """
     def __init__(self, fobj=None, ext=None, instrument=None, detector=None, minerr=0.0):
@@ -37,18 +37,18 @@ class HSTWCS(WCS):
                 extension number
                 if ext==None, it is assumed the data is in the primary hdu
         `instrument`: string
-                one of 'ACS', 'NICMOS', 'WFPC2', 'STIS', 'WFC3' 
+                one of 'ACS', 'NICMOS', 'WFPC2', 'STIS', 'WFC3'
                 Used only to define a default HSTWCS object, when fobj==None
         `detector`:  string
                 for example 'WFC'
-                If instrument and detector parameters are given, a default HSTWCS 
+                If instrument and detector parameters are given, a default HSTWCS
                 instrument is created. Used only with fobj==None
         `minerr`: float
-                minimum value a distortion correction must have in order to be applied. 
-                If CPERRja, CQERRja are smaller than minerr, the corersponding 
+                minimum value a distortion correction must have in order to be applied.
+                If CPERRja, CQERRja are smaller than minerr, the corersponding
                 distortion is not applied.
         """
-        
+
         self.inst_kw = ins_spec_kw
         self.minerr = minerr
         if instrument == None:
@@ -56,12 +56,12 @@ class HSTWCS(WCS):
             self.filename = filename
             self.setHDR0kw(hdr0, ehdr)
             WCS.__init__(self, ehdr, fobj=phdu, minerr=minerr)
-            # If input was a pyfits HDUList object, it's the user's 
+            # If input was a pyfits HDUList object, it's the user's
             # responsibility to close it, otherwise, it's closed here.
             if not isinstance(fobj, pyfits.HDUList):
                 phdu.close()
-                
-            
+
+
             self.setInstrSpecKw(hdr0, ehdr)
             self.setPscale()
             self.setOrient()
@@ -69,18 +69,17 @@ class HSTWCS(WCS):
             extname = ehdr.get('EXTNAME', "")
             extnum = ehdr.get('EXTVER', None)
             self.extname = (extname, extnum)
-            self.d2imcorr = self.get_d2im_lookup()    
         else:
-            # create a default HSTWCS object based on 
+            # create a default HSTWCS object based on
             #instrument and detector parameters
             self.instrument = instrument
             self.detector = detector
             self.setInstrSpecKw()
-        
+
     def parseInput(self, f=None, ext=None):
         if isinstance(f, str):
             # create an HSTWCS object from a filename
-            
+
             if ext != None:
                 filename = f
                 extnum = ext
@@ -97,7 +96,7 @@ class HSTWCS(WCS):
                 ehdr = pyfits.getheader(filename, ext=extnum)
             except IndexError:
                 print 'Unable to get extension %d. /n' % ext
-            
+
         elif isinstance(f, pyfits.HDUList):
             phdu = f
             if ext == None:
@@ -105,15 +104,15 @@ class HSTWCS(WCS):
             else:
                 extnum = ext
             ehdr = f[extnum].header
-            hdr0 = f[0].header    
+            hdr0 = f[0].header
             filename = hdr0.get('FILENAME', "")
-        
+
         return filename, hdr0, ehdr, phdu
 
     def setHDR0kw(self, primhdr, ehdr):
         # Set attributes from kw defined in the primary header.
         self.instrument = primhdr.get('INSTRUME', None)
-        self.offtab = primhdr.get('OFFTAB', None) 
+        self.offtab = primhdr.get('OFFTAB', None)
         self.idctab = primhdr.get('IDCTAB', None)
         self.date_obs = primhdr.get('DATE-OBS', None)
         self.ra_targ = primhdr.get('RA_TARG', None)
@@ -124,15 +123,15 @@ class HSTWCS(WCS):
         self.d2imerr = primhdr.get('D2IMERR', 0.0)
         try:
             self.pav3 = primhdr['PA_V3']
-        
+
         except KeyError:
             print 'Keyword PA_V3 not found in primary header.'
             print 'This is typical for some old files. Please retrieve the files from the archive again.'
             #print 'Quitting ...'
             #raise
-        
-    
-    
+
+
+
     def readIDCCoeffs(self, header):
         """
         Reads in first order IDCTAB coefficients if present in the header
@@ -143,7 +142,7 @@ class HSTWCS(WCS):
 
     def setInstrSpecKw(self, prim_hdr=None, ext_hdr=None):
         # Based on the instrument kw creates an instalnce of an instrument WCS class
-        # and sets attributes from instrument specific kw 
+        # and sets attributes from instrument specific kw
         if self.instrument in inst_mappings.keys():
             inst_kl = inst_mappings[self.instrument]
             inst_kl = instruments.__dict__[inst_kl]
@@ -160,29 +159,29 @@ class HSTWCS(WCS):
                         pass
         else:
             raise KeyError, "Unsupported instrument - %s" %self.instrument
-    
+
     def setPscale(self):
         # Calculates the plate scale from the cd matrix
-       
+
         cd11 = self.wcs.cd[0][0]
         cd21 = self.wcs.cd[1][0]
         self.pscale = np.sqrt(np.power(cd11,2)+np.power(cd21,2)) * 3600.
-    
+
     def setOrient(self):
         # Recompute ORIENTAT
         cd12 = self.wcs.cd[0][1]
         cd22 = self.wcs.cd[1][1]
         self.orientat = RADTODEG(np.arctan2(cd12,cd22))
-    
+
     def updatePscale(self, pscale):
         """Given a plate scale, update the CD matrix"""
         old_pscale = self.pscale
         self.pscale = pscale
         self.wcs.cd = self.wcs.cd * pscale/old_pscale
-        self.naxis1 = self.naxis1 * old_pscale/ pscale 
-        self.naxis2 = self.naxis2 * old_pscale/ pscale 
+        self.naxis1 = self.naxis1 * old_pscale/ pscale
+        self.naxis2 = self.naxis2 * old_pscale/ pscale
         self.wcs.crpix = self.wcs.crpix *old_pscale/pscale
-        
+
     def updateOrient(self, orient):
         """Given n angle update the CD matrix"""
         if self.orientat == orient:
@@ -196,15 +195,15 @@ class HSTWCS(WCS):
         cd22 = -cd11
         cdmat = np.array([[cd11, cd12],[cd21,cd22]])
         self.wcs.cd = cdmat * self.pscale/3600
-            
-            
+
+
     def readModel(self, update=False, header=None):
         """
         Purpose
         =======
         Read distortion model from idc table.
         Save some of the information as kw needed for interpreting the distortion
-        If header is provided and update is True, some IDC model kw 
+        If header is provided and update is True, some IDC model kw
         will be recorded in the header.
         """
         if self.idctab == None or self.date_obs == None:
@@ -215,157 +214,28 @@ class HSTWCS(WCS):
             'No filter information available\n'
             self.idcmodel = None
             return
-        
+
         self.idcmodel = models.IDCModel(self.idctab,
                     chip=self.chip, direction='forward', date=self.date_obs,
-                    filter1=self.filter1, filter2=self.filter2, 
+                    filter1=self.filter1, filter2=self.filter2,
                     offtab=self.offtab, binned=self.binned)
-        
+
         if update:
             if header==None:
                 print 'Update header with IDC model kw requested but header was not provided\n.'
                 return
             else:
                 self.updatehdr(header)
-    """
-    The next four methods overwrite the corresponding PyWCS methods
-    If detector to image correction is specified in the primary science
-    header and a correction extension exists (D2IMEXT keyword) then 
-    this correction is applied before the corrsponding PyWCS method is called.
-    """
-    def all_pix2sky(self, *args, **kwargs):
-        origin = self.get_origin(*args)
-        if self.det2imext != None and self.d2imerr > self.minerr:
-            img = WCS.all_pix2sky(self,self.det2im(*args) ,origin )
-            if len(args) == 3:
-                return [img[:, i] for i in range(img.shape[1])]
-            else:
-                return img
-        else:
-            return WCS.all_pix2sky(self, *args)
-    all_pix2sky.__doc__ = """
-        Applies detector to image correction before it does the 
-        following pixel transformations:
-        
-        %s
-        """ % (WCS.all_pix2sky.__doc__)
-        
-    def pix2foc(self, *args, **kwargs):
-        origin = self.get_origin(*args)
-        if self.det2imext != None and self.d2imerr > self.minerr:
-            img = WCS.pix2foc(self, self.det2im(*args), origin)
-            if len(args)==3:
-                return [img[:, i] for i in range(img.shape[1])]
-            else:
-                return img
-        else:
-            return WCS.pix2foc(self, *args)
-        
-    pix2foc.__doc__ =  """
-        Applies detector to image correction before it does the 
-        following pixel transformations:
-        
-        %s
-        """ % (WCS.pix2foc.__doc__)
-           
-    def p4_pix2foc(self, *args, **kwargs):
-        origin = self.get_origin(*args)
-        if self.det2imext != None and self.d2imerr > self.minerr:
-            img = WCS.p4_pix2foc(self, self.det2im(*args), origin)
-            if len(args)==3:
-                return [img[:, i] for i in range(img.shape[1])]
-            else:
-                return img
-        else:
-            return WCS.p4_pix2foc(self, *args)
-    
-    p4_pix2foc.__doc__ =  """
-        Applies detector to image correction before it does the 
-        following pixel transformations:
-        
-        %s
-        """ % (WCS.p4_pix2foc.__doc__)
-        
-    def sip_pix2foc(self, *args, **kwargs):
-        origin = self.get_origin(*args)
-        if self.det2imext != None and self.d2imerr > self.minerr:
-            img = WCS.sip_pix2foc(self, self.det2im(*args), origin)
-            if len(args)==3:
-                return [img[:, i] for i in range(img.shape[1])]
-            else:
-                return img
-        else:
-            return WCS.sip_pix2foc(self, *args)
-    
-    sip_pix2foc.__doc__ =  """
-        Applies detector to image correction before it does the 
-        following pixel transformations:
-        
-        %s
-        """ % (WCS.sip_pix2foc.__doc__)
 
     def get_origin(self, *args):
-        # Parse the arguments to get the origin of the 
+        # Parse the arguments to get the origin of the
         #transformation: 0 or 1
         if len(args) == 2:
             return args[1]
         elif len(args) == 3:
             return args[2]
         raise TypeError("Expected 2 or 3 arguments, %d given" % len(args))
-        
-    def det2im(self, *args):
-        """
-        Convert detector to image coordinates
-        """
-        if len(args) == 2:
-            xy, origin = args
-            try:
-                xy = np.asarray(xy)
-                origin = int(origin)
-            except:
-                raise TypeError(
-                    "When providing two arguments, they must be (xy, origin)")
-            return self.d2imcorr.p4_pix2foc(xy,origin)
-        elif len(args) == 3:
-            x, y, origin = args
-            try:
-                x = np.asarray(x)
-                y = np.asarray(y)
-                origin = int(origin)
-            except:
-                raise TypeError(
-                    "When providing three arguments, they must be (x, y, origin)")
-            if len(x) != len(y):
-                raise ValueError("x and y arrays are not the same size")
-            length = len(x)
-            xy = np.hstack((x.reshape((length, 1)),
-                            y.reshape((length, 1))))
-            img = self.d2imcorr.p4_pix2foc(xy,origin)
-            return np.asarray([img[:, i] for i in range(img.shape[1])]).T
-    def get_d2im_lookup(self):
-        """
-        Create a paper IV type lookup table from a reference file
-        """
-        if self.det2imext in [None, "", 'N/A']:
-            return None
-        try:
-            d2im_data = pyfits.getdata(self.filename, ext=('D2IMARR', 1))
-        except KeyError:
-            return None
-        d2im_data = np.array([d2im_data])
-        d2im_hdr = pyfits.getheader(self.filename, ext=('D2IMARR', 1))
-        
-        crpix = (d2im_hdr['CRPIX1'],d2im_hdr['CRPIX2'])
-        crval = (d2im_hdr['CRVAL1'],d2im_hdr['CRVAL2'])
-        cdelt = (d2im_hdr['CDELT1'],d2im_hdr['CDELT2'])
-        cpdis = DistortionLookupTable(d2im_data, crpix, crval, cdelt)
-        d2im_wcs = WCS()
-        if self.axiscorr == 1:
-            d2im_wcs.cpdis1 = cpdis
-        else:
-            d2im_wcs.cpdis2 = cpdis
-        return d2im_wcs
-    
+
     def restore(self, header=None):
         """
         Restore a WCS archive in memory and update the WCS object.
@@ -375,8 +245,8 @@ class HSTWCS(WCS):
         backup = {}
         if header == None:
             print 'Need a valid header in order to restore archive\n'
-            return 
-        
+            return
+
         for k in basic_wcs:
             try:
                 nkw = ('O'+k)[:7]
@@ -390,15 +260,15 @@ class HSTWCS(WCS):
         for item in backup.items():
             card = pyfits.Card(key=item[0], value=item[1])
             cdl.append(card)
-            
+
         h = pyfits.Header(cdl)
         wprm = Wcsprm("".join([str(x) for x in h.ascardlist()]))
         self.wcs = wprm
         self.setPscale()
         self.setOrient()
-        
+
     def updatehdr(self, ext_hdr, newkeywords=None):
-        #kw2add : OCX10, OCX11, OCY10, OCY11 
+        #kw2add : OCX10, OCX11, OCY10, OCY11
         # record the model in the header for use by pydrizzle
         ext_hdr.update('OCX10', self.idcmodel.cx[1,0])
         ext_hdr.update('OCX11', self.idcmodel.cx[1,1])
@@ -410,7 +280,7 @@ class HSTWCS(WCS):
         ext_hdr.update('IDCYREF', self.idcmodel.refpix['YREF'])
         ext_hdr.update('IDCV2REF', self.idcmodel.refpix['V2REF'])
         ext_hdr.update('IDCV3REF', self.idcmodel.refpix['V3REF'])
-        
+
     def printwcs(self):
         print 'WCS Keywords\n'
         print 'CD_11  CD_12: %r %r' % (self.wcs.cd[0,0],  self.wcs.cd[0,1])
@@ -420,26 +290,26 @@ class HSTWCS(WCS):
         print 'NAXIS    : %d %d' % (self.naxis1, self.naxis2)
         print 'Plate Scale : %r' % self.pscale
         print 'ORIENTAT : %r' % self.orientat
-        
+
 def help():
     print 'How to create an HSTWCS object:\n\n'
     print """ \
     1. Using a pyfits HDUList object and an extension number \n
     Example:\n
-    
+
     fobj = pyfits.open('some_file.fits')\n
     w = wcsutil.HSTWCS(fobj, 3)\n\n
-    
+
     2. Create an HSTWCS object using a qualified file name. \n
     Example:\n
     w = wcsutil.HSTWCS('j9irw4b1q_flt.fits[sci,1]')\n\n
-    
+
     3. Create an HSTWCS object using a file name and an extension number. \n
     Example:\n
     w = wcsutil.HSTWCS('j9irw4b1q_flt.fits', ext=2)\n\n
-    
+
     4. Create a template HSTWCS object for an instrument/detector combination.]n
     Example:\n
     w = wcsutil.HSTWCS(instrument='ACS', detector='WFC'\n\n
     """
-    
+