source: TI02-CSML/branches/CSML2/csmllibs/csmlfeaturetypes.py @ 1897

Subversion URL: http://proj.badc.rl.ac.uk/svn/ndg/TI02-CSML/branches/CSML2/csmllibs/csmlfeaturetypes.py@1897
Revision 1897, 21.8 KB checked in by domlowe, 14 years ago (diff)

added coverage function to scanner

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
Line 
1#!/usr/bin/env python
2#**************************************************************************************
3#csmlfeaturetypes.py
4#For creating CSML featuretypes
5#v0.5 split off 11th November 2005
6#Dominic Lowe, BADC
7#**************************************************************************************
8
9import csml.parser as cp
10import csml.csmllibs
11import sys
12
13class featureBuilder(object):
14    def __init__(self, dataset_element, gml_FeatureCollection_element, ffmap,fileExtractDictionary, timedim, timestorage,spatialstorage,valuestorage):
15        self.ds_element=dataset_element
16        self.gml_FeatureCollection_element = gml_FeatureCollection_element
17        self.ffmap = ffmap
18        self.fileExtractDictionary = fileExtractDictionary
19        self.timedim = timedim
20        self.timestorage=timestorage
21        self.spatialstorage=spatialstorage
22        self.valuestorage=valuestorage
23               
24        #empty list to hold featureMembers
25        self.fms =[]
26               
27        #at the moment, only one featuretype per CSML Dataset is supported.
28        #get the featuretype of the first representative file in the ffmap object
29        self.featuretype=  self.ffmap.getRepresentativeFiles()[0].getFeatureType()
30       #and create the features
31        print 'determining feature type'
32        print self.featuretype
33        if self.featuretype == 'GridSeries':
34            self.createCSMLGridSeriesFeatures()
35        elif self.featuretype == 'PointSeries':       
36            self.createCSMLPointSeriesFeatures()
37       
38        #after the features have been generated append all featureMembers to the feature collection
39        self.gml_FeatureCollection_element.members=self.fms
40   
41       
42    #Some internal methods that are of use to all feature types:
43    def _getDescriptiveName(self,DI):
44        #given a data interface class with the variable or axis set, try to get a descriptive name
45        #eg. long name
46        try:
47            descName=DI.getVariableAttribute('long_name')
48            descName
49        except AttributeError:
50            descName = "missing name"
51        descName=descName.replace('&','&') #remove ampersands TODO- extend this
52        return descName
53   
54    def _populateListOfFiles(self,repfile):
55        #given a representative file, get list of files: one representative file + all related files
56        listOfFiles=[]
57        repfilename=repfile.getRepresentativeFileName()
58        listOfFiles.append(repfilename)
59        relfiles = repfile.getRelatedFiles()
60        for f in relfiles:
61            fname = f.getRelatedFileName()
62            listOfFiles.append(fname)
63        return repfilename,listOfFiles
64       
65    def _getFilesAndTimes(self):
66        #TODO try and speed up csmllibs.csmltime.getFileTimeList
67        OrderedFileTimeList,self.caltype,self.units = csml.csmllibs.csmltime.getFileTimeList(self.listOfFiles,self.timedim)
68        #build strings to hold times/filenames for current gridseriesfeature
69        self.timeString =''
70        self.filesinDir = ''
71        for j in range (0, len(OrderedFileTimeList)):
72            t= OrderedFileTimeList[j][0]
73            f = OrderedFileTimeList[j][1]
74            self.timeString = self.timeString + ' ' + str(t)
75            self.filesinDir = self.filesinDir + ' ' + f
76   
77    def _getCorrectExtractType(self):
78        #returns an empty parser file extract object of the correct type.
79        if self.extractType=='NetCDFExtract':
80            fe = csml.parser.NetCDFExtract()
81        if self.extractType=='NASAAmesExtract':
82            fe = csml.parser.NASAAmesExtract()
83        if self.extractType=='GRIBExtract':
84            fe = csml.parser.GRIBExtract()
85        if self.extractType=='PPExtract':
86            fe = csml.parser.PPExtract()
87        return fe
88       
89   
90    def createCSMLGridSeriesFeatures(self):
91        #This method assumes that the variables (features) are shared across identically structured files
92        #should be supplied with a featurefilemap object (see csmlfiles for FileMapMaker)
93        representativeFiles=self.ffmap.getRepresentativeFiles()
94        for repfile in representativeFiles:
95            self.repfilename,self.listOfFiles=self._populateListOfFiles(repfile)
96            self._getFilesAndTimes()
97            #Open representative file and create feature members:
98            DI = csml.csmllibs.csmldataiface.DataInterface()
99            DI=DI.getUnknownInterfaceType(self.repfilename)
100            DI.openFile(self.repfilename)
101            allVarNames=DI.getListofVariables()
102            numFeatures=len(allVarNames)
103            #Create a GridSeriesFeature for each variable:
104            for i in range(0, numFeatures):
105                DI.setVariable(allVarNames[i])
106                dimNames=DI.getVariableAxes()
107                if len(dimNames) <= 2:
108                    #it's an axis or bounds not a feature, try next variable
109                    continue
110                gsFeature=cp.GridSeriesFeature()
111                gsFeature.id=str(allVarNames[i])
112                desc = self._getDescriptiveName(DI)
113                #GridSeriesFeature_element.description=csml.parser.Description(desc)
114                gsFeature.description=desc
115                #value (coverage)
116                gsCoverage=cp.GridSeriesCoverage()
117                gsDomain=cp.GridSeriesDomain()
118                gcT=cp.GridCoordinatesTable()
119               
120                #add an axisName element(s) for  each spatial dimension.
121                #and an ordinate element
122                axes=' '
123                for i in range (len(dimNames)):
124                    i=i+1
125                    axisname ='dim'+str(i)
126                    axes =axes + axisname + ' '
127                gsDomain.axisLabels=cp.csString(axes)
128                ordinates=[]
129                for dimName in enumerate(dimNames):
130                    ord=cp.GridOrdinateDescription()
131                    ord.gridAxesSpanned=cp.csString('dim' + str(dimName[0]))
132                    ord.coordAxisLabel=cp.csString(dimName[1])
133                    ord.sequenceRule=cp.csString(csml.csmllibs.csmlextra.getSeqRule(len(dimNames)))
134                    sptList=cp.SpatialOrTemporalPositionList()
135                   
136                    if dimName[1]==self.timedim:
137                        #this is the time dimension. handle calendaring etc when getting the data.
138                        if self.timestorage=='fileextract':
139                            #look up file extract name in dictionary
140                            #(axisid stored in dictionary = current filename + variable name)
141                            axisid=self.repfilename+dimName[1]
142                            sptList.coordinateList=cp.csString('#'+self.fileExtractDictionary[axisid])
143                        else:
144                            #store times inline
145                            DI.setAxis(dimName[1])
146                            sptList.coordinateList=cp.csString(self.timeString)
147                            sptList.frame='%s:%s'%(self.caltype,self.units)
148                    else:  #for all other dimensions, create ordinates
149                        if self.spatialstorage=='fileextract':
150                            #look up file extract name in dictionary
151                            #(axisid stored in dictionary = current filename + variable name)
152                            axisid=self.repfilename+dimName[1]
153                            sptList.coordinateList=cp.csString('#'+self.fileExtractDictionary[axisid])
154                        else:
155                            #store inline
156                            DI.setAxis(dimName[1])
157                            sptList.coordinateList=cp.csString(csml.csmllibs.csmlextra.cleanString(str(DI.getDataForAxis())))
158                    ord.coordAxisValues=sptList
159                    gcT.addChildElem('gridOrdinates',ord)                   
160                gsDomain.coordTransformTable=gcT
161                gsCoverage.gridSeriesDomain=gsDomain
162                #COVERAGE FUNCTION
163                mr =csml.csmllibs.csmlextra.getMappingRule(len(dimNames))
164                gsCoverage.coverageFunction=cp.csString(mr)
165                gsFeature.value=gsCoverage
166               
167                ##RANGESET
168                #arrSz = DI.getArraySizeOfVar()
169                #try:
170                    #strUom = DI.getVariableAttribute('units')
171                #except AttributeError:
172                    ## if units attribute doesn't exist:
173                    #strUom ="dimensionless or units not determined"
174                #rs=csml.parser.RangeSet()
175                #if self.valuestorage=='inline':
176                    ##TO DO, store the rangeset inline - use Datablock class???
177                    #pass
178                #else:
179                    ##store the rangeSet as an aggregatedArray
180                    #aa=csml.parser.AggregatedArray()
181                    #aa.arraySize=[]
182                    #aa.arraySize.append(arrSz)
183                    #aa.uom=strUom
184                    #aa.aggType='new' #can it be anything else?
185                    #aa.aggIndex='1'
186                    ##FileExtract (fe) element will be NetCDF/GRIB/PPExtract element (As defined earlier in ExtractType)
187                    #self.extractType= DI.extractType
188                    #fe = self._getCorrectExtractType()
189                    #varSize=DI.getShapeOfVar()
190                    #fe.arraySize=varSize
191                    #fe.fileName=self.filesinDir
192                    #fe.variableName=allVarNames[i]
193                    #aa.component=[fe]
194                    #rs.aggregatedArray=aa
195                #GridSeriesFeature_element.rangeSet=rs
196               
197               
198                ##DOMAIN COMPLEMENT
199                #grid.srsName='urn:EPSG:GeographicCRS:4326'
200                #numSpDims=len(varSize) -1
201                #grid.srsDimension=str(numSpDims)
202                #grid.dimension=str(numSpDims)
203                #ge =csml.parser.GridEnvelope(low=DI.getLowLimits(), high=DI.getHighLimits())
204                #grid.limits=ge
205                ##add an axisName element(s) for  each spatial dimension.
206                ## and an ordinate element
207                #axes=[]
208                #for i in range (1, len(dimNames)):
209                    ##axisNames
210                    #axisname ='dim'+str(i)
211                    #axes.append(axisname)
212                    ##ordinates
213                    #grid.ordinates=[]
214                    #for i in range (1, len(dimNames)):
215                        #ord=csml.parser.GridOrdinateDescription()
216                        #ord.gridAxesSpanned='dim' + str(i)
217                        #ord.sequenceRule=csml.csmllibs.csmlextra.getSeqRule(len(dimNames))
218                        #dimName=dimNames[len(dimNames)-i]
219                        #ord.definesAxis=dimName
220                        ##look up file extract name in dictionary
221                        ##(axisid stored in dictionary = current filename + variable name)
222                        #axisid=self.repfilename+dimName
223                        #if self.spatialstorage=='fileextract':
224                            ##refer to extract
225                            #ord.axisValues='#'+self.fileExtractDictionary[axisid]
226                        #else:
227                            ##store inline
228                             #DI.setAxis(dimName)
229                             #ord.axisValues=csml.csmllibs.csmlextra.cleanString(str(DI.getDataForAxis()))
230                        #grid.ordinates.append(ord)
231                    #grid.axisNames=axes
232                #gsDomain.domainComplement=grid
233                #GridSeriesFeature_element.domain=gsDomain
234                #GridSeriesFeature_element.parameter=csml.parser.Phenomenon(href='http://badc.rl.ac.uk/localparams#%s'%allVarNames[i])
235                self.fms.append(gsFeature)
236            DI.closeFile()
237    ###End of createCSMLGridSeriesFeatures###
238
239    def createCSMLPointSeriesFeatures(self): 
240        representativeFiles=self.ffmap.getRepresentativeFiles()
241        for repfile in representativeFiles:
242            self.repfilename,self.listOfFiles=self._populateListOfFiles(repfile)
243            self._getFilesAndTimes()
244            DI = csml.csmllibs.csmldataiface.DataInterface()
245            DI=DI.getUnknownInterfaceType(self.repfilename)
246            DI.openFile(self.repfilename)
247            allVarNames=DI.getListofVariables()
248            numFeatures=len(allVarNames)       
249            try:
250                DI.setAxis(self.timedim)
251                times=DI.getDataForAxis()
252            except:                     
253                times = DI.getTimes()
254            #Create features:
255            for i in range (0, numFeatures):
256                PointSeriesFeature_element=csml.parser.PointSeriesFeature()
257                if str(allVarNames[i]).upper() in ['ERROR FLAG', 'ERROR']: #might need to extend this list
258                    break
259                PointSeriesFeature_element.id=str(allVarNames[i])
260                desc=self._getDescriptiveName(DI)
261                PointSeriesFeature_element.description=csml.parser.Description(desc)
262                #DOMAIN
263                psDomain=csml.parser.PointSeriesDomain()
264                t=csml.parser.Trajectory()
265                t.srsName='urn:EPSG:geographicCRS:4326' #TO Do
266                t.locations =csml.parser.DirectPositionList(vals='1 1')
267               
268                if self.timestorage =='inline':
269                    tpl =csml.parser.TimePositionList()
270                    tpl.timePositions=self.timeString
271                    tpl.frame='%s:%s'%(self.caltype,self.units)
272                    t.times=tpl
273                else:
274                    # do something to create a single extract for the times (from the representative file).
275                    tpl.timePositions = csml.csmllibs.csmlfileextracts.createSingleExtract(self.extractType, repfilename, self.timedim, len(self.timeString.split())) 
276                    tpl.frame='%s:%s'%(self.caltype,self.units)
277               
278               
279#                 if self.timestorage =='inline':
280#                     t.times=csmllibs.Parser.TimePositionList('#RefSysX',str(times))
281#                 else:
282#                     #todo: depends on the file mapping???
283#                     t.times=csmllibs.Parser.TimePositionList('#RefSysX','blah') #blah = dummy times
284#                 print 'times: ' + str(allVarNames[i])
285#                 print len(times)
286#                 print len(listOfFiles)
287#                 arraySize=len(times) * len(listOfFiles)
288#                 fextract=csmllibs.csmlfileextracts.createSingleExtract(self.extractType,filenames,self.timedim,arraySize)
289#                 tplist = csmllibs.Parser.TimePositionList(timePositions=fextract)
290#                 t.times=tplist                                                                   
291                filenames=csml.csmllibs.csmlextra.cleanString(str(self.listOfFiles))
292                psDomain.domainReference=t
293                #RANGESET
294                DI.setVariable(allVarNames[i])
295                try:
296                    strUom = DI.getVariableAttribute('units')
297                except AttributeError:
298                    #if units attribute doesn't exist:
299                    strUom ="dimensionless or units not determined"
300                try:                   
301                    measuredvalues = DI.getDataForVar()
302                except:
303                    measuredvalues = ' could not get values '
304                rs=csml.parser.RangeSet()
305                if self.valuestorage=='inline':
306                    #encode inline
307                    rs.quantityList=csml.parser.MeasureOrNullList(uom=strUom, val=str(measuredvalues)[1:-1])                         
308                else:
309                    #create a file extract link
310                    arraySize=len(measuredvalues)*len(self.listOfFiles) 
311                    #TODO this needs to be able to handle inline, use VALUESTORAGE to determine which to use:
312                    self.extractType=DI.extractType
313                    fextract=csml.csmllibs.csmlfileextracts.createSingleExtract(self.extractType,filenames,allVarNames[i],arraySize)
314                    qlist = csml.parser.MeasureOrNullList(val=fextract)
315                    rs.quantityList=qlist
316                PointSeriesFeature_element.rangeSet=rs
317                #COVERAGEFUNCTION                           
318                #PARAMETER
319                #need to do parameter and coverageFunction elements
320                PointSeriesFeature_element.domain=psDomain
321                self.fms.append(PointSeriesFeature_element)
322            DI.closeFile()
323       
324
325#This function needs revising in light of a) csml parser and b) new profile feature types
326    def createCSMLProfileFeature(csmldoc, dataset_element, gml_FeatureCollection_element,  ffmap, timedim):
327            representativeFiles=ffmap.getRepresentativeFiles()
328            listOfFiles=[]
329            for repfile in representativeFiles:
330                    repfilename=repfile.getRepresentativeFileName()
331                    listOfFiles.append(repfilename)
332                    relfiles = repfile.getRelatedFiles()
333                    for f in relfiles:
334                            #hopefully there are no related files at the moment!
335                            fname = f.getRelatedFileName()
336                            listOfFiles.append(fname)
337                    #print listOfFiles
338                   
339            for file in listOfFiles:
340                    DI = csmllibs.csmldataiface.DataInterface()
341                    DI=DI.getUnknownInterfaceType(file)
342                    print'opening file'
343                    DI.openFile(file)
344                    print 'getting variables'
345                    allVarNames=DI.getListofVariables()
346                    print 'getting feature count'
347                    numFeatures=len(allVarNames)       
348                   
349                    print "FEATURES"
350                    print "***********"
351                    for i in range (0, len(allVarNames)):
352                            print allVarNames[i]
353                           
354                    for i in range (0, numFeatures):
355                            gml_featureMember_element=csmldoc.createElement("gml:featureMember")
356                            ProfileFeature_element=csmldoc.createElement("ProfileFeature")
357                            ProfileFeature_element.setAttribute('gml:id',str(allVarNames[i]))
358                            gml_description_element = csmldoc.createElement("gml:description")
359                            gml_featureMember_element.appendChild(ProfileFeature_element)
360                            #***********************************************************************
361                            #PointSeriesDomain:
362                            #***********************************************************************
363                            ProfileDomain_element=csmldoc.createElement("ProfileDomain")
364                           
365                           
366                            #***********************************************************************
367                            # domainReference element (and sub-elements)               
368                            #***********************************************************************
369                            domainReference_element=csmldoc.createElement("domainReference")
370                            #orientedPosition_element=csmldoc.createElement("OrientedPosition")
371                            #locations_element=csmldoc.createElement("locations")
372                            #times_element=csmldoc.createElement("times")
373                            #trajectory_element.appendChild(locations_element)
374                            #trajectory_element.appendChild(times_element)
375                            #domainReference_element.appendChild(orientedPosition_element)
376                           
377                            #gml_timePositionList_element = csmldoc.createElement("gml:TimePositionList")
378                            #gml_timePositionList_element.appendChild(csmldoc.createTextNode(self.timeString))
379                            #domainReference_element.appendChild(gml_timePositionList_element)
380                            ProfileDomain_element.appendChild(domainReference_element)
381                            #***********************************************************************
382                            domainComplement_element=csmldoc.createElement("domainComplement")
383                            ProfileDomain_element.appendChild(domainComplement_element)
384                           
385                            #***********************************************************************
386                            # gml:rangeSet_element
387                            #***********************************************************************
388                           
389                            gml_rangeSet_element=csmldoc.createElement("gml:rangeSet") 
390                           
391                            #***********************************************************************
392                            # gml:coverageFunction element (and sub-element MappingRule)               
393                            #***********************************************************************
394                            gml_coverageFunction_element=csmldoc.createElement("gml:coverageFunction")
395                            MappingRule_element=csmldoc.createElement("MappingRule")
396                            #MappingRule_element.setAttribute('scanOrder',csmllibs.csmlextra.getMappingRule(len(dimNames)))
397                            MappingRule_element.setAttribute('scanOrder','tba')
398                            gml_coverageFunction_element.appendChild(MappingRule_element)
399                           
400                           
401                            gml_featureMember_element.appendChild(ProfileDomain_element)
402                            gml_featureMember_element.appendChild(gml_rangeSet_element)
403                            gml_featureMember_element.appendChild(gml_coverageFunction_element)
404                            gml_FeatureCollection_element.appendChild(gml_featureMember_element)       
405                           
406            return 
407                           
408       
Note: See TracBrowser for help on using the repository browser.