oursin.probes

Probers

Functions

clear	Clear all custom meshes
create	Create probe objects
delete	Delete probe objects
set_angles	Set probe azimuth/elevation/spin angles in degrees
set_colors	Set colors of probe objects
set_positions	Set probe tip positions in AP/ML/DV coordinates in um relative to the zero point (front, left, top)
set_scales	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.

Classes

Probe

clear()

Clear all custom meshes

class Probe(color='FFFFFF', position=[0, 0, 0], angle=[0, 0, 0], style='line', scale=[0.07, 3.84, 0.02])

Bases: object

delete()

Delete probe objects

Parameters

references probe being deleted

Examples

>>> p1.delete()

set_color(color)

Set colors of probe objects

Parameters

colorstring

string is hex color

Examples

>>> p1.set_color('#FFFFFF')

set_position(position)

Set probe tip position in AP/ML/DV coordinates in um relative to the zero coordinate (front, top, left)

Parameters

probe_positionsvector3

value is list of floats in AP/ML/DV in um

Examples

>>> p1.set_position([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_anglesfloat list

value is list of floats in az/elev/spin

Examples

>>> p1.set_angle([-90,0,0])

set_scale(probe_scale)

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_scale: float list

list of floats for width, height, depth

Examples

>>> p1.set_scale([0.070, 3.840, 0.020])

create(num_objects)

Create probe objects

Parameters

num_objects: int

number of probe objects to be created

Examples

>>> probes = urchin.probes.create(2)

delete(probes_list)

Delete probe objects

Parameters

probes_list: list

list of probe objects to be deleted

Examples

>>> probes.delete([p1,p2])

set_colors(probes_list, colors_list)

Set colors of probe objects

Parameters

probes_list: list of probe objects

list of probe objects to be colored

colors_listlist of string hex colors

new hex colors for each probe

Examples

>>> urchin.probes.set_colors(probes,['#FFFFFF','#000000'])

set_positions(probes_list, positions_list)

Set probe tip positions in AP/ML/DV coordinates in um relative to the zero point (front, left, top)

Parameters

probes_list : list of Probe positions_list : list of vector3

tip coordinate in AP/ML/DV in um

Examples

>>> urchin.probes.set_positions(probes,[[1000,2000,1000],[2000,2000,2000]])

set_angles(probes_list, angles_list)

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

probes_listlist of probe objects

list of probes being set

probe_angleslist of list of three floats

value is list of floats in az/elev/spin

Examples

>>> urchin.probes.set_angles(probes,[[-90,0,0],[0,30,0]])

set_scales(probes_list, scales_list)

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

probes_list: list of probe objects

list of probe sizes being set

scales_list: list of list of three floats

list of floats for width, height, depth for each probe

Examples

>>> urchin.probes.set_scales(probes,[[0.070, 3.840, 0.020],[0.070, 3.840, 0.020]])