diff --git a/documentation/FirewireWinDoc.html b/documentation/FirewireWinDoc.html index 30a4bf2..19b5f9f 100755 --- a/documentation/FirewireWinDoc.html +++ b/documentation/FirewireWinDoc.html @@ -8,7 +8,7 @@
- This is a driver for Firewire (IEEE 1394) cameras that follow the - IIDC/DCAM specification. - This industry standard allows a single driver to control cameras from any manufacturer, using any of - the supported video formats and features. - It inherits from ADDriver and implements many of the parameters in ADStdDriverParams.h. - It also implements a number of parameters that are specific to the Firewire cameras.
+ This is a driver for Firewire (IEEE 1394) cameras that follow the + IIDC/DCAM specification. This industry standard allows a single driver to + control cameras from any manufacturer, using any of the supported video formats + and features. It inherits from ADDriver and implements many of the parameters in + ADStdDriverParams.h. It also implements a number of parameters that are specific + to the Firewire cameras.- This driver runs only on Windows. It uses the - Carnegie Mellon 1394 camera driver and library. There is also an - areaDetector Firewire driver for Linux available from the - - Diamond Light Source. + This driver runs only on Windows. It uses the + Carnegie Mellon 1394 camera driver and library. There is also an areaDetector + Firewire driver for Linux available from the + Diamond Light Source.
-The IIDC/DCAM specification defines standard ways that manufacturers must implement features like shutter time, - white balance, frame sizes, frame rates, etc. There is a standard way to determine whether or not a particular - camera supports a particular feature. If it does then there is a standard way of querying the allowed - range of values for that feature. This makes it quite easy to write a driver that can support +
+ The IIDC/DCAM specification defines standard ways that manufacturers must implement + features like shutter time, white balance, frame sizes, frame rates, etc. There + is a standard way to determine whether or not a particular camera supports a particular + feature. If it does then there is a standard way of querying the allowed range of + values for that feature. This makes it quite easy to write a driver that can support cameras with any capabilities from any manufacturer.
The DCAM specification defines standard video frame sizes, color modes and frames rates. The following tables lists - these standard formats and mode. Video format 7 is special. It allows defining an ROI on the camera to read out. - The pixel resolution with which the size and position of this ROI can be defined can be queried, and is not - necessarily a single pixel. In Format 7 the frame rate settings do not apply, and the frame rate is determined - by the size of the Fireware data packets.
++ The DCAM specification defines standard video frame sizes, color modes and frames + rates. The following tables lists these standard formats and mode. Video format + 7 is special. It allows defining an ROI on the camera to read out. The pixel resolution + with which the size and position of this ROI can be defined can be queried, and + is not necessarily a single pixel. In Format 7 the frame rate settings do not apply, + and the frame rate is determined by the size of the Fireware data packets.
| Vendor-defined |
The following tables lists the standard frame rates for formats 0, 1 and 2. Note that not all frame rates are supported - by the IIDC standard for every format and mode, and even when a frame rate is supported by the standard it may not - be implemented for a particular camera. - In Format 7 the frame rate settings do not apply, and the frame rate is determined by the size of - the Fireware data packets. The areaDetector driver currently sets the Format 7 packet size to the vendor recommended - size, which typically results in the maximum possible frame rate.
-+ The following tables lists the standard frame rates for formats 0, 1 and 2. Note + that not all frame rates are supported by the IIDC standard for every format and + mode, and even when a frame rate is supported by the standard it may not be implemented + for a particular camera. In Format 7 the frame rate settings do not apply, and the + frame rate is determined by the size of the Fireware data packets. The areaDetector + driver currently sets the Format 7 packet size to the vendor recommended size, which + typically results in the maximum possible frame rate.
+| @@ -345,16 +349,18 @@ | 240 | |
The DCAM specification defines 22 standard features, which control things such as the brightness, white balance, - shutter time, etc.. For each feature the standard defines - control in both device units (12-bit integers) and absolute units (floating point). For example shutter time - may support absolute seconds, as well as device units. A feature may or may not - be supported on a particular camera. If it is supported it may or may not permit control in absolute units. - Each feature may support both manual control and automatic control (e.g. automatic gain control). - The following tables lists these standard features.
-+ The DCAM specification defines 22 standard features, which control things such as + the brightness, white balance, shutter time, etc.. For each feature the standard + defines control in both device units (12-bit integers) and absolute units (floating + point). For example shutter time may support absolute seconds, as well as device + units. A feature may or may not be supported on a particular camera. If it is supported + it may or may not permit control in absolute units. Each feature may support both + manual control and automatic control (e.g. automatic gain control). The following + tables lists these standard features.
+| @@ -544,13 +550,13 @@ | QUALITY | ||
- The firewireWinDCAM driver implements the following parameters in addition to those in ADStdDriverParams.h.
- Note that to reduce the width of this table the enum names have been split into
- 2 lines, but these are just a single name, for example mar345ScanSize.
+ The firewireWinDCAM driver implements the following parameters in addition to those
+ in ADStdDriverParams.h. Note that to reduce the width of this table the enum names
+ have been split into 2 lines, but these are just a single name, for example
+ mar345ScanSize.
| - Video format parameters. In firewireDCAM.template and firewireVideoModes.template. | + Video format parameters. In firewireDCAM.template and firewireVideoModes.template.||||||
| @@ -587,17 +593,20 @@ | r/w | - The video format. The allowed choices are 0="VGA", 1="Super VGA 1", 2="Super VGA 2", 6="Still image", 7="User-defined". - The FDC_has_format and FDC_valid_format parameters described below indicate whether a particular format is actually supported - by the camera. | + The video format. The allowed choices are 0="VGA", 1="Super VGA 1", 2="Super VGA + 2", 6="Still image", 7="User-defined". The FDC_has_format and FDC_valid_format parameters + described below indicate whether a particular format is actually supported by the + camera.FDC_FORMAT |
$(P)$(R)FORMAT $(P)$(R)FORMAT_RBV |
- mbbo - mbbi |
+ mbbo
+ |
| @@ -612,9 +621,10 @@ | FDC_HAS_FORMAT | - $(P)$(R)HAS_FORMAT_$(N) (N=0-7) | + $(P)$(R)HAS_FORMAT_$(N) (N=0-7)- bi | + bi +|||
| @@ -625,13 +635,15 @@ | r/o | - A string describing each of the formats (0-7) supported by the camera. The string is "N.A." if the format is not supported. | + A string describing each of the formats (0-7) supported by the camera. The string + is "N.A." if the format is not supported.FDC_VALID_FORMAT | - $(P)$(R)VALID_FORMAT_$(N) (N=0-7) | + $(P)$(R)VALID_FORMAT_$(N) (N=0-7)- stringin | + stringin +|
| @@ -648,11 +660,12 @@ | $(P)$(R)CURRENT_FORMAT | - stringin | + stringin +||||
| - Video mode parameters. In firewireDCAM.template and firewireVideoModes.template. | + Video mode parameters. In firewireDCAM.template and firewireVideoModes.template.||||||
| @@ -663,8 +676,8 @@ | r/w | - The video mode. The allowed choices are 0-7. - The FDC_has_mode and FDC_valid_mode parameters described below indicate whether a particular mode is actually supported + The video mode. The allowed choices are 0-7. The FDC_has_mode and FDC_valid_mode + parameters described below indicate whether a particular mode is actually supported by the camera in the currently selected video format. | FDC_MODE | @@ -672,8 +685,10 @@ $(P)$(R)MODE
- mbbo - mbbi |
+ mbbo
+ ||
| @@ -684,13 +699,15 @@ | r/o | - A flag indicating whether a particular mode (0-7) is supported by the camera in the currently selected format. | + A flag indicating whether a particular mode (0-7) is supported by the camera in + the currently selected format.FDC_HAS_MODE | - $(P)$(R)HAS_MODE_$(N) (N=0-7) | + $(P)$(R)HAS_MODE_$(N) (N=0-7)- bi | + bi +|
| @@ -701,14 +718,16 @@ | r/o | - A string describing each of the modes (0-7) supported by the camera in the currently selected video format. - The string is "N.A." if the mode is not supported in this format. | + A string describing each of the modes (0-7) supported by the camera in the currently + selected video format. The string is "N.A." if the mode is not supported in this + format.FDC_VALID_MODE | - $(P)$(R)VALID_MODE_$(N) (N=0-7) | + $(P)$(R)VALID_MODE_$(N) (N=0-7)- stringin | + stringin +|
| @@ -725,12 +744,13 @@ | $(P)$(R)CURRENT_MODE | - stringin | + stringin +||||
| - Video frame rate parameters. These parameters do not apply when the video format=7. - In firewireDCAM.template and firewireVideoModes.template. | + Video frame rate parameters. These parameters do not apply when the video format=7. + In firewireDCAM.template and firewireVideoModes.template.||||||
| @@ -741,17 +761,20 @@ | r/w | - The frame rate in frames/second. The allowed choices are 0="1.875", 1="3.75", 2="7.5", 3="15", 4="30", 5="60", 6="120", 7="240". - FDC_has_framerate and FDC_valid_framerate parameters described below indicate whether a particular frame rate is actually supported - by the camera in the currently selected video format and mode. | + The frame rate in frames/second. The allowed choices are 0="1.875", 1="3.75", 2="7.5", + 3="15", 4="30", 5="60", 6="120", 7="240". FDC_has_framerate and FDC_valid_framerate + parameters described below indicate whether a particular frame rate is actually + supported by the camera in the currently selected video format and mode.FDC_FRAMERATE |
$(P)$(R)FR $(P)$(R)FR_RBV |
- mbbo - mbbi |
+ mbbo
+ |
| @@ -762,13 +785,15 @@ | r/o | - A flag indicating whether a particular frame rate (0-7) is supported by the camera in the currently selected video format and mode. | + A flag indicating whether a particular frame rate (0-7) is supported by the camera + in the currently selected video format and mode.FDC_HAS_FRAMERATE | - $(P)$(R)HAS_RATE_$(N) (N=0-7) | + $(P)$(R)HAS_RATE_$(N) (N=0-7)- bi | + bi +|
| @@ -779,14 +804,16 @@ | r/o | - A string describing each of the frame rates (0-7) supported by the camera in the currently selected video format and mode. - The string is "N.A." if the frame rate is not supported in this format and mode. | + A string describing each of the frame rates (0-7) supported by the camera in the + currently selected video format and mode. The string is "N.A." if the frame rate + is not supported in this format and mode.FDC_VALID_FRAMERATE | - $(P)$(R)VALID_RATE_$(N) (N=0-7) | + $(P)$(R)VALID_RATE_$(N) (N=0-7)- stringin | + stringin +|
| @@ -803,12 +830,13 @@ | $(P)$(R)CURRENT_RATE | - stringin | + stringin +||||
| - Video color code parameters. These parameters only apply when the video format=7. - In firewireDCAM.template and firewireColorCodes.template. | + Video color code parameters. These parameters only apply when the video format=7. + In firewireDCAM.template and firewireColorCodes.template.||||||
| @@ -819,17 +847,19 @@ | r/w | - The color code. The allowed choices are 0-10. - FDC_has_colorcode and FDC_valid_colorcode parameters described below indicate whether a particular color code is actually supported - by the camera in the currently selected video format (7) and mode. | + The color code. The allowed choices are 0-10. FDC_has_colorcode and FDC_valid_colorcode + parameters described below indicate whether a particular color code is actually + supported by the camera in the currently selected video format (7) and mode.FDC_COLORCODE |
$(P)$(R)COLORCODE $(P)$(R)COLORCODE_RBV |
- mbbo - mbbi |
+ mbbo
+ |
| @@ -840,13 +870,15 @@ | r/o | - A flag indicating whether a particular color code (0-10) is supported by the camera in the currently selected video format (7) and mode. | + A flag indicating whether a particular color code (0-10) is supported by the camera + in the currently selected video format (7) and mode.FDC_HAS_COLORCODE | - $(P)$(R)HAS_COLORCODE_$(N) (N=0-10) | + $(P)$(R)HAS_COLORCODE_$(N) (N=0-10)- bi | + bi +|
| @@ -857,14 +889,16 @@ | r/o | - A string describing each of the color codes (0-10) supported by the camera in the currently selected video format (7) and mode. - The string is "N.A." if the color code is not supported in this format and mode. | + A string describing each of the color codes (0-10) supported by the camera in the + currently selected video format (7) and mode. The string is "N.A." if the color + code is not supported in this format and mode.FDC_VALID_COLORCODE | - $(P)$(R)VALID_COLORCODE_$(N) (N=0-10) | + $(P)$(R)VALID_COLORCODE_$(N) (N=0-10)- stringin | + stringin +|
| @@ -881,11 +915,13 @@ | $(P)$(R)CURRENT_COLORCODE | - stringin | + stringin +||||
| - Video feature parameters. These parameters apply to each of the 22 DCAM features listed above. In firewireFeature.template. | + Video feature parameters. These parameters apply to each of the 22 DCAM features + listed above. In firewireFeature.template.||||||
|
@@ -903,8 +939,10 @@
$(P)$(R)$(FEATURE) $(P)$(R)$(FEATURE)_RBV |
- ao - ai |
+ ao
+ |||||
|
@@ -922,8 +960,10 @@
$(P)$(R)$(FEATURE)_ABS $(P)$(R)$(FEATURE)_ABS_RBV |
- ao - ai |
+ ao
+ |||||
| @@ -940,7 +980,8 @@ | $(P)$(R)$(FEATURE)_AVL | - bi | + bi +||||
| @@ -957,7 +998,8 @@ | $(P)$(R)$(FEATURE)_ABS_AVL | - bi | + bi +||||
|
@@ -975,8 +1017,10 @@
$(P)$(R)$(FEATURE)_CTRL $(P)$(R)$(FEATURE)_CTRL_RBV |
- bo - bi |
+ bo
+ |||||
| @@ -987,14 +1031,15 @@ | r/o | - The minimum allowed value of the feature in device units. The database copies this value to the LOPR and DRVL fields - of the $(P)$(R)$(FEATURE) record. | + The minimum allowed value of the feature in device units. The database copies this + value to the LOPR and DRVL fields of the $(P)$(R)$(FEATURE) record.FDC_FEAT_VAL_MIN | $(P)$(R)$(FEATURE)_MIN | - ai | + ai +|
| @@ -1005,14 +1050,15 @@ | r/o | - The maximum allowed value of the feature in device units. The database copies this value to the HOPR and DRVH fields - of the $(P)$(R)$(FEATURE) record. | + The maximum allowed value of the feature in device units. The database copies this + value to the HOPR and DRVH fields of the $(P)$(R)$(FEATURE) record.FDC_FEAT_VAL_MAX | $(P)$(R)$(FEATURE)_MAX | - ai | + ai +|
| @@ -1023,14 +1069,15 @@ | r/o | - The minimum allowed value of the feature in absolute units. The database copies this value to the LOPR and DRVL fields - of the $(P)$(R)$(FEATURE)_ABS record. | + The minimum allowed value of the feature in absolute units. The database copies + this value to the LOPR and DRVL fields of the $(P)$(R)$(FEATURE)_ABS record.FDC_FEAT_VAL_ABS_MIN | $(P)$(R)$(FEATURE)_ABS_MIN | - ai | + ai +|
| @@ -1041,14 +1088,15 @@ | r/o | - The maximum allowed value of the feature in absolute units. The database copies this value to the HOPR and DRVH fields - of the $(P)$(R)$(FEATURE)_ABS record. | + The maximum allowed value of the feature in absolute units. The database copies + this value to the HOPR and DRVH fields of the $(P)$(R)$(FEATURE)_ABS record.FDC_FEAT_VAL_ABS_MAX | $(P)$(R)$(FEATURE)_ABS_MAX | - ai | + ai +|
mar345PortdrvAsynIPPortConfig(),
+ The name of the asyn TCP/IP port to communicate with mar345dtb. This must have been
+ previously created with drvAsynIPPortConfig(),
The following show the MEDM screens that are used to control the Firewire detectors. Note that the general purpose screen ADBase.adl can be used, but it exposes some - controls that are not applicable to Firewire cameras, and lacks many fields that are important - for such cameras.
+ controls that are not applicable to Firewire cameras, and lacks many fields that + are important for such cameras.
- FirewireFeatures.adl is the screen used to control the features of Firewire cameras.
+ FirewireFeatures.adl is the screen used to control the features of
+ Firewire cameras.

- FirewireVideoFormats.adl is the screen used to control the video formats and modes of Firewire cameras.
- This is a screen shot when the camera is not in Format 7.
+ FirewireVideoFormats.adl is the screen used to control the video formats
+ and modes of Firewire cameras. This is a screen shot when the camera is not in Format
+ 7.

- FirewireVideoFormats.adl is the screen used to control the video formats and modes of Firewire cameras.
- This is a screen shot when the camera is in Format 7, in which case the video rate menu is not displayed.
+ FirewireVideoFormats.adl is the screen used to control the video formats
+ and modes of Firewire cameras. This is a screen shot when the camera is in Format
+ 7, in which case the video rate menu is not displayed.

- The mar345 is definitely not a fast detector! - The following measurements show the time to perform various erase and scan operations. Note that because the - mar345 file format is compressed the file sizes are typically much less than the image sizes listed.
+ The mar345 is definitely not a fast detector! The following measurements show the + time to perform various erase and scan operations. Note that because the mar345 + file format is compressed the file sizes are typically much less than the image + sizes listed.| 82.7 | +|||||||||||
180 mm
@@ -1457,8 +1504,8 @@ create_monitor_set("auto_settings.req", 30,"P=13MAR345_1:,D=cam1:")
The following are some current restrictions of the mar345 driver:
| |||||||||||
| $(P)$(R)DetectorState_RBV | - mar345 replaces the state strings with the following: Exposing, Scanning, Erasing, Changing Mode, - Aborting, Error, and Waiting. + mar345 replaces the state strings with the following: Exposing, Scanning, Erasing, + Changing Mode, Aborting, Error, and Waiting. | r/w | - The detector diameter to read out. Choices are 180mm, 240mm, 300mm, and 345mm. | + The detector diameter to read out. Choices are 180mm, 240mm, 300mm, and 345mm.MAR_SIZE |
$(P)$(R)ScanSize $(P)$(R)ScanSize_RBV |
- mbbo - mbbi |
+ mbbo
+ |||||
| @@ -213,15 +219,17 @@ | r/w | - The pixel size to use when reading the detector out. Choices are 0.10 and 0.15mm. | + The pixel size to use when reading the detector out. Choices are 0.10 and 0.15mm.MAR_RESOLUTION |
$(P)$(R)ScanResolution $(P)$(R)ScanResolution_RBV |
- mbbo - mbbi |
+ mbbo
+ ||||||
| @@ -232,19 +240,21 @@ | r/w | - Writing 1 to this parameter causes the ScanSize and ScanResolution values to be sent to - the server, changing the scan mode. This is not strictly necessary, because the size and resolution - is also encoded in the file extension used in the scan command. However, changing the mode before - doing a scan reduces the time for the scan, because the detector is already configured for - the correct mode. | + Writing 1 to this parameter causes the ScanSize and ScanResolution values to be + sent to the server, changing the scan mode. This is not strictly necessary, because + the size and resolution is also encoded in the file extension used in the scan command. + However, changing the mode before doing a scan reduces the time for the scan, because + the detector is already configured for the correct mode.MAR_CHANGE_MODE |
$(P)$(R)ChangeMode $(P)$(R)ChangedMode_RBV |
- busy - bi |
+ busy
+ ||||||
| @@ -259,16 +269,18 @@ | r/w | - Controls whether an erase cycle should be automatically performed during acquisition. Choices are - None, Before expose, and After scan. | + Controls whether an erase cycle should be automatically performed during acquisition. + Choices are None, Before expose, and After scan.MAR_ERASE_MODE |
$(P)$(R)EraseMode $(P)$(R)EraseMode_RBV |
- mbbo - mbbi |
+ mbbo
+ ||||||
| @@ -279,16 +291,19 @@ | r/w | - The number of erase cycles to perform each time the detector is erased, either because the mar345Erase - parameter is set to 1, or because of an automatic erase as part of an acquisition. | + The number of erase cycles to perform each time the detector is erased, either because + the mar345Erase parameter is set to 1, or because of an automatic erase as part + of an acquisition.MAR_NUM_ERASE |
$(P)$(R)NumErase $(P)$(R)NumErase_RBV |
- longout - longin |
+ longout
+ ||||||
| @@ -299,16 +314,18 @@ | r/w | - Write 1 to this parameter to initiate erasing the detector. The detector will be erased - multiple times if mar345NumErase is greater than 1. | + Write 1 to this parameter to initiate erasing the detector. The detector will be + erased multiple times if mar345NumErase is greater than 1.MAR_ERASE |
$(P)$(R)Erase $(P)$(R)Erase_RBV |
- busy - bi |
+ busy
+ ||||||
| @@ -323,18 +340,19 @@ | r/w | - Writing 1 to this parameter aborts the current operation as soon as possible and returns the driver - to the idle state. Note however that - commands to the mar345 server cannot be aborted, so the driver must wait for - the current command to complete. | + Writing 1 to this parameter aborts the current operation as soon as possible and + returns the driver to the idle state. Note however that commands to the mar345 server + cannot be aborted, so the driver must wait for the current command to complete.MAR_ABORT |
$(P)$(R)Abort $(P)$(R)Abort_RBV |
- bo - bi |
+ bo
+ ||||||
| @@ -403,8 +421,8 @@ mar345Config(const char *portName, const char *mar345Port, |
mar345Port |
- The name of the asyn TCP/IP port to communicate with mar345dtb. This
- must have been previously created with drvAsynIPPortConfig(),
+ The name of the asyn TCP/IP port to communicate with mar345dtb. This must have been
+ previously created with drvAsynIPPortConfig(),
|
|||||||||