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

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

more on ReferenceableGrid

  • 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 (1, len(dimNames)):
124                    axisname ='dim'+str(i)
125                    axes =axes + axisname + ' '
126                gsDomain.axisLabels=cp.csString(axes)
127                ordinates=[]
128                for i in range (1, len(dimNames)):
129                    dimName=dimNames[len(dimNames)-i]
130                    ord=cp.GridOrdinateDescription()
131                    ord.gridAxesSpanned=cp.csString('dim' + str(i))
132                    ord.coordAxisLabel=cp.csString(dimName)
133                    ord.sequenceRule=cp.csString(csml.csmllibs.csmlextra.getSeqRule(len(dimNames)))
134                    sptList=cp.SpatialOrTemporalPositionList()
135                   
136                    if self.spatialstorage=='fileextract':
137                        #look up file extract name in dictionary
138                        #(axisid stored in dictionary = current filename + variable name)
139                        axisid=self.repfilename+dimName
140                        sptList.coordinateList=cp.csString('#'+self.fileExtractDictionary[axisid])
141                    else:
142                        #store inline
143                        DI.setAxis(dimName)
144                        sptList.coordinateList=cp.csString(csml.csmllibs.csmlextra.cleanString(str(DI.getDataForAxis())))
145                    ord.coordAxisValues=sptList
146                    gcT.addChildElem('gridOrdinates',ord)                   
147                gsDomain.coordTransformTable=gcT
148                gsCoverage.gridSeriesDomain=gsDomain
149                gsFeature.value=gsCoverage
150                gsDomain=csml.parser.GridSeriesDomain()
151               
152                #DOMAIN REFERENCE
153                #tpl=csml.parser.TimePositionList()
154                #if self.timestorage =='inline':
155                    #tpl.timePositions=self.timeString
156                    #tpl.frame='%s:%s'%(self.caltype,self.units)
157                #else:
158                    ## do something to create a single extract for the times (from the representative file).
159                    #tpl.timePositions = csml.csmllibs.csmlfileextracts.createSingleExtract(self.extractType, repfilename, self.timedim, len(self.timeString.split()))
160                    #tpl.frame='%s:%s'%(self.caltype,self.units)
161                #gsDomain.domainReference=tpl
162                #grid=csml.parser.Grid()
163                ##COVERAGE FUNCTION
164                #mr =csml.parser.MappingRule(csml.csmllibs.csmlextra.getMappingRule(len(dimNames)))
165                #GridSeriesFeature_element.coverageFunction=mr
166                ##RANGESET
167                #arrSz = DI.getArraySizeOfVar()
168                #try:
169                    #strUom = DI.getVariableAttribute('units')
170                #except AttributeError:
171                    ## if units attribute doesn't exist:
172                    #strUom ="dimensionless or units not determined"
173                #rs=csml.parser.RangeSet()
174                #if self.valuestorage=='inline':
175                    ##TO DO, store the rangeset inline - use Datablock class???
176                    #pass
177                #else:
178                    ##store the rangeSet as an aggregatedArray
179                    #aa=csml.parser.AggregatedArray()
180                    #aa.arraySize=[]
181                    #aa.arraySize.append(arrSz)
182                    #aa.uom=strUom
183                    #aa.aggType='new' #can it be anything else?
184                    #aa.aggIndex='1'
185                    ##FileExtract (fe) element will be NetCDF/GRIB/PPExtract element (As defined earlier in ExtractType)
186                    #self.extractType= DI.extractType
187                    #fe = self._getCorrectExtractType()
188                    #varSize=DI.getShapeOfVar()
189                    #fe.arraySize=varSize
190                    #fe.fileName=self.filesinDir
191                    #fe.variableName=allVarNames[i]
192                    #aa.component=[fe]
193                    #rs.aggregatedArray=aa
194                #GridSeriesFeature_element.rangeSet=rs
195                ##DOMAIN COMPLEMENT
196                #grid.srsName='urn:EPSG:GeographicCRS:4326'
197                #numSpDims=len(varSize) -1
198                #grid.srsDimension=str(numSpDims)
199                #grid.dimension=str(numSpDims)
200                #ge =csml.parser.GridEnvelope(low=DI.getLowLimits(), high=DI.getHighLimits())
201                #grid.limits=ge
202                ##add an axisName element(s) for  each spatial dimension.
203                ## and an ordinate element
204                #axes=[]
205                #for i in range (1, len(dimNames)):
206                    ##axisNames
207                    #axisname ='dim'+str(i)
208                    #axes.append(axisname)
209                    ##ordinates
210                    #grid.ordinates=[]
211                    #for i in range (1, len(dimNames)):
212                        #ord=csml.parser.GridOrdinateDescription()
213                        #ord.gridAxesSpanned='dim' + str(i)
214                        #ord.sequenceRule=csml.csmllibs.csmlextra.getSeqRule(len(dimNames))
215                        #dimName=dimNames[len(dimNames)-i]
216                        #ord.definesAxis=dimName
217                        ##look up file extract name in dictionary
218                        ##(axisid stored in dictionary = current filename + variable name)
219                        #axisid=self.repfilename+dimName
220                        #if self.spatialstorage=='fileextract':
221                            ##refer to extract
222                            #ord.axisValues='#'+self.fileExtractDictionary[axisid]
223                        #else:
224                            ##store inline
225                             #DI.setAxis(dimName)
226                             #ord.axisValues=csml.csmllibs.csmlextra.cleanString(str(DI.getDataForAxis()))
227                        #grid.ordinates.append(ord)
228                    #grid.axisNames=axes
229                #gsDomain.domainComplement=grid
230                #GridSeriesFeature_element.domain=gsDomain
231                #GridSeriesFeature_element.parameter=csml.parser.Phenomenon(href='http://badc.rl.ac.uk/localparams#%s'%allVarNames[i])
232                self.fms.append(gsFeature)
233            DI.closeFile()
234    ###End of createCSMLGridSeriesFeatures###
235
236    def createCSMLPointSeriesFeatures(self): 
237        representativeFiles=self.ffmap.getRepresentativeFiles()
238        for repfile in representativeFiles:
239            self.repfilename,self.listOfFiles=self._populateListOfFiles(repfile)
240            self._getFilesAndTimes()
241            DI = csml.csmllibs.csmldataiface.DataInterface()
242            DI=DI.getUnknownInterfaceType(self.repfilename)
243            DI.openFile(self.repfilename)
244            allVarNames=DI.getListofVariables()
245            numFeatures=len(allVarNames)       
246            try:
247                DI.setAxis(self.timedim)
248                times=DI.getDataForAxis()
249            except:                     
250                times = DI.getTimes()
251            #Create features:
252            for i in range (0, numFeatures):
253                PointSeriesFeature_element=csml.parser.PointSeriesFeature()
254                if str(allVarNames[i]).upper() in ['ERROR FLAG', 'ERROR']: #might need to extend this list
255                    break
256                PointSeriesFeature_element.id=str(allVarNames[i])
257                desc=self._getDescriptiveName(DI)
258                PointSeriesFeature_element.description=csml.parser.Description(desc)
259                #DOMAIN
260                psDomain=csml.parser.PointSeriesDomain()
261                t=csml.parser.Trajectory()
262                t.srsName='urn:EPSG:geographicCRS:4326' #TO Do
263                t.locations =csml.parser.DirectPositionList(vals='1 1')
264               
265                if self.timestorage =='inline':
266                    tpl =csml.parser.TimePositionList()
267                    tpl.timePositions=self.timeString
268                    tpl.frame='%s:%s'%(self.caltype,self.units)
269                    t.times=tpl
270                else:
271                    # do something to create a single extract for the times (from the representative file).
272                    tpl.timePositions = csml.csmllibs.csmlfileextracts.createSingleExtract(self.extractType, repfilename, self.timedim, len(self.timeString.split())) 
273                    tpl.frame='%s:%s'%(self.caltype,self.units)
274               
275               
276#                 if self.timestorage =='inline':
277#                     t.times=csmllibs.Parser.TimePositionList('#RefSysX',str(times))
278#                 else:
279#                     #todo: depends on the file mapping???
280#                     t.times=csmllibs.Parser.TimePositionList('#RefSysX','blah') #blah = dummy times
281#                 print 'times: ' + str(allVarNames[i])
282#                 print len(times)
283#                 print len(listOfFiles)
284#                 arraySize=len(times) * len(listOfFiles)
285#                 fextract=csmllibs.csmlfileextracts.createSingleExtract(self.extractType,filenames,self.timedim,arraySize)
286#                 tplist = csmllibs.Parser.TimePositionList(timePositions=fextract)
287#                 t.times=tplist                                                                   
288                filenames=csml.csmllibs.csmlextra.cleanString(str(self.listOfFiles))
289                psDomain.domainReference=t
290                #RANGESET
291                DI.setVariable(allVarNames[i])
292                try:
293                    strUom = DI.getVariableAttribute('units')
294                except AttributeError:
295                    #if units attribute doesn't exist:
296                    strUom ="dimensionless or units not determined"
297                try:                   
298                    measuredvalues = DI.getDataForVar()
299                except:
300                    measuredvalues = ' could not get values '
301                rs=csml.parser.RangeSet()
302                if self.valuestorage=='inline':
303                    #encode inline
304                    rs.quantityList=csml.parser.MeasureOrNullList(uom=strUom, val=str(measuredvalues)[1:-1])                         
305                else:
306                    #create a file extract link
307                    arraySize=len(measuredvalues)*len(self.listOfFiles) 
308                    #TODO this needs to be able to handle inline, use VALUESTORAGE to determine which to use:
309                    self.extractType=DI.extractType
310                    fextract=csml.csmllibs.csmlfileextracts.createSingleExtract(self.extractType,filenames,allVarNames[i],arraySize)
311                    qlist = csml.parser.MeasureOrNullList(val=fextract)
312                    rs.quantityList=qlist
313                PointSeriesFeature_element.rangeSet=rs
314                #COVERAGEFUNCTION                           
315                #PARAMETER
316                #need to do parameter and coverageFunction elements
317                PointSeriesFeature_element.domain=psDomain
318                self.fms.append(PointSeriesFeature_element)
319            DI.closeFile()
320       
321
322#This function needs revising in light of a) csml parser and b) new profile feature types
323    def createCSMLProfileFeature(csmldoc, dataset_element, gml_FeatureCollection_element,  ffmap, timedim):
324            representativeFiles=ffmap.getRepresentativeFiles()
325            listOfFiles=[]
326            for repfile in representativeFiles:
327                    repfilename=repfile.getRepresentativeFileName()
328                    listOfFiles.append(repfilename)
329                    relfiles = repfile.getRelatedFiles()
330                    for f in relfiles:
331                            #hopefully there are no related files at the moment!
332                            fname = f.getRelatedFileName()
333                            listOfFiles.append(fname)
334                    #print listOfFiles
335                   
336            for file in listOfFiles:
337                    DI = csmllibs.csmldataiface.DataInterface()
338                    DI=DI.getUnknownInterfaceType(file)
339                    print'opening file'
340                    DI.openFile(file)
341                    print 'getting variables'
342                    allVarNames=DI.getListofVariables()
343                    print 'getting feature count'
344                    numFeatures=len(allVarNames)       
345                   
346                    print "FEATURES"
347                    print "***********"
348                    for i in range (0, len(allVarNames)):
349                            print allVarNames[i]
350                           
351                    for i in range (0, numFeatures):
352                            gml_featureMember_element=csmldoc.createElement("gml:featureMember")
353                            ProfileFeature_element=csmldoc.createElement("ProfileFeature")
354                            ProfileFeature_element.setAttribute('gml:id',str(allVarNames[i]))
355                            gml_description_element = csmldoc.createElement("gml:description")
356                            gml_featureMember_element.appendChild(ProfileFeature_element)
357                            #***********************************************************************
358                            #PointSeriesDomain:
359                            #***********************************************************************
360                            ProfileDomain_element=csmldoc.createElement("ProfileDomain")
361                           
362                           
363                            #***********************************************************************
364                            # domainReference element (and sub-elements)               
365                            #***********************************************************************
366                            domainReference_element=csmldoc.createElement("domainReference")
367                            #orientedPosition_element=csmldoc.createElement("OrientedPosition")
368                            #locations_element=csmldoc.createElement("locations")
369                            #times_element=csmldoc.createElement("times")
370                            #trajectory_element.appendChild(locations_element)
371                            #trajectory_element.appendChild(times_element)
372                            #domainReference_element.appendChild(orientedPosition_element)
373                           
374                            #gml_timePositionList_element = csmldoc.createElement("gml:TimePositionList")
375                            #gml_timePositionList_element.appendChild(csmldoc.createTextNode(self.timeString))
376                            #domainReference_element.appendChild(gml_timePositionList_element)
377                            ProfileDomain_element.appendChild(domainReference_element)
378                            #***********************************************************************
379                            domainComplement_element=csmldoc.createElement("domainComplement")
380                            ProfileDomain_element.appendChild(domainComplement_element)
381                           
382                            #***********************************************************************
383                            # gml:rangeSet_element
384                            #***********************************************************************
385                           
386                            gml_rangeSet_element=csmldoc.createElement("gml:rangeSet") 
387                           
388                            #***********************************************************************
389                            # gml:coverageFunction element (and sub-element MappingRule)               
390                            #***********************************************************************
391                            gml_coverageFunction_element=csmldoc.createElement("gml:coverageFunction")
392                            MappingRule_element=csmldoc.createElement("MappingRule")
393                            #MappingRule_element.setAttribute('scanOrder',csmllibs.csmlextra.getMappingRule(len(dimNames)))
394                            MappingRule_element.setAttribute('scanOrder','tba')
395                            gml_coverageFunction_element.appendChild(MappingRule_element)
396                           
397                           
398                            gml_featureMember_element.appendChild(ProfileDomain_element)
399                            gml_featureMember_element.appendChild(gml_rangeSet_element)
400                            gml_featureMember_element.appendChild(gml_coverageFunction_element)
401                            gml_FeatureCollection_element.appendChild(gml_featureMember_element)       
402                           
403            return 
404                           
405       
Note: See TracBrowser for help on using the repository browser.