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

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

fixing SpatialOrTemporalList?

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, gridnames, **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     
13    for key in kwargs:
14    #need to skip time axis
15        #handle single values
16        if type(kwargs[key]) is not tuple:
17            if type(domain[key]) is not list:
18                axeslist=domain[key].tolist()
19            else:
20                axeslist = domain[key]
21            nearestNeighbour=csml.API.csmlutils.nudgeSingleValuesToAxisValues(kwargs[key],axeslist)
22            if nearestNeighbour is not None:
23                kwargs[key]=nearestNeighbour   
24        else:
25            #handle ranges
26            tmpkey=[]
27            for val in kwargs[key]:
28                nearestNeighbour=csml.API.csmlutils.nudgeSingleValuesToAxisValues(val, domain[key])
29                if nearestNeighbour is not None:
30                    tmpkey.append(nearestNeighbour)   
31                kwargs[key]=tuple(tmpkey)
32    return kwargs
33
34def subsetDomain(timeaxis,times, domain,**kwargs):
35    '''takes the domain and returns a subset according to the keyword selection criteria
36    time = name of time dimension
37    times = string of times
38    '''   
39    strTimes=times
40    subsetDomain={}
41    totalArraySize=1
42    for key in domain.keys():
43        straxisValues=''
44        if key in kwargs:
45            if key ==timeaxis:
46                straxisValues=strTimes
47                arraySize=len(strTimes.split())
48            elif type(kwargs[key]) is not tuple:
49                #only one value not a range
50                straxisValues=str(kwargs[key]) 
51            elif kwargs[key][0] < kwargs[key][1]:   
52                for val in domain[key]:
53                      if val is not '':
54                            if float(val) >= kwargs[key][0]:
55                                if float(val) <= kwargs[key] [1]:
56                                    straxisValues=straxisValues+ str(val) + ','
57                straxisValues=straxisValues[:-1]
58            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.
59                    for val in domain[key]:
60                        if val is not '':
61                            if val >= kwargs[key][0]:
62                                straxisValues=straxisValues+ str(val) + ','
63                    for val in domain[key]:
64                        if val is not '':
65                            if val <= kwargs[key] [1]:
66                                straxisValues=straxisValues+ str(val) + ','
67                    straxisValues=straxisValues[:-1]                                             
68        else: # this dimension has not been subsetted at all - CHECK  THIS
69            for val in domain[key]:
70                if val is not '':
71                    straxisValues=straxisValues+ str(val) + ','       
72            straxisValues=straxisValues[:-1]                       
73                                           
74        subsetDomain[key]=straxisValues
75        if key != timeaxis:
76            arraySize=len(subsetDomain[key].split(','))
77        else:
78            arraySize=len(subsetDomain[key].split())
79        totalArraySize = totalArraySize * arraySize
80    return subsetDomain, totalArraySize
81   
82def _setCalendar(feature, timeName, ords):
83    '''sets the cdtime calendar needed for conversion from CSML to NetCDF'''
84    calset=False
85    for gridOrd in ords:
86        if gridOrd.coordAxisLabel.CONTENT==timeName:
87           
88            try:
89                caltype=gridOrd.coordAxisValues.timePositionList.frame.split(':',1)[0]
90                calunits=gridOrd.coordAxisValues.timePositionList.frame.split(':',1)[1]
91                csml.csmllibs.csmltime.setcdtimeCalendar(caltype)
92                calset=True
93            except:pass
94    if calset!=True:
95        csml.csmllibs.csmltime.setcdtimeCalendar(csml.csmllibs.csmltime.cdtime.DefaultCalendar)   
96    try:
97        caltype=gridOrd.timePositionList.frame.split(':',1)[0]
98        calunits=gridOrd.timePositionList.frame.split(':',1)[1]
99        csml.csmllibs.csmltime.setcdtimeCalendar(caltype)
100    except:
101        csml.csmllibs.csmltime.setcdtimeCalendar(csml.csmllibs.csmltime.cdtime.DefaultCalendar)
102       
103    return calunits, caltype
104
105
106def _getTimes(timeSelection, timeName, domain):
107    #currently supporting domain subsetting only by CRS name
108    #(but should be easy to extend later)
109    if type(timeSelection) is str:
110        times=(timeSelection,)
111    else:
112        times=timeSelection
113   
114    if len(times)==0:
115        #no time specified, select all.
116        times= domain[timeName]
117    tone=csml.csmllibs.csmltime.getCDtime(times[0])
118    if len(times) == 2:
119        #then this is a range of times (t1, tn), and not a list
120        try:
121            tone=csml.csmllibs.csmltime.getCDtime(times[0])
122        except:
123            tone=times[0]
124        try:
125            ttwo=csml.csmllibs.csmltime.getCDtime(times[1])
126        except:
127            ttwo=times[1]
128        times=[]         
129        for time in domain[timeName]:
130            timeok=csml.csmllibs.csmltime.compareTimes(tone,time,ttwo)
131            if timeok ==1:
132                times.append(time)
133    return times
134
135def _getTimeToFileRatio(feature,domain, timeName):
136    if hasattr(feature.value.rangeSet, 'valueArray'):
137        if hasattr(feature.value.rangeSet.valueArray.valueComponent.quantityList, '__insertedExtract'):
138            numFiles= len( csmlutils.listify(feature.value.rangeSet.valueArray.valueComponent.quantityList.__insertedExtract.components)[0].fileList.fileNames.CONTENT.split())
139            return len(domain[timeName])/numFiles
140
141def getCoordTransformTable(domainSubset, crs, frame):
142    cTT=csml.parser.GridCoordinatesTable()
143    ords =[]
144    for key in domainSubset.keys():
145        go=csml.parser.GridOrdinateDescription()
146        go.coordAxisLabel=csml.parser.csString(key)
147        go.gridAxesSpanned=csml.parser.csString(key)
148        go.coordAxisValues = csml.parser.SpatialOrTemporalPositionList()
149        if key==crs.axes[crs.timeAxis]:
150            go.coordAxisValues.timePositionList=csml.parser.csString(domainSubset[key])
151            go.coordAxisValues.frame = frame
152            #self.domain.key placeholder
153        else:
154            go.coordAxisValues.coordinateList=csml.parser.csString(domainSubset[key]) #self.domain.key placeholder
155        ords.append(go) #go needs a few more properties setting
156    cTT.gridOrdinates=ords
157    return cTT
158
159
160
161def getTheData(feature, selection, times,timeName):
162    print selection
163    print times
164    print timeName
165   
166    #SOME OF THIS SHOULD PROBABLY BE IN THE DATA IO LAYER
167    domain = feature.domain
168    value=feature.value
169    files=[]
170    strTimes=''
171    fulldata=None
172    #get the ratio of times to files
173    timeToFileRatio = _getTimeToFileRatio(feature, domain, timeName)
174           
175    #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...
176    filesFetched=[]
177     
178    if hasattr(value.rangeSet, 'arrayDescriptor'):
179        #then just dealing with one file.
180        componentlist = csmlutils.listify(value.rangeSet.arrayDescriptor)
181    else:
182        #dealing with aggregated array
183         componentlist = csmlutils.listify(value.rangeSet.valueArray.valueComponent.quantityList.__insertedExtract.components)
184       
185    for time in times:
186        listPosition=domain[timeName].index(time)
187        strTimes= strTimes + ' ' + time                   
188        for comp in componentlist:
189            if timeToFileRatio == None:
190                filePos=None
191            else:
192                filePos=int(float(listPosition)/timeToFileRatio)
193            if filePos in filesFetched:
194                continue #already got data from this file, try next time         
195            data, fillvalue, axisorder, units=comp.getData(fileposition=filePos, **selection)         
196            if filePos is None:
197                files.append(comp.fileName.CONTENT)
198            else:
199                files.append(comp.fileList.fileNames.CONTENT[filePos]) #TODO, get the right file name
200           
201            if fulldata is None:
202                fulldata=data
203            else:
204                newfulldata=Numeric.concatenate([fulldata,data], axis=0)   
205                fulldata=newfulldata
206            filesFetched.append(filePos)
207    if hasattr(value.rangeSet, 'valueArrayl'):
208        units.append(value.rangeSet.valueArray.valueComponent.quantityList.uom) # final unit is that of the parameter
209    else:
210        units.append ('unitsTBA')
211    return strTimes, axisorder, units, fulldata, fillvalue
212
213def genericSubset(feature, csmlpath, ncpath, domain, kwargs):
214    if ncpath is not None:
215        pathToSubsetNetCDF=ncpath
216    else:
217        pathToSubsetNetCDF='temp.nc'
218   
219    #deal with longitude requests
220    #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.
221    kwargs=csmlutils.fixLongitude(domain,kwargs)
222       
223    #get the name of the time axis in the coordinate reference system
224    cat=csml.csmllibs.csmlcrs.CRSCatalogue()
225    if type(feature) == csml.parser.GridSeriesFeature:
226        crs=cat.getCRS(feature.value.gridSeriesDomain.srsName,feature.value.gridSeriesDomain.axisLabels)
227        gridordinates = feature.value.gridSeriesDomain.coordTransformTable.gridOrdinates
228    elif type(feature) == csml.parser.ProfileSeriesFeature:
229        crs=cat.getCRS(feature.value.profileSeriesDomain.srsName)
230        gridordinates = feature.value.profileSeriesDomain.coordTransformTable.gridOrdinates
231    timeName=crs.axes[crs.timeAxis]
232    #Find the original time name (timeAxis) for the file.
233    for gridOrd in gridordinates:
234        if gridOrd.coordAxisLabel.CONTENT==timeName:
235            timeAxis = gridOrd.gridAxesSpanned.CONTENT  #only works for regular grids atm
236            break
237    #set the reference system for the time axis
238    calunits, caltype=_setCalendar(feature, timeName, gridordinates)
239   
240    try:
241        timeSelection=kwargs[timeName]
242    except KeyError:
243        timeSelection=[]
244   
245    times=_getTimes(timeSelection, timeName,domain)   
246    return pathToSubsetNetCDF, kwargs, timeAxis,timeName, calunits, caltype, times
Note: See TracBrowser for help on using the repository browser.