Skip to main content
`Ctrl`+`K`

# BoxLeastSquaresResults

class astropy.timeseries.BoxLeastSquaresResults(*args)

  Bases: `dict`

  The results of a BoxLeastSquares search.

  Attributes:
    objective `python:str`

      The scalar used to optimize to find the best fit phase, duration, and depth. See `BoxLeastSquares.power()` for more information.

    period numpy:array_like or `Quantity` [:ref: ‘time’]

      The set of test periods.

    power numpy:array_like or `Quantity`

      The periodogram evaluated at the periods in `period`. If `objective` is:

      - `'likelihood'`: the values of `power` are the log likelihood maximized over phase, depth, and duration, or

      - `'snr'`: the values of `power` are the signal-to-noise with which the depth is measured maximized over phase, depth, and duration.

    depth numpy:array_like or `Quantity`

      The estimated depth of the maximum power model at each period.

    depth_err numpy:array_like or `Quantity`

      The 1-sigma uncertainty on `depth`.

    duration numpy:array_like or `Quantity` [:ref: ‘time’]

      The maximum power duration at each period.

    transit_time numpy:array_like, `Quantity`, or `Time`

      The maximum power phase of the transit in units of time. This indicates the mid-transit time and it will always be in the range (0, period).

    depth_snr numpy:array_like or `Quantity`

      The signal-to-noise with which the depth is measured at maximum power.

    log_likelihood numpy:array_like or `Quantity`

      The log likelihood of the maximum power model.

  Methods Summary

  `clear`(/) | Remove all items from the dict.
  `copy`(/) | Return a shallow copy of the dict.
  `fromkeys`(iterable[, value]) | Create a new dictionary with keys from iterable and values set to value.
  `get`(key[, default]) | Return the value for key if key is in the dictionary, else default.
  `items`(/) | Return a set-like object providing a view on the dict's items.
  `keys`(/) | Return a set-like object providing a view on the dict's keys.
  `pop`(key[, default]) | If the key is not found, return the default if given; otherwise, raise a KeyError.
  `popitem`(/) | Remove and return a (key, value) pair as a 2-tuple.
  `setdefault`(key[, default]) | Insert key with a value of default if key is not in the dictionary.
  `update`([E, ]**F) | If E is present and has a .keys() method, then does: for k in E.keys(): D[k] = E[k] If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v In either case, this is followed by: for k in F: D[k] = F[k]
  `values`(/) | Return an object providing a view on the dict's values.

  Methods Documentation

  clear(/)

    Remove all items from the dict.

  copy(/)

    Return a shallow copy of the dict.

  classmethod fromkeys(iterable, value=None, /)

    Create a new dictionary with keys from iterable and values set to value.

  get(key, default=None, /)

    Return the value for key if key is in the dictionary, else default.

  items(/)

    Return a set-like object providing a view on the dict’s items.

  keys(/)

    Return a set-like object providing a view on the dict’s keys.

  pop(key, default=<unrepresentable>, /)

    If the key is not found, return the default if given; otherwise, raise a KeyError.

  popitem(/)

    Remove and return a (key, value) pair as a 2-tuple.

    Pairs are returned in LIFO (last-in, first-out) order. Raises KeyError if the dict is empty.

  setdefault(key, default=None, /)

    Insert key with a value of default if key is not in the dictionary.

    Return the value for key if key is in the dictionary, else default.

  update([E, ]**F) → None. Update D from mapping/iterable E and F.

    If E is present and has a .keys() method, then does: for k in E.keys(): D[k] = E[k] If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v In either case, this is followed by: for k in F: D[k] = F[k]

  values(/)

    Return an object providing a view on the dict’s values.