Submodule: opexebo.defaults

Default values for optional keyword arguments

Detailed Documentation

Opexebo default values

This module provides default values for all keyword arguments in the Opexebo package.

opexebo.defaults.all_methods = ('default', 'sep', 'not implemented')

Score related

opexebo.defaults.bin_angle = 15

Standard angular bin width [degree]

opexebo.defaults.bin_speed = 5

Standard speed bin, [cm/s]

opexebo.defaults.bin_width = 2.5

Standard spatial resolution, [cm]

opexebo.defaults.firing_field_min_bins = 9

Minimum number of bins for a firing field to be valid [bins]

opexebo.defaults.firing_field_min_mean = 0.1

Minimum mean firing rate for a firing field to be valid [Hz]

opexebo.defaults.firing_field_min_peak = 1

Minimum peak firing rate for a firing field to be valid [Hz]

opexebo.defaults.hd_percentile = 0.95

Percentile for head drection arc, in range [0,1]

opexebo.defaults.initial_search_threshold = 0.96

Initial relative threshold to search for local maxima, in range [0,1]

opexebo.defaults.lower_bound_speed = 2

The default lower edge of the bandpass filter used for speedscore [cm/s]

opexebo.defaults.mask_fill = 0

LFP related

opexebo.defaults.min_orientation = 15

minimum angular separation between fields in acorr considered for grid ellipse [degrees]

opexebo.defaults.power_spectrum_method = 'welch'

Default method for calculating a power spectrum

opexebo.defaults.psd_resolution_welch = 1

Default effective resolution for Welch’s method (Hz)

opexebo.defaults.psd_return_scale = 'log'

Firing field related

opexebo.defaults.search_method = 'default'

The method used to find local maxima

opexebo.defaults.search_width = 8

Search width for border coverage, see analyses.bordercoverage, [bins]

opexebo.defaults.shape = 'rectangular'

Shape of area: assume a rectangular arena

opexebo.defaults.shapes_linear = ('linear', 'line', 'l')

Smoothing

opexebo.defaults.sigma = 2.0

Standard Gaussian Standard Deviation for smoothing, [bins]

opexebo.defaults.sigma_time = 0.4

Standard Gaussian stdev for smoothing firing rat, [s]. Default at 0.4s from doi 10.1038/nature14622 .

opexebo.defaults.speed_bandwidth = 2

The default speed bandwidth for adaptive bandpassing [cm/s]

opexebo.defaults.speed_cutoff = 0

Standard speed cutoff below which to ignore positions [cm/s]

opexebo.defaults.upper_bound_speed = 15

The default upper edge of the bandpass filter if a fixed (rather than adaptive) filter is chosen [cm/s]

opexebo.defaults.upper_bound_time = 10

The default time used to calculate the upper edge of the bandpass filter [s]

opexebo.defaults.walls = 'trbl'

standard walls for border search, see analyses.bordercoverage, string