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

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

parameter, and AggregatedArray? implemented in scanner. Also changes to AssociationAttributeGroup in parser

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