TimeFormat#

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

Bases: object

Base class for time representations.

Parameters:
val1numpy ndarray, python:list, number, python:str, or bytes

Values to initialize the time or times. Bytes are decoded as ascii. Quantities with time units are allowed for formats where the interpretation is unambiguous.

val2numpy ndarray, python:list, or number; optional

Value(s) to initialize the time or times. Only used for numerical input, to help preserve precision.

scalepython:str

Time scale of input value(s)

precisionpython:int

Precision for seconds as floating point

in_subfmtpython:str

Select subformat for inputting string times

out_subfmtpython:str

Select subformat for outputting string times

from_jdbool

If true then val1, val2 are jd1, jd2

Attributes Summary

Methods Summary

fill_value(subfmt)

Return a value corresponding to J2000 (2000-01-01 12:00:00) in this format.

set_jds(val1, val2)

Set internal jd1 and jd2 from val1 and val2.

to_value([parent, out_subfmt])

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

Attributes Documentation

in_subfmt#
jd1#
jd2#
out_subfmt#
precision#
scale#

Time scale.

subfmts = ()#
value#

Methods Documentation

classmethod fill_value(subfmt)[source]#

Return a value corresponding to J2000 (2000-01-01 12:00:00) in this format.

This is used as a fill value for masked arrays to ensure that any ERFA operations on the masked array will not fail due to the masked value.

set_jds(val1, val2)[source]#

Set internal jd1 and jd2 from val1 and val2. Must be provided by derived classes.

to_value(parent=None, out_subfmt=None)[source]#

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:
parentobject

Parent Time object associated with this TimeFormat object

out_subfmtpython:str or python: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