Correlation reset and readout timing configuration container. More...

#include <correlation.h>

Classes
struct	ResetDuration
	Duration of correlation reset for synapses (+3 ppu clock cycles). More...

struct	ResetFallTime
	Wait time in PPU clock cycles after disabling the correlation column reset enable. More...

struct	SenseDelay
	Wait time in PPU clock cycles between connecting the outputs of a synapse to the CADC inputs and starting the CADC read. More...

Public Types
typedef halco::hicann_dls::vx::CommonCorrelationConfigOnDLS	coordinate_type

typedef std::true_type	is_leaf_node

typedef halco::common::typed_array< halco::hicann_dls::vx::CapMemBlockOnHemisphere, halco::hicann_dls::vx::CapMemBlockOnHemisphere >	RampOffsets
	Define the source of the CADC ramp offset voltages. More...

enum class	ResetMode : uint_fast8_t { normal = 0b0 , auto_calibrating = 0b1 }
	Switch between normal and auto-calibrating correlation reset. More...

Public Member Functions
	CommonCorrelationConfig () SYMBOL_VISIBLE
	Default constructor. More...

template<typename WordT >
void	decode (std::array< WordT, config_size_in_words > const &data) SYMBOL_VISIBLE

template<typename WordT >
std::array< WordT, config_size_in_words >	encode () const SYMBOL_VISIBLE

ResetDuration	get_reset_duration () const SYMBOL_VISIBLE
	Duration of correlation reset for synapses (+3 ppu clock cycles). More...

ResetFallTime	get_reset_fall_time () const SYMBOL_VISIBLE
	Wait time in PPU clock cycles after disabling the correlation column reset enable. More...

ResetMode	get_reset_mode () const SYMBOL_VISIBLE
	Reset mode for correlation storage capacitors. More...

SenseDelay	get_sense_delay () const SYMBOL_VISIBLE
	Wait time in PPU clock cycles between connecting the outputs of a synapse to the CADC inputs and starting the CADC read. More...

bool	operator!= (CommonCorrelationConfig const &other) const SYMBOL_VISIBLE

bool	operator== (CommonCorrelationConfig const &other) const SYMBOL_VISIBLE

	return_value_policy (reference)) RampOffsets const &get_cadc_v_offset_assignment() const SYMBOL_VISIBLE

void	set_cadc_v_offset_assignment (RampOffsets const &value) SYMBOL_VISIBLE

void	set_reset_duration (ResetDuration value) SYMBOL_VISIBLE

void	set_reset_fall_time (ResetFallTime value) SYMBOL_VISIBLE

void	set_reset_mode (ResetMode value) SYMBOL_VISIBLE

void	set_sense_delay (SenseDelay value) SYMBOL_VISIBLE

Static Public Member Functions
template<typename AddressT >
static std::array< AddressT, config_size_in_words >	addresses (coordinate_type const &word) SYMBOL_VISIBLE

Static Public Attributes
static constexpr size_t	config_size_in_words = 4

Friends
class	cereal::access

std::ostream &	operator<< (std::ostream &os, CommonCorrelationConfig const &config) SYMBOL_VISIBLE

Detailed Description

Correlation reset and readout timing configuration container.

Definition at line 26 of file correlation.h.

Member Typedef Documentation

◆ coordinate_type

typedef halco::hicann_dls::vx::CommonCorrelationConfigOnDLS haldls::vx::CommonCorrelationConfig::coordinate_type

Definition at line 30 of file correlation.h.

◆ is_leaf_node

typedef std::true_type haldls::vx::CommonCorrelationConfig::is_leaf_node

Definition at line 29 of file correlation.h.

◆ RampOffsets

typedef halco::common::typed_array< halco::hicann_dls::vx::CapMemBlockOnHemisphere, halco::hicann_dls::vx::CapMemBlockOnHemisphere> haldls::vx::CommonCorrelationConfig::RampOffsets

Define the source of the CADC ramp offset voltages.

Definition at line 81 of file correlation.h.

Member Enumeration Documentation

◆ ResetMode

enum haldls::vx::CommonCorrelationConfig::ResetMode : uint_fast8_t

strong

Switch between normal and auto-calibrating correlation reset.

Enumerator
normal
auto_calibrating

Definition at line 71 of file correlation.h.

Constructor & Destructor Documentation

◆ CommonCorrelationConfig()

haldls::vx::CommonCorrelationConfig::CommonCorrelationConfig ( )

Default constructor.

Member Function Documentation

◆ addresses()

template<typename AddressT >

static std::array<AddressT, config_size_in_words> haldls::vx::CommonCorrelationConfig::addresses ( coordinate_type const & word )

static

◆ decode()

template<typename WordT >

void haldls::vx::CommonCorrelationConfig::decode ( std::array< WordT, config_size_in_words > const & data )

◆ encode()

template<typename WordT >

std::array<WordT, config_size_in_words> haldls::vx::CommonCorrelationConfig::encode ( ) const

◆ get_reset_duration()

ResetDuration haldls::vx::CommonCorrelationConfig::get_reset_duration ( ) const

Duration of correlation reset for synapses (+3 ppu clock cycles).

Determines how long the measurement capacitor is connected to the reset voltage.

◆ get_reset_fall_time()

ResetFallTime haldls::vx::CommonCorrelationConfig::get_reset_fall_time ( ) const

Wait time in PPU clock cycles after disabling the correlation column reset enable.

◆ get_reset_mode()

ResetMode haldls::vx::CommonCorrelationConfig::get_reset_mode ( ) const

Reset mode for correlation storage capacitors.

Defaults to normal mode.

◆ get_sense_delay()

SenseDelay haldls::vx::CommonCorrelationConfig::get_sense_delay ( ) const

Wait time in PPU clock cycles between connecting the outputs of a synapse to the CADC inputs and starting the CADC read.

◆ operator!=()

bool haldls::vx::CommonCorrelationConfig::operator!= ( CommonCorrelationConfig const & other ) const

◆ operator==()

bool haldls::vx::CommonCorrelationConfig::operator== ( CommonCorrelationConfig const & other ) const

◆ return_value_policy()

haldls::vx::CommonCorrelationConfig::return_value_policy ( reference ) const &

◆ set_cadc_v_offset_assignment()

void haldls::vx::CommonCorrelationConfig::set_cadc_v_offset_assignment ( RampOffsets const & value )

◆ set_reset_duration()

void haldls::vx::CommonCorrelationConfig::set_reset_duration ( ResetDuration value )

◆ set_reset_fall_time()

void haldls::vx::CommonCorrelationConfig::set_reset_fall_time ( ResetFallTime value )

◆ set_reset_mode()

void haldls::vx::CommonCorrelationConfig::set_reset_mode ( ResetMode value )

◆ set_sense_delay()

void haldls::vx::CommonCorrelationConfig::set_sense_delay ( SenseDelay value )

Friends And Related Function Documentation

◆ cereal::access

friend class cereal::access

friend

Definition at line 150 of file correlation.h.

◆ operator<<

std::ostream& operator<<	(	std::ostream &	os,
		CommonCorrelationConfig const &	config
	)