oursin.probes

Probers

Functions

create	Create probe objects
delete	Delete probe objects
set_angle	Set probe azimuth/elevation/spin angles in degrees
set_color	Set colors of probe objects
set_position	Set probe tip position in ml/ap/dv coordinates in um relative to the CCF (0,0,0) point
set_size	Set probe scale in mm units, by default probes are scaled to 70 um wide x 20 um deep x 3840 um tall which is the size of a NP 1.0 probe.

create(probe_names)

Create probe objects

Parameters

probe_namesstring list

list of names of new probes to create

Examples

>>> urn.create(['p1'])

delete(probe_names)

Delete probe objects

Parameters

probe_namesstring list

list of names of new probes to create

Examples

>>> urn.delete(['p1'])

set_color(probe_colors)

Set colors of probe objects

Parameters

probe_colorsdict {string: string}

key is probe name, value is hex color

Examples

>>> urn.set_color({'p1':'#FFFFFF'})

set_position(probe_positions)

Set probe tip position in ml/ap/dv coordinates in um relative to the CCF (0,0,0) point

Parameters

probe_positionsdict {string: float list}

key is probe name, value is list of floats in ml/ap/dv in um

Examples

>>> urn.set_position({'p1':[500,1500,2500]})

set_angle(probe_angles)

Set probe azimuth/elevation/spin angles in degrees

Azimuth 0 = has the probe facing the AP axis, positive values rotate clockwise Elevation 0 = probe is vertical, 90 = horizontal

Parameters

probe_anglesdict {string: float list}

key is probe name, value is list of floats in az/elev/spin

Examples

>>> urn.set_angle({'p1':[-90,0,0]})

set_size(probe_size)

Set probe scale in mm units, by default probes are scaled to 70 um wide x 20 um deep x 3840 um tall which is the size of a NP 1.0 probe.

Parameters

probe_sizedict {string: float list}

key is probe name, value is list of floats for width, height, depth

Examples

>>> urn.set_size({'p1':[0.070, 3.840, 0.020]})