pulse2percept.models.axon_map

This module implements several equations from [Beyeler2019].

Classes

AxonMapModel(**kwargs)

Axon map model

class pulse2percept.models.axon_map.AxonMapModel(**kwargs)

Axon map model

Implements the axon map model described in [Beyeler2019], where percepts are elongated along nerve fiber bundle trajectories of the retina.

Parameters:

• axlambda (double) – Exponential decay constant along the axon (microns).
• rho (double) – Exponential decay constant away from the axon (microns).

build(**build_params)

Build the model

Every model must have a `build method, which is meant to perform all expensive one-time calculations. You must call build before calling predict_percept.

You can override build in your own model (for a good example, see the AxonMapModel). You will want to make sure that:

• all build_params take effect,
• the flag _is_built is set,
• the method returns self.

One way to do this is to call the BaseModel’s build method from within your own model:

class MyModel(BaseModel):

def build(self, **build_params):

super(MyModel, self).build(self, **build_params) # Add your own code here…

Parameters:**build_params (Additional build parameters) – Additional build parameters passed as keyword arguments (e.g., model.build(engine='joblib')). Note that these must be listed in get_params; i.e., you can’t add any new parameters outside the constructor.

calc_bundle_tangent(xc, yc)

Calculates orientation of fiber bundle tangent at (xc,yc)

Parameters:yc (xc,) – (x,y) location of point at which to calculate bundle orientation in microns.

find_closest_axon(bundles, xret=None, yret=None)

Finds the closest axon segment for every point (xret, yret)

get_params()

Get a dictionary of all model parameters (don’t override!)

get_tissue_coords(xdva, ydva)

Converts dva to retinal coords

Parameters:ydva (xdva,) – x,y coordinates in dva Returns:xret, yret (double or array-like) – Corresponding x,y coordinates in microns

predict_percept(implant, t=None)

Predict a percept

Parameters:

• implant (ProsthesisSystem) – Stimulus can be passed via stim.
• fps (int, double) – Frames per second at which the percept should be rendered.
• n_frames (int) – If None, will simulate for the duration of the stimulus plus one frame (rounding up).