Package gavo :: Package grammars :: Module fitsprodgrammar :: Class FITSProdGrammar
[frames] | no frames]

Class FITSProdGrammar

source code

                   object --+                
                            |                
 base.structure.StructureBase --+            
                                |            
                   object --+   |            
                            |   |            
           base.common.Parser --+            
                                |            
base.structure.ParseableStructure --+        
                                    |        
             base.structure.Structure --+    
                                        |    
                   object --+           |    
                            |           |    
     base.macros.MacroPackage --+       |    
                                |       |    
   base.macros.StandardMacroMixin --+   |    
                                    |   |    
             common.GrammarMacroMixin --+    
                                        |    
                           common.Grammar --+
                                            |
                                           FITSProdGrammar

A grammar that returns FITS-headers as dictionaries.

This is the grammar you want when one FITS file corresponds to one row in the destination table.

The keywords of the grammar record are the cards in the primary header (or some other hdu using the same-named attribute). "-" in keywords is replaced with an underscore for easier @-referencing. You can use a mapKeys element to effect further name cosmetics.

This grammar should handle compressed FITS images transparently if set qnd="False". This means that you will essentially get the headers from the second extension for those even if you left hdu="0".

The original header is preserved as the value of the header\_ key. This is mainly intended for use WCS use, as in ``wcs.WCS(@header_)``.

If you have more complex structures in your FITS files, you can get access to the pyfits HDU using the hdusField attribute. With ``hdusField="_H"``, you could say things like ``@_H[1].data[10][0]`` to get the first data item in the tenth row in the second HDU.

Nested Classes
  rowIterator
An object that encapsulates the a source being parsed by a grammar.

Inherited from base.structure.StructureBase: __metaclass__

Instance Methods
 
onElementComplete(self) source code
 
clearProperty(self, name) source code
 
getFullId(self) source code
 
getProperty(self, name, default=<Undefined>) source code
 
hasProperty(self, name) source code
 
setProperty(self, name, value) source code

Inherited from common.Grammar: getSourceFields, parse

Inherited from base.structure.Structure: __provides__, callCompletedCallbacks, completeElement, finishElement, validate

Inherited from base.structure.ParseableStructure: __init__, end_, feed, feedFrom, feedObject, getAttribute, iterEvents, start_, value_

Inherited from base.structure.StructureBase: __providedBy__, adopt, breakCircles, change, copy, getAttributes, getCopyableAttributes, getSourcePosition, iterChildren, setPosition

Inherited from base.common.Parser: feedEvent

Inherited from common.GrammarMacroMixin: macro_colNames, macro_dlMetaURI, macro_fullDLURL, macro_inputRelativePath, macro_inputSize, macro_lastSourceElements, macro_property, macro_rootlessPath, macro_rowsProcessed, macro_sourceDate, macro_splitPreviewPath, macro_srcstem, macro_standardPreviewPath

Inherited from base.macros.StandardMacroMixin: macro_RSTservicelink, macro_RSTtable, macro_decapitalize, macro_getConfig, macro_internallink, macro_magicEmpty, macro_metaSeq, macro_metaString, macro_rdId, macro_rdIdDotted, macro_schema, macro_test, macro_today, macro_upper, macro_urlquote

Inherited from base.macros.MacroPackage: execMacro, expand, getExpander, listMacros, macro_quote, macro_reSub, macro_sql_standardPubDID, macro_sqlquote

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Class Methods

Inherited from base.structure.StructureBase: fromStructure

Class Variables
  name_ = 'fitsProdGrammar'
a sentinel for all kinds of undefined values.
  attrSeq = [<gavo.base.attrdef.UnicodeAttribute object>, <gavo....
  managedAttrs = {'enc': <gavo.base.attrdef.UnicodeAttribute obj...

Inherited from common.Grammar: isDispatching

Inherited from base.structure.Structure: __implemented__

Inherited from base.structure.StructureBase: completedCallbacks

Properties
  rd

Inherited from object: __class__

Method Details

onElementComplete(self)

source code 
Overrides: base.structure.Structure.onElementComplete

clearProperty(self, name)

source code 
Overrides: common.Grammar.clearProperty

getFullId(self)

source code 
Overrides: common.Grammar.getFullId

getProperty(self, name, default=<Undefined>)

source code 
Overrides: common.Grammar.getProperty

hasProperty(self, name)

source code 
Overrides: common.Grammar.hasProperty

setProperty(self, name, value)

source code 
Overrides: common.Grammar.setProperty

Class Variable Details

attrSeq

Value:
[<gavo.base.attrdef.UnicodeAttribute object>,
 <gavo.base.attrdef.IntAttribute object>,
 <gavo.base.attrdef.UnicodeAttribute object>,
 <gavo.base.parsecontext.IdAttribute object>,
 <gavo.base.complexattrs.StructAttribute object>,
 <gavo.base.complexattrs.StructAttribute object>,
 <gavo.base.attrdef.IntAttribute object>,
 <gavo.base.parsecontext.OriginalAttribute object>,
...

managedAttrs

Value:
{'enc': <gavo.base.attrdef.UnicodeAttribute object>,
 'hdu': <gavo.base.attrdef.IntAttribute object>,
 'hdusField': <gavo.base.attrdef.UnicodeAttribute object>,
 'id': <gavo.base.parsecontext.IdAttribute object>,
 'ignoreOn': <gavo.base.complexattrs.StructAttribute object>,
 'mapKeys': <gavo.base.complexattrs.StructAttribute object>,
 'maxHeaderBlocks': <gavo.base.attrdef.IntAttribute object>,
 'original': <gavo.base.parsecontext.OriginalAttribute object>,
...

Property Details

rd

Get Method:
unreachable._getRD(self)