sensorGet

Get data from ISET image sensor array 

     val = sensorGet(ISA,param,varargin)

  The (very long) sensor parameter list is described below.  The image
  sensory array is often referred to as ISA, or sensor in the code.  The
  sensor array includes a pixel data structure, and this structure has its
  own accessor functions.  The pixel optics depend on microlens
  structures, and there is a separate microlens analysis toolkit.
       
 A '*' indicates a routine that can return different spatial units.

 Examples:
    val = sensorGet(ISA,'name')
    val = sensorGet(ISA,'size','um');
    val = sensorGet(ISA,'Electrons',2);   % Second color type
    val = sensorGet(ISA,'PIXEL')

 Basic sensor array parameters
      {'name'}                 - this sensor name
      {'type'}                 - always 'ISA'
      {'row'}                  - sensor rows
      {'col'}                  - sensor columns
      {'size'}                 - (rows,cols)
      {'height'}*              - sensor height
      {'width'}*               - sensor width
      {'dimension'}*           - (height,width)
      {'spatialsupport'}*      - position of pixels.  
      {'wspatialresolution'}*  - spatial distance between pixels (width)
      {'hspatialresolution'}*  - spatial distance between pixels (height)

  Sensor optics related
      {'fov'}                  - sensor field of view
      {'chiefrayangle'}        - chief ray angle in radians at each pixel
          sensorGet(ISA,'chiefRayAngle',sourceFocaLengthMeters)
      {'chiefrayangledegrees'} - chief ray angle in degrees at each pixel
          sensorGet(ISA,'chiefRayAngleDegrees',sourceFocaLengthMeters)
      {'sensoretendue'}        - optical efficiency at each pixel
      {'microlens'}            - microlens data structure, accessed using
          mlensGet() and mlensSet (optics toolbox only)

 Sensor array electrical processing properties and outputs
      {'volts'}          - Sensor output in volts
      {'digitalvalues'}  - Sensor output in digital units
      {'electrons'}      - Sensor output in electrons
         A color plane can be returned: sensorGet(isa,'electrons',2);
      {'dvorvolts'}      - Return either dv if present, otherwise volts
      {'roi'}            - Stored region of interest
      {'roivolts'}       - Volts inside of stored region of interest
         If there is no stored region of interest, ask the user to select.
      {'roielectrons'}   - Electrons inside of stored ROI, or user selects
      {'sensordynamicrange'}
    
      {'quantization}   -  Quantization structre
        {'nbits'}                - number of bits in quantization method
        {'maxoutput'}            -
        {'quantizationlut'}
        {'quantizationmethod'}
       
 Sensor color propertes
      {'color'}
        {'filterspectra'}
        {'filternames'}
        {''infraredfilter'}
         % We sometimes put other filters, such as macular pigment, in the
         % ir slot.  

      {'filtercolornames'}
         % N.B.  The order of filter colors returned here describes their
         % position in the columns of filterspectra.  The order in
         % colororder (see below) describes their position in array.
      {'filtercolornamescellarray'}
         % N.B.  The order of filter colors returned here describes their
         % position in the columns of filterspectra.  The order in
         % colororder (see below) describes their position in array.
      {'nfilters'}
      {'spectralQE'}  - product of photodetector QE, IR and color filters
           It does not include vignetting or pixel fill factor.
      {'spectrum'}    - structure about spectral information
        {'wave'}      - wavelength samples
        {'binwidth'}  - bin size between wavelength samples
        {'nwave'}     - number of wavelength samples
      {'colorfilterarray'} - color filter array structure
      {'colororder'}       - array of letters describing mosaic (e.g.['r','g' ; 'g','b'])
      {'colorOrderString'} - the array in vector form           (e.g., ['r','g','b','g'])
      right
      {'pattern'}          - color filter array pattern
      {'cfaname'}

 Noise properties
      {'dsnusigma'}           - Dark signal nonuniformity (DSNU) parameter (mv)
      {'prnusigma'}           - Photoresponse nonuniformity (PRNU) parameter (std dev mv)
      {'fpnparameters'}       - (dsnusigma,prnusigma)
      {'dsnuimage'}           - Dark signal non uniformity (DSNU) image
      {'prnuimage',}          - Photo response non uniformity (PRNU) image
      {'columnfpn'}           - Column (offset,gain) parameters
      {'columndsnu'}          - The column offset parameters (Volts)
      {'columnprnu'}          - The column gain parameters (std dev in Volts)
      {'coloffsetfpnvector'}  - The sensor column offset data
      {'colgainfpnvector'}    - The sensor column gain data
      {'shortNoiseFlag'}      - Do not add shot noise (photon noise)
                                Useful for seeing the effect of this noise
  The pixel structure

      {'pixel'}  - pixel structure is complex; accessed using pixelGet();

  Sensor computation parameters
      {'autoexposure'}   - Auto-exposure flag (0,1)
      {'exposuretime'}   - Exposure time (sec)
      {'cds'}            - Correlated double-sampling flag
      {'pixelvignetting'}- Include pixel optical efficiency in
             sensorCompute.  
             val = 1 Means vignetting only. 
             val = 2 means microlens included. (Microlens shifting NYI).
             otherwise, skip both vignetting and microlens.
      {'sensorcompute','sensorcomputemethod'}
         % Swap in a sensorCompute routine.  If this is empty, then the
         % standard vcamera\sensor\mySensorCompute routine will be used.
      {'ngridsamples','pixelsamples','nsamplesperpixel','npixelsamplesforcomputing'}
         % Default is 1.  If not parameter is not set, we return the default.
      {'consistency','computationalconsistency'}
         % If the consistency field is not present, assume false and set it
         % false.  This checks whether the parameters and the displayed
         % image are consistent/updated.

 Copyright ImagEval Consultants, LLC, 2005.