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

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

subsetting grid to profileseries to profile 99 percent working..

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            try:
88                caltype=gridOrd.coordAxisValues.frame.split(':',1)[0]
89                calunits=gridOrd.coordAxisValues.frame.split(':',1)[1]
90                csml.csmllibs.csmltime.setcdtimeCalendar(caltype)
91                calset=True
92            except:pass
93    if calset!=True:
94        csml.csmllibs.csmltime.setcdtimeCalendar(csml.csmllibs.csmltime.cdtime.DefaultCalendar)   
95    try:
96        caltype=gridOrd.coordAxisValues.frame.split(':',1)[0]
97        calunits=gridOrd.coordAxisValues.frame.split(':',1)[1]
98        csml.csmllibs.csmltime.setcdtimeCalendar(caltype)
99    except:
100        csml.csmllibs.csmltime.setcdtimeCalendar(csml.csmllibs.csmltime.cdtime.DefaultCalendar)
101       
102    return calunits, caltype
103
104
105def _getTimes(timeSelection, timeName, domain):
106    #currently supporting domain subsetting only by CRS name
107    #(but should be easy to extend later)
108    if type(timeSelection) is str:
109        times=(timeSelection,)
110    else:
111        times=timeSelection
112   
113    if len(times)==0:
114        #no time specified, select all.
115        times= domain[timeName]
116    tone=csml.csmllibs.csmltime.getCDtime(times[0])
117    if len(times) == 2:
118        #then this is a range of times (t1, tn), and not a list
119        try:
120            tone=csml.csmllibs.csmltime.getCDtime(times[0])
121        except:
122            tone=times[0]
123        try:
124            ttwo=csml.csmllibs.csmltime.getCDtime(times[1])
125        except:
126            ttwo=times[1]
127        times=[]         
128        for time in domain[timeName]:
129            timeok=csml.csmllibs.csmltime.compareTimes(tone,time,ttwo)
130            if timeok ==1:
131                times.append(time)
132    return times
133
134def _getTimeToFileRatio(feature,domain, timeName):
135    if hasattr(feature.value.rangeSet, 'valueArray'):
136        if hasattr(feature.value.rangeSet.valueArray.valueComponent.quantityList, '__insertedExtract'):
137            numFiles= len( csmlutils.listify(feature.value.rangeSet.valueArray.valueComponent.quantityList.__insertedExtract.components)[0].fileList.fileNames.CONTENT.split())
138            return len(domain[timeName])/numFiles
139
140def getCoordTransformTable(domainSubset, crs, frame):
141    cTT=csml.parser.GridCoordinatesTable()
142    ords =[]
143    for key in domainSubset.keys():
144        go=csml.parser.GridOrdinateDescription()
145        go.coordAxisLabel=csml.parser.csString(key)
146        go.gridAxesSpanned=csml.parser.csString(key)
147        go.coordAxisValues = csml.parser.SpatialOrTemporalPositionList()
148        if key==crs.axes[crs.timeAxis]:
149            go.coordAxisValues.timePositionList=csml.parser.csString(domainSubset[key])
150            go.coordAxisValues.frame = frame
151            #self.domain.key placeholder
152        else:
153            go.coordAxisValues.coordinateList=csml.parser.csString(domainSubset[key]) #self.domain.key placeholder
154        ords.append(go) #go needs a few more properties setting
155    cTT.gridOrdinates=ords
156    return cTT
157
158
159
160def getTheData(feature, selection, times,timeName):
161    print selection
162    print times
163    print timeName
164   
165    #SOME OF THIS SHOULD PROBABLY BE IN THE DATA IO LAYER
166    domain = feature.domain
167    value=feature.value
168    files=[]
169    strTimes=''
170    fulldata=None
171    #get the ratio of times to files
172    timeToFileRatio = _getTimeToFileRatio(feature, domain, timeName)
173           
174    #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...
175    filesFetched=[]
176     
177    if hasattr(value.rangeSet, 'arrayDescriptor'):
178        #then just dealing with one file.
179        componentlist = csmlutils.listify(value.rangeSet.arrayDescriptor)
180    else:
181        #dealing with aggregated array
182         componentlist = csmlutils.listify(value.rangeSet.valueArray.valueComponent.quantityList.__insertedExtract.components)
183       
184    for time in times:
185        listPosition=domain[timeName].index(time)
186        strTimes= strTimes + ' ' + time                   
187        for comp in componentlist:
188            if timeToFileRatio == None:
189                filePos=None
190            else:
191                filePos=int(float(listPosition)/timeToFileRatio)
192            if filePos in filesFetched:
193                continue #already got data from this file, try next time         
194            data, fillvalue, axisorder, units=comp.getData(fileposition=filePos, **selection)         
195            if filePos is None:
196                files.append(comp.fileName.CONTENT)
197            else:
198                files.append(comp.fileList.fileNames.CONTENT[filePos]) #TODO, get the right file name
199           
200            if fulldata is None:
201                fulldata=data
202            else:
203                newfulldata=Numeric.concatenate([fulldata,data], axis=0)   
204                fulldata=newfulldata
205            filesFetched.append(filePos)
206    if hasattr(value.rangeSet, 'valueArrayl'):
207        units.append(value.rangeSet.valueArray.valueComponent.quantityList.uom) # final unit is that of the parameter
208    else:
209        units.append ('unitsTBA')
210    return strTimes, axisorder, units, fulldata, fillvalue
211
212def genericSubset(feature, csmlpath, ncpath, domain, kwargs):
213    if ncpath is not None:
214        pathToSubsetNetCDF=ncpath
215    else:
216        pathToSubsetNetCDF='temp.nc'
217   
218    #deal with longitude requests
219    #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.
220    kwargs=csmlutils.fixLongitude(domain,kwargs)
221       
222    #get the name of the time axis in the coordinate reference system
223    cat=csml.csmllibs.csmlcrs.CRSCatalogue()
224    if type(feature) == csml.parser.GridSeriesFeature:
225        crs=cat.getCRS(feature.value.gridSeriesDomain.srsName)
226        gridordinates = feature.value.gridSeriesDomain.coordTransformTable.gridOrdinates
227    elif type(feature) == csml.parser.ProfileSeriesFeature:
228        crs=cat.getCRS(feature.value.profileSeriesDomain.srsName)
229        gridordinates = feature.value.profileSeriesDomain.coordTransformTable.gridOrdinates
230    timeName=crs.axes[crs.timeAxis]
231    #Find the original time name (timeAxis) for the file.
232    for gridOrd in gridordinates:
233        if gridOrd.coordAxisLabel.CONTENT==timeName:
234            timeAxis = gridOrd.gridAxesSpanned.CONTENT  #only works for regular grids atm
235            break
236    #set the reference system for the time axis
237    calunits, caltype=_setCalendar(feature, timeName, gridordinates)
238   
239    try:
240        timeSelection=kwargs[timeName]
241    except KeyError:
242        timeSelection=[]
243   
244    times=_getTimes(timeSelection, timeName,domain)   
245    return pathToSubsetNetCDF, kwargs, timeAxis,timeName, calunits, caltype, times
Note: See TracBrowser for help on using the repository browser.