Struct SensorLayout 

pub struct SensorLayout {
    pub name: String,
    pub contacts: Vec<SensorSite>,
}

Physical sensor array geometry layout (e.g. multi-electrode arrays, acoustic arrays).

Fields

name: String

contacts: Vec<SensorSite>

Implementations

impl SensorLayout

pub fn new(name: impl Into<String>, contacts: Vec<SensorSite>) -> Self

pub fn total_channels(&self) -> usize

pub fn active_channels(&self) -> usize

pub fn get_site(&self, channel_id: usize) -> DspResult<&SensorSite>

Site of recording channel channel_id. O(1) when sites are stored in channel order (the usual case), a scan otherwise.

pub fn get_contact(&self, channel_id: usize) -> DspResult<&SensorSite>

pub fn sites(&self) -> &[SensorSite]

pub fn select_channels(&self, channels: &[usize]) -> Self

Layout restricted to channels (recording channel ids of the parent), renumbered so that the site of channels[i] gets channel id i — the layout of a channel subset.

pub fn to_channel_arrays(&self) -> (Vec<usize>, Vec<[f32; 2]>, Vec<usize>)

Flat (channel_map, channel_positions_xy, channel_shanks) arrays as used by Phy / Kilosort and Zarr stores.

pub fn from_channel_arrays( name: impl Into<String>, channel_map: &[usize], positions: &[[f32; 2]], shanks: &[usize], ) -> Option<Self>

Reconstructs a SensorLayout from flat (channel_map, channel_positions_xy, channel_shanks) arrays (None when positions is empty). Missing channel_map or shanks entries fall back to identity (i) and shank 0.

impl SensorLayout

pub fn remap(&self, map: &ChannelMap) -> DspResult<SensorLayout>

The geometry of the channels after map (whose inputs are this layout’s channel ids): output channel i sits where input order[i] did, renamed i.

pub fn depth_order(&self) -> ChannelMap

A map that sorts the channels by shank, then depth (y, from the tip up), then x: neighbouring rows of the data become neighbouring sites.

Trait Implementations

impl Clone for SensorLayout

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SensorLayout

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SensorLayout

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for SensorLayout

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for SensorLayout

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for SensorLayout