matfaust::proj::toeplitz Class Reference

Functor for the TOEPLITZ projector. More...

Public Member Functions
function	toeplitz (S, varargin)
Public Member Functions inherited from matfaust::proj::proj_gen
function	subsref (self, S)

Additional Inherited Members
Protected Attributes inherited from matfaust::proj::proj_gen
Property	constraint

Detailed Description

Functor for the TOEPLITZ projector.

Each diagonal of the projector output matrix is filled with a constant value which is the mean of the elements in the same diagonal of the input matrix.

Usage

    toeplitz(shape): returns a TOEPLITZ projector (functor), shape defines the size of the input matrix (e.g. [1, 10]).
    toeplitz(shape,'normalized', bool,'pos', bool): the optional parameters are set. By default both normalized and pos are false.

Parameters

'normalized',true	normalizes the projection image according to its Frobenius norm.
'normalized',false	(the default) no normalization.
'pos',true	skips the negative values (replaced by zero) of the input matrix.
'pos',false	(the default) negative values are not skipped.

Return values

proj	the toeplitz projector.

Example

>> import matfaust.proj.toeplitz
>> rng(42)
>> M = rand(5, 5)
 
M =
 
    0.3745    0.1560    0.0206    0.1834    0.6119
    0.9507    0.0581    0.9699    0.3042    0.1395
    0.7320    0.8662    0.8324    0.5248    0.2921
    0.5987    0.6011    0.2123    0.4319    0.3664
    0.1560    0.7081    0.1818    0.2912    0.4561
 
>> p = toeplitz(size(M), 3);
>> p(M)
 
ans =
 
    0.1838    0.2153    0.0878    0.0689    0.2612
    0.2477    0.1838    0.2153    0.0878    0.0689
    0.2156    0.2477    0.1838    0.2153    0.0878
    0.2789    0.2156    0.2477    0.1838    0.2153
    0.0666    0.2789    0.2156    0.2477    0.1838

Constructor & Destructor Documentation

toeplitz()

function matfaust::proj::toeplitz::toeplitz	(	S	,
		varargin
	)

---

The documentation for this class was generated from the following file:

• +proj/@toeplitz/toeplitz.m