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

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

more on Referenceable Grid

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