imap_processing.hi.utils.HiConstants#

class imap_processing.hi.utils.HiConstants#

Constants for Hi instrument.

DE_CLOCK_TICK_US#

Duration of Direct Event clock tick in microseconds. This is the time resolution of the Direct Event time tags. See IMAP-Hi Algorithm Document Section 2.2.5 Annotated Direct Events for more details.

Type:: int

DE_CLOCK_TICK_S#

Duration of Direct Event clock tick in seconds. This is derived from DE_CLOCK_TICK_US.

Type:: float

HALF_CLOCK_TICK_S#

Half of the Direct Event clock tick duration in seconds. This is derived from DE_CLOCK_TICK_S.

Type:: float

TOF1_TICK_DUR#

Duration of Time-of-Flight 1 clock tick in nanoseconds.

Type:: int

TOF2_TICK_DUR#

Duration of Time-of-Flight 2 clock tick in nanoseconds.

Type:: int

TOF3_TICK_DUR#

Duration of Time-of-Flight 3 clock tick in nanoseconds.

Type:: int

TOF1_BAD_VALUES#

Tuple of values indicating TOF1 does not contain a valid time.

Type:: tuple[int]

TOF2_BAD_VALUES#

Tuple of values indicating TOF2 does not contain a valid time.

Type:: tuple[int]

TOF3_BAD_VALUES#

Tuple of values indicating TOF3 does not contain a valid time.

Type:: tuple[int]

STAT_FILTER_MIN_POINTINGS#

Minimum number of Pointings required for statistical filters.

Type:: int

STAT_FILTER_0_THRESHOLD_FACTOR#

Multiplier for median comparison in Statistical Filter 0. Values exceeding threshold_factor * median are culled.

Type:: float

STAT_FILTER_0_TOF_AB_LIMIT_NS#

Maximum abs(tof_ab) in nanoseconds for AB coincidences in Filter 0.

Type:: int

STAT_FILTER_1_CONSECUTIVE_SIGMA#

Sigma multiplier for consecutive interval check in Filter 1.

Type:: float

STAT_FILTER_1_EXTREME_SIGMA#

Sigma multiplier for extreme outlier check in Filter 1.

Type:: float

STAT_FILTER_1_MIN_CONSECUTIVE#

Minimum consecutive intervals above threshold in Filter 1.

Type:: int

STAT_FILTER_2_MIN_EVENTS#

Minimum events to form a pulse cluster in Filter 2.

Type:: int

STAT_FILTER_2_MAX_TIME_DELTA#

Maximum time span in seconds for events to be considered clustered in Filter 2.

Type:: float

STAT_FILTER_2_BIN_PADDING#

Number of bins to add on each side of pulse angle range in Filter 2.

Type:: int

__init__() → None#

Methods

__init__()

Attributes

`DE_CLOCK_TICK_S`
`DE_CLOCK_TICK_US`
`HALF_CLOCK_TICK_S`
`STAT_FILTER_0_THRESHOLD_FACTOR`
`STAT_FILTER_0_TOF_AB_LIMIT_NS`
`STAT_FILTER_1_CONSECUTIVE_SIGMA`
`STAT_FILTER_1_EXTREME_SIGMA`
`STAT_FILTER_1_MIN_CONSECUTIVE`
`STAT_FILTER_2_BIN_PADDING`
`STAT_FILTER_2_MAX_TIME_DELTA`
`STAT_FILTER_2_MIN_EVENTS`
`STAT_FILTER_MIN_POINTINGS`
`TOF1_BAD_VALUES`
`TOF1_TICK_DUR`
`TOF2_BAD_VALUES`
`TOF2_TICK_DUR`
`TOF3_BAD_VALUES`
`TOF3_TICK_DUR`

imap_processing.hi.utils.HiConstants#

This Page