TimeString

class astropy.time.TimeString(val1, val2, scale, precision, in_subfmt, out_subfmt, from_jd=False)[source]

Bases: astropy.time.TimeUnique

Base class for string-like time representations.

This class assumes that anything following the last decimal point to the right is a fraction of a second.

This is a reference implementation can be made much faster with effort.

Attributes Summary

cache

Return the cache associated with this instance.

jd1

jd2

jd2_filled

mask

masked

scale

Time scale

subfmts

value

Methods Summary

format_string(self, str_fmt, \*\*kwargs)

Write time to a string using a given format.

mask_if_needed(self, value)

parse_string(self, timestr, subfmts)

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

set_jds(self, val1, val2)

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

str_kwargs(self)

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

to_value(self[, 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.

jd1
jd2
jd2_filled
mask
masked
scale

Time scale

subfmts = ()
value

Methods Documentation

format_string(self, str_fmt, **kwargs)[source]

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.

mask_if_needed(self, value)
parse_string(self, timestr, subfmts)[source]

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

set_jds(self, val1, val2)[source]

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

str_kwargs(self)[source]

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

to_value(self, 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
parentobj

Parent Time object associated with this TimeFormat object

out_subfmtstr or None

Output subformt (use existing self.out_subfmt if None)

Returns
valuenumpy.array, numpy.ma.array

Array or masked array of formatted time representation values