Skip to content

ENABLE_HITTYPE

Flag to enable detection pattern bitmask field in sensor data.

Controls whether an 8-bit hit_type bitmask field is included in the sensor_data_t structure and all output formats (SSV/TSV/CSV/JSONL). The bitmask represents which detection channels (1-3) were active during a single cosmic ray event, enabling efficient pattern-based filtering without inspecting individual signal counts.

Default

  • v2: Enabled by default (ENABLE_HITTYPE=1) — set in platformio.ini
  • v1: Disabled by default (ENABLE_HITTYPE=0, backward compatible)

Options

  • ENABLE_HITTYPE=0: Omit hit_type field from output (v1 default, zero overhead)
  • ENABLE_HITTYPE=1: Include hit_type field in all outputs (v2 default)

Bitmask Encoding

Bit 0 (0x01): Channel 1 active
Bit 1 (0x02): Channel 2 active
Bit 2 (0x04): Channel 3 active
Bits 3-7: Reserved for future use

Examples

0x00 = No channels (no detection)
0x01 = Channel 1 only
0x03 = Channels 1+2 (dual-channel coincidence)
0x07 = All channels active (triple-channel event)

Impact

  • Binary Size: +48 bytes when enabled, 0 bytes when disabled
  • Memory: 1 byte per event (struct field)
  • Performance: <1 microsecond computation (3 bitwise operations)

Added

v1.10.3

Recommendation

Use ENABLE_HITTYPE=1 in development builds for testing pattern-based event filtering. In production, enable only if downstream tools require pattern analysis.