SCETime

class stixcore.time.SCETime(*args, **kwargs)

Bases: SCETBase

SolarOrbiter Spacecraft Elapse Time (SCET) or Onboard Time (OBT).

The mission clock time is compose of a coarse time in seconds in 32bit field and fine time in 16bit field fractions of second 1s/(2**16 -1) can be represented as a single 48bit field or a float.

The top most bit is used to indicate time sync issues.

time_sync

Time synchronisation status

Type:

bool

coarse

Coarse time stamp (seconds)

Type:

int

fine

Fine time stamp fraction of seconds 1/2**31 -1

Type:

int

Examples

SCETimes can be created in a number of ways from scaler values,

>>> SCETime(123, 456)
SCETime(coarse=123, fine=456)

combinations of scalers and array-like,

>>> SCETime(123, [1,2,3,4,5])
SCETime(coarse=[123 123 123 123 123], fine=[1 2 3 4 5])

or from seconds with the understanding this are from the epoch of the start or the SCET

>>> SCETime.from_float(123.345*u.s)
SCETime(coarse=123, fine=22610)

Attributes Summary

fits
info

Methods Summary

from_btime(btime)
from_float(scet_float)	Create an SCETime from a float representation of seconds since epoch
from_string(scet_str[, sep])	Create an SCETime for a string representation e.g. '123456:789'.
max_time()	The maximum possible time value
min_time()	The minimum possible time value
to_datetime([raise_error])	Return a python datetime object.
to_string([full, sep])
to_time()

Attributes Documentation

fits

info

Methods Documentation

classmethod from_btime(btime)

classmethod from_float(scet_float)

Create an SCETime from a float representation of seconds since epoch

Parameters:

scet_float (astropy.units.Quantity) – The scet float representation

Returns:

SCETime – The SCETime object

classmethod from_string(scet_str, sep=':')

Create an SCETime for a string representation e.g. '123456:789'

Parameters:

scet_str (array_like) – Time/s in SCET string format

Returns:

SCETime – The SCETime object

static max_time()

The maximum possible time value

static min_time()

The minimum possible time value

to_datetime(raise_error=False)

Return a python datetime object.

Returns:

datetime.datetime – The corresponding UTC datetime object.

to_string(full=True, sep=':')

to_time()