source: TI02-CSML/trunk/csml/csmllibs/csmlfeaturetypes.py @ 2196

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

ProfileSeriesFeature? mostly working in scanner - location attribute needs finishing

  • 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
12import pdb
13   
14
15class featureBuilder(object):
16    def __init__(self, dataset_element, featureCollection_element, ffmap,fileExtractDictionary, timedim, timestorage,spatialstorage,valuestorage):
17        self.ds_element=dataset_element
18        self.featureCollection = featureCollection_element
19        self.ffmap = ffmap
20        self.fileExtractDictionary = fileExtractDictionary
21        self.timedim = timedim
22        self.timestorage=timestorage
23        self.spatialstorage=spatialstorage
24        self.valuestorage=valuestorage
25               
26        #empty list to hold featureMembers
27        self.fms =[]
28               
29        #at the moment, only one featuretype per CSML Dataset is supported.
30        #get the featuretype of the first representative file in the ffmap object
31        self.featuretype=  self.ffmap.getRepresentativeFiles()[0].getFeatureType()
32       #and create the features
33        print 'determining feature type'
34        print self.featuretype
35        if self.featuretype == 'GridSeries':
36            self.createCSMLGridSeriesFeatures()
37        elif self.featuretype == 'PointSeries':       
38            self.createCSMLPointSeriesFeatures()
39        elif self.featuretype == 'ProfileSeries':       
40            self.createCSMLProfileSeriesFeatures()
41        #after the features have been generated append all featureMembers to the feature collection
42        self.featureCollection.featureMembers=self.fms
43       
44    #Some internal methods that are of use to all feature types:
45    def _getDescriptiveName(self,DI):
46        #given a data interface class with the variable or axis set, try to get a descriptive name
47        #eg. long name
48        try:
49            descName=DI.getVariableAttribute('long_name')
50            descName
51        except AttributeError:
52            descName = "missing name"
53        descName=descName.replace('&','&') #remove ampersands TODO- extend this
54        return descName
55   
56    def _populateListOfFiles(self,repfile):
57        #given a representative file, get list of files: one representative file + all related files
58        listOfFiles=[]
59        repfilename=repfile.getRepresentativeFileName()
60        listOfFiles.append(repfilename)
61        relfiles = repfile.getRelatedFiles()
62        for f in relfiles:
63            fname = f.getRelatedFileName()
64            listOfFiles.append(fname)
65        return repfilename,listOfFiles
66       
67    def _getFilesAndTimes(self):
68        #TODO try and speed up csmllibs.csmltime.getFileTimeList
69        OrderedFileTimeList,self.caltype,self.units = csml.csmllibs.csmltime.getFileTimeList(self.listOfFiles,self.timedim)
70        #build strings to hold times/filenames for current gridseriesfeature
71        self.timeString =''
72        self.filesinDir = ''
73        lastf=''
74        for j in range (0, len(OrderedFileTimeList)):
75            t= OrderedFileTimeList[j][0]
76            f = OrderedFileTimeList[j][1]
77            self.timeString = self.timeString + ' ' + str(t)
78            if f != lastf:
79                self.filesinDir = self.filesinDir + ' ' + f
80                lastf=f
81           
82    def _getCorrectExtractType(self):
83        #returns an empty parser file extract object of the correct type.
84        if self.extractType=='NetCDFExtract':
85            fe = csml.parser.NetCDFExtract()
86        if self.extractType=='NASAAmesExtract':
87            fe = csml.parser.NASAAmesExtract()
88        if self.extractType=='GRIBExtract':
89            fe = csml.parser.GRIBExtract()
90        if self.extractType=='PPExtract':
91            fe = csml.parser.PPExtract()
92        return fe
93       
94   
95   
96    #the following __functions are used by all or most feature types:
97   
98    def __getVarInfo(self, representativeFile):
99        self.repfilename,self.listOfFiles=self._populateListOfFiles(representativeFile)
100        self._getFilesAndTimes()
101        #Open representative file and create feature members:
102        self.DI = csml.csmllibs.csmldataiface.DataInterface()
103        self.DI=self.DI.getUnknownInterfaceType(self.repfilename)
104        self.DI.openFile(self.repfilename)
105        allVarNames=self.DI.getListofVariables()
106        numFeatures=len(allVarNames)
107        return allVarNames, numFeatures
108   
109    def __getGridCoordinatesTable(self,dimNames, crs,axisorder):
110        #referenceableGrid/GridCoordinatesTable
111        gcT=cp.GridCoordinatesTable()
112        ##add an axisName element(s) for  each spatial dimension.
113        #and an ordinate element
114        axes=''
115        for axis in dimNames:
116            axes =axes + ' '+ axis
117        ordinates=[]
118        for dimName in enumerate(dimNames):
119            ord=cp.GridOrdinateDescription()               
120            #map the grid axis to the crs axis
121            #default to empty element
122            ord.coordAxisLabel=cp.csString('')
123            ord.gridAxesSpanned=cp.csString('')
124            for axis in axisorder:
125                if axisorder[axis]==dimName[0]:
126                    ord.coordAxisLabel=cp.csString(axis)
127                    ord.gridAxesSpanned=cp.csString(dimName[1])
128                    break
129            seqRule= cp.SequenceRule()
130            seqRule.CONTENT='Linear'
131            seqRule.axisOrder='+1'  #TO DO. Work this out.
132            ord.sequenceRule=seqRule
133            sptList=cp.SpatialOrTemporalPositionList()
134           
135            if dimName[1]==self.timedim:
136                #this is the time dimension. handle calendaring etc when getting the data.
137                if self.timestorage=='fileextract':
138                    #look up file extract name in dictionary
139                    #(axisid stored in dictionary = current filename + variable name)
140                    axisid=self.repfilename+dimName[1]
141                    sptList.coordinateList=cp.csString('#'+self.fileExtractDictionary[axisid])
142                else:
143                    #store times inline
144                    self.DI.setAxis(dimName[1])
145                    sptList.coordinateList=cp.csString(self.timeString)
146                    sptList.frame='%s:%s'%(self.caltype,self.units)
147            else:  #for all other dimensions, create ordinates
148                if self.spatialstorage=='fileextract':
149                    #look up file extract name in dictionary
150                    #(axisid stored in dictionary = current filename + variable name)
151                    axisid=self.repfilename+dimName[1]
152                    sptList.coordinateList=cp.csString('#'+self.fileExtractDictionary[axisid])
153                else:
154                    #store inline
155                    self.DI.setAxis(dimName[1])
156                    sptList.coordinateList=cp.csString(csml.csmllibs.csmlextra.cleanString(str(self.DI.getDataForAxis())))
157            ord.coordAxisValues=sptList
158            gcT.addChildElem('gridOrdinates',ord)                         
159        return gcT
160       
161    def __getCRS(self,varName,catalogue):
162        self.DI.setVariable(varName)
163        dimNames=self.DI.getVariableAxes() 
164        if len(dimNames) <= 1:
165                #it's an axis or bounds not a feature, try next variable
166            return None, None, None
167        unitlist=[]
168        for dim in dimNames:
169            self.DI.setAxis(dim)
170            units=self.DI.getAxisAttribute('units')  #need to make special case of units in DI layer
171            unitlist.append(units)   
172        crs, axisorder=catalogue.determineCRS(dimNames,unitlist)
173        return crs, axisorder, dimNames
174   
175    def __featureMetadata(self,feature, varName):
176        feature.id=str(varName)
177        desc = self._getDescriptiveName(self.DI)
178        feature.description=csml.parser.csString(desc)
179       
180    def __getGMLRangeset(self,varName):
181        #GML RANGESET
182        rs=csml.parser.RangeSet()
183        self.DI.setVariable(varName)
184        arrSz = self.DI.getArraySizeOfVar()
185        try:
186            strUom = self.DI.getVariableAttribute('units')
187        except AttributeError:
188            # if units attribute doesn't exist:
189            strUom ="dimensionless or units not determined"
190        if self.valuestorage=='inline':
191            #TO DO, store the rangeset inline - use Datablock class???
192            pass
193        else:
194            #store the rangeSet as an aggregatedArray
195            #TODO, need to take this out of the rangeset and use xlink to reference it.
196            aa=cp.AggregatedArray()
197            aa.arraySize=cp.csString(arrSz)
198            aa.uom=cp.csString(strUom)
199            aa.aggType=cp.csString('new') #can it be anything else?
200            aa.aggIndex=cp.csString('1')
201            #FileExtract (fe) element will be NetCDF/GRIB/PPExtract element (As defined earlier in ExtractType)
202            self.extractType= self.DI.extractType
203            fe = self._getCorrectExtractType()
204            varSize=self.DI.getShapeOfVar()
205            varSize=csml.csmllibs.csmlextra.cleanString1(str(varSize))
206            fe.arraySize=cp.csString(varSize)
207            fl=cp.FileList()
208            fl.fileNames=cp.csString(self.filesinDir)
209            fe.fileList=fl
210            fe.variableName=cp.csString(varName)
211            aa.components=[fe]
212            aa.id=csml.csmllibs.csmlextra.getRandomID()
213            if hasattr(self.ds_element, 'storageDescriptor'):
214                self.ds_element.storageDescriptor.descriptors.append(aa)
215            else:
216                sd =csml.parser.CSMLStorageDescriptor()
217                sd.descriptors=aa
218                setattr(self.ds_element, 'storageDescriptor',sd)
219            #rs.aggregatedArray=aa
220            va=csml.parser.ValueArray()
221            vc=csml.parser.ValueComponent()
222            vc.href='#%s'%aa.id
223            vc.arcrole="http://ndg.nerc.ac.uk/xlinkUsage/insert#QuantityList"
224            vc.role="http://ndg.nerc.ac.uk/fileFormat/csmlStorageDescriptor"
225            vc.show='embed'
226            ql=csml.parser.MeasureOrNullList()
227            ql.uom=strUom
228            vc.quantityList=ql
229            va.valueComponent=vc
230            rs.valueArray=va
231        return rs
232   
233   
234    #the following functions are for creation of specific feature types (and call the __functions above)
235    def createCSMLGridSeriesFeatures(self):
236        #This method assumes that the variables (features) are shared across identically structured files
237        #should be supplied with a featurefilemap object (see csmlfiles for FileMapMaker)
238        representativeFiles=self.ffmap.getRepresentativeFiles()
239        cat=csml.csmllibs.csmlcrs.CRSCatalogue()
240        for repfile in representativeFiles:
241            #get the names of all the variables in the files:
242            allVarNames, numFeatures = self.__getVarInfo(repfile)
243            #Create a GridSeriesFeature for each variable:
244            for i in range(0, numFeatures):
245                crs,axisorder, dimNames=self.__getCRS(allVarNames[i], cat)
246                if crs == None:
247                    continue            #try next variable
248                gsFeature=cp.GridSeriesFeature()
249                self.__featureMetadata(gsFeature,allVarNames[i])
250                #VALUE (coverage)
251                gsCoverage=cp.GridSeriesCoverage()
252                gsDomain=cp.GridSeriesDomain()
253                gsDomain.srsName=crs.srsName
254                gsDomain.axisLabels=crs.axisLabels # note this is the xml attribute axisLabels, not the child element (aLabels)
255                gsDomain.srsDimension=crs.srsDimension
256                aLabels=''
257                for dim in dimNames:
258                    aLabels=aLabels + dim + ' '
259                gsDomain.aLabels=cp.csString(aLabels)
260                gcT=self.__getGridCoordinatesTable(dimNames, crs,axisorder)
261                gsDomain.coordTransformTable=gcT
262                gsCoverage.gridSeriesDomain=gsDomain
263               
264                #COVERAGE FUNCTION
265                mr =csml.csmllibs.csmlextra.getMappingRule(len(dimNames))
266                gsCoverage.coverageFunction=cp.csString(mr)
267                rs=self.__getGMLRangeset(allVarNames[i])
268               
269                #RANGESET
270                gsCoverage.rangeSet=rs
271                gsFeature.parameter=csml.parser.Phenomenon(href='http://badc.rl.ac.uk/localparams#%s'%allVarNames[i])
272                gsFeature.value=gsCoverage
273                self.fms.append(gsFeature)
274            self.DI.closeFile()
275    ###End of createCSMLGridSeriesFeatures###
276   
277    def createCSMLProfileSeriesFeatures(self):
278        #This method assumes that the variables (features) are shared across identically structured files
279        #should be supplied with a featurefilemap object (see csmlfiles for FileMapMaker)
280        representativeFiles=self.ffmap.getRepresentativeFiles()
281        cat=csml.csmllibs.csmlcrs.CRSCatalogue()
282        for repfile in representativeFiles:
283            #get the names of all the variables in the files:
284            allVarNames, numFeatures = self.__getVarInfo(repfile)
285            #Create a ProfileSeriesFeature for each variable:
286            for i in range(0, numFeatures):
287                crs,axisorder, dimNames=self.__getCRS(allVarNames[i], cat)
288                if crs == None:
289                    print 'none'
290                    continue            #try next variable
291                psFeature=cp.ProfileSeriesFeature()
292                self.__featureMetadata(psFeature,allVarNames[i])
293                #VALUE (coverage)
294                psCoverage=cp.ProfileSeriesCoverage()
295                psDomain=cp.ProfileSeriesDomain()
296                psDomain.srsName=crs.srsName
297                psDomain.axisLabels=crs.axisLabels # note this is the xml attribute axisLabels, not the child element (aLabels)
298                psDomain.srsDimension=crs.srsDimension
299                aLabels=''
300                for dim in dimNames:
301                    aLabels=aLabels + dim + ' '
302                psDomain.aLabels=cp.csString(aLabels)
303                gcT=self.__getGridCoordinatesTable(dimNames, crs,axisorder)
304                psDomain.coordTransformTable=gcT
305                psCoverage.profileSeriesDomain=psDomain
306               
307                #COVERAGE FUNCTION
308                mr =csml.csmllibs.csmlextra.getMappingRule(len(dimNames))
309                psCoverage.coverageFunction=cp.csString(mr)
310                rs=self.__getGMLRangeset(allVarNames[i])
311               
312                #RANGESET
313                psCoverage.rangeSet=rs
314                psFeature.parameter=csml.parser.Phenomenon(href='http://badc.rl.ac.uk/localparams#%s'%allVarNames[i])
315                psFeature.value=psCoverage
316               
317                psFeature.location=csml.parser.DirectPositionList(CONTENT='blahha', srsName='blah')
318                self.fms.append(psFeature)
319            self.DI.closeFile()
320    ###End of createCSMLProfileSeriesFeatures###
321
322        #BELOW THIS POINT ALL NEEDS REWRITING
323####################################
324    def createCSMLPointSeriesFeatures(self): 
325
326        representativeFiles=self.ffmap.getRepresentativeFiles()
327        for repfile in representativeFiles:
328            self.repfilename,self.listOfFiles=self._populateListOfFiles(repfile)
329            self._getFilesAndTimes()
330            DI = csml.csmllibs.csmldataiface.DataInterface()
331            DI=DI.getUnknownInterfaceType(self.repfilename)
332            DI.openFile(self.repfilename)
333            allVarNames=DI.getListofVariables()
334            numFeatures=len(allVarNames)       
335            try:
336                DI.setAxis(self.timedim)
337                times=DI.getDataForAxis()
338            except:                     
339                times = DI.getTimes()
340            #Create features:
341            for i in range (0, numFeatures):
342                PointSeriesFeature_element=csml.parser.PointSeriesFeature()
343                if str(allVarNames[i]).upper() in ['ERROR FLAG', 'ERROR']: #might need to extend this list
344                    break
345                PointSeriesFeature_element.id=str(allVarNames[i])
346                desc=self._getDescriptiveName(DI)
347                PointSeriesFeature_element.description=csml.parser.Description(desc)
348                #DOMAIN
349                psDomain=csml.parser.PointSeriesDomain()
350                t=csml.parser.Trajectory()
351                t.srsName='urn:EPSG:geographicCRS:4326' #TO Do
352                t.locations =csml.parser.DirectPositionList(vals='1 1')
353               
354                if self.timestorage =='inline':
355                    tpl =csml.parser.TimePositionList()
356                    tpl.timePositions=self.timeString
357                    tpl.frame='%s:%s'%(self.caltype,self.units)
358                    t.times=tpl
359                else:
360                    # do something to create a single extract for the times (from the representative file).
361                    tpl.timePositions = csml.csmllibs.csmlfileextracts.createSingleExtract(self.extractType, repfilename, self.timedim, len(self.timeString.split())) 
362                    tpl.frame='%s:%s'%(self.caltype,self.units)
363               
364               
365#                 if self.timestorage =='inline':
366#                     t.times=csmllibs.Parser.TimePositionList('#RefSysX',str(times))
367#                 else:
368#                     #todo: depends on the file mapping???
369#                     t.times=csmllibs.Parser.TimePositionList('#RefSysX','blah') #blah = dummy times
370#                 print 'times: ' + str(allVarNames[i])
371#                 print len(times)
372#                 print len(listOfFiles)
373#                 arraySize=len(times) * len(listOfFiles)
374#                 fextract=csmllibs.csmlfileextracts.createSingleExtract(self.extractType,filenames,self.timedim,arraySize)
375#                 tplist = csmllibs.Parser.TimePositionList(timePositions=fextract)
376#                 t.times=tplist                                                                   
377                filenames=csml.csmllibs.csmlextra.cleanString(str(self.listOfFiles))
378                psDomain.domainReference=t
379                #RANGESET
380                DI.setVariable(allVarNames[i])
381                try:
382                    strUom = DI.getVariableAttribute('units')
383                except AttributeError:
384                    #if units attribute doesn't exist:
385                    strUom ="dimensionless or units not determined"
386                try:                   
387                    measuredvalues = DI.getDataForVar()
388                except:
389                    measuredvalues = ' could not get values '
390                rs=csml.parser.RangeSet()
391                if self.valuestorage=='inline':
392                    #encode inline
393                    rs.quantityList=csml.parser.MeasureOrNullList(uom=strUom, val=str(measuredvalues)[1:-1])                         
394                else:
395                    #create a file extract link
396                    arraySize=len(measuredvalues)*len(self.listOfFiles) 
397                    #TODO this needs to be able to handle inline, use VALUESTORAGE to determine which to use:
398                    self.extractType=DI.extractType
399                    fextract=csml.csmllibs.csmlfileextracts.createSingleExtract(self.extractType,filenames,allVarNames[i],arraySize)
400                    qlist = csml.parser.MeasureOrNullList(val=fextract)
401                    rs.quantityList=qlist
402                PointSeriesFeature_element.rangeSet=rs
403                #COVERAGEFUNCTION                           
404                #PARAMETER
405                #need to do parameter and coverageFunction elements
406                PointSeriesFeature_element.domain=psDomain
407                self.fms.append(PointSeriesFeature_element)
408            DI.closeFile()
409       
410
411#This function needs revising in light of a) csml parser and b) new profile feature types
412    def createCSMLProfileFeature(csmldoc, dataset_element, gml_FeatureCollection_element,  ffmap, timedim):
413            representativeFiles=ffmap.getRepresentativeFiles()
414            listOfFiles=[]
415            for repfile in representativeFiles:
416                    repfilename=repfile.getRepresentativeFileName()
417                    listOfFiles.append(repfilename)
418                    relfiles = repfile.getRelatedFiles()
419                    for f in relfiles:
420                            #hopefully there are no related files at the moment!
421                            fname = f.getRelatedFileName()
422                            listOfFiles.append(fname)
423                    #print listOfFiles
424                   
425            for file in listOfFiles:
426                    DI = csmllibs.csmldataiface.DataInterface()
427                    DI=DI.getUnknownInterfaceType(file)
428                    print'opening file'
429                    DI.openFile(file)
430                    print 'getting variables'
431                    allVarNames=DI.getListofVariables()
432                    print 'getting feature count'
433                    numFeatures=len(allVarNames)       
434                   
435                    print "FEATURES"
436                    print "***********"
437                    for i in range (0, len(allVarNames)):
438                            print allVarNames[i]
439                           
440                    for i in range (0, numFeatures):
441                            gml_featureMember_element=csmldoc.createElement("gml:featureMember")
442                            ProfileFeature_element=csmldoc.createElement("ProfileFeature")
443                            ProfileFeature_element.setAttribute('gml:id',str(allVarNames[i]))
444                            gml_description_element = csmldoc.createElement("gml:description")
445                            gml_featureMember_element.appendChild(ProfileFeature_element)
446                            #***********************************************************************
447                            #PointSeriesDomain:
448                            #***********************************************************************
449                            ProfileDomain_element=csmldoc.createElement("ProfileDomain")
450                           
451                           
452                            #***********************************************************************
453                            # domainReference element (and sub-elements)               
454                            #***********************************************************************
455                            domainReference_element=csmldoc.createElement("domainReference")
456                            #orientedPosition_element=csmldoc.createElement("OrientedPosition")
457                            #locations_element=csmldoc.createElement("locations")
458                            #times_element=csmldoc.createElement("times")
459                            #trajectory_element.appendChild(locations_element)
460                            #trajectory_element.appendChild(times_element)
461                            #domainReference_element.appendChild(orientedPosition_element)
462                           
463                            #gml_timePositionList_element = csmldoc.createElement("gml:TimePositionList")
464                            #gml_timePositionList_element.appendChild(csmldoc.createTextNode(self.timeString))
465                            #domainReference_element.appendChild(gml_timePositionList_element)
466                            ProfileDomain_element.appendChild(domainReference_element)
467                            #***********************************************************************
468                            domainComplement_element=csmldoc.createElement("domainComplement")
469                            ProfileDomain_element.appendChild(domainComplement_element)
470                           
471                            #***********************************************************************
472                            # gml:rangeSet_element
473                            #***********************************************************************
474                           
475                            gml_rangeSet_element=csmldoc.createElement("gml:rangeSet") 
476                           
477                            #***********************************************************************
478                            # gml:coverageFunction element (and sub-element MappingRule)               
479                            #***********************************************************************
480                            gml_coverageFunction_element=csmldoc.createElement("gml:coverageFunction")
481                            MappingRule_element=csmldoc.createElement("MappingRule")
482                            #MappingRule_element.setAttribute('scanOrder',csmllibs.csmlextra.getMappingRule(len(dimNames)))
483                            MappingRule_element.setAttribute('scanOrder','tba')
484                            gml_coverageFunction_element.appendChild(MappingRule_element)
485                           
486                           
487                            gml_featureMember_element.appendChild(ProfileDomain_element)
488                            gml_featureMember_element.appendChild(gml_rangeSet_element)
489                            gml_featureMember_element.appendChild(gml_coverageFunction_element)
490                            gml_FeatureCollection_element.appendChild(gml_featureMember_element)       
491                           
492            return 
493                           
494       
Note: See TracBrowser for help on using the repository browser.