neurodec.mdt.Electrode#

class neurodec.mdt.Electrode(dictionary: dict)#

An electrode

classmethod new(location: ArrayLike, radius: float, force_computation: bool = False) → Electrode#

Create a circular electrode.

Parameters

location – NumPy array with shape (3,) containing the 3D coordinates of the electrode.
radius – Radius of the electrode.
force_computation – Boolean flag that allows to bypass a status check. Normally, the API would check if an object with the requested parameters was already present in the database. If this was the case, the API would not request its computation and would simply return its identifier. By setting this flag to True, the user can bypass this logic and force the computation of the resource even if it existed already. The main reason is to allow starting a calculation again in case of unexpected errors.

Returns

The metadata of the new electrode. If another electrode with the same parameters already exists, it will be returned instead of building a new one.

property status: Status#: Returns the up-to-date status of the object, by performing an API request.