- NIRC2 Software Functional Requirements
Contents
1. Only one font shall be used unless there is a compelling reason to do otherwise Italic and bold fonts may be used for user warnings and alarm notification if their use results in improved clarity The text shall be readable by someone with 20 20 vision at six feet Text size shall not vary significantly A visual alarm mechanism such as reverse video or flashing display shall be pro vided Obvious redundant or superfluous information shall not be displayed Color shall not be the sole method of imparting information Text shall tend to fill the space Wide borders etc shall not be used Display shall be in specified SI units and units shall not be changed unless clarity is improved Numerical display shall be in integer for integer parameters Numerical display shall be in fixed point for real parameters and only be displayed to page 7 of 25 5 2 2 12 NIRC2 98001 a significance appropriate to the uncertainty of the parameter Exponential notation is discouraged Integer displays shall never be truncated Fixed point and alpha displays may be trun cated on the right Exponential notation may never be truncated 5 2 3 Display Organization 5 2 3 1 5 2 3 2 5 2 3 3 5 2 3 4 5 2 3 5 5 2 4 5 2 4 1 5 2 4 2 A primary display with the fundamental parameters for observing shall always be available and immutable in format It shall contain parameters such as integration time filter name grism camera e2. 2 SNe ta RS eg gS CY Ss 12 Pupil Mask Commands 032 ctcs tents Rava ee Che eee Be OY eA 12 Presiit Command Sinsen eria teens date be epee cnet 12 Coronagraph Commands vii cas be dew a CeO ee AeA aa Hees 13 Calibration Lamp Commands Local and AO 0 0 0 0 e ee eee eee ee 13 Telescope COMMISSION esas 13 Hybrid telescope instrument Commands 00 eee eee eee 14 Data Storage Commands ss fy 8asGdad anes AS aw eee ek we eae 14 Internal Commands ocupa hedged wae ee ta dared 15 Miscellaneous Commands suscita ceed tees 15 Maintenance Commands ii Sve blero AA POs 15 Mechanism Commands 3 2 45 da a sew ida 15 Array Voltage Commands 10d la boetagics 15 a a A E eh a ON lia 16 Motor Commands oseba daea aa ar a ir A 16 Reserved ssa a td dd ad e dad id 16 Temperature Controller Commands 0 0 cece eee eee eee 16 Coldhead Speed Control Commands 0 0 eee eee eee 16 Lamp controller commands ii eunee os awa bie cade cee See os 16 Read of Parameters sida cs wee ak eS 16 Write to Selected Y amables seins 0 sees thee eee Ne Bae eee Se 17 Target commands si sixteen a AA eee Pie es dae es 17 Command and Language Characteristics 0 0 eee eee eee 17 HARDWARE SOFTWARE REQUIREMENTS 00202 ee eee eens 18 General R guireme ts ndo 18 Instrument Mechanism Motor Control 0 0 eee eee a 18 Programing s cabo Kee cuana rt Kees lsgoh ta a rd db a 18 Homing caime oe ees eee eee oe
3. 25 NIRC2 98001 7 3 2 Programming 7 3 2 1 7 3 2 2 7 3 2 3 7 3 2 4 7 3 2 5 7 3 3 7 3 3 1 7 3 4 7 3 4 1 7 3 4 2 7 3 5 7 3 5 1 7 3 5 2 7 3 5 3 7 3 5 4 7 3 5 5 7 3 5 6 There shall be provisions for loading parameters into the cold head controller the DGH modules There shall be a command to read the loaded parameters from the controller Initial programing shall set the module addresses and other parameters appropriate for the controller The default start up and shutdown should not change the computer manual mode set ting The programing shall allow the controller commands and read back variable to be used in a program to allow future automatic control of the head in concert with the temperature controller and open loop timed speed adjust for cool down of the instru ment Initiating Computer control There shall be a command to change from computer to manual mode This should be a robust operation since the cold head is in continuous operation and the thermal time constants are very long Setting motor parameters There shall be commands to independently turn either motor on or off There shall be commands to independently change the speed of either motor Sensing motor condition The specified motor speed shall be displayed in revolutions per second The read back motor speed if available shall be displayed in revolutions per second to a precision of 0 01 revolution per second Th
4. agreement of the AO A time out and success signaling shall be provided Temperature Control and Monitoring General All instrument temperature control shall be open loop as far as software is concerned with the possible exception of a very slow software loop hours response using the cold head speed as a driver The temperature controllers are TBD but are baselined as Lake Shore Cryotronics Model 340 with a 8 input option card With this card the controller will sense ten tem peratures and control two The interfaces is nominally RS 485 if available If not RS 232C and IEEE 488 are available Except for cooldown and warm up the temperature setting will be unchanged during normal operations 7 5 2 Programing 7 5 2 1 7 5 2 2 L23 7 5 2 4 There shall be a provision to load parameters into the temperature controller There shall be a means to read parameters from the controller The default start up and shutdown should not change the controller setting The programing shall allow the controller commands and read back variables to be used in a program to allow future automatic control of the cold heads in concert with the temperature controller page 21 of 25 NIRC2 98001 7 5 3 Temperature and Heater Monitoring 7 5 3 1 All temperatures should be readable individually or as a block of 10 7 5 3 2 Temperatures and temperature set points shall be displayed in K to 0 001 K precision 7 5 3 3 All heater powers should be read
5. an annu lar region and a circular region Find the centroid of intensity in a circular region of an image Reserved Find the parameters of the best fit circular Gaussian centered on a specified position Find the parameters of the best fit elliptical Gaussian centered on a specified position page 9 of 25 NIRC2 98001 6 USER COMMANDS 6 1 Observer Commands 6 1 1 Detector Array Commands Commands for the detector array shall be implemented through UCLA provided software similar to NIRSPEC but modified to provide subframing capability See document no TBD Array commands which are not already predefined in the UCLA software are implemented in the NIRC2 software through the UCLA keyword library To the extent supported by the UCLA soft ware commands for the following functions shall be provided 6 1 1 1 Data Acquisition Commands 6 1 1 1 1 Start a sequence of exposures that will be handled until done by the host in a deter ministically timed fashion and be stored with FITS header 6 1 1 1 2 Start a sequence as in 6 1 1 1 1 but query for object name and type and give informa tive warnings 6 1 1 1 3 Abort an ongoing sequence of exposures without saving anything and do not advance the run number 6 1 1 2 Target Configuration Commands 6 1 1 2 1 Load a target array readout program by name if there is more than one This would include clocks biases timing patterns etc 6 1 1 2 2 Assign the number of the next data file
6. and displayed to 0 01 in watts 7 5 4 Detector Temperature Control 7 5 4 1 The desired detector temperature shall be a command setting 7 5 4 2 Maximum temperature and header power limits should be enabled 7 5 4 3 The precision of the setting should be to 16 bits in the controller 7 5 5 Optical Bench Temperature Control 7 5 5 1 The desired detector temperature shall be a command setting 7 5 5 2 Maximum temperature and header power limits should be enabled TO The precision of the setting should be to 14 bits in the controller 7 5 6 Radiation Shield Temperature Control Provision shall be made to allow future use of the Temperature controller temperature monitor feature in concert with the cold head speed controller to control the radiation shield temperatures This has a frequency of once per day 7 5 7 Cool Down Provision shall be made to allow future use of cool down scripts 7 5 8 Warm Up and Baking 7 5 8 1 Provision shall be made to allow future use of warm up scripts with over temperature protection 7 5 8 2 Provision shall be made to allow future use of detector baking scripts with over tem perature protection 7 6 Array Electronics TBD page 22 of 25 NIRC2 98001 APPENDIX A IMAGE HEADERS This appendix lists the parameters that shall be available for writing to the FITS headers Topic Data Configuration Telescope Parameters AO parameters Instrument Mechanism Configuration Camera Filter
7. es SG Dees aw onsite Sy 18 M vement 52 524 cosy DIA A A A teenage oe 19 Cold Head Motors oisicceie bees ake AAA ake 19 General Considerations cs 4 3 04 hem ee ev gee bon aca ave bboy Wedd ue es 19 Programming rita A A Bede k A Gad DEER Ge ieee deeds 20 Initiating Computer control b cicid wees Sede Cee See Re Ee Sebo es 20 Setting motor parameters i seh Sees oe A a eS oe ees ee eee eed 20 Sensing motor CONAN cer bose eed a othe Doed eae we eee 20 page 2 of 3 NIRC2 98001 7 4 Spectral LAMPS 300 A AA EA Gee RAS AAA 20 7 4 1 General considerations veria a di et eaters 20 7 4 2 PrOpramine e Sul Lua dt do ei de ao ed le do a Ad Dia eo Ad cd e 21 75 Temperature Control and Monitoring 0 0 cece ee eee 21 7 5 1 General ue al da ete SAS 21 7 5 2 POSTAL ia A A AS EA E AAA 21 7 5 3 Temperature and Heater Monitoring 0 0 eee eee eee 22 7 5 4 Detector Temperature Controls a ek fd ia a 22 7 5 5 Optical Bench Temperature Control 00 0 0 eee eee eee 22 7 5 6 Radiation Shield Temperature Control 0 0 cc cece eee eee 22 7 5 1 Cool DOWN oubibis ido ra da ddr 22 7 5 8 Warm Up and Baking oes eeir sa a a ae a a E a a a S N 22 7 6 Array Bl COMES DAA A A DO SS 22 Appendix A Image Headers 2 522 ir ete tr 23 page 3 of 3 NIRC2 98001 1 INTRODUCTION 1 1 Purpose and Scope This document identifies the requirements on software to second generation Near InfraRed Camera NIRC2 for the Keck II Telescop
8. sorting filter grism cross disperser in a filter wheel and decker mask A home command to locate a home position which will be regarded as the grism page 11 of 25 6 1 5 7 6 1 6 6 1 6 1 6 1 6 2 6 1 6 3 6 1 6 4 6 1 6 5 6 1 6 6 6 1 7 6 1 7 1 6 1 7 2 6 1 7 3 6 1 7 4 6 1 7 5 6 1 7 6 6 1 7 7 6 1 8 6 1 8 1 6 1 8 2 6 1 8 3 NIRC2 98001 slide s absolute zero position Motion commands to move the grism slide by grism name by discrete numbered position by displacement from its home position in absolute motor units and by off sets in motor units Slit Commands Insert a slit of given width with appropriate slit mask at position y Insert a slit of given width with appropriate slit mask of given length x used as a decker for echelle at position y Clear the slits and mask Close the slits and mask to block all light A home command to locate a home position which will be regarded as the slit s or slit mask s absolute zero position Motion commands to move the slit or slit mask by name by discrete numbered posi tion by displacement from a home position by absolute motor units and by offsets in motor units Pupil Mask Commands Insert the circumscribed circular pupil mask Insert the inscribed circular pupil mask Insert one of the hexagonal masks adjust to match telescope pupil orientation and follow the pupil rotation Insert square pupil mask A home command to locate a hom
9. 3 3 3 3 4 3 4 1 NIRC2 98001 TOP LEVEL FUNCTIONAL REQUIREMENTS User Observer Can operate from a remote site if desired Can easily determine the configuration of the instrument Can configure the instrument for data collection Can initiate data collection and abort it if so desired Has the ability to inspect images as they arrive and do a limited number of quick look arithmetic operations on them This requirement can be relaxed because of data throughput limitations Can send commands to the telescope which includes the AO system Can enter a sequence of commands before execution Can produce scripts and procedures embodying the above functions Has access to an on line help facility User Instrument Specialist and Engineering Has all of the abilities of the Observer Has the ability to temporarily or permanently change any of the parameters of the instrument For example filter names and wavelengths slit parameters optical parameters thermal parameters array parameters etc Has access to low level engineering functions for example primitive motor com mands limit changes electronic test functions Is given the maximum flexibility without recompilation of software Array readout Setup the array operating parameters Read out the array in various modes full frame and subframe Time stamp the sequence of images Data handling Data shall be stored on disk in FITS format with a keyword header givin
10. 3 Data Storage Commands 6 1 13 1 6 1 13 2 6 1 13 3 6 1 13 4 6 1 13 5 6 1 13 6 Get the directory information of the file space Display available free disk space Write a data buffer to a file with a modified FITS header Copy a file to another file Rename a file Delete a file page 14 of 25 NIRC2 98001 6 1 14 Internal Commands 6 1 14 1 6 1 14 2 6 1 14 3 A sleep command that halts the execution of the command sequence for a specified number of seconds This command should be aborted by a continue command A pause command that halts the command sequence until a continue command restarts the flow It would be desirable if the amount of time the pause was held was displayed A wait till a time command This command should be aborted by a continue com mand 6 1 15 Miscellaneous Commands 6 1 15 1 6 1 15 2 6 1 15 3 6 1 15 4 Enter the names of the observers Enter the object name and type Enter and edit comments Create and execute a command script 6 2 Maintenance Commands Maintenance commands are those which an instrument specialist might utilize to diagnose problems but would rarely if ever be used by observers 6 2 1 Mechanism Commands Mechanisms are those specified in sections 6 1 3 through 6 1 10 6 2 1 1 6 2 1 2 6 2 1 3 6 2 1 4 6 2 1 5 6 2 1 6 6 2 1 7 6 2 2 6 2 2 1 6 2 2 2 6 2 2 3 A halt command for each of the motor driven mechanisms Enable and disable a mechanism
11. Technical NIRC2 98001 Rev 3 12 29 98 Specification NIRC2 Software Functional Requirements A Conrad A Honey K Matthews Distribution of this draft NIRC2 bulletin board at http www 2 keck hawaii edu 3636 realpublic inst nirc2 ddoc software_des_req pdf file home wea nirc software_des current software_des_req_rev3_cover fm5 printed December 29 NIRC2 98001 NIRC2 Software Functional Requirements Table of Contents 1 INTRODUCTION suie rada A AA OR ee t a 1 1 1 P rpose and SCOPES d e ree n wd A eh ed pea E 1 1 2 ACTOR DIA E O AAA AN ie E AE A A 1 1 3 Applicable Documents 100 a AA Ad E 1 1 4 Instrument Geseripuion ii AA AA IA 1 1 4 1 A A A ew avon oa bese aetea vee Gt 434 1 1 4 2 IMAGING i bok Sow eee TAG bbe eRe AE dE AA Oe TAME OL ee eee es 1 1 4 3 SPECHOSCOPY fo nyc aa dw arn MOR Be ee ted ee awed vee ee ie as 1 1 4 4 ECOTRADER ence NA a ae Ol dial ENE Re 1 1 4 5 Instrument Environmental sk x ee Seen Rw oo a ew oe 2 1 4 6 Electronics and Computers 2 jniy ious ed ew be eyes o r Sakata ee Raw ded eee lt 2 1 4 7 USE ice A UG eee A A A AS gees 2 2 GENERAL DESIGN QUALITY AND DOCUMENTATION REQUIREMENTS 3 2 1 DESEAR A E de 3 2 Testability ara Ai A 3 2 3 READ O ek A AS pete NS A E E E OSA SEA 3 2 4 Documentation AAA ey eS Raw ee ip ee eee 3 3 TOP LEVEL FUNCTIONAL REQUIREMENTS 00 0 c eee eee eee 5 3 1 User Obseryer uso diablita dieta ira ata De 5 3 2 User Instrument Specialist and Eng
12. adjustment e Show a window that depicts the color map as an RGB graph and or a color bar e Rescale ADU to histogram equalization autodisp or linear page 8 of 25 5 3 2 NIRC2 98001 e Line Graphics X Y plot of pixel values lying below a rubber band line drawn with the mouse e Produce a column plot in the line graphics window of the column clicked on e Produce a row plot in the line graphics window of the row clicked on e Decrease or increase the number of pixels averaged for a line plot e Statistics Within a box specified via the mouse report mean sigma min max X range Y range total pixels and x y of max e Mouse over reports X Y and ADU e Print the entire image e Toggle color map inversion e Report the centroid and the FWHM of the image e Display help text e Report all values in reasonable precision and avoid floating point notation e Label the grid ticks on line graphics at reasonable intervals Image arithmetic commands Commands shall be provided to perform the following arithmetic operations on images 5 3 2 1 5 3 2 2 5 3 2 3 5 3 2 4 5 3 2 5 5 3 2 6 5 3 2 7 5 3 2 8 5 3 2 9 Move images between storage and memory buffers Do arithmetic between images and images and constants variables or functions Reserved Find the average sum median mode and rms fluctuation from the mean of a rectan gular region Find the average sum median mode and rms fluctuation from the mean of
13. commands NIRC2 software expects acknowledgment of receipt and completion 6 1 11 1 Move the telescope a distance in sky coordinates 6 1 11 2 Move the telescope a distance in elevation and azimuth 6 1 11 3 Move the telescope a distance in NIRC2 entrance focal plane coordinates 6 1 11 4 Move the telescope to a position on the detector focal plane in pixels 6 1 11 5 Move the telescope by the vector between two cursors positions 6 1 11 6 Set the focus of the telescope to a position 6 1 11 7 Increment the focus of the telescope 6 1 11 8 Request a move of the telescope to a coordinate in a given equinox with given proper motion 6 1 11 9 Request a move of the telescope to an entry on an object list 6 1 11 10 Get the telescope coordinates airmass times parallactic angle 6 1 11 11 Get meteorological information and temperatures 6 1 11 12 Go to a given AO mode Laser guide star Natural guide star flattened mirror simula tor etc 6 1 11 13 Track on sky with Y axis at a given position angle on the sky Command is restricted by mode used page 13 of 25 6 1 11 14 6 1 11 15 6 1 11 16 6 1 11 17 6 1 11 18 6 1 11 19 6 1 11 20 6 1 11 21 6 1 11 22 NIRC2 98001 Track on sky with Y axis at a given position angle the section of the great circle going from the pointing axis to the zenith fix in telescope pupil space Command is restricted by mode used Calibration lamp commands See 6 1 10 These require t
14. e 1 2 Acronyms ADU Analog Data Unit AO Adaptive Optics system of the Keck II Telescope FITS Flexible Image Transport System NIRSPEC Near InfraRed Spectrometer 1 3 Applicable Documents 1 4 Instrument description NIRC2 is a diffraction limited imaging spectrograph to be used in conjunction with the adap tive optics AO system on the Keck II Telescope 1 4 1 Detector NIRC2 uses a single 1024 by 1024 pixel InSb detector which has 32 parallel outputs 8 for each of the 4 independent quadrants of the multiplexer The readout electronics is a duplicate of that built for NIRSPEC modified to provide capability for subframing with the restriction that the same readout pattern is used on each quadrant of the detector 1 4 2 Imaging NIRC2 has three selectable cameras each with a different plate scale 01 02 and 04 arcsec per pixel two filter wheels and a wheel containing selectable pupil masks that can be driven to follow the rotation of the hexagonal telescope pupil These are in series in the collimated portion of the optical path Polarizing prisms may be installed in the filter wheels in the future 1 4 3 Spectroscopy For spectroscopy NIRC2 has up to five grisms on a movable stage and two stages that are used to position slits and slit masks In addition to the slits it has a preslit consisting of two mov able masks used to baffle the spectrograph Grisms may also be installed in the filter wheels in the future There ar
15. e position which will be regarded as the pupil mask s or pupil rotation drives s absolute zero position Motion commands to move the pupil mask by name by discrete numbered position by displacement from a home position by absolute motor counts and by offsets in motor counts Motion commands to move the pupil rotation drive to absolute angular positions in absolute motor units and by offsets in motor units Preslit Commands Set preslits to follow the slits if they are in or act as a baffle if in imaging mode Clear the preslits A home command to locate a home position which will be regarded as the preslits absolute zero position page 12 of 25 NIRC2 98001 6 1 8 4 Motion commands to move the preslits by aperture or edge name by discrete num bered position by displacement from a home position by absolute motor units and by offsets motor units 6 1 9 Coronagraph Commands 6 1 9 1 Insert a given diameter coronagraph mask at position y 6 1 9 2 Clear the coronagraph masks same as clearing the slits 6 1 10 Calibration Lamp Commands Local and AO 6 1 10 1 Position a lamp at a y value in the focal plane 6 1 10 2 Position a lamp at the current slit position 6 1 10 3 Turn on or off a specified lamp 6 1 10 4 Turn off all lamps 6 1 10 5 Turn off all lamps and return them to their stowed position 6 1 11 Telescope Commands These commands are controlled by other non NIRC2 software implemented through NIRC2
16. e read back motor current if available shall be displayed in amperes to 0 01 amperes A provision shall be made to enter a parameter for each motor such that the associated values are not volatile through software shutdown or failure Jumper selections for each motor will indicate if the respective read backs are for speed or current The state of the motors should be available on command and also able to be logged at low frequency An alarm provision for over current is desirable 7 4 Spectral Lamps 7 4 1 General considerations page 20 of 25 7 4 1 1 7 4 1 2 7 4 1 3 7 4 1 4 7 4 1 5 7 4 2 7 4 2 1 1 4 2 2 TAL 74 2 4 TADS 7 5 7 5 1 7 5 1 1 7 5 1 2 7 5 1 3 NIRC2 98001 There shall be at least four lamps for spectral calibrations They shall be mounted on a linear stage on the AO bench Their position control shall be by command to the AO DCS system Their roll angle as seen from NIRC2 shall be by command of the AO system K mirror field rotation mechanism through AO DCS commands Their activation shall be by RS485 command to a DGH D17xx module in a NIRC2 supplied lamp power control box mounted near the AO bench Programing The program shall coordinate the stage and K mirror motions if desired by the user The stage slit and lamp shall be coordinated if desired by the user Activation of any combination of lamps shall be allowed The program shall not move the K mirror or stage or turn on lamps without
17. e spectral calibration lamps for NIRC2 mounted on the AO system 1 4 4 Coronagraphy Besides carrying slits the slit stage will carry occulting masks to be used with the pupil masks to give the camera mode a coronagraphic capability page of 25 NIRC2 98001 1 45 Instrument Environment Temperatures in the instrument are monitored and controlled by cryogenic temperature con trollers mounted near the instrument The speeds of the cold head motors are controlled by variable frequency controllers located in the machinery room in the observatory building 1 4 6 Electronics and Computers The readout electronics are located near the instrument vacuum case and are connected to the dedicated target and host computers in the computer room which is also on top of Mauna Kea This connection is by optical fiber The host is also network connected to the telescope control system for the purpose of sending commands and receiving telescope and adaptive optics system information 1 4 7 User The users observer instrument specialist or engineer may connect to the host from any loca tion using a remote computer networked to the host page 2 of 25 NIRC2 98001 2 GENERAL DESIGN QUALITY AND DOCUMENTATION REQUIREMENTS 2 1 Design 2 1 1 The design shall be modular Each module shall be as self contained as possible with a well defined interface to the other modules 2 1 2 The design shall have a rational organization so that it can be c
18. form that can get the input from variables 6 4 3 Commands shall put any output into variables not supported by UCLA software 6 4 4 Where appropriate there shall be a command form that also displays the output to the user page 17 of 25 NIRC2 98001 7 HARDWARE SOFTWARE REQUIREMENTS This section identifies software requirements imposed by the hardware 7 1 General Requirements 7 1 1 Software that interfaces directly with the motor controller shall be designed to be eas ily replaced if a different controller is used 7 1 2 Software shall be consistent with the following hardware constraints e The controllers for instrument mechanisms are Amamatics Smart Motor control lers There are 11 of these motors e The controllers for the cold heads are through DGH serial interfaces There are two cold heads e The lamps are controlled through calls to the AO system and will not be consid ered motor controllers as they are handled by the AO software e The current baseline interface to the motor controllers is by RS 485 The motor that drives the pupil mask rotation must have real time control 7 2 Instrument Mechanism Motor Control 7 2 1 Programming 7 2 1 1 There shall be provision to load programs into the controller For the Smart Motor controller these programs are non volatile T212 There shall be provision to read programs from the controller for inspection 7 2 1 3 Each controller shall have its own address one that
19. g parameters of the exposure listed in Appendix A including an accurate time stamp Sequences of single or multiple full or subframe images shall be saved to disk at the maximum rate supported by the UCLA software with a sequence length limited only by storage medium size page 5 of 25 3 4 2 3 4 3 3 4 4 3 4 5 3 4 6 3 5 3 5 1 3 5 2 3 5 3 3 5 4 3 5 5 3 5 6 4 4 1 4 2 4 3 4 4 4 5 NIRC2 98001 There shall be fast buffers for the data and their headers for quick display Data shall be accessible over the net for other uses without impacting instrument operation Housekeeping data shall be archived at a low rate The command sequence to the host shall be archived As much as possible errors and exceptions shall be archived Software Operation Start up shall require a minimum of commands ideally one Start up shall not depend on the previous state of the system Shutdown shall leave the system in a cleaned up state The state of the instrument shall be saved to allow restart in the same configuration as much as is sensible in case of a failure The software shall be robust and reliable A user should not be able to break it and it should run for weeks without failure The software shall protect itself against failures caused by interactions with systems outside of itself for instance instrument user or telescope communications USER Logon from remote network connected computers Security suc
20. h as a password Several levels of user with nested subsets of capability to interact with the software Observer Instrument Specialist and Engineer in order of capabilities High level users can preempt lower level users A user can be logged on multiple times so that non blocked commands such as image display or manipulation can be executed in parallel with data acquisition page 6 of 25 NIRC2 98001 5 USER INTERFACE 5 1 User Command Input 5 1 1 3 1 2 5 1 3 All commands shall be executable by typing at a command line interface Commands can be combined on a line but not executed until a carriage return is typed The commands shall be part of a command scripting language in which command sequences can be created and stored as text files The editing functions shall include at least insertion deletion rearrangement and duplication The arrow keys should operate in tcsh fashion It is desirable that the user be able to test a command file by use of some sort of pre viewer The design shall facilitate the future addition of a graphical user interface GUI for the entering of commands These commands shall act the same way as typed in com mands 5 2 User display of system parameters 5 2 1 System parameters shall be clearly and unambiguously displayed 5 2 2 Text clarity Delo 5 2 2 2 5 2 2 3 5 2 2 4 5 223 5 2 2 6 5 221 5 2 2 8 522 9 5 2 2 10 5 2 2 11 The most readable font shall be used
21. hat the stage on the AO bench be moved to a position and also that the K mirror be set to a specific angle Send image parameter e g object brightness image quality loss of track that deter mines when the AO should signal a shutter open or close The AO signal to NIRC2 returned via mechanism control keyword section XXX below must have latency of less than 100 msec Send tip tilt star parameters to AO Center a target in the NIRC2 detector given its current x y pixel coordinates Center a target on the NIRC2 slit given 1ts current x y pixel coordinates Move a target along the length of the slit Return the telescope to its zero position Load the current telescope offset position into variables and restore the telescope to this loaded position 6 1 12 Hybrid telescope instrument Commands 6 1 12 1 6 1 12 2 6 1 12 3 Dither patterns which will combine telescope offsets with NIRC2 images and possi bly image display For spectroscopy this will include dithering along the slit A simple image telescope offset image return sequence with optional image dis play Focusing tools This would include the standard MA lign technique for focusing and tilting the Keck secondary and restacking the mirror segments It would also include taking a series of images at different secondary focus positions and allowing the observer to estimate a best focus position from the subsequent image quality 6 1 1
22. ide slits and preslits for a filter It shall also set the header for the configuration name This is for imag ing with and without the coronagraph A dark command shall also be included Blocker command that moves one filter wheel and does not move anything else Grism command that puts in a filter wheel based grism of n grooves mm Grism procedure with filter name and grism of n grooves mm that puts in that filter and grism and clears the grism slide Other named commands such as those for a polarizing prism A home command to locate a home position which will be regarded as the filter wheel s absolute zero position Motion commands to move the filter wheels by filter name by discrete numbered position by absolute angular position in degrees from its home position by absolute motor counts and by offsets in motor units Camera Commands Insert a camera of a given scale A home command to locate a home position which will be regarded as the camera slide s absolute zero position Motion commands to move the camera stage by camera name to discrete numbered position by displacement from its home position by absolute motor units and by off sets in motor units Grism Slide Commands Insert grism of a given groove spacing Insert pupil mask imager if on stage Clear grisms and pupil mask imager A procedure that inserts a given grism and its order sorting filter A procedure that inserts a given grism its order
23. ineering 0 ce cee eee eee 5 33 Atray r ado t s pnie doroine Pew he aha La ae PE a hae oe heer eee Rhee 5 3 4 Pata ANNI NS e DA Gi a Hare ae Re eee SL a RS A 5 3 5 Software Operation a A A AS ES AA A Vane eee 6 4 USER cistitis da a A A E A RG 6 5 USER INTERFACES ee NA AA AAA Eh 7 5 1 User Command Input issn ss A SERA ee 7 5 2 User display of system parameters 0 cee eee eee ee eens 7 5 2 2 Text Clarity A aieiaa a LA oo ec da E a 4 EA we ES aoe ye wR acted 7 5 2 3 Display Organization a eT E EEE EEA o Baek Race See we 8 5 2 4 Display content Sd SAA AS A AS ASA 8 5 3 User image display and manipulation 0 0 0 cee eee eee eee 8 5 3 1 O 8 5 3 2 Image arithmetic commands is sy Ghee dk oe Pot eine Dae UNOS eo wee as 9 page of 3 6 1 6 1 1 6 1 2 6 1 3 6 1 4 6 1 5 6 1 6 6 1 7 6 1 8 6 1 9 6 1 10 6 1 11 6 1 12 6 1 13 6 1 14 6 1 15 6 2 6 2 1 6 2 2 6 3 6 3 1 6 3 2 6 3 3 6 3 4 6 3 5 6 3 6 6 3 7 6 3 8 6 4 7 1 T2 7 2 1 1 2 2 7 2 3 7 3 7 3 1 1 3 2 7 3 3 7 3 4 7 3 5 NIRC2 98001 USER COMMANDS 00 a EMGAGE Ua a ROY AA ARA ee 10 Observer Commands scroll a 10 Detector Array Commands DA oes PGA Eee ID CI eta 10 Housekeeping Data Acquisition Commands 0 0 0 e ee eee eee 10 Filter Wheel Commands 72 4 4 ER E a 11 Camera Commands ia beige sabes cieta o a a baie seeds 11 Grism Slide Commands scaner oe dea dt earn get 11 A A eked eA heals anaes tlk teed
24. is consistent with the motor num bering convention 7 2 1 4 Initial programming shall set the appropriate parameters for the motor Acceleration error limit switches etc 7 2 1 5 The programming shall include an algorithm for backlash removal The backlash removal shall be a delta move and then a return The amount of delta shall be a changeable variable 7 2 2 Homing 1 221 Each motor shall be homed as much as is practical through a program in the control ler T2222 The homing shall be in most cases to limit switches or it might be a move of a given number of turns to slip a clutch 7 2 2 3 The zero shall be determined in the case of the Smart Motors by the home position in conjunction with the index signal page 18 of 25 NIRC2 98001 7 2 3 Movement 7 2 3 1 T 2 3 2 UE 7 2 3 4 T233 7 2 3 6 Pla 7 2 3 8 7 2 3 9 7 2 3 10 There shall be software high and low limits These shall be user settable These shall be coordinated with the backlash removal delta constant Reserved There shall be scaling constants to map controller position and zero into high level position These shall be user settable There shall be a variable indicating the intended motor position There shall be an error band parameter within which the motor will be considered to be in position for the Smart Motor This shall be user settable There shall be a flag to indicate whether the motor was found to be outside the set err
25. language 2 4 3 A user manual describing the functionality for the user page 3 of 25 2 4 4 2 4 5 2 4 6 2 4 7 2 4 8 2 4 9 NIRC2 98001 An engineering user supplement describing engineering commands and hardware interfaces A description of the functionality of the software and its relationship to the hardware A detailed description of the structure of the software A detailed description of the interaction of any module with other modules Each module shall have a title a header listing all inputs and outputs and data struc tures that mention how these items are modified A description of what the module does and a description or reference to any algorithms executed by the module shall be given If the module interfaces with hardware there shall be a reference to the appro priate hardware manual Additional Documents per KSD 3 In addition the delivered system shall include the following documentation as specified in the Keck Software Document Software Items for the Acceptance Review KSD 3 2 4 9 1 2 4 9 2 2 4 9 3 2 4 9 4 2 4 9 5 2 4 9 6 2 4 9 7 2 4 9 8 User s Manual same as 2 4 1 As Built CDR Documents Source Code List Function Descriptions Start up Shutdown Procedures Installation Manual Troubleshooting Guide Programmer s manual page 4 of 25 3 3 1 3 1 1 3 1 2 3 1 3 3 1 4 3 1 5 3 1 6 3 1 7 3 1 8 3 1 9 3 2 3 2 1 3 2 2 3 2 3 3 2 4 3 3 3 3 1 3 3 2
26. me delay Start delay Wipe mode parameters Integration times Pixel readout times page 24 of 25 Array voltages Target Configuration Environmental Parameters Titles Organization NIRC2 98001 Array detector bias Fixed bias voltages High and low clock voltages Version of target program Versions of any parameter files use for timing patterns Instrument temperatures and settings Cold head settings and readings Observatory environmental conditions temps wind dewpoint Telescope name Instrument name Observer name Object name Object type Comment lines The data shall be presented to no more significance than the uncertainty of the data The lines shall be commented as to e the meaning of the entry e the units of the entry e alternative units such as hours min and sec Irrelevant data lines shall be clearly and consistently marked e g slit width N A if slits out page 25 of 25
27. nd set Reserved Temperature Controller Commands Read the current value of any of the temperature sensors Enable and disable temperature control Set detector block temperature Set the optical bench temperature Issue any command provided by the temperature controller s command set Coldhead Speed Control Commands Set either of the continuously adjustable coldhead speeds independently or currents as determined by a hardware jumper Read either coldhead speed Turn either coldhead on or off independently Set the hardware controller to either computer control or manual mode Issue any command provided by the coldhead controller s command set Lamp controller commands Move the lamps to a specified position in mm independent of K mirror motion Issue any command provided by the lamp controller s command set Read of Parameters Read the motor controller and thermal devices control parameters page 16 of 25 NIRC2 98001 6 3 7 Write to Selected Variables 6 3 7 1 Set any of the motor controller and thermal devices control parameters and a mecha nism for making updates permanent between observing runs 6 3 8 Target commands TBD 6 4 Command and Language Characteristics 6 4 1 The language shall have read access to the parameters of the instrument and write access to as large a set as is sensible 6 4 2 In general commands shall not query for user input If a command does there shall be an alternate
28. omprehended by others and by the original programmers after the fact Pam We Appropriate attention shall be given to the fact that the code might need to be modifi cations or extended in the future 2 1 4 Appropriate attention shall be given to the fact that the code might need to be ported to another machine or that an operating system upgrade might be desired 215 The code shall be appropriately fast The user should not be bothered by unnecessary delays but the code should not be made complicated to achieve unneeded speed 2 2 Testability 2 2 1 Modules shall be as much as possible testable as stand alone pieces 2 2 2 Dummy modules shall be available where necessary 2 2 3 Emulation programs shall be supplied for use in place of external interfaces 2 3 Reliability 2 3 1 The software shall be written with reliability in mind 2 3 2 Exceptions and errors shall be handled in a way that prevents failure 2 3 3 Time outs shall be used with all external interfaces to prevent the software from hang ing 2 3 4 Memory shall be properly managed for instance leaks shall be well controlled 2 3 5 Testing shall be intensive and extensive It shall be very thorough over the most com monly used range of operating modes while also sampling the boundaries of the oper ation space 2 3 6 The hardware response to the software shall be thoroughly tested 2 4 Documentation 2 4 1 An installation guide 2 4 2 A programming guide for the command
29. or band There shall be a flag to indicate whether the motor is considered to be unsettled The motor controller position shall be checked before a move to find if it is at the expected position The motor controller position shall be checked after a move to verify the completion of the move The real time control of the pupil mask shall match the phase of the primary 1 mrad 7 3 Cold Head Motors 7 3 1 7 3 1 1 7 3 1 2 7 3 1 3 7 3 1 4 General Considerations There are two CTI cold heads with motors a single stage high temperature head to be operated at about 100K and at two stage head with its high temperature stage at about 50K and its low temperature stage at below 20K Each head has a synchronous motor which is driven by a CTI frequency converter slightly modified by Caltech Both con verters connect to a Caltech supplied NIRC2 Cold Head Filter Interface box This box interfaces in turn to a Caltech supplied NIRC2 Cold Head Computer Control box This box contains one DGH D4172 and one DGH D1132 module for each head All 4 modules are on one RS485 serial circuit Each module has a separate address The NIRC2 Cold Head Computer Control box will be located in the Observatory equipment room The interaction with the heads will be very infrequent on the order of once per hour and not time critical Refer to DGH D1000 Series Users Manual Revised 5 1 94 and DGH D3000 4000 Series Users Manual Revised 6 1 94 page 19 of
30. s Grisms Etc Data Item Data type NAXIS Word length and type Subframe configuration UTC date and time Equinox RA Dec HA Air mass Azimuth Zenith angle Parallactic angle Angle of y axis on the sky K mirror angle K mirror tracking mode sky pupil stationary AO mode natural laser fixed simulator etc Guide star parameters Atmospheric parameters AO control parameters Simulator and calibration lamp parameters Camera scale or warning if in nonstandard position Name of configuration filter grism with type of blocker pupil imager polarizing prism etc Name of item in each mechanism F256 for instance Parameters of the configuration short wavelength cutoff etc page 23 of 25 NIRC2 98001 Instrument Mechanism Configuration continued Slits Coronagraph Test Masks Pupil Mask Shutter Array Electronics Configuration Image organization Readout mode and mode parameters Slit width Slit position Slit length 1f decker Range if used as wide mask Occulting mask type occulting disk etc Occulting mask size ff ff arcsec dia etc Occulting mask position Mask name Mask position Pupil mask type Pupil mask orientation How tracking fixed telescope other Time closed during exposure Times of closings and openings TBD Image size and subframe parameters Number of cycles Number of coadds Type of sampling e mode e mode parameters Frames skipped Inter fra
31. s servo Set and release a mechanisms s brakes Reset a mechanism s motor controller Determine whether or not a mechanism s motor is idle Determine whether or not a mechanism s motor has successfully homed Display the information relevant to a mechanism An example would be a mechanism with discrete positions whose display would include position numbers names and absolute positions Array Voltage Commands Set the detector bias voltage Set the preamplifier offset voltages for each detector quadrant independently Globally set the preamplifier offset voltages page 15 of 25 NIRC2 98001 6 3 Engineering Commands Engineering commands are commands which are needed for configuring of controllers and device modules integration and trouble shooting 6 3 1 Motor Commands These motor commands are low level referring to each individual motor rather than mecha nisms where mechanisms are those discussed in sections 6 1 3 through 6 1 10 6 3 1 1 6 3 1 2 6 3 1 3 6 3 2 6 3 3 6 3 3 1 6 3 3 2 6 3 3 3 6 3 3 4 6 3 3 5 6 3 4 6 3 4 1 6 3 4 2 6 3 4 3 6 3 4 4 6 3 4 5 6 3 5 6 3 5 1 6 3 5 2 6 3 6 6 3 6 1 Home reset stop motion enable and disable servos set and release brakes and com mence motion to a specified motor position in absolute or relative terms Obtain any status value that is supplied by the motor controller s command set Issue any command provided by the motor controller s comma
32. tc Less used parameters shall be placed in secondary displays They should be orga nized by function and need not always be present Provision of a user configurable display of information is desirable but not required Access to displays shall be by command but may also be by a GUI mechanism such as a pull down menu A countdown time to the end of the current exposure shall always be displayed This can be a time bar with time of completion and time of start also displayed as text A graphical display for overall instrument configuration with pull out menus of func tions would be desirable Display content Displays shall show ACTUAL parameters in a timely fashion User input should not be just displayed but for instance motor positions should be read back from the con troller and the positions verified If a parameter is unknown or out of range it shall be indicated For example for unknown and for out of range 5 3 User image display and manipulation The NIRC2 image display functions will be provided through the UCLA furnished IDL dis play package 5 3 1 5 3 1 1 Image display The image display shall provide the following functionality e Zoom 2D in out 1D in out and go to normal zoom e Pan the image via the mouse drag function e Recenter image e Provide a small display of the full image that indicates the zoomed in location of the main window e Color map adjustment also known as contrast
33. to be written 6 1 1 2 3 Select a readout mode e Fowler mode with global reset e Read mode with pair reset after n read e Read mode with global reset after n full frame read e Others TBD 6 1 1 2 4 Change of parameters associated with the readout mode e Detector bias e Frame integration time e Number of frames coadded to a picture e Start and end of subframe in x and y e Number of reads if Fowler number of nondestructive reads at each end 6 1 2 Housekeeping Data Acquisition Commands 6 1 2 1 Get the instrument temperatures and heater powers and display them 6 1 2 2 Get the cold head motor physical parameters and display them 6 1 2 3 Get the current positions of the motor driven mechanisms and display them For those page 10 of 25 NIRC2 98001 mechanisms with discrete positions the displayed positions must include the name of the position the position number and the target position name and number when in transit For all mechanisms the display must include the state of the mechanism e g moving or idle the absolute position in engineering units e g angular position in degrees or displacement in millimeters and the position in motor units 6 1 3 Filter Wheel Commands 6 1 3 1 6 1 3 2 6 1 3 3 6 1 3 4 6 1 3 5 6 1 3 6 6 1 3 7 6 1 4 6 1 4 1 6 1 4 2 6 1 4 3 6 1 5 6 1 5 1 6 1 5 2 6 1 5 3 6 1 5 4 6 1 5 5 6 1 5 6 A named procedure that configures the two filter wheels grism sl
Download Pdf Manuals
Related Search