summaryrefslogtreecommitdiff
path: root/stwcs/gui/archive_headerlet.py
blob: 577a348608e372b744901467a8a58ead7e30eca5 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
from __future__ import absolute_import, division, print_function
import os

from stsci.tools import teal
from .. import __version__
from ..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 += headerlet.archive_as_headerlet.__doc__

    else:
        helpString = 'file://' + htmlfile

    return helpString


def run(configObj=None):

    if configObj['hdrname'] in ['', ' ', 'INDEF']:
        print('=' * 60)
        print('ERROR:')
        print('    No valid "hdrname" parameter value provided!')
        print('    Please restart this task and provide a value for this parameter.')
        print('=' * 60)
        return

    str_kw = ['wcsname', 'destim', 'sipname', 'npolfile', 'd2imfile',
              'descrip', 'history', 'author']

    # 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']
    del cdict['hdrname']

    # Convert blank string input as None
    for kw in str_kw:
        if cdict[kw] == '': cdict[kw] = None
    if cdict['wcskey'].lower() == 'primary': cdict['wcskey'] = ' '

    # Call function with properly interpreted input parameters
    # Syntax: archive_as_headerlet(filename, sciext='SCI', wcsname=None, wcskey=None,
    #                    hdrname=None, destim=None,
    #                    sipname=None, npolfile=None, d2imfile=None,
    #                    author=None, descrip=None, history=None,
    #                    hdrlet=None, clobber=False)
    headerlet.archive_as_headerlet(configObj['filename'], configObj['hdrname'],
                                   **cdict)