From 73593db39eebeb98b8bef4b57ec35b87303c8c4d Mon Sep 17 00:00:00 2001 From: hammonds Date: Thu, 12 Aug 2010 16:47:46 +0000 Subject: [PATCH] Add documentation for new image types. git-svn-id: https://subversion.xor.aps.anl.gov/synApps/areaDetector/trunk@11319 dc6c5ff5-0b8b-c028-a01f-ffb33f00fc8b --- documentation/simDetectorDoc.html | 243 +++++++++++++++++++++++++++--- 1 file changed, 221 insertions(+), 22 deletions(-) diff --git a/documentation/simDetectorDoc.html b/documentation/simDetectorDoc.html index b3baed3..517ad7c 100755 --- a/documentation/simDetectorDoc.html +++ b/documentation/simDetectorDoc.html @@ -24,6 +24,13 @@
  • 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. +
    +
  • Configuration
  • MEDM screens
  • Image viewers
    • @@ -184,28 +191,220 @@ longout
    longin + + + SimImageType + + asynInt32 + + r/w + + Set the image type to be displayed. Options are:
    + + + + SIM_IMAGE_TYPE + + $(P)$(R)ImageType
    + $(P)$(R)ImageType_RBV + + longout
    + longin + + + Parameters for Peak Array + + + + SimPeaksStartX + + asynInt32 + + r/w + + X location of the first peak centroid + + SIM_PEAK_START_X + + $(P)$(R)PeakStartX
    + $(P)$(R)PeakStartX_RBV + + longout
    + longin + + + + SimPeaksStartY + + asynInt32 + + r/w + + Y location of the first peak centroid + + SIM_PEAK_START_Y + + $(P)$(R)PeakStartY
    + $(P)$(R)PeakStartY_RBV + + longout
    + longin + + + + SimPeaksWidthX + + asynInt32 + + r/w + + X width of the peaks + + SIM_PEAK_WIDTH_X + + $(P)$(R)PeakWidthX
    + $(P)$(R)PeakWidthX_RBV + + longout
    + longin + + + + SimPeaksWidthY + + asynInt32 + + r/w + + Y width of the peaks + + SIM_PEAK_WIDTH_Y + + $(P)$(R)PeakWidthY
    + $(P)$(R)PeakWidthY_RBV + + longout
    + longin + + + + SimPeaksNumX + + asynInt32 + + r/w + + Number of peaks in X direction + + SIM_PEAK_NUM_X + + $(P)$(R)PeakNumX
    + $(P)$(R)PeakNumX_RBV + + longout
    + longin + + + + SimPeaksNumY + + asynInt32 + + r/w + + Number of peaks in Y direction + + SIM_PEAK_NUM_Y + + $(P)$(R)PeakNumY
    + $(P)$(R)PeakNumY_RBV + + longout
    + longin + + + + SimPeaksStepX + + asynInt32 + + r/w + + X step between peaks + + SIM_PEAK_STEP_X + + $(P)$(R)PeakStepX
    + $(P)$(R)PeakStepX_RBV + + longout
    + longin + + + + SimPeaksStepY + + asynInt32 + + r/w + + Y location of the first peak centroid + + SIM_PEAK_STEP_Y + + $(P)$(R)PeakStepY
    + $(P)$(R)PeakStepY_RBV + + longout
    + longin + + -

    - 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.

    + +

    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. +

    +

    + Some random behavior and RGB implementation will be added later. +

    +

    Array of Rings

    +

    + An array of Rings will be added later. +

    + +

    Unsupported standard driver parameters