differential_entropy_sp.m

Back to Stowell-Plumbley estimator

matlab/+tim/

% DIFFERENTIAL_ENTROPY_SP
% A differential entropy estimate from samples
% using Stowell-Plumbley recursive partition estimator.
%
% H = differential_entropy_sp(S)
%
% where
%
% S is a signal set.
%
% Type 'help tim' for documentation.

% Description: Differential entropy estimation
% Detail: Stowell-Plumbley recursive partition estimator
% Documentation: differential_entropy_sp.txt

function H = differential_entropy_sp(S)

import([tim_package, '.*']);

concept_check(nargin, 'inputs', 1);
concept_check(nargout, 'outputs', 0 : 1);

if isnumeric(S)
    S = {S};
end

pastelmatlab.concept_check(...
    S, tim_package('signal_set'));

if (size(S{1}, 1) > 3)
    warning('tim:inaccurate', ...
        'This estimator is inaccurate for dimensions > 3!');
end

H = tim_matlab('differential_entropy_sp', S);