Home > mpt > @mptctrl > modify.m

modify

PURPOSE ^

MODIFY Modifies an MPTCTRL object

SYNOPSIS ^

function [ctrl,Idx_orig] = modify(ctrl, action, indices, Options)

DESCRIPTION ^

MODIFY Modifies an MPTCTRL object

   [ctrl,Idx_orig] = modify(ctrl, action, indices)
   [ctrl,Idx_orig] = modify(ctrl, action, Options)
   [ctrl,Idx_orig] = modify(ctrl, action, indices, Options)

 ---------------------------------------------------------------------------
 DESCRIPTION
 ---------------------------------------------------------------------------
 Modifies a given MPTCTRL object by either removing and adding regions.

 ---------------------------------------------------------------------------
 INPUT
 ---------------------------------------------------------------------------
 ctrl        - explicit controller (an MPTCTRL object)
 action      - what to do:
                 'remove'     - remove selected regions
                 'pick'       - pick a subset of regions
                 'removeflat' - remove flat regions
 indices     - indices of regions to remove/pick
 Options     - additional options structure
   .r_small  - maximal chebychev ball size for detection of a flat region 
               (default: mptOptions.rel_tol)
   .bbox     - minimal bounding box size for detection of a flat region
               (default: mptOptions.rel_tol)

 ---------------------------------------------------------------------------
 OUTPUT                                                                                                    
 ---------------------------------------------------------------------------

 ctrl      - updated MPTCTRL object with given regions removed
 Idx_orig  - corresponding region number in the original partition ctrl

CROSS-REFERENCE INFORMATION ^

This function calls: This function is called by:
Generated on Thu 30-Mar-2006 10:26:47 by m2html © 2003