astro py:docs

- Index
- Modules

### Navigation

- next »
- « previous |
- Astropy v5.2.1 »
- Time and Dates (`astropy.time`) »
- TimeISO

# TimeISO

class astropy.time.TimeISO(val1, val2, scale, precision, in_subfmt, out_subfmt, from_jd=False)

  Bases: `TimeString`

  ISO 8601 compliant date-time format “YYYY-MM-DD HH:MM:SS.sss…”. For example, 2000-01-01 00:00:00.000 is midnight on January 1, 2000.

  The allowed subformats are:

  - ‘date_hms’: date + hours, mins, secs (and optional fractional secs)

  - ‘date_hm’: date + hours, mins

  - ‘date’: date

  Attributes Summary

  `cache` | Return the cache associated with this instance.
  `fast_parser_pars` |
  `in_subfmt` |
  `jd1` |
  `jd2` |
  `jd2_filled` |
  `mask` |
  `masked` |
  `name` |
  `out_subfmt` |
  `precision` |
  `scale` | Time scale
  `subfmts` |
  `value` |

  Methods Summary

  `format_string`(str_fmt, **kwargs) | Write time to a string using a given format.
  `get_jds_fast`(val1, val2) | Use fast C parser to parse time strings in val1 and get jd1, jd2
  `get_jds_python`(val1, val2) | Parse the time strings contained in val1 and get jd1, jd2
  `mask_if_needed`(value) |
  `parse_string`(timestr, subfmts) | Read time from a single string, using a set of possible formats.
  `set_jds`(val1, val2) | Parse the time strings contained in val1 and set jd1, jd2
  `str_kwargs`() | Generator that yields a dict of values corresponding to the calendar date and time for the internal JD values.
  `to_value`([parent, out_subfmt]) | Return time representation from internal jd1 and jd2 in specified `out_subfmt`.

  Attributes Documentation

  cache

    Return the cache associated with this instance.

  fast_parser_pars = {'break_allowed': (0, 0, 0, 1, 0, 1, 1), 'delims': (0, 45, 45, 32, 58, 58, 46), 'has_day_of_year': 0, 'starts': (0, 4, 7, 10, 13, 16, 19), 'stops': (3, 6, 9, 12, 15, 18, -1)}
  in_subfmt
  jd1
  jd2
  jd2_filled
  mask
  masked
  name = 'iso'
  out_subfmt
  precision
  scale

    Time scale

  subfmts = (('date_hms', re.compile('(?P<year>\\d\\d\\d\\d)-(?P<mon>\\d{1,2})-(?P<mday>\\d{1,2}) (?P<hour>\\d{1,2}):(?P<min>\\d{1,2}):(?P<sec>\\d{1,2})$'), '{year:d}-{mon:02d}-{day:02d} {hour:02d}:{min:02d}:{sec:02d}'), ('date_hm', re.compile('(?P<year>\\d\\d\\d\\d)-(?P<mon>\\d{1,2})-(?P<mday>\\d{1,2}) (?P<hour>\\d{1,2}):(?P<min>\\d{1,2})$'), '{year:d}-{mon:02d}-{day:02d} {hour:02d}:{min:02d}'), ('date', re.compile('(?P<year>\\d\\d\\d\\d)-(?P<mon>\\d{1,2})-(?P<mday>\\d{1,2})$'), '{year:d}-{mon:02d}-{day:02d}'))
  value

  Methods Documentation

  format_string(str_fmt, **kwargs)

    Write time to a string using a given format.

    By default, just interprets str_fmt as a format string, but subclasses can add to this.

  get_jds_fast(val1, val2)

    Use fast C parser to parse time strings in val1 and get jd1, jd2

  get_jds_python(val1, val2)

    Parse the time strings contained in val1 and get jd1, jd2

  mask_if_needed(value)
  parse_string(timestr, subfmts)

    Read time from a single string, using a set of possible formats.

  set_jds(val1, val2)

    Parse the time strings contained in val1 and set jd1, jd2

  str_kwargs()

    Generator that yields a dict of values corresponding to the calendar date and time for the internal JD values.

  to_value(parent=None, out_subfmt=None)

    Return time representation from internal jd1 and jd2 in specified `out_subfmt`.

    This is the base method that ignores `parent` and uses the `value` property to compute the output. This is done by temporarily setting `self.out_subfmt` and calling `self.value`. This is required for legacy Format subclasses prior to astropy 4.0 New code should instead implement the value functionality in `to_value()` and then make the `value` property be a simple call to `self.to_value()`.

    Parameters:
      parent `object`

        Parent `Time` object associated with this `TimeFormat` object

      out_subfmt `python:str` or `python:None`

        Output subformt (use existing self.out_subfmt if `None`)

    Returns:
      value `numpy.array`, `numpy.ma.array`

        Array or masked array of formatted time representation values