;+

; Project     :	SOLAR-B - EIS

;

; Name        :	EIS_CAM_readout__DEFINE

;

; Purpose     :	Generates structure EIS_CAM_readout.

;

; Explanation : When IDL encounters structure 'STRname', if structure not already defined

;               it looks for routine strname__define and compiles and calls routine to define

;               structure. NB under unix it looks for lower case flename.

;

;               This routine defines the structure :

;

;                 EIS_CAM_readout. Tags are :

;                   On_Chip_Binning          : UINT[2] X and Y flags. OCB will not be used so fixed

;                                              at [1,1]. NB If OCB used would need appropriate CSG

;                                              sequence ID and line list.

;                   CAM_CSG_flush_sequence_ID : UINT Identifies clocking sequence required to perform

;                                              flushing.

;                   CAM_CSG_readout_sequence_ID : UINT Identifies clocking sequence required to

;                                              perform CCDs read-out.

;                   Readout_nodes            : UINT[4] flags that define the CCD readout nodes.

;                                                  0 : CCDA R R/O chain enable

;                                                  1 : CCDA L R/O chain enable

;                                                  2 : CCDB R R/O chain enable

;                                                  3 : CCDB L R/O chain enable

;                                              NB This setting must match the instrument automatic

;                                              state set by the CAM command C_SET_AE.

;                   CCD_ro_node              : UINT CCD readout node in linelist header required for hunter studies.

;                   CCD_length               : UINT CCD readout register length. Only changes if

;                                              OCB used so fixed at 2148.

;                   flush_CCDs               : UINT number of times to flush CCDs before each exposure, range 0-255.

;                   addresses                : ULONG[4] Camera flare readout sequence window coordinate addresses

;                                              for the FM CAM RROM CODE for CSG ID 4. Elements are :-

;                                                  0 : X start   = 0x04002D00

;                                                  1 : Y start   = 0x04000C00

;                                                  2 : X length  = 0x04010700

;                                                  3 : Y length  = 0x04001400

;

; Use         :	<dummy = {EIS_CAM_readout>

;

; Inputs      :	None.

;

; Opt. Inputs : None.

;

; Outputs     : Sets up structure definition.

;

; Opt. Outputs:	None.

;

; Keywords    : None,

;

; Calls       : None.

;

; Common      :	None.

;

; Restrictions:	None.

;

; Side effects:	None.

;

; Category    :	EIS_CPT.

;

; Prev. Hist. :	None.

;

; Written     :	Martin Carter RAL 03/08/04

;

; Modified    :	Version 0.1, 29/09/04, MKC

;                 Removed CAM_hardware_window.

;               Version 0.2, 30/11/04, MKC

;                 Added flush_CCDS.

;               Version 0.3, 24/02/05, MKC

;                 Added ystart and yheight tags.

;               Version 0.4, 12/04/05, MKC

;                 Reversed order of readout nodes.

;                 Added special readout sequence ID and renamed other normal readout sequence ID.

;                 Changed ystart and yheight tags to addresses tag.

;               Version 0.5, 24/06/05, MKC

;                 Changed INT values to UINT.

;               Version 0.6, 08/06/11, MKC

;                 Added ccd_ro_node tag for value used in linelist which is required by hunter studies.

;

; Version     :	0.6, 08/06/11, MKC

;-

;**********************************************************



PRO eis_cam_readout__define



  dummy = { EIS_CAM_readout, $

            On_Chip_Binning                     : UINTARR(2), $

            CAM_CSG_flush_sequence_ID           : 0U, $

            CAM_CSG_normal_readout_sequence_ID  : 0U, $

            CAM_CSG_special_readout_sequence_ID : 0U, $

            Readout_nodes                       : UINTARR(4), $

            CCD_ro_node                         : 0U, $

            CCD_length                          : 0U, $

            flush_CCDs                          : 0U, $

            addresses                           : ULONARR(4) }



END