diff --git a/documentation/simDetectorDoc.html b/documentation/simDetectorDoc.html index 4e47045..d6d2ece 100755 --- a/documentation/simDetectorDoc.html +++ b/documentation/simDetectorDoc.html @@ -10,7 +10,7 @@

areaDetector Simulation driver

- May 19, 2010

+ August 8, 2011

Mark Rivers and John Hammonds

@@ -24,13 +24,12 @@
  • Introduction
  • Simulation driver specific parameters
  • Unsupported standard driver parameters
    • -
  • Image Types -
      -
    1. Linear Ramp
      2. -
    2. Array of Peaks
      3. -
    3. Array of Rings
      4. -
    -
    • +
  • Simulation modes +
      +
    1. Linear ramp
      2. +
    2. Array of peaks
      3. +
    +
  • Configuration
  • MEDM screens
  • Image viewers
    • @@ -193,50 +192,30 @@ - SimImageType + SimMode asynInt32 r/w - Set the image type to be displayed. Options are:
    - - - - SIM_IMAGE_TYPE - - $(P)$(R)ImageType
    - $(P)$(R)ImageType_RBV - - longout
    - longin - - - - SimNoise - - asynInt32 - - r/w - - Used to introduce randomness. Each affected pixel is assigned a scaling factor.
    - scalingFactor = 1.0 + (rand()%noise +1)/100.0 + Sets the simulation mode. Options are:
    + - SIM_NOISE + SIM_MODE - $(P)$(R)Noise
    - $(P)$(R)Noise_RBV + $(P)$(R)SimMode
    + $(P)$(R)SimMode_RBV longout
    longin - Parameters for Peak Array + + Parameters for Array of Peaks Mode @@ -390,7 +369,8 @@ r/w - Used to introduce randomness. Each gaussian peak in the array is assigned a scaling factor.
    + Used to introduce randomness in the peak height. Each gaussian peak in the array + is assigned a scaling factor.
    scalingFactor = 1.0 + (rand()%peakVariation +1)/100.0 @@ -402,56 +382,75 @@ longout
    longin - + + + SimNoise + + asynInt32 + + r/w + + Used to introduce randomness. Each affected pixel is assigned a scaling factor.
    + scalingFactor = 1.0 + (rand()%noise +1)/100.0 + + + SIM_NOISE + + $(P)$(R)Noise
    + $(P)$(R)Noise_RBV + + longout
    + longin + - -

    Image Types

    -

    Linear Ramp

    -

    - For monochrome images (NDColorMode=NDColorModeMono) the simulation driver initially - sets the image[i, j] = i*SimGainX + j*SimGainY * ADGain * ADAcquireTime * 1000. - Thus the image is a linear ramp in the X and Y directions, with the gains in each - direction being detector-specific parameters. Each subsquent acquisition increments - each pixel value by ADgain*ADAcquireTime*1000. Thus if ADGain=1 and ADAcquireTime=.001 - second then the pixels are incremented by 1. If the array is an unsigned 8 or 16 - bit integer then the pixels will overflow and wrap around to 0 after some period - of time. This gives the appearance of bands that appear to move with time. The slope - of the bands and their periodicity can be adjusted by changing the gains and acquire - times. -

    -

    - For color images (NDColorMode=NDColorModeRGB1, RGB2 or RGB3) there are 3 images - computed, one each for the red, green and blue channels. Each image is computed - with the same algorithm as for the monochrome case, except each is multiplied by - its appropriate gain factor (SimGainRed, SimGainGreen, SimGainBlue). Thus if each - of these color gains is 1.0 the color image will be identical to the monochrome - image, but if the color gains are different from each other then image will have - color bands.

    -

    Array of Peaks

    -

    - For monochrome images, an array of gaussian peaks is produced. The user specifies the - start location for the first peak in PeakStartX & PeakStartY. The size of the peak is - controlled by PeakWidthX and PeakWidthY. The array is specified by giving the number of - peaks in each direction with PeakNumX and PeakNumY and the step size between peak centroids - with PeakStepX and PeakStepY. Note that data for each peak is only added to the image over a - range of four times the PeakWidth in any direction (in the interest of speed). -

    -

    - Dynamic behavior can be introduced into the system by changing PeakVariation and Noise - records. PeakVariation introduces variation on each pixel in the array and Noise introduces - variation in each pixel. -

    -

    - The description for RGB images is the same as for the Linear Ramp. Pixels are computed the same way - as for monochrome and there is a separate gain for each color. -

    -

    Array of Rings

    -

    - An array of Rings will be added later. -

    - - +

    + Simulation Modes

    +

    + Linear Ramp

    +

    + For monochrome images (NDColorMode=NDColorModeMono) the simulation driver initially + sets the image[i, j] = i*SimGainX + j*SimGainY * ADGain * ADAcquireTime * 1000. + Thus the image is a linear ramp in the X and Y directions, with the gains in each + direction being detector-specific parameters. Each subsquent acquisition increments + each pixel value by ADgain*ADAcquireTime*1000. Thus if ADGain=1 and ADAcquireTime=.001 + second then the pixels are incremented by 1. If the array is an unsigned 8 or 16 + bit integer then the pixels will overflow and wrap around to 0 after some period + of time. This gives the appearance of bands that appear to move with time. The slope + of the bands and their periodicity can be adjusted by changing the gains and acquire + times. +

    +

    + For color images (NDColorMode=NDColorModeRGB1, RGB2 or RGB3) there are 3 images + computed, one each for the red, green and blue channels. Each image is computed + with the same algorithm as for the monochrome case, except each is multiplied by + its appropriate gain factor (SimGainRed, SimGainGreen, SimGainBlue). Thus if each + of these color gains is 1.0 the color image will be identical to the monochrome + image, but if the color gains are different from each other then image will have + color bands.

    +

    + Array of Peaks

    +

    + For monochrome images, an array of gaussian peaks is produced. The user specifies + the start location for the first peak in PeakStartX & PeakStartY. The size of the + peak is controlled by PeakWidthX and PeakWidthY. The array is specified by giving + the number of peaks in each direction with PeakNumX and PeakNumY and the step size + between peak centroids with PeakStepX and PeakStepY. The amplitude of each peak + is controlled by SimGainX, SimGainY, and ADGain. If SimGainX=1, SimGainY=1, SimNoise=0, + and SimPeakHeightVariation=0 then the peak height is equal to ADGain, ADGain=255 + would be appropriate for an 8-bit image. Note that data for each peak is only added + to the image over a range of four times the PeakWidth in any direction (in the interest + of speed). +

    +

    + Dynamic behavior can be introduced into the system by changing PeakVariation and + Noise records. PeakVariation introduces variation in the height of each peak in + the array and Noise introduces variation in each pixel. +

    +

    + The description for RGB images is the same as for the Linear Ramp. Pixels are computed + the same way as for monochrome and there is a separate gain for each color. +

    Unsupported standard driver parameters