katgpucbf package

Subpackages

• katgpucbf.dsim package
  • Submodules
    • katgpucbf.dsim.descriptors module
      • create_config()
      • create_descriptors_heap()
    • katgpucbf.dsim.main module
      • async_main()
      • first_timestamp()
      • main()
      • parse_args()
    • katgpucbf.dsim.send module
      • HeapSet
      • Sender
      • make_stream()
      • make_stream_base()
    • katgpucbf.dsim.server module
      • DeviceServer
    • katgpucbf.dsim.shared_array module
      • SharedArray
    • katgpucbf.dsim.signal module
      • CHUNK_SIZE
      • CW
      • Comb
      • CombinedSignal
      • Constant
      • Delay
      • Nodither
      • Periodic
      • Random
      • Signal
      • SignalService
      • TerminalError
      • WGN
      • format_signals()
      • make_dither()
      • packbits()
      • parse_signals()
      • quantise()
      • sample()
      • saturation_counts()
  • Module contents
• katgpucbf.fgpu package
  • Submodules
    • katgpucbf.fgpu.compute module
      • Compute
      • ComputeTemplate
      • NarrowbandConfig
    • katgpucbf.fgpu.ddc module
      • DDC
      • DDCTemplate
    • katgpucbf.fgpu.delay module
      • AbstractDelayModel
      • AlignedDelayModel
      • LinearDelayModel
      • MultiDelayModel
      • NonMonotonicQueryWarning
      • wrap_angle()
    • katgpucbf.fgpu.engine module
    • katgpucbf.fgpu.main module
    • katgpucbf.fgpu.output module
      • NarrowbandOutput
      • Output
      • WidebandOutput
    • katgpucbf.fgpu.pfb module
      • PFBFIR
      • PFBFIRTemplate
    • katgpucbf.fgpu.postproc module
      • Postproc
      • PostprocTemplate
    • katgpucbf.fgpu.recv module
      • Chunk
      • Layout
      • iter_chunks()
    • katgpucbf.fgpu.send module
      • Chunk
      • Frame
      • PREAMBLE_SIZE
      • make_descriptor_heap()
      • make_streams()
  • Module contents
    • DIG_SAMPLE_BITS_VALID
• katgpucbf.fsim package
  • Submodules
    • katgpucbf.fsim.main module
      • QUEUE_DEPTH
      • Sender
      • async_main()
      • main()
      • make_heap()
      • make_heap_payload()
      • make_stream()
      • parse_args()
  • Module contents
• katgpucbf.xbgpu package
  • Submodules
    • katgpucbf.xbgpu.beamform module
      • Beamform
      • BeamformTemplate
    • katgpucbf.xbgpu.bsend module
      • BSend
      • Chunk
      • Frame
      • make_stream()
    • katgpucbf.xbgpu.correlation module
      • Correlation
      • CorrelationTemplate
      • MIN_COMPUTE_CAPABILITY
      • MISSING
      • device_filter()
    • katgpucbf.xbgpu.engine module
    • katgpucbf.xbgpu.main module
    • katgpucbf.xbgpu.output module
      • BOutput
      • Output
      • XOutput
    • katgpucbf.xbgpu.recv module
      • Layout
      • make_sensors()
      • make_stream()
      • recv_chunks()
    • katgpucbf.xbgpu.xsend module
      • Heap
      • XSend
      • make_stream()
  • Module contents

Submodules

• katgpucbf.curand_helpers module
  • RandomStateBuilder
    • RandomStateBuilder.make_states()
• katgpucbf.mapped_array module
• katgpucbf.meerkat module
  • Band
    • Band.adc_sample_rate
    • Band.centre_frequency
    • Band.long_name
• katgpucbf.monitor module
  • FileMonitor
    • FileMonitor.close()
    • FileMonitor.event_qsize()
    • FileMonitor.event_qsize_delta()
    • FileMonitor.event_state()
  • Monitor
    • Monitor.close()
    • Monitor.event_qsize()
    • Monitor.event_qsize_delta()
    • Monitor.event_state()
    • Monitor.make_queue()
    • Monitor.time()
    • Monitor.with_state()
  • NullMonitor
    • NullMonitor.event_qsize()
    • NullMonitor.event_qsize_delta()
    • NullMonitor.event_state()
    • NullMonitor.make_queue()
  • Queue
    • Queue.get()
    • Queue.get_nowait()
    • Queue.put()
    • Queue.put_nowait()
• katgpucbf.queue_item module
  • QueueItem
    • QueueItem.add_marker()
    • QueueItem.async_wait_for_events()
    • QueueItem.enqueue_wait_for_events()
    • QueueItem.events
    • QueueItem.reset()
    • QueueItem.timestamp
• katgpucbf.recv module
  • BaseLayout
    • BaseLayout.chunk_bytes
    • BaseLayout.chunk_heaps
    • BaseLayout.chunk_place()
    • BaseLayout.heap_bytes
  • Chunk
    • Chunk.device
    • Chunk.recycle()
    • Chunk.sink
    • Chunk.timestamp
  • EVICTION_MODE
  • RX_SENSOR_TIMEOUT_CHUNKS
  • RX_SENSOR_TIMEOUT_MIN
  • StatsCollector
    • StatsCollector.add_stream()
    • StatsCollector.collect()
    • StatsCollector.update()
  • add_reader()
  • make_stream()
  • make_stream_group()
• katgpucbf.ringbuffer module
  • ChunkRingbuffer
    • ChunkRingbuffer.get()
• katgpucbf.send module
  • DescriptorSender
    • DescriptorSender.halt()
    • DescriptorSender.run()
• katgpucbf.spead module
  • DEFAULT_PORT
  • DIGITISER_STATUS_SATURATION_COUNT_SHIFT
  • DIGITISER_STATUS_SATURATION_FLAG_BIT
  • FLAVOUR
  • IMMEDIATE_DTYPE
  • IMMEDIATE_FORMAT
  • make_immediate()
• katgpucbf.utils module
  • DeviceStatusSensor
    • DeviceStatusSensor.aggregate_add()
    • DeviceStatusSensor.aggregate_compute()
    • DeviceStatusSensor.aggregate_remove()
    • DeviceStatusSensor.filter_aggregate()
    • DeviceStatusSensor.update_aggregate()
  • TimeConverter
    • TimeConverter.adc_to_unix()
    • TimeConverter.unix_to_adc()
  • TimeoutSensorStatusObserver
    • TimeoutSensorStatusObserver.cancel()
  • add_gc_stats()
  • add_signal_handlers()
  • add_time_sync_sensors()
  • comma_split()
  • gaussian_dtype()
  • parse_source()
  • steady_state_timestamp_sensor()

Module contents

katgpucbf.DEFAULT_PACKET_PAYLOAD_BYTES: Final = 8192

Biggest power of 2 that fits in a jumbo MTU. A power of 2 isn’t required but it can be convenient to have packet boundaries align with the natural boundaries in the payload (for antenna-channelised-voltage output). Bigger is better to minimise the number of packets/second to process.

katgpucbf.DEFAULT_TTL: Final = 4

Default TTL for spead multicast transmission

katgpucbf.MIN_SENSOR_UPDATE_PERIOD: Final = 1.0

Minimum update period (in seconds) for katcp sensors where the underlying value may update extremely rapidly.