source: TI02-CSML/trunk/csml/csmllibs/csmlcrs.py @ 3277

Subversion URL: http://proj.badc.rl.ac.uk/svn/ndg/TI02-CSML/trunk/csml/csmllibs/csmlcrs.py@3277
Revision 3277, 16.4 KB checked in by domlowe, 13 years ago (diff)

more doctrings and fixing indentation

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