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

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

subsetting by index initially working for rawfileextracts (more testing needed)

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