matfaust::proj::proj_id Class Reference

Functor for the ID projector. More...

Public Member Functions
function	proj_id (mat_size, 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 ID projector.

Usage

    proj_id([M, N]): returns a ID projector (functor). This identity projector returns the input matrix whatever it is. Optionally a normalization or a positivity filter can be applied.
    proj_id([M, N],'normalized', bool,'pos', bool): the optional parameters are set. By default both normalized and pos are false.

Parameters

mat_size	the size of the input matrix (eg. [M, N]).
'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

the	proj_id projector.

Example

>> import matfaust.proj.proj_id
>> 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 = proj_id(size(M), 'normalized', false);
>> p(M)
 
ans =
 
    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
 
>>

Constructor & Destructor Documentation

proj_id()

function matfaust::proj::proj_id::proj_id	(	mat_size	,
		varargin
	)

---

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

• proj_id.m