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, list, number, str, or bytes

Values to initialize the time or times. Bytes are decoded as ascii.

val2numpy ndarray, list, or number; optional

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

scalestr

Time scale of input value(s)

precisionint

Precision for seconds as floating point

in_subfmtstr

Select subformat for inputting string times

out_subfmtstr

Select subformat for outputting string times

from_jdbool

If true then val1, val2 are jd1, jd2

Attributes Summary

cache

Return the cache associated with this instance.

jd1

jd2

jd2_filled

mask

masked

scale

Time scale

subfmts

value

Methods Summary

mask_if_needed(self, value)

set_jds(self, val1, val2)

Set internal jd1 and jd2 from val1 and val2.

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

mask_if_needed(self, value)[source]
set_jds(self, val1, val2)[source]

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

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