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

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

beginning to refactor API module

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