Added documentation for AlignSortingExtractor
Added some documentation for the `AlignSortingExtractor`.
It wasn't clear that `unit_peak_shifts` was a dictionary mapping the unit_id to the shift (and not a list),
and it wasn't clear also what a positive shift meant.
@@ -8,6 +8,24 @@ from ..postprocessing import get_template_extremum_channel_peak_shift
class AlignSortingExtractor(BaseSorting):
+ """
+ Class to shift a unit (generally to align the template on the peak) given
+ the shifts for each unit.
+
+ Parameters
+ ----------
+ sorting: BaseSorting
+ The sorting to align.
+ unit_peak_shifts: dict
+ Dictionary mapping the unit_id to the unit's shift (in number of samples).
+ A positive shift means the spike train is shifted back in time, while
+ a negative shift means the spike train is shifted forward.
+
+ Returns
+ -------
+ aligned_sorting: AlignSortingExtractor
+ The aligned sorting.
+ """
is_dumpable = False
