Home > ISET > vcamera > scene > sceneSet.m

sceneSet

PURPOSE ^

Set ISET scene parameter values

SYNOPSIS ^

function scene = sceneSet(scene,parm,val,varargin)

DESCRIPTION ^

Set ISET scene parameter values 

   scene = sceneSet(scene,parm,val,varargin)

  All of the parameters of a scene structure are set through the calls to
  this routine.  

  The scene 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 sceneGet routine.  Many fewer parameters are
  available for 'sceneSet' than 'sceneGet'. This is because many of the
  parameters derived from sceneGet are derived from the few parameters
  that can be set, and sometimes the derived quantities require some
  knowledge of the optics as well.

  Examples:
    scene = sceneSet(scene,'name','myScene');      % Set the scene name
    scene = sceneSet(scene,'fov',3);               % Set scene field of view to 3 deg
    oi = sceneSet(oi,'optics',optics);
    oi = sceneSet(oi,'oicomputemethod','myOIcompute');

 Scene description
      {'name'}          - An informative name describing the scene
      {'type'}          - The string 'scene'
      {'distance'}      - Object distance from the optics (meters)
      {'wangular'}      - Width (horizontal) field of view
      {'magnification'} - Always 1 for scenes. 

 Scene radiance
      {data}   - structure containing the data
        {'photons','uncompressedphotons'}
         row x col x nwave array representing the radiance photons
        {'cphotons','compressedphotons'}
         row x col x nwave array representing the radiance photons.
           Data are compressed to 16 bits over a range determined by the
           min and max levels of the data. 

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

 Scene color information
      {'spectrum'}   - structure that contains wavelength information
        {'wavelength'} - Wavelength sample values (nm)

 Some multispectral scenes have information abou the illuminant
      {'illuminant'}  - Scene illumination (watts/sr/m^2/sec/nm)

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

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

    Used to cache the scene luminance
      {'luminance'}
      {'meanluminance'}

      {'consistency'} - Display consistent with window data

 (The list of scene parameters includes aliases for the same parameter.)

 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