matfaust::proj::circ Class Reference

Functor for the CIRC projector. More...

Public Member Functions
function	circ (shape, 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 CIRC projector.

The output matrix of the projector is a circulant matrix.

Each constant used to fill a pair of diagonals of the output matrix is the mean of all the input matrix entries that it replaces in the output matrix.

Usage

    circ(shape): returns a CIRC projector (functor), shape defines the size of the input matrix (e.g. [1, 10]).
    circ(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

circ	projector.

Example

>> import matfaust.proj.circ
>> 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 = circ(size(M), 3);
>> p(M)
 
ans =
 
    0.1924    0.1942    0.1719    0.1643    0.2621
    0.2621    0.1924    0.1942    0.1719    0.1643
    0.1643    0.2621    0.1924    0.1942    0.1719
    0.1719    0.1643    0.2621    0.1924    0.1942
    0.1942    0.1719    0.1643    0.2621    0.1924
 
>>

Constructor & Destructor Documentation

circ()

function matfaust::proj::circ::circ	(	shape	,
		varargin
	)

---

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

• +proj/@circ/circ.m