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

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

Numeric.array is now the standard data container

  • 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   
162    def __getCRS(self,varName,catalogue):
163        self.DI.setVariable(varName)
164        dimNames=self.DI.getVariableAxes() 
165        if len(dimNames) <= 2:
166                #it's an axis or bounds not a feature, try next variable
167            return None, None, None
168        unitlist=[]
169        for dim in dimNames:
170            self.DI.setAxis(dim)
171            units=self.DI.getAxisAttribute('units')  #need to make special case of units in DI layer
172            unitlist.append(units)   
173        crs, axisorder=catalogue.determineCRS(dimNames,unitlist)
174        return crs, axisorder, dimNames
175   
176    def __featureMetadata(self,feature, varName):
177        feature.id=str(varName)
178        desc = self._getDescriptiveName(self.DI)
179        feature.description=csml.parser.csString(desc)
180       
181    def __getGMLRangeset(self,varName):
182        #GML RANGESET
183        rs=csml.parser.RangeSet()
184        self.DI.setVariable(varName)
185        arrSz = self.DI.getArraySizeOfVar()
186        try:
187            strUom = self.DI.getVariableAttribute('units')
188        except AttributeError:
189            # if units attribute doesn't exist:
190            strUom ="dimensionless or units not determined"
191        if self.valuestorage=='inline':
192            #TO DO, store the rangeset inline - use Datablock class???
193            pass
194        else:
195            #store the rangeSet as an aggregatedArray
196            #TODO, need to take this out of the rangeset and use xlink to reference it.
197            aa=cp.AggregatedArray()
198            aa.arraySize=cp.csString(arrSz)
199            aa.uom=cp.csString(strUom)
200            aa.aggType=cp.csString('new') #can it be anything else?
201            aa.aggIndex=cp.csString('1')
202            #FileExtract (fe) element will be NetCDF/GRIB/PPExtract element (As defined earlier in ExtractType)
203            self.extractType= self.DI.extractType
204            fe = self._getCorrectExtractType()
205            varSize=self.DI.getShapeOfVar()
206            varSize=csml.csmllibs.csmlextra.cleanString1(str(varSize))
207            fe.arraySize=cp.csString(varSize)
208            fl=cp.FileList()
209            fl.fileNames=cp.csString(self.filesinDir)
210            fe.fileList=fl
211            fe.variableName=cp.csString(varName)
212            aa.components=[fe]
213            aa.id=csml.csmllibs.csmlextra.getRandomID()
214            if hasattr(self.ds_element, 'storageDescriptor'):
215                self.ds_element.storageDescriptor.descriptors.append(aa)
216            else:
217                sd =csml.parser.CSMLStorageDescriptor()
218                sd.descriptors=aa
219                setattr(self.ds_element, 'storageDescriptor',sd)
220            #rs.aggregatedArray=aa
221            va=csml.parser.ValueArray()
222            vc=csml.parser.ValueComponent()
223            vc.href='#%s'%aa.id
224            vc.arcrole="http://ndg.nerc.ac.uk/xlinkUsage/insert#QuantityList"
225            vc.role="http://ndg.nerc.ac.uk/fileFormat/csmlStorageDescriptor"
226            vc.show='embed'
227            ql=csml.parser.MeasureOrNullList()
228            ql.uom=strUom
229            vc.quantityList=ql
230            va.valueComponent=vc
231            rs.valueArray=va
232        return rs
233   
234   
235    #the following functions are for creation of specific feature types (and call the __functions above)
236    def createCSMLGridSeriesFeatures(self):
237        #This method assumes that the variables (features) are shared across identically structured files
238        #should be supplied with a featurefilemap object (see csmlfiles for FileMapMaker)
239        representativeFiles=self.ffmap.getRepresentativeFiles()
240        cat=csml.csmllibs.csmlcrs.CRSCatalogue()
241        for repfile in representativeFiles:
242            #get the names of all the variables in the files:
243            allVarNames, numFeatures = self.__getVarInfo(repfile)
244            #Create a GridSeriesFeature for each variable:
245            for i in range(0, numFeatures):
246                crs,axisorder, dimNames=self.__getCRS(allVarNames[i], cat)
247                if crs == None:
248                    continue            #try next variable
249                gsFeature=cp.GridSeriesFeature()
250                self.__featureMetadata(gsFeature,allVarNames[i])
251                #VALUE (coverage)
252                gsCoverage=cp.GridSeriesCoverage()
253                gsDomain=cp.GridSeriesDomain()
254                gsDomain.srsName=crs.srsName
255                gsDomain.axisLabels=crs.axisLabels # note this is the xml attribute axisLabels, not the child element (aLabels)
256                gsDomain.srsDimension=crs.srsDimension
257                aLabels=''
258                for dim in dimNames:
259                    aLabels=aLabels + dim + ' '
260                gsDomain.aLabels=cp.csString(aLabels)
261                gcT=self.__getGridCoordinatesTable(dimNames, crs,axisorder)
262                gsDomain.coordTransformTable=gcT
263                gsCoverage.gridSeriesDomain=gsDomain
264               
265                #COVERAGE FUNCTION
266                mr =csml.csmllibs.csmlextra.getMappingRule(len(dimNames))
267                gsCoverage.coverageFunction=cp.csString(mr)
268                rs=self.__getGMLRangeset(allVarNames[i])
269               
270                #RANGESET
271                gsCoverage.rangeSet=rs
272                gsFeature.parameter=csml.parser.Phenomenon(href='http://badc.rl.ac.uk/localparams#%s'%allVarNames[i])
273                gsFeature.value=gsCoverage
274                self.fms.append(gsFeature)
275            self.DI.closeFile()
276    ###End of createCSMLGridSeriesFeatures###
277   
278    def createCSMLProfileSeriesFeatures(self):
279        #This method assumes that the variables (features) are shared across identically structured files
280        #should be supplied with a featurefilemap object (see csmlfiles for FileMapMaker)
281        representativeFiles=self.ffmap.getRepresentativeFiles()
282        cat=csml.csmllibs.csmlcrs.CRSCatalogue()
283        for repfile in representativeFiles:
284            #get the names of all the variables in the files:
285            allVarNames, numFeatures = self.__getVarInfo(repfile)
286            #Create a GridSeriesFeature for each variable:
287            for i in range(0, numFeatures):
288                crs,axisorder, dimNames=self.__getCRS(allVarNames[i], cat)
289                if crs == None:
290                    continue            #try next variable
291                psFeature=cp.ProfileSeriesFeature()
292                self.__featureMetadata(gsFeature,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.gridSeriesDomain=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                self.fms.append(psFeature)
317            self.DI.closeFile()
318    ###End of createCSMLProfileSeriesFeatures###
319
320
321
322
323
324        #BELOW THIS POINT ALL NEEDS REWRITING
325####################################
326    def createCSMLPointSeriesFeatures(self): 
327
328        representativeFiles=self.ffmap.getRepresentativeFiles()
329        for repfile in representativeFiles:
330            self.repfilename,self.listOfFiles=self._populateListOfFiles(repfile)
331            self._getFilesAndTimes()
332            DI = csml.csmllibs.csmldataiface.DataInterface()
333            DI=DI.getUnknownInterfaceType(self.repfilename)
334            DI.openFile(self.repfilename)
335            allVarNames=DI.getListofVariables()
336            numFeatures=len(allVarNames)       
337            try:
338                DI.setAxis(self.timedim)
339                times=DI.getDataForAxis()
340            except:                     
341                times = DI.getTimes()
342            #Create features:
343            for i in range (0, numFeatures):
344                PointSeriesFeature_element=csml.parser.PointSeriesFeature()
345                if str(allVarNames[i]).upper() in ['ERROR FLAG', 'ERROR']: #might need to extend this list
346                    break
347                PointSeriesFeature_element.id=str(allVarNames[i])
348                desc=self._getDescriptiveName(DI)
349                PointSeriesFeature_element.description=csml.parser.Description(desc)
350                #DOMAIN
351                psDomain=csml.parser.PointSeriesDomain()
352                t=csml.parser.Trajectory()
353                t.srsName='urn:EPSG:geographicCRS:4326' #TO Do
354                t.locations =csml.parser.DirectPositionList(vals='1 1')
355               
356                if self.timestorage =='inline':
357                    tpl =csml.parser.TimePositionList()
358                    tpl.timePositions=self.timeString
359                    tpl.frame='%s:%s'%(self.caltype,self.units)
360                    t.times=tpl
361                else:
362                    # do something to create a single extract for the times (from the representative file).
363                    tpl.timePositions = csml.csmllibs.csmlfileextracts.createSingleExtract(self.extractType, repfilename, self.timedim, len(self.timeString.split())) 
364                    tpl.frame='%s:%s'%(self.caltype,self.units)
365               
366               
367#                 if self.timestorage =='inline':
368#                     t.times=csmllibs.Parser.TimePositionList('#RefSysX',str(times))
369#                 else:
370#                     #todo: depends on the file mapping???
371#                     t.times=csmllibs.Parser.TimePositionList('#RefSysX','blah') #blah = dummy times
372#                 print 'times: ' + str(allVarNames[i])
373#                 print len(times)
374#                 print len(listOfFiles)
375#                 arraySize=len(times) * len(listOfFiles)
376#                 fextract=csmllibs.csmlfileextracts.createSingleExtract(self.extractType,filenames,self.timedim,arraySize)
377#                 tplist = csmllibs.Parser.TimePositionList(timePositions=fextract)
378#                 t.times=tplist                                                                   
379                filenames=csml.csmllibs.csmlextra.cleanString(str(self.listOfFiles))
380                psDomain.domainReference=t
381                #RANGESET
382                DI.setVariable(allVarNames[i])
383                try:
384                    strUom = DI.getVariableAttribute('units')
385                except AttributeError:
386                    #if units attribute doesn't exist:
387                    strUom ="dimensionless or units not determined"
388                try:                   
389                    measuredvalues = DI.getDataForVar()
390                except:
391                    measuredvalues = ' could not get values '
392                rs=csml.parser.RangeSet()
393                if self.valuestorage=='inline':
394                    #encode inline
395                    rs.quantityList=csml.parser.MeasureOrNullList(uom=strUom, val=str(measuredvalues)[1:-1])                         
396                else:
397                    #create a file extract link
398                    arraySize=len(measuredvalues)*len(self.listOfFiles) 
399                    #TODO this needs to be able to handle inline, use VALUESTORAGE to determine which to use:
400                    self.extractType=DI.extractType
401                    fextract=csml.csmllibs.csmlfileextracts.createSingleExtract(self.extractType,filenames,allVarNames[i],arraySize)
402                    qlist = csml.parser.MeasureOrNullList(val=fextract)
403                    rs.quantityList=qlist
404                PointSeriesFeature_element.rangeSet=rs
405                #COVERAGEFUNCTION                           
406                #PARAMETER
407                #need to do parameter and coverageFunction elements
408                PointSeriesFeature_element.domain=psDomain
409                self.fms.append(PointSeriesFeature_element)
410            DI.closeFile()
411       
412
413#This function needs revising in light of a) csml parser and b) new profile feature types
414    def createCSMLProfileFeature(csmldoc, dataset_element, gml_FeatureCollection_element,  ffmap, timedim):
415            representativeFiles=ffmap.getRepresentativeFiles()
416            listOfFiles=[]
417            for repfile in representativeFiles:
418                    repfilename=repfile.getRepresentativeFileName()
419                    listOfFiles.append(repfilename)
420                    relfiles = repfile.getRelatedFiles()
421                    for f in relfiles:
422                            #hopefully there are no related files at the moment!
423                            fname = f.getRelatedFileName()
424                            listOfFiles.append(fname)
425                    #print listOfFiles
426                   
427            for file in listOfFiles:
428                    DI = csmllibs.csmldataiface.DataInterface()
429                    DI=DI.getUnknownInterfaceType(file)
430                    print'opening file'
431                    DI.openFile(file)
432                    print 'getting variables'
433                    allVarNames=DI.getListofVariables()
434                    print 'getting feature count'
435                    numFeatures=len(allVarNames)       
436                   
437                    print "FEATURES"
438                    print "***********"
439                    for i in range (0, len(allVarNames)):
440                            print allVarNames[i]
441                           
442                    for i in range (0, numFeatures):
443                            gml_featureMember_element=csmldoc.createElement("gml:featureMember")
444                            ProfileFeature_element=csmldoc.createElement("ProfileFeature")
445                            ProfileFeature_element.setAttribute('gml:id',str(allVarNames[i]))
446                            gml_description_element = csmldoc.createElement("gml:description")
447                            gml_featureMember_element.appendChild(ProfileFeature_element)
448                            #***********************************************************************
449                            #PointSeriesDomain:
450                            #***********************************************************************
451                            ProfileDomain_element=csmldoc.createElement("ProfileDomain")
452                           
453                           
454                            #***********************************************************************
455                            # domainReference element (and sub-elements)               
456                            #***********************************************************************
457                            domainReference_element=csmldoc.createElement("domainReference")
458                            #orientedPosition_element=csmldoc.createElement("OrientedPosition")
459                            #locations_element=csmldoc.createElement("locations")
460                            #times_element=csmldoc.createElement("times")
461                            #trajectory_element.appendChild(locations_element)
462                            #trajectory_element.appendChild(times_element)
463                            #domainReference_element.appendChild(orientedPosition_element)
464                           
465                            #gml_timePositionList_element = csmldoc.createElement("gml:TimePositionList")
466                            #gml_timePositionList_element.appendChild(csmldoc.createTextNode(self.timeString))
467                            #domainReference_element.appendChild(gml_timePositionList_element)
468                            ProfileDomain_element.appendChild(domainReference_element)
469                            #***********************************************************************
470                            domainComplement_element=csmldoc.createElement("domainComplement")
471                            ProfileDomain_element.appendChild(domainComplement_element)
472                           
473                            #***********************************************************************
474                            # gml:rangeSet_element
475                            #***********************************************************************
476                           
477                            gml_rangeSet_element=csmldoc.createElement("gml:rangeSet") 
478                           
479                            #***********************************************************************
480                            # gml:coverageFunction element (and sub-element MappingRule)               
481                            #***********************************************************************
482                            gml_coverageFunction_element=csmldoc.createElement("gml:coverageFunction")
483                            MappingRule_element=csmldoc.createElement("MappingRule")
484                            #MappingRule_element.setAttribute('scanOrder',csmllibs.csmlextra.getMappingRule(len(dimNames)))
485                            MappingRule_element.setAttribute('scanOrder','tba')
486                            gml_coverageFunction_element.appendChild(MappingRule_element)
487                           
488                           
489                            gml_featureMember_element.appendChild(ProfileDomain_element)
490                            gml_featureMember_element.appendChild(gml_rangeSet_element)
491                            gml_featureMember_element.appendChild(gml_coverageFunction_element)
492                            gml_FeatureCollection_element.appendChild(gml_featureMember_element)       
493                           
494            return 
495                           
496       
Note: See TracBrowser for help on using the repository browser.