Home > ISET > vcamera > opticalImage > oiSet.m

oiSet

PURPOSE ^

Set ISET optical image parameter values

SYNOPSIS ^

function oi = oiSet(oi,parm,val,varargin)

DESCRIPTION ^

 Set ISET optical image parameter values

    oi = oiSet(oi,parm,val,varargin)

 All of the parameters of an optical iamge are set through the calls to
 this routine.  

 The oi is the object; parm is the name of the parameter; val is the
 value of the parameter; varargin allows some additional parameters in
 certain cases.

 There is a corresponding oiGet routine.  Many fewer parameters are
 available for 'oiSet' than 'oiGet'. This is because many of the
 parameters derived from oiGet are derived from the few parameters
 that can be set, and sometimes the derived quantities require some
 knowledge of the optics as well.

  Examples:
    oi = oiSet(oi,'optics',optics);
    oi = oiSet(oi,'oicomputemethod','myOIcompute');
    oi = oiSet(oi,'name','myName')
    oi = oiSet(oi,'filename','test')

 User-settable oi parameters

      {'name'}
      {'type'}
      {'distance' }
      {'horizontalfieldofview'}
      {'magnification'}

      {'data'}  - Irradiance information
        {'cphotons'}   - Compressed photons; can be set one waveband at a
                         time: oi = oiSet(oi,'cphotons',data,wavelength); 
 
 N.B.: Because of the large size of the photon data (row,col,wavelength)
 and the high dynamic range, they are stored in a special compressed
 format.  They also permit the user to read and write individual
 wavelength planes. Data sent in and returned are always in double()
 format.

 When you write to 'photons', the compression fields used by cphotons are
 cleared. When reading and writing a waveband in compressed mode, it is
 assumed that the compression fields already exist.  We do not compress
 each individual waveband, though this would be possible (i.e., to have an
 array of min/max values for each waveband).

 After writing to the photons field, the illuminance and mean illuminance
 fields are set to empty.

 Wavelength information
      {'spectrum'}            - Spectrum structure
        {'wavelength'}        - Wavelength samples

 Custom computations
        {'customcompute'}     - 1/0 Whether to use custom method
        {'oicomputemethod'}   - Name of custom method

 Optics 
      {'optics'}  - optics structure

 Diffuser
      {'diffuserMethod'} - 'blur' or 'skip'  Always Gaussian blur (LPF)
      {'diffuserBlur'}   - FWHM blur amount (meters)

 Auxiliary
      {'consistency'}

 Private variables used by ISET but not normally set by the user

   Used for management of compressed photons
      {'datamin'}
      {'datamax'}
      {'bitdepth'}

   Used to cache optical image illuminance
      {'illuminance'}
      {'meanilluminance'}

 Copyright ImagEval Consultants, LLC, 2003.

CROSS-REFERENCE INFORMATION ^

This function calls: This function is called by:
Generated on Sun 14-Jan-2007 10:24:23 by m2html © 2003