source: TI02-CSML/branches/csml-cdms2/csmllibs/csmlcrs.py @ 3627

Subversion URL: http://proj.badc.rl.ac.uk/svn/ndg/TI02-CSML/branches/csml-cdms2/csmllibs/csmlcrs.py@3627
Revision 3627, 17.2 KB checked in by spascoe, 12 years ago (diff)

This branch contains CSML converted to use cdat_lite-5.

  • convertcdms was run on the source
  • the MA.set_print_limit call was changed to the numpy equivilent
  • The tests were changed to account for the existence of numpy scalar types.

All tests, except the two known to fail, pass on i686 ubuntu.

Line 
1# Adapted for numpy/ma/cdms2 by convertcdms.py
2import string
3import sys     
4import csml.csmllibs.csmlextra
5from copy import copy
6
7class CRSystem(object):
8    ''' Represents a Coordinate Reference System.'''
9    def __init__(self, srsName, axes):
10        self.srsName=srsName
11        self.axes=axes
12        self.srsDimension=len(self.axes)
13        self.axisLabels=''
14        for axis in self.axes:
15            self.axisLabels=self.axisLabels + axis + ' '
16        self.axisLabels=self.axisLabels[:-1]
17        self.timeAxis=None
18        self.lonAxis=None
19        self.latAxis=None
20        self.units=None
21        self.twoD=None
22   
23    def getAxisLabels(self):
24        ''' returns the names of the axes in the system'''
25        labelList=[]
26        for item in self.axisLabels.split():
27            labelList.append(item)
28        return labelList
29
30class CRSCatalogue(object):
31    ''' represents a Catalogue of coordinate reference systems. CRSystem instances are defined in this catalogue. '''
32    def __init__(self):
33        # dictionary to hold known CRSystems:
34        self.systems={}
35        self.pseudosystems={}
36       
37        # define WGS84 CRS:        #time?
38        crs=CRSystem(srsName='WGS84', axes =['time', 'latitude','longitude'])
39        crs.lonAxis=2
40        crs.latAxis=1
41        crs.timeAxis=0
42        crs.twoD='EPSG:4326'
43        self.systems['WGS84']=crs
44       
45        # define WGS84 CRS:        #no time?
46        #crs=CRSystem(srsName='WGS84', axes =['longitude','latitude'])
47        #crs.lonAxis=0
48        #crs.latAxis= 1
49        ##crs.timeAxis=0
50        #self.systems['WGS84']=crs
51       
52       
53         #time only crs
54        crs=CRSystem(srsName='ndg:crs:t', axes =['time'])
55        crs.timeAxis=0
56        crs.lonAxis=None
57        crs.latAxis=None
58        self.systems['ndg:crs:t']=crs
59       
60        #pressure only crs
61        crs=CRSystem(srsName='ndg:crs:p', axes =['pressure'])
62        crs.timeAxis=0
63        crs.lonAxis=None
64        crs.latAxis=None
65        self.systems['ndg:crs:p']=crs
66       
67       
68        # define lon lat pressure time CRS:       
69        crs=CRSystem(srsName='ndg:crs:lonlatpt', axes =['longitude', 'latitude','pressure','time'])
70        crs.lonAxis=0
71        crs.latAxis=1
72        crs.timeAxis=3
73        crs.twoD='EPSG:4326'
74        self.systems['ndg:crs:lonlatpt']=crs
75       
76        # define lon lat height time CRS:       
77        crs=CRSystem(srsName='ndg:crs:lonlatht', axes =['longitude', 'latitude','height','time'])
78        crs.lonAxis=0
79        crs.latAxis=1
80        crs.timeAxis=3
81        crs.twoD='EPSG:4326'
82        self.systems['ndg:crs:lonlatht']=crs
83
84       
85        # define lon lat time CRS:
86        crs=CRSystem(srsName='ndg:crs:lonlatt', axes =['longitude', 'latitude','time'])
87        self.systems['ndg:crs:lonlatt']=crs
88        crs.lonAxis=0
89        crs.latAxis=1
90        crs.timeAxis=2
91        crs.twoD='EPSG:4326'
92       
93        # define lon lat height CRS:
94        crs=CRSystem(srsName='ndg:crs:lonlath', axes =['longitude', 'latitude','height'])
95        self.systems['ndg:crs:lonlath']=crs
96        crs.lonAxis=0
97        crs.latAxis=1
98        crs.timeAxis=None
99        crs.twoD='EPSG:4326'
100       
101       
102        # define height time CRS:
103        crs=CRSystem(srsName='ndg:crs:ht', axes =['height', 'time'])
104        self.systems['ndg:crs:ht']=crs
105        crs.lonAxis=None
106        crs.latAxis=None
107        crs.timeAxis=1
108       
109        # define british national grid plus time CRS:
110        crs=CRSystem(srsName='ndg:crs:bngt', axes =['eastings','northings','time'])
111        self.systems['ndg:crs:bngt']=crs
112        crs.lonAxis=None
113        crs.latAxis=None
114        crs.timeAxis=2
115        crs.twoD='EPSG:27700'
116       
117       
118        #define rotated_latitude_longitude CRS (test)
119        #crs=CRSystem(srsName='ndg:crs:rlonrlatsurft', axes =['grid_longitude', 'grid_latitude','surface', 'time'])
120        #self.systems['ndg:crs:rlonrlatsurft']=crs
121        #crs.lonAxis=0
122        #crs.latAxis=1
123        #crs.timeAxis=3
124       
125       
126        ##define rotated_latitude_longitude_undefined surface CRS (test)
127        #crs=CRSystem(srsName='ndg:crs:undefined_rlonrlatt', axes =['grid_longitude', 'grid_latitude','tba', 'time'])
128        #self.pseudosystems['ndg:crs:undefined_rlonrlatt']=crs
129        #crs.lonAxis=0
130        #crs.latAxis=1
131        #crs.timeAxis=3
132       
133        #define unknown 2D CRS:
134        crs=CRSystem(srsName='ndg:crs:undefined_xt', axes=['tba','time'])
135        self.pseudosystems['ndg:crs:undefined_xt']=crs
136        crs.timeAxis=1
137        crs.lonAxis=None
138        crs.latAxis=None
139       
140        #define unknown 3D CRS:
141        crs=CRSystem(srsName='ndg:crs:undefined_lonlatz', axes=['longitude','latitude','tba'])
142        self.pseudosystems['ndg:crs:undefined_lonlatz']=crs
143        crs.lonAxis=0
144        crs.latAxis=1
145        crs.timeAxis=None
146        crs.twoD='EPSG:4326'
147       
148        #define unknown 4D CRS:
149        crs=CRSystem(srsName='ndg:crs:undefined_lonlatzt', axes=['longitude','latitude','tba','time'])
150        self.pseudosystems['ndg:crs:undefined_lonlatzt']=crs
151        crs.lonAxis=0
152        crs.latAxis=1
153        crs.timeAxis=3
154        crs.twoD='EPSG:4326'
155       
156        #define unknown 5D CRS (test):
157        crs=CRSystem(srsName='ndg:crs:undefined5d_lonlatzt', axes=['probAx','time','tba', 'latitude','longitude'])
158        self.pseudosystems['ndg:crs:undefined5d_lonlatzt']=crs
159        crs.lonAxis=4
160        crs.latAxis=3
161        crs.timeAxis=1
162        crs.twoD='EPSG:4326'
163       
164        #define unknown 1D CRS:
165        crs=CRSystem(srsName='ndg:crs:unknown', axes=['unknown'])
166        self.systems['ndg:crs:unknown']=crs
167                       
168        #define unknown 3D CRS:
169        crs=CRSystem(srsName='ndg:crs:unknown2d', axes=['unknown','unknown'])
170        self.systems['ndg:crs:unknown2d']=crs
171       
172        #define unknown 3D CRS:
173        crs=CRSystem(srsName='ndg:crs:unknown3d', axes=['unknown','unknown','unknown'])
174        self.systems['ndg:crs:unknown3d']=crs
175       
176        #define unknown 4D CRS:
177        crs=CRSystem(srsName='ndg:crs:unknown4d', axes=['unknown','unknown','unknown','unknown'])
178        self.systems['ndg:crs:unknown4d']=crs
179       
180    def getCRS(self, srsName):
181        '''given the name of a CRS e.g. 'ndg:crs:xypt' return the CRSystem object '''
182        try:
183            return self.systems[srsName]
184        except:
185            return self.pseudosystems[srsName]
186   
187   
188    def getUnitType(self, unit):
189        ''' tries to identify unit types'''
190        unittype='unknown'
191        if string.lower(unit) in ['second', 'seconds', 's', 'mins','minute','minutes','hour','hours','h','hr','hrs','day','days']:
192            unittype='time'
193        elif string.lower(unit)[:10] in ['days since', 'seconds si', 'minutes si', 'hours sinc','months sin', 'years sinc']:
194            unittype='time'
195        elif string.lower(unit) in ['mbar', 'pa']:
196            unittype='pressure'
197        elif string.lower(unit) in ['m', 'km']:
198            unittype='height'
199        elif string.lower(unit) in ['degrees_north', 'degrees_south']:
200            unittype='latitude'
201        elif string.lower(unit) in ['degrees_east','degrees_west']:
202            unittype='longitude'
203        elif string.lower(unit) in ['-']:
204            unittype='probAx'
205           
206        else:
207            unittype = unit
208        return unittype
209    def __removespaces(self, s):
210            ''' replaces spaces with underscores'''
211            return s.replace(' ','_')
212
213    def __generatePseudoCRS(self,crsMap, axes, units):
214        ''' if a suitable crs cannot be found a pseudo crs is created'''
215               
216        for psystem in self.pseudosystems:
217            if len(self.pseudosystems[psystem].axes) == len(crsMap):
218                axisorder={}
219                indexes=[]
220                for ax in crsMap:
221                    if ax in self.pseudosystems[psystem].axes:
222                        axisorder[ax]=crsMap.index(ax)
223                        indexes.append(crsMap.index(ax))
224                           
225                if len(axisorder)== len(self.pseudosystems[psystem].axes) - 1:
226                    for ax in enumerate(crsMap):
227                        if ax[1] not in axisorder:
228                            for i in range(3):
229                                if i not in indexes:                               
230                                    axisorder[axes[ax[0]]]=i
231                                    break         
232                               
233                    axisLabels=''                 
234                    orderedNewAxes=[] 
235                    for ax in self.pseudosystems[psystem].axes:
236                        orderedNewAxes.append(ax)
237                    for key in axisorder:
238                        if key in orderedNewAxes:
239                            pass
240                        else:
241                            orderedNewAxes[orderedNewAxes.index('tba')] = key
242
243                    for ax in orderedNewAxes:
244                        axisLabels=axisLabels + ax + ' '         
245               
246                    #crs=CRSystem('ndg:pseudoCRS', orderedNewAxes) #this should be ordered list.
247                    crs=CRSystem(psystem, orderedNewAxes) #this should be ordered list.
248                    crs.axisLabels=axisLabels
249                    crs.timeAxis=self.pseudosystems[psystem].timeAxis
250                    crs.latAxis=self.pseudosystems[psystem].latAxis
251                    crs.latAxis=self.pseudosystems[psystem].lonAxis
252                    orderedunits=[]
253                    for a in crs.axes:
254                        if units[axisorder[a]] == '':
255                            orderedunits.append('none')     
256                        else:
257                            unit=self.__removespaces(units[axisorder[a]])
258                            orderedunits.append(unit) 
259                    crs.units=csml.csmllibs.csmlextra.stringify(orderedunits)                         
260        return crs, axisorder
261
262   
263    def _compareRealAxisNames(self, axes):
264        ''' Used for identifying coordinate systems - will find complete exact matches only. Uses copy to avoid sorting original lists'''
265
266        crs = None
267        axisorder={}
268        unsortedaxes=copy(axes)
269        for system in self.systems:
270            crsaxes=self.systems[system].axes
271            unsortedcrsaxes=copy(crsaxes)
272            tempcrsaxes=copy(crsaxes)
273            tempcrsaxes.sort()
274            tempaxes=copy(axes)
275            tempaxes.sort()
276            if tempcrsaxes==tempaxes:
277                #found exact match  - stop checking
278                crs=self.systems[system]
279                axisorder=self._getAxisOrder(unsortedaxes,unsortedcrsaxes)
280                break
281        return crs, axisorder
282       
283    def _getAxisOrder(self, axes, crsaxes):
284        '''given a list of axis names and a list of comparable crsaxes returns an axis order list e.g. [3,2,1,0] where '3' means the first item in axes corresponds to the item at index 3 in the crsaxes list.'''
285        axisorder={}
286        for ax in axes:
287            if ax in crsaxes:
288                axisorder[ax]=axes.index(ax)
289        return axisorder
290   
291    def _compareNamesAndUnits(self, axes, units, crsMap, stdNames=None):
292        '''build a map of axes and units - use std names to help '''
293        crs = None
294        axisorder={}
295        if not crsMap:
296            for axis in axes:
297                unittype = None
298                if stdNames is not None:
299                    if stdNames[axes.index(axis)]:
300                        unittype=stdNames[axes.index(axis)]
301                else:
302                    unit=units[axes.index(axis)]
303                    unittype=self.getUnitType(unit)         
304                crsMap.append(unittype) 
305           
306        match=0
307        #now try and match up crsMap with known crsystems.       
308        #axisorder stores the order of the supplied axes against the known crs.
309        #so if the known crs is 'Lat' 'Lon' 'Time' and the supplied axes are 'Time' 'Lat' 'Lon' then
310        #axisorder would be [2, 0, 1]         
311        for system in self.systems:
312            if len(self.systems[system].axes) != len(crsMap):
313                #wrong dimensionality, skip this crs
314                continue
315            match=1
316            axisorder={}
317            for ax in self.systems[system].axes:
318                if ax in crsMap:
319                    axisorder[ax]=crsMap.index(ax)
320                else:
321                    match = 0
322                    break
323            if match == 1: 
324                crs=self.systems[system]   
325                break   
326        return crs, axisorder, crsMap
327   
328    def _addUnitsToCRSDefinition(self, crs, units, axisorder):
329        '''if no units are defined in the crs, set the units to be those of the original data'''
330        if crs.units is None:
331            if units is not None:
332                orderedunits=[]
333                for a in crs.axes:
334                    orderedunits.append(self.__removespaces(units[axisorder[a]]))
335                    crs.units=csml.csmllibs.csmlextra.stringify(orderedunits)
336        return crs
337               
338    def determineCRS(self, axes=None, units=None, knownCRSAxes=None,stdNames=None):
339        '''given any list of axis names and a list of units for these axes attempt to determine the CRS and return the CRSystem object and an axis order list.
340        e.g passing in: (axes=['t', 'ht', 'latitude', 'longitude'],units=['days since 1991-09-01 00:00:00', 'm', 'degrees_north', 'degrees_east'])
341        returns self.systems['ndg:crs:xypt'], {'latitude': 2, 'pressure': 1, 'longitude': 3, 'time': 0}
342        Assumes the units are ordered to correspond with the axes
343        ''' 
344        axisorder={}
345        crs =None
346        #perform various tests to try and determine which crs this is.
347        #test: compare real names of axes with names of axes in coordinate reference systems
348        #looks for exact matches only.
349        if axes is not None:
350            crs, axisorder = self._compareRealAxisNames(copy(axes))
351        #set up crsMap - may be empty
352        crsMap=[]
353        if knownCRSAxes is not None:
354            for item in knownCRSAxes:
355                if item is not None:
356                    crsMap=knownCRSAxes
357                    break 
358                       
359       
360        if crs is None:
361            #try and match based on units, names and stdNames
362            crs,axisorder, crsMap=self._compareNamesAndUnits(axes, units, crsMap, stdNames=None)
363        if crs is None:
364            #try to generate a pseudo crs
365            crs, axisorder=self.__generatePseudoCRS(crsMap, axes, units)
366           
367        #Finally, if no units are defined in the crs, set the units to be those of the original data
368        if crs is not None:
369            crs=self._addUnitsToCRSDefinition(crs, units, axisorder)
370        return crs, axisorder
371     
372    def _identifyAxisByStdName(self,  stdName):
373        '''given a CF standard name return the axis name'''
374        understoodNames={'grid_longitude': 'grid_longitude', 'grid_latitude':'grid_latitude'}
375        if stdName in understoodNames.keys():
376            axisname= understoodNames[stdName]
377        else:
378            axisname =None
379        return axisname
380       
381def main():
382    import cdms2 as cdms # just for testing
383    #sys.stdout = open("/home/dom/svn/trunk/csml/testfiles/gridseries/crsout.txt", "w")
384    cat=CRSCatalogue()
385 
386    #test every crs in this netcdf file
387    crsdictionary={}
388    f=cdms.open('/home/dom/svn/trunk/csml/testfiles/gridseries/xaaqda@pxs09c1.nc')
389    #f=cdms.open('/home/dom/EN/air_frost_1961-1990.nc')
390    for var in f.variables:
391        v=f.variables[var]
392        axes=v.getAxisIds()
393        units =[]
394        for axis in axes:
395            ax=f.getAxis(axis)
396            units.append(ax.attributes['units'])
397        crsdictionary[str(axes)]=units
398    n=0
399    #test each definition in dictionary
400       
401    for key in crsdictionary:
402        n=n+1
403        print '\n TEST %d'%n
404        print '*************************************'
405        #make list from string.
406        axs=[]
407        for item in key.split():
408            axs.append(item)
409        axs=eval(key)
410        uns=crsdictionary[key]
411        print 'AXES: %s'%axs
412        print 'UNITS: %s'%uns
413        print '----------------------------'
414        crs, axisorder= cat.determineCRS(axes=axs, units=uns)
415        print crs, axisorder
416        if crs is not None:
417            print 'CRS found: %s'%crs.srsName
418            print 'ORDER:  %s'%axisorder
419            print 'LABELS: %s'%crs.axisLabels
420            print 'CRS AXES: %s'%crs.axes
421        else:
422            print 'CRS not found'
423        labels=''
424       
425       
426        #for axis in axes:
427            #labels=labels + axis + ' '
428       
429        ##print '\n Pseudo CSML:'
430        ##print '<GridSeriesDomain srsName=%s srsDimension=%s axisLabels=%s>'%(crs.srsName, crs.srsDimension,crs.axisLabels)
431        ##print '<axisLabels>%s</axisLabels>'%labels
432        ##for axis in axes:
433            ##print '<GridOrdinate>'
434            ##unit=units[axes.index(axis)]
435            ##print '     <coordAxisLabel>%s</coordAxisLabel>'%crs.axes[axisorder[axes.index(axis)]]
436            ##print '     <gridAxesSpanned>%s</gridAxesSpanned>'%axis
437            ##print '</GridOrdinate>'
438        ##print '</GridSeriesDomain>'
439       
440        ##print '**************************************'
441   ##test getting CRS by name:
442    #print 'getting ndg:crs:xypt by name'
443    #crs=cat.getCRS('ndg:crs:xypt')
444    #print 'returns %s'%crs.srsName
445       
446   
447if __name__=="__main__":
448    main()
Note: See TracBrowser for help on using the repository browser.