summaryrefslogtreecommitdiff
path: root/stwcs/gui/headerlet_summary.py
diff options
context:
space:
mode:
Diffstat (limited to 'stwcs/gui/headerlet_summary.py')
-rw-r--r--stwcs/gui/headerlet_summary.py47
1 files changed, 47 insertions, 0 deletions
diff --git a/stwcs/gui/headerlet_summary.py b/stwcs/gui/headerlet_summary.py
new file mode 100644
index 0000000..82a3e0c
--- /dev/null
+++ b/stwcs/gui/headerlet_summary.py
@@ -0,0 +1,47 @@
+import os
+from stsci.tools import teal
+
+import stwcs
+from stwcs.wcsutil import headerlet
+
+__taskname__ = __name__.split('.')[-1] # needed for help string
+__package__ = headerlet.__name__
+__version__ = stwcs.__version__
+#
+#### Interfaces used by TEAL
+#
+def getHelpAsString(docstring=False):
+ """
+ return useful help from a file in the script directory called __taskname__.help
+ """
+ install_dir = os.path.dirname(__file__)
+ htmlfile = os.path.join(install_dir,'htmlhelp',__taskname__+'.html')
+ helpfile = os.path.join(install_dir,__taskname__+'.help')
+ if docstring or (not docstring and not os.path.exists(htmlfile)):
+ helpString = __taskname__+' Version '+__version__+'\n\n'
+ if os.path.exists(helpfile):
+ helpString += teal.getHelpFileAsString(__taskname__,__file__)
+ else:
+ helpString += eval('.'.join([__package__,__taskname__,'__doc__']))
+ else:
+ helpString = 'file://'+htmlfile
+
+ return helpString
+
+def run(configObj=None):
+
+ # create dictionary of remaining parameters, deleting extraneous ones
+ # such as those above
+ cdict = configObj.dict()
+ # remove any rules defined for the TEAL interface
+ if "_RULES_" in cdict: del cdict['_RULES_']
+ del cdict['_task_name_']
+ del cdict['filename']
+ if headerlet.is_par_blank(cdict['columns']):
+ cdict['columns'] = None
+ # Call function with properly interpreted input parameters
+
+ # Syntax: headerlet_summary(filename,columns=None,pad=2,maxwidth=None,
+ # output=None,clobber=True,quiet=False)
+ headerlet.headerlet_summary(configObj['filename'],**cdict)
+