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

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

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