Class FlowThroughPipeline

Inheritance Relationships

Base Type

Class Documentation

class FlowThroughPipeline : public ska::pst::dsp::DspsrPipeline

The FlowThroughPipeline adapts the dsp::LoadToQuantize pipeline into a DspsrPipeline.

Public Functions

FlowThroughPipeline() = default

Construct a new Flow Through Pipeline object.

~FlowThroughPipeline() override = default

Destroy the Flow Through Pipeline object.

virtual ::dsp::LoadToQuantize *get_pipeline() override

Return the LoadToQuantize Pipeline.

inline virtual bool has_pipeline() override

Return true if the LoadToQuantize Pipeline has been constructed.

virtual void validate(const ska::pst::common::AsciiHeader &config, ska::pst::common::ValidationContext *context) override

Validate the scan configuration parameters, reporting any errors found.

Parameters
  • config – scan configuration parameters, that must contain the scan_config_keys.

  • context – A validation context where errors should be added.

virtual void configure(const ska::pst::common::AsciiHeader &config) override

Configure the pipeline.

Parameters

config – configuration passed to dsp::LoadToQuantize.

inline std::pair<int32_t, int32_t> get_channels()

The indices of the first and last (inclusive) frequency channels that define the single contiguous range of frequency channels to be recorded.

inline uint32_t get_nchan() const

Return the number of channels being selected.

inline uint32_t get_npol() const

Return the number of polarisations being selected.

inline uint32_t get_num_bits_out() const

Return the number of bits per output sample.

inline void set_scale_offset_filename(const std::string &scloffs_filename)

Set the scale offset filename in the pipeline configuration.

inline const std::map<std::string, std::string> &get_log_context() const

return mapped diagnostic context key/value pairs

Public Static Attributes

static const std::vector<uint32_t> valid_nbit_out = {1, 2, 4, 8, 16, 32}

List of valid NBIT_OUT values.

static const std::vector<std::string> valid_polarisations = {"A", "B", "Both"}

List of valid NBIT_OUT values.