dreye.ReceptorEstimator.compute_hull#
- ReceptorEstimator.compute_hull(fraction=True, at_l1=None, metric='width', seed=None, relative=True)[source]#
Compute the hull metric. This indicates the fraction of a perfect stimulation system is covered by the registered stimulation system.
- Parameters:
- fractionbool, optional
Whether to calculate the fractional metric (relative to the perfect system) or the absolute metric. By default True.
- at_l1float, optional
Whether to calculate the metric for a specific overall capture. That is a specific L1 norm value of the hull. By default None.
- metricstr, optional
Metric used to compute. Currently the mean width is implemented (‘width’) and computing the volume of the convex hull (‘volume’). By default ‘width’.
- seedint, optional
Seed used when computing the mean width, by default None
- relativebool, optional
Whether to use relative total capture or light-induced absolute capture, by default True.
- Returns:
- metricfloat
The hull metric.