`km3io.online`¶

Module Contents¶

Classes¶

`SummarysliceReader`	A reader for summaryslices which are loaded as chunks given by step_size.
`OnlineReader`	Reader for online ROOT files
`Timeslices`	A simple wrapper for timeslices
`TimesliceStream`
`Timeslice`	A wrapper for a timeslice
`OnlineEvents`	A simple wrapper for online events
`OnlineEvent`	A wrapper for a online event

Functions¶

`get_rate`(value)	Return the rate in Hz from the short int value
`unpack_bits`(value, bits_template, out)	Return a boolean array for a value's bit representation.
`get_channel_flags`(value)	Returns the hrv/fifo flags for the PMT channels (hrv/fifo)
`get_number_udp_packets`(value)	Returns the number of received UDP packets (dq_status)
`get_udp_max_sequence_number`(value)	Returns the maximum sequence number of the received UDP packets (dq_status)
`has_udp_trailer`(value)	Returns the UDP Trailer flag (fifo)

Attributes¶

`TIMESLICE_FRAME_BASKET_CACHE_SIZE`
`SUMMARYSLICE_FRAME_BASKET_CACHE_SIZE`
`BASKET_CACHE_SIZE`
`BASKET_CACHE`
`MINIMAL_RATE_HZ`
`MAXIMAL_RATE_HZ`
`RATE_FACTOR`
`CHANNEL_BITS_TEMPLATE`
`BranchConfiguration`

km3io.online.TIMESLICE_FRAME_BASKET_CACHE_SIZE[source]¶

km3io.online.SUMMARYSLICE_FRAME_BASKET_CACHE_SIZE[source]¶

km3io.online.BASKET_CACHE_SIZE[source]¶

km3io.online.BASKET_CACHE[source]¶

km3io.online.MINIMAL_RATE_HZ = 2000.0[source]¶

km3io.online.MAXIMAL_RATE_HZ = 2000000.0[source]¶

km3io.online.RATE_FACTOR[source]¶

km3io.online.CHANNEL_BITS_TEMPLATE[source]¶

km3io.online.BranchConfiguration[source]¶

class km3io.online.SummarysliceReader(fobj, step_size=1000)[source]¶

A reader for summaryslices which are loaded as chunks given by step_size.

To be used as an iterator (for chunks in SummarysliceReader(…): …)

TREE_ADDR = 'KM3NET_SUMMARYSLICE/KM3NET_SUMMARYSLICE'[source]¶

km3io.online.get_rate(value)[source]¶: Return the rate in Hz from the short int value

km3io.online.unpack_bits(value, bits_template, out)[source]¶

Return a boolean array for a value’s bit representation.

This function also accepts arrays as input, the output shape will be NxM where N is the number of input values and M the length of the bits_template array, which is just a dummy array, due to the weird signature system of numba.

Parameters:

value: int or np.array(int) with shape (N,): The binary value of containing the bit information
bits_template: np.array() with shape (M,): The template for the output array, the only important is its shape

Returns:

np.array(bool) either with shape (M,) or (N, M)

km3io.online.get_channel_flags(value)[source]¶

Returns the hrv/fifo flags for the PMT channels (hrv/fifo)

Parameters:

valueint32: The integer value to be parsed.

km3io.online.get_number_udp_packets(value)[source]¶

Returns the number of received UDP packets (dq_status)

Parameters:

valueint32: The integer value to be parsed.

km3io.online.get_udp_max_sequence_number(value)[source]¶

Returns the maximum sequence number of the received UDP packets (dq_status)

Parameters:

valueint32: The integer value to be parsed.

km3io.online.has_udp_trailer(value)[source]¶

Returns the UDP Trailer flag (fifo)

Parameters:

valueint32: The integer value to be parsed.

class km3io.online.OnlineReader(filename)[source]¶

Reader for online ROOT files

property uuid[source]¶

property events[source]¶

property timeslices[source]¶

property summaryslices[source]¶

close()[source]¶

class km3io.online.Timeslices(fobj)[source]¶

A simple wrapper for timeslices

stream(stream, idx)[source]¶

class km3io.online.TimesliceStream(headers, superframes, hits_buffer)[source]¶

class km3io.online.Timeslice(header, superframe, hits_buffer, idx, stream)[source]¶

A wrapper for a timeslice

property frames[source]¶

class km3io.online.OnlineEvents(headers, snapshot_hits, triggered_hits)[source]¶: A simple wrapper for online events

class km3io.online.OnlineEvent(header, snapshot_hits, triggered_hits)[source]¶: A wrapper for a online event

km3io.online¶

Module Contents¶

Classes¶

Functions¶

Attributes¶

`km3io.online`¶