1
# Licensed under a 3-clause BSD style license - see LICENSE.rst
2 1
"""
3
Construct a SLAP query.
4

5
This is not presently used, since I don't know how to construct a complete SLAP
6
query.
7
"""
8

9

10 1
def slap_default_payload(request='queryData', version='2.0', wavelength='',
11
                         chemical_element='', initial_level_energy='',
12
                         final_level_energy='', temperature='', einstein_a=''):
13
    """
14
    Parse the valid parameters specified by the `IVOA SLAP`_ interface
15
    document.
16

17
    .. _IVOA SLAP: http://www.ivoa.net/documents/SLAP/20101209/REC-SLAP-1.0-20101209.pdf
18

19

20
    Parameters
21
    ----------
22
    request : 'queryData'
23
        No other valid entries are known
24
    version : '2.0'
25
        A valid data version number
26
    wavelength : 'x/y' or 'x' or 'x,y/z' or 'x/'
27
        Wavelength range in meters.
28
        'x/y' means 'in the range from x to y'
29
        'x/' means 'wavelength > x'
30
        'x' means 'wavelength == x'
31
        'x/y,y/z' means 'wavelength in range [x,y] or [y,z]'
32
        See Appendix A of the `IVOA SLAP`_ manual
33

34
    Other Parameters
35
    ----------------
36
    chemical_element : str
37
        A chemical element name.  Can be specified as a comma-separated list
38
    initial_level_energy : float
39
        Unit: Joules
40
    final_level_energy : float
41
        Unit: Joules
42
    temperature : float
43
        Unit : Kelvin
44
        Expected temperature of object.  Not needed for splatalogue
45
    einstein_a : float
46
        Unit : s^-1
47
    process_type : str
48
    process_name : str
49
        Examples:
50
        "Photoionization", "Collisional excitation",
51
        "Gravitational redshift", "Stark broadening", "Resonance broadening",
52
        "Van de Waals broadening"
53

54
    Returns
55
    -------
56
    Dictionary of parameters which can then be POSTed to the service
57
    """
58 0
    return locals()

Read our documentation on viewing source code .

Loading