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:
- val1
numpy
ndarray
,python:list
, number,python:str
, orbytes
Values to initialize the time or times. Bytes are decoded as ascii.
- val2
numpy
ndarray
,python:list
, or number; optional Value(s) to initialize the time or times. Only used for numerical input, to help preserve precision.
- scale
python:str
Time scale of input value(s)
- precision
python:int
Precision for seconds as floating point
- in_subfmt
python:str
Select subformat for inputting string times
- out_subfmt
python:str
Select subformat for outputting string times
- from_jdbool
If true then val1, val2 are jd1, jd2
- val1
Attributes Summary
Return the cache associated with this instance.
Time scale
Methods Summary
mask_if_needed
(value)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
- cache¶
Return the cache associated with this instance.
- in_subfmt¶
- jd1¶
- jd2¶
- jd2_filled¶
- mask¶
- masked¶
- out_subfmt¶
- precision¶
- scale¶
Time scale
- subfmts = ()¶
- value¶
Methods Documentation
- 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 thevalue
property to compute the output. This is done by temporarily settingself.out_subfmt
and callingself.value
. This is required for legacy Format subclasses prior to astropy 4.0 New code should instead implement the value functionality into_value()
and then make thevalue
property be a simple call toself.to_value()
.- Parameters:
- parent
object
Parent
Time
object associated with thisTimeFormat
object- out_subfmt
python:str
orpython:None
Output subformt (use existing self.out_subfmt if
None
)
- parent
- Returns:
- value
numpy.array
,numpy.ma.array
Array or masked array of formatted time representation values
- value