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

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

fixed axislabel attribute and printscreen option.

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