source: TI02-CSML/trunk/csml/API/genSubset.py @ 2598

Subversion URL: http://proj.badc.rl.ac.uk/svn/ndg/TI02-CSML/trunk/csml/API/genSubset.py@2598
Revision 2598, 12.0 KB checked in by domlowe, 12 years ago (diff)

nearest neighbour bug fixed

Line 
1'''#getSubset.py contains generic subsetting code that can be reused for multiple features
2Dominic Lowe, CCLRC, 31/01/2007'''
3
4import csml
5import csmlutils
6import sys
7import Numeric
8
9def checkNeighbours(domain, **kwargs):
10    #for any non-range requests, get nearest neighbour
11    #e.g if 'latitude': (11) requested, latitude=12 may be the nearest value
12    for key in kwargs:
13    #need to skip time axis
14        #handle single values
15        if type(kwargs[key]) is not tuple:
16            if type(domain[key]) is not list:
17                axeslist=domain[key].tolist()
18            else:
19                axeslist = domain[key]
20            nearestNeighbour=csml.API.csmlutils.nudgeSingleValuesToAxisValues(kwargs[key],axeslist)
21            if nearestNeighbour is not None:
22                kwargs[key]=nearestNeighbour   
23        else:
24            ##handle ranges
25            #tmpkey=[]
26            ##this finds the nearest neighbour without overstepping 0 (for longitude)
27            #if kwargs[key][0] > kwargs[key][1]:                               
28                #nearestNeighbour=csml.API.csmlutils.nudgeSingleValuesToAxisValues(val, domain[key], minBound=kwargs[key][0], maxBound=0)
29                #if nearestNeighbour is not None:
30                    #tmpkey.append(nearestNeighbour)   
31                #nearestNeighbour=csml.API.csmlutils.nudgeSingleValuesToAxisValues(val, domain[key], minBound=0, maxBound=kwargs[key][1])
32                #if nearestNeighbour is not None:
33                    #tmpkey.append(nearestNeighbour)   
34                                 
35            #else:
36                tmpkey=[]
37                for val in kwargs[key]:
38                    nearestNeighbour=csml.API.csmlutils.nudgeSingleValuesToAxisValues(val, domain[key], minBound=kwargs[key][0], maxBound=kwargs[key][1])
39                    if nearestNeighbour is not None:
40                        tmpkey.append(nearestNeighbour)   
41                kwargs[key]=tuple(tmpkey)           
42    return kwargs
43
44def subsetDomain(timeaxis,times, domain,**kwargs):
45    '''takes the domain and returns a subset according to the keyword selection criteria
46    time = name of time dimension
47    times = string of times
48    '''   
49    strTimes=times
50    subsetDomain={}
51    totalArraySize=1
52    for key in domain.keys():
53        straxisValues=''
54        if key in kwargs:
55            if key ==timeaxis:
56                straxisValues=strTimes
57                arraySize=len(strTimes.split())
58            elif type(kwargs[key]) is not tuple:
59                #only one value not a range
60                straxisValues=str(kwargs[key]) 
61            elif kwargs[key][0] < kwargs[key][1]:   
62                for val in domain[key]:
63                      if val is not '':
64                            if float(val) >= kwargs[key][0]:
65                                if float(val) <= kwargs[key] [1]:
66                                    straxisValues=straxisValues+ str(val) + ','
67                straxisValues=straxisValues[:-1]
68            else:#this if deals with selections such as longitude (330,30) where the lower limit is 'greater' than the upper limit in a mathematical sense.
69                    for val in domain[key]:
70                        if val is not '':
71                            if val >= kwargs[key][0]:
72                                straxisValues=straxisValues+ str(val) + ','
73                    for val in domain[key]:
74                        if val is not '':
75                            if val <= kwargs[key] [1]:
76                                straxisValues=straxisValues+ str(val) + ','
77                    straxisValues=straxisValues[:-1]                                             
78        else: # this dimension has not been subsetted at all - CHECK  THIS
79            for val in domain[key]:
80                if val is not '':
81                    straxisValues=straxisValues+ str(val) + ','       
82            straxisValues=straxisValues[:-1]                       
83                                           
84        subsetDomain[key]=straxisValues
85        if key != timeaxis:
86            arraySize=len(subsetDomain[key].split(','))
87        else:
88            arraySize=len(subsetDomain[key].split())
89        totalArraySize = totalArraySize * arraySize
90 
91    return subsetDomain, totalArraySize
92   
93def _setCalendar(feature, timeName, ords):
94    '''sets the cdtime calendar needed for conversion from CSML to NetCDF'''
95    calset=False
96    for gridOrd in ords:
97        if gridOrd.coordAxisLabel.CONTENT==timeName:     
98            try:
99                caltype=gridOrd.coordAxisValues.timePositionList.frame.split(':',2)[1]
100                csml.csmllibs.csmltime.setcdtimeCalendar(caltype)
101                calset=True
102            except:pass
103    if calset!=True:
104        csml.csmllibs.csmltime.setcdtimeCalendar(csml.csmllibs.csmltime.cdtime.DefaultCalendar)       
105    try:
106        caltype=gridOrd.coordAxisValues.timePositionList.frame.split(':',2)[1]
107        csml.csmllibs.csmltime.setcdtimeCalendar(caltype)
108    except:
109        csml.csmllibs.csmltime.setcdtimeCalendar(csml.csmllibs.csmltime.cdtime.DefaultCalendar)     
110        caltype='standard' 
111    return caltype
112
113
114def _getTimes(timeSelection, timeName, domain):
115    #currently supporting domain subsetting only by CRS name
116    #(but should be easy to extend later)
117    if type(timeSelection) is str:
118        times=(timeSelection,)
119    else:
120        times=timeSelection
121   
122    if len(times)==0:
123        #no time specified, select all.
124        times= domain[timeName]
125    tone=csml.csmllibs.csmltime.getCDtime(times[0])
126    if len(times) == 2:
127        #then this is a range of times (t1, tn), and not a list
128        try:
129            tone=csml.csmllibs.csmltime.getCDtime(times[0])
130        except:
131            tone=times[0]
132        try:
133            ttwo=csml.csmllibs.csmltime.getCDtime(times[1])
134        except:
135            ttwo=times[1]
136        times=[]         
137        for time in domain[timeName]:
138            timeok=csml.csmllibs.csmltime.compareTimes(tone,time,ttwo)
139            if timeok ==1:
140                times.append(time)
141    return times
142
143def _getTimeToFileRatio(feature,domain, timeName):
144    if hasattr(feature.value.rangeSet, 'valueArray'):
145        if hasattr(feature.value.rangeSet.valueArray.valueComponent, 'insertedExtract'):
146            try:
147                numFiles= len( csmlutils.listify(feature.value.rangeSet.valueArray.valueComponent.insertedExtract.components)[0].fileList.fileNames.CONTENT.split())
148            except:
149                try:
150                    numFiles= len(csmlutils.listify(feature.value.rangeSet.valueArray.valueComponent.insertedExtract.components)[0].fileName.CONTENT)
151                except:
152                    numFiles= len(csmlutils.listify(feature.value.rangeSet.valueArray.valueComponent.insertedExtract.fileName.CONTENT))
153            timeToFileRatio= len(domain[timeName])/numFiles
154            if timeToFileRatio==0:
155                timeToFileRatio=None           
156            return timeToFileRatio
157
158def getCoordTransformTable(domainSubset, crs, frame):
159    cTT=csml.parser.GridCoordinatesTable()
160    ords =[]
161    for key in domainSubset.keys():
162        go=csml.parser.GridOrdinateDescription()
163        go.coordAxisLabel=csml.parser.csString(key)
164        go.gridAxesSpanned=csml.parser.csString(key)
165        go.coordAxisValues = csml.parser.SpatialOrTemporalPositionList()
166        go.coordAxisValues.id=csml.csmllibs.csmlextra.getRandomID()
167        vals=str(domainSubset[key]).replace(',',' ')
168       
169        if key==crs.axes[crs.timeAxis]:
170            go.coordAxisValues.timePositionList=csml.parser.csString(vals)
171            go.coordAxisValues.frame = frame
172            #self.domain.key placeholder
173        else:
174            go.coordAxisValues.coordinateList=csml.parser.csString(vals) #self.domain.key placeholder
175        seqRule= csml.parser.SequenceRule()
176        seqRule.CONTENT='Linear'
177        seqRule.axisOrder='+1'  #TO DO. Work this out.
178        go.sequenceRule=seqRule
179        ords.append(go) #go needs a few more properties setting
180    cTT.gridOrdinates=ords
181    return cTT
182
183
184
185def getTheData(feature, selection, times,timeName):
186    #SOME OF THIS SHOULD PROBABLY BE IN THE DATA IO LAYER
187    #add time range back into the selection
188    if len(times)==1:
189        selection[timeName]=times[0]
190    else:
191         selection[timeName]=(times[0], times[len(times)-1])
192
193    domain = feature.domain
194    value=feature.value
195    files=[]
196    strTimes=''
197    fulldata=None
198    #get the ratio of times to files
199    timeToFileRatio = _getTimeToFileRatio(feature, domain, timeName)
200           
201    #list to keep track of files that have already been fetched. eg. if multiple times are in a single file only need to get data from that file once...
202    filesFetched=[]
203     
204    #get list of file extracts
205    try:
206        componentlist = csmlutils.listify(value.rangeSet.valueArray.valueComponent.insertedExtract.components)
207    except:
208        componentlist = csmlutils.listify(value.rangeSet.valueArray.valueComponent.insertedExtract)
209    for time in times:
210        listPosition=domain[timeName].index(time)
211        strTimes= strTimes + ' ' + time                   
212        for comp in componentlist:
213            if timeToFileRatio == None:
214                filePos=None
215            else:               
216                filePos=int(float(listPosition)/timeToFileRatio)
217            if filePos in filesFetched:
218                continue #already got data from this file, try next time         
219            data, fillvalue, axisorder, units=comp.getData(fileposition=filePos, **selection)         
220            if filePos is None:
221                files.append(comp.fileName.CONTENT)
222            else:
223                try:
224                    files.append(comp.fileList.fileNames.CONTENT[filePos]) #TODO, get the right file name
225                except:
226                    files.append(comp.fileName.CONTENT)
227               
228    #open the file
229           
230           
231            if fulldata is None:
232                fulldata=data
233            else:
234                newfulldata=Numeric.concatenate([fulldata,data], axis=0)   
235                fulldata=newfulldata
236            filesFetched.append(filePos)
237    if hasattr(value.rangeSet, 'valueArrayl'):
238        units.append(value.rangeSet.valueArray.valueComponent.quantityList.uom) # final unit is that of the parameter
239    else:
240        units.append ('unitsTBA')
241    return strTimes, axisorder, units, fulldata, fillvalue
242
243def genericSubset(feature, outputdir, ncname, domain, kwargs):
244    if outputdir is not None:
245        pathToSubsetNetCDF=outputdir+'/' +ncname
246    else:
247        pathToSubsetNetCDF=ncname
248   
249    #deal with longitude requests
250    #if the request is in -ve,+ve eg (-30,30) but the data is in (0,360) need to handle this by changing the args.
251    kwargs=csmlutils.fixLongitude(domain,kwargs)
252
253    #if request doesn't match domain points find nearest neighbours
254    kwargs=csml.API.genSubset.checkNeighbours(domain, **kwargs)
255   
256   
257   
258   
259    #get the name of the time axis in the coordinate reference system
260    cat=csml.csmllibs.csmlcrs.CRSCatalogue()
261    if type(feature) == csml.parser.GridSeriesFeature:
262        crs=cat.getCRS(feature.value.gridSeriesDomain.srsName,labels=feature.value.gridSeriesDomain.axisLabels)
263        gridordinates = feature.value.gridSeriesDomain.coordTransformTable.gridOrdinates
264    elif type(feature) == csml.parser.ProfileSeriesFeature:
265        crs=cat.getCRS(feature.value.profileSeriesDomain.srsName,labels = feature.value.profileSeriesDomain.axisLabels)
266        gridordinates = feature.value.profileSeriesDomain.coordTransformTable.gridOrdinates
267   
268    timeName=crs.axes[crs.timeAxis]
269    #Find the original time name (timeAxis) for the file.
270    for gridOrd in gridordinates:
271        if gridOrd.coordAxisLabel.CONTENT==timeName:
272            timeAxis = gridOrd.gridAxesSpanned.CONTENT  #only works for regular grids atm
273            break
274    #set the reference system for the time axis
275    caltype=_setCalendar(feature, timeName, gridordinates)
276   
277    try:
278        timeSelection=kwargs[timeName]
279    except KeyError:
280        timeSelection=[]
281   
282    times=_getTimes(timeSelection, timeName,domain)   
283    return pathToSubsetNetCDF, kwargs, timeAxis,timeName, caltype, times
Note: See TracBrowser for help on using the repository browser.