astro query:docs

- Index
- Modules

### Navigation

- next »
- « previous |
- astroquery v0.4.11 »
- Atomic Line List (`astroquery.atomic`) »
- AtomicLineListClass

# AtomicLineListClass

class astroquery.atomic.AtomicLineListClass

  Bases: `BaseQuery`

  Attributes Summary

  `FORM_URL` |
  `TIMEOUT` |

  Methods Summary

  `query_object`(*[, wavelength_range, ...]) | Queries Atomic Line List for the given parameters adnd returns the result as a `Table`.
  `query_object_async`(*[, wavelength_range, ...]) | Queries Atomic Line List for the given parameters adnd returns the result as a `Table`.

  Attributes Documentation

  FORM_URL = 'https://linelist.pa.uky.edu/atomic/'
  TIMEOUT = 60

  Methods Documentation

  query_object(*, wavelength_range=None, wavelength_type=None, wavelength_accuracy=None, element_spectrum=None, minimal_abundance=None, depl_factor=None, lower_level_energy_range=None, upper_level_energy_range=None, nmax=None, multiplet=None, transitions=None, show_fine_structure=None, show_auto_ionizing_transitions=None, output_columns=('spec', 'type', 'conf', 'term', 'angm', 'prob', 'ener'), cache=True, get_query_payload=False)

    Queries Atomic Line List for the given parameters adnd returns the result as a `Table`. All parameters are optional.

    Parameters:
      wavelength_range pair of `astropy.units.Unit` values

        Wavelength range. Can be done in two ways: supply a lower and upper limit for the region or, supply the central wavelength and the 1 sigma error (68 % confidence value) for that line. If the first number is smaller than the second number, this implies that the first option has been chosen, and otherwise the second option.

      wavelength_type str

        Either `'Air'` or `'Vacuum'`.

      wavelength_accuracy str

        All wavelengths in the line list have relative accuracies of 5% or better. The default is to list all lines, irrespective of their accuracy. When a relative accuracy in percent is given, only those lines with accuracies better than or equal to the passed value are included in the search. Values larger than 5% will be ignored.

      element_spectrum str

        Restrict the search to a range of elements and/or ionization stages. The elements should be entered by their usual symbolic names (e.g. Fe) and the ionization stages by the usual spectroscopic notation (e.g. I for neutral, II for singly ionized etc.). To pass multiple values, separate them by `\n` (newline).

      minimal_abundance str

        Impose a lower limit on the abundances of elements to be considered for possible identifications. Default is to consider arbitrary low abundances. The elements are assumed to have standard cosmic abundances.

      depl_factor str

        For nebular conditions it is not a realistic assumption that the elements have standard cosmic abundances since most metals will be depleted on grains. To simulate this it is possible to supply a depletion factor df. This factor will be used to calculate the actual abundance A from the cosmic abundance Ac using the formula A(elm) = Ac(elm) - df*sd(elm) where sd is the standard depletion for each element.

      lower_level_energy_range `Quantity`

        Default is to consider all values for the lower/upper level energy to find a possible identification. To restrict the search a range of energies can be supplied. The supported units are: Ry, eV, 1/cm, J, erg.

      upper_level_energy_range `Quantity`

        See parameter `lower_level_energy_range`.

      nmax int

        Maximum for principal quantum number n. Default is to consider all possible values for the principal quantum number n to find possible identifications. However, transitions involving electrons with a very high quantum number n tend to be weaker and can therefore be less likely identifications. These transitions can be suppressed using this parameter.

      multiplet str

        This option (case sensitive) can be used to find all lines in a specific multiplet within a certain wavelength range. The lower and upper level term should be entered here exactly as they appear in the output of the query. The spectrum to which this multiplet belongs should of course also be supplied in the `element_spectrum` parameter.

      transitions str`
        Possible values are:
          - `'all'`:

              The default, consider all transition types.

          - `'nebular'`:

              Consider only allowed transitions of Hydrogen or Helium and only magnetic dipole or electric quadrupole transitions of other elements.

          - A union of the values: One of the following: `'E1'`, `'IC'`, `'M1'`, `'E2'` Refer to [1] for the meaning of these values.

      show_fine_structure bool

        If `True`, the fine structure components will be included in the output. Refer to [1] for more information.

      show_auto_ionizing_transitions bool

        If `True`, transitions originating from auto-ionizing levels will be included in the output. In this context, all levels with energies higher than the ionization potential going to the ground state of the next ion are considered auto-ionizing levels.

      output_columns tuple

        A Tuple of strings indicating which output columns are retrieved. A subset of (‘spec’, ‘type’, ‘conf’, ‘term’, ‘angm’, ‘prob’, ‘ener’) should be used. Where each string corresponds to the column titled Spectrum, Transition type, Configuration, Term, Angular momentum, Transition probability and Level energies respectively.

      cache bool

        Defaults to True. If set overrides global caching behavior. See caching documentation.

    Returns:
      result `Table`

        The result of the query as a `Table` object.

    References

    [1] (1,2)

    https://linelist.pa.uky.edu/atomic/instruction.html

  query_object_async(*, wavelength_range=None, wavelength_type='', wavelength_accuracy=None, element_spectrum=None, minimal_abundance=None, depl_factor=None, lower_level_energy_range=None, upper_level_energy_range=None, nmax=None, multiplet=None, transitions=None, show_fine_structure=None, show_auto_ionizing_transitions=None, output_columns=('spec', 'type', 'conf', 'term', 'angm', 'prob', 'ener'), cache=True, get_query_payload=False)

    Queries Atomic Line List for the given parameters adnd returns the result as a `Table`. All parameters are optional.

    Parameters:
      wavelength_range pair of `astropy.units.Unit` values

        Wavelength range. Can be done in two ways: supply a lower and upper limit for the region or, supply the central wavelength and the 1 sigma error (68 % confidence value) for that line. If the first number is smaller than the second number, this implies that the first option has been chosen, and otherwise the second option.

      wavelength_type str

        Either `'Air'` or `'Vacuum'`.

      wavelength_accuracy str

        All wavelengths in the line list have relative accuracies of 5% or better. The default is to list all lines, irrespective of their accuracy. When a relative accuracy in percent is given, only those lines with accuracies better than or equal to the passed value are included in the search. Values larger than 5% will be ignored.

      element_spectrum str

        Restrict the search to a range of elements and/or ionization stages. The elements should be entered by their usual symbolic names (e.g. Fe) and the ionization stages by the usual spectroscopic notation (e.g. I for neutral, II for singly ionized etc.). To pass multiple values, separate them by `\n` (newline).

      minimal_abundance str

        Impose a lower limit on the abundances of elements to be considered for possible identifications. Default is to consider arbitrary low abundances. The elements are assumed to have standard cosmic abundances.

      depl_factor str

        For nebular conditions it is not a realistic assumption that the elements have standard cosmic abundances since most metals will be depleted on grains. To simulate this it is possible to supply a depletion factor df. This factor will be used to calculate the actual abundance A from the cosmic abundance Ac using the formula A(elm) = Ac(elm) - df*sd(elm) where sd is the standard depletion for each element.

      lower_level_energy_range `Quantity`

        Default is to consider all values for the lower/upper level energy to find a possible identification. To restrict the search a range of energies can be supplied. The supported units are: Ry, eV, 1/cm, J, erg.

      upper_level_energy_range `Quantity`

        See parameter `lower_level_energy_range`.

      nmax int

        Maximum for principal quantum number n. Default is to consider all possible values for the principal quantum number n to find possible identifications. However, transitions involving electrons with a very high quantum number n tend to be weaker and can therefore be less likely identifications. These transitions can be suppressed using this parameter.

      multiplet str

        This option (case sensitive) can be used to find all lines in a specific multiplet within a certain wavelength range. The lower and upper level term should be entered here exactly as they appear in the output of the query. The spectrum to which this multiplet belongs should of course also be supplied in the `element_spectrum` parameter.

      transitions str`
        Possible values are:
          - `'all'`:

              The default, consider all transition types.

          - `'nebular'`:

              Consider only allowed transitions of Hydrogen or Helium and only magnetic dipole or electric quadrupole transitions of other elements.

          - A union of the values: One of the following: `'E1'`, `'IC'`, `'M1'`, `'E2'` Refer to [1] for the meaning of these values.

      show_fine_structure bool

        If `True`, the fine structure components will be included in the output. Refer to [1] for more information.

      show_auto_ionizing_transitions bool

        If `True`, transitions originating from auto-ionizing levels will be included in the output. In this context, all levels with energies higher than the ionization potential going to the ground state of the next ion are considered auto-ionizing levels.

      output_columns tuple

        A Tuple of strings indicating which output columns are retrieved. A subset of (‘spec’, ‘type’, ‘conf’, ‘term’, ‘angm’, ‘prob’, ‘ener’) should be used. Where each string corresponds to the column titled Spectrum, Transition type, Configuration, Term, Angular momentum, Transition probability and Level energies respectively.

      cache bool

        Defaults to True. If set overrides global caching behavior. See caching documentation.

    Returns:
      response `requests.Response`

        The HTTP response returned from the service.

    References

    [1] (1,2)

    https://linelist.pa.uky.edu/atomic/instruction.html