The CASPIR Command

back to software page




CASPIR/APERTURE=position

back to top

Moves the aperture wheel  to the specified position. The position may be specified by a number in the range 1-16, or by name. The position names are:

      Blank,      FastClr,    SlowClr,
      Sslit1,     Sslit1.5,   Sslit2,     Sslit5,     Sslit10,
      Lslit1,     Lslit1.5,   Lslit2,     Lslit5,     Lslit10,
      Disk2,      Disk5,      Polar
These names may be abbreviated.



CASPIR/UTILITY=position

back to top

Moves the utility wheel  to the specified position. The position may be specified by a number in the range 1-16, or by name. The position names are:

      Align,      Clear,      Wollastn,   SlowCam,    Mask,
      J_grism,    H_grism,    K_grism,    
      IJ_grism,   JH_grism,   HK_grism,
      Foccal,     Focus,      Hart2,      Hart1,      BigClear
These names may be abbreviated.



CASPIR/FILTER=desired_filter

back to top

Moves both filter wheels  in combination to select the desired filter. This is equivalent to entering /UFILTER=pos1/LFILTER=pos2, where ''pos1'' and ''pos2'' make up a sensible combination. The desired_filter may be specified by name, which is one of the following:

      Blank,            J,                H,                K, 
      KP,               KN,               L,                M,
      Helium (NB108),   PGamma (NB109),   PBeta (NB128),    Cont1.6,
      FeII (NB164),     AAOFeII (NB165),  H2O (NB199),      H2_1_0 (NB212),
      BrGamma (NB217),  Cont2.2 (NB222),  H2_2_1 (NB225),   CO (NB236),
      Ice (NB310),      Dust3.28 (NB328), Dust3.4 (NB340),  Cont3.6 (NB360),
      Cont4.0 (NB400),  BrAlpha (NB405),  Grid,             Focus
These names may be abbreviated. Alternative names for a position are shown in parentheses. This qualifier cannot be specified with the /UFILTER qualifier or the /LFILTER qualifier.



CASPIR/UFILTER=position

back to top

Moves the upper filter wheel  to the specified position. Normally, the two filter wheels are set using the /FILTER qualifier; this qualifier is provided to allow unusual settings of the upper filter wheel. The position may be specified by a number in the range 1-16, or by name. The position names are:

      Blank,            Clear,            Helium (NB108)    PGamma (NB109),   
      PBeta (NB128),    FeII (NB164),     AAOFeII (NB165),  H2O (NB199),
      H2_1_0 (NB212),   BrGamma (NB217),  Cont2.2 (NB222),  H2_2_1 (NB225),
      CO (NB236),       Cont1.6,          Grid,             Focus
These names may be abbreviated. Alternative names for a position are shown in parentheses. This qualifier cannot be specified with the /FILTER qualifier.



CASPIR/LFILTER=position

back to top

Moves the lower filter wheel  to the specified position. Normally, the two filter wheels are set using the /FILTER qualifier; this qualifier is provided to allow unusual settings of the lower filter wheel. The position may be specified by a number in the range 1-16, or by name. The position names are:

      Blank,            Clear,            J,                H,
      KP,               KN,               K,                L,       
      Ice (NB310),      Dust3.28 (NB328), Dust3.4 (NB340),  Cont3.6 (NB360),  
      Cont4.0 (NB400),  BrAlpha (NB405),  M,                PK50
These names may be abbreviated. Alternative names for a position are shown in parentheses. This qualifier cannot be specified with the /FILTER qualifier.



CASPIR/LENS=position

back to top

Moves the lens wheel  to the specified position. The position may be specified by a number in the range 1-4, or by name. The position names are:

      Blank,            FastCam,            Blank3,           Clear
These names may be abbreviated.



CASPIR/STATUS_NOW

back to top

The /STATUS_NOW qualifier causes CASPIR to interrogate the LSI-11/23 for the current wheel positions and their status and updates the Status Display accordingly.



CASPIR/[NO]REPORT

back to top

The /REPORT qualifier asks CASPIR to report (with a message to the IR status display) when each wheel arrives at its requested position. The /NOREPORT qualifier turns off wheel position reporting.



CASPIR/MODE=mode_number

back to top

Sets the observing mode to be used. The observing modes describe different ways in which the data-taking occurs, and may be specified as a number in the range 1-2, or by name. The observing mode names are:

      Direct_Imaging,   Nod

In Direct_Imaging mode, single exposures are obtained for each run.

In Nod mode, successive exposures are obtained in an ABBA pattern at two positions on the sky defined by telescope focal plane apertures named N1 and N2. This is designed for use with the grisms. The number of AB pairs obtained is set by the REPEATS parameter which can be changed during data acquisition. If the SHOW parameter has been set to CURRENT with a CASPIR/SHOW=CURRENT command, the current A-B difference is displayed in the Run Display. If the SHOW parameter has been set to MEAN with a CASPIR/SHOW=MEAN command, the average of the accummulated difference images is displayed in the Run Display.



CASPIR/IMETHOD=method_number

back to top

Sets the integration method to be used when CASPIR is idling. This must be set as a value in the range 1-5, where the methods are as follows:

      1 = Fast           
      2 = Absolute       
      3 = Double Correlated
      4 = Triple Correlated
      5 = Fowler Sampling



CASPIR/ICYCLES=cycle_count

back to top

Sets the number of coadd cycles to perform for each image CASPIR is to obtain when idling. Cycle_count should be an integer in the range 1-4095.



CASPIR/ITIME=time_value

back to top

Sets the integration time in seconds for each cycle, to be used when CASPIR is idling.



CASPIR/IFNDR=read_count

back to top

Sets the number of non-destructive reads performed at the beginning and end of an integration when using Fowler read-out methods, to be used when CASPIR is idling. This value is ignored for non-Fowler methods.



CASPIR/IPERIOD=time_value

back to top

Sets the read period (in units of seconds) for non-destructive reads within each integration cycle when using the linear fitting read-out method, to be used when CASPIR is idling. This value is not currently used (see /IFNDR instead).



CASPIR/METHOD=method_number

back to top

Sets the integration method to be used when CASPIR carries out its next run. This must be set as a value in the range 1-5, where the methods are as follows:

      1 = Fast           
      2 = Absolute       
      3 = Double Correlated
      4 = Triple Correlated
      5 = Fowler Sampling



CASPIR/CYCLES=cycle_count

back to top

Sets the number of integration cycles to perform for each image CASPIR is to obtain on its next run. Cycle_count should be an integer in the range 1-4095.



CASPIR/TIME=time_value

back to top

Sets the integration time in seconds for each cycle, to be used on CASPIR's next run.



CASPIR/FNDR=read_count

back to top

Sets the number of non-destructive reads performed at the beginning and end of an integration when using Fowler read-out methods, to be used on CASPIR's next run. This value is ignored for non-Fowler methods.



CASPIR/PERIOD=time_value

back to top

Sets the read period (in units of seconds) for non-destructive reads within each integration cycle when using the linear fitting read-out method, to be used on CASPIR's next run. This value is not currently used (see /FNDR instead).



CASPIR/REPEATS=repeat_count

back to top

Sets the number of images to be obtained (i.e the number of data files to be written) at the next run. Each image consists of CYCLES coadds of frames with an integration time of TIME seconds.




CASPIR/RUN

back to top

The /RUN qualifier starts a run. A data file with name IRxxx (where xxx is the current run number) will be written at the end of the run. If REPEATS is set to more than one, more than one data file will be written, and xxx will be incremented for each one.



CASPIR/DARK

back to top

The /DARK qualifier takes a dark frame . That is, it starts a run, but it sets filter and aperture wheels to their blank positions to exclude light first. A file is written, just as for /RUN. The Filter and Aperture wheels are returned to their original positions when the run completes successfully.



CASPIR/BIAS

back to top

The /BIAS qualifier takes a bias frame . That is, it starts a run, but it sets filter and aperture wheels to their blank positions to exclude light first (just as does /DARK) and it sets integration time to the minimum possible for the selected readout method. A file is written, just as for /RUN. The Filter and Aperture wheels are returned to their original positions when the run completes successfully.



CASPIR/DO=filespec

back to top

This qualifier specifies a text file  in the directory defined by the logical name IR_DO containing instructions for taking data frames automatically. On startup, IR_DO points to the default directory DATADISK:[INFRARED]. The file can also contain comment lines (lines beginning with the ``!'' character), which may appear anywhere in the file.

The file type, if not specified, is assumed to be ``.DO''.

The format of each instruction line is as follows:

COMMAND Object_Name RA_Offset Dec_Offset Method Cycles Time Fndr -
 Repeats Aperture Ufilter Utility Lfilter Lens Filter Period Tiptilt -
 Stage_Offset Track_Coord Guide_Coord GRA_Offset GDec_Offset TTX TTY -
 TTDX TTDY AcqX AcqY AcqDX AcqDY TT_Mode TT_ATime TT_GTime TT_CTime -
 TT_Find TT_Error

The syntax of the instruction lines is flexible. The COMMAND item must appear, and it must be one of ``RUN'', ``BIAS'' or ``DARK''. All other items are optional. Items may be separated by spaces and/or commas; if items are omitted, commas are required to identify the missing item (but note that COMMAND ,,,,, will interpret the commas as the object name). A ``-'' character at the end of a line indicates that the instruction is continued on the next line.

Items may also be specified non-positionally, using a ITEM_NAME=value syntax. This is the most convenient way of formatting an instruction when only a few items need be specified. For example:

RUN  Object_1, TIME = 15  CYCLES = 2  FILT=K

If the command is BIAS or DARK, then the Aperture, Ufilter, Utility, Lfilter, Lens and Filter items must not be specified. If the command is BIAS, the Time item must not be specified. If the command is RUN, the Filter item cannot be specified if either the Ufilter or Lfilter items is present.

The items in detail:

 COMMAND           "RUN", "BIAS" or "DARK".
 Object_Name=      Character string.
 RA_Offset=        Offset in Right Ascension to move telescope to, before
                     taking data (arcseconds).
 Dec_Offset=       Offset in Declination (arcseconds).
 Method=           Integration (readout) method (integer, range 1-7).
 Cycles=           Number of transputer co-add cycles.
 Time=             Exposure time (seconds).
 Fndr=             Number of Fowler non-destructive reads.
 Repeats=          Number of repeats of integration sequence.
 Aperture=         Aperture wheel position.
 Ufilter=          Upper Filter wheel position.
 Utility=          Utility wheel position.
 Lfilter=          Lower Filter wheel position.
 Lens=             Lens wheel position.
 Filter=           Combined Upper and Lower Filter wheel position.
 Period=           Non-destructive read period (seconds) [not used].
 Tiptilt           Enable Tip-Tilt operation.
 NoTipTilt         Disable Tip-Tilt operation.
 Stage_Offset      Enables IMB X-Y stage motion.
 NoStage_Offset    Disables IMB X-Y stage motion.
 Track_Coord=      Track on a new object coordinate specified as a text string 
                     delimited by double quotes.  The string format is as for 
                     the telescope TRACK/COORD command.  No object name can be 
                     present; use the ``Object_Name'' DO file command instead.
                     The telescope returns to the original tracking coordinate 
                     at the end of the DO file.
 Guide_Coord=      Defines a new guide star coordinate specified as a text 
                     string delimited by double quotes.  The string format is 
                     as for the telescope TRACK/COORD command.  No object name
                     can be present.  The guide coordinates return to their 
                     original values at the end of the DO file.
 GRA_Offset=       Defines guide star offset in arcsec in RA as a floating point
                     number.  The guide coordinate returns to its original 
                     value at the end of the DO file.
 GDec_Offset=      Defines guide star offset in arcsec in Dec. as a floating
                     point number.  The guide coordinate returns to its original 
                     value at the end of the DO file. 
 TTX=              X coordinate of Tip-Tilt correct subframe center in integer 
                     units of CCD pixels.
 TTY=              Y coordinate of Tip-Tilt correct subframe center in integer
                     units of CCD pixels.
 TTDX=             X size of Tip-Tilt correct subframe in integer units of CCD 
                     pixels.  Permitted values are 8, 10, 12, 16.
 TTDY=             Y size of Tip-Tilt correct subframe in integer units of CCD 
                     pixels.  Permitted values are 8, 10, 12, 16.
 AcqX=             X coordinate of Tip-Tilt acquire subframe center in integer
                     units of CCD pixels.
 AcqY=             Y coordinate of Tip-Tilt acquire subframe center in integer 
                     units of CCD pixels.
 AcqDX=            X size of Tip-Tilt acquire subframe in integer units of CCD
                     pixels.  Permitted values are 8, 10, 12, 16.
 AcqDY=            Y size of Tip-Tilt acquire subframe in integer units of CCD
                     pixels.  Permitted values are 8, 10, 12, 16.
 TT_Mode=          Tip-Tilt operation mode specified as one of ``correct'', 
                     ``guide'', ``acquire'', or ``recalibrate''.  Tip-Tilt is
                     left in acquire mode at the end of the DO file.
 TT_ATime=         Specifies acquire mode integration time in ms as a floating 
                     point number.  Remains in effect when DO file completes.
 TT_GTime=         Specifies guide mode integration time in ms as a floating 
                     point number.  Remains in effect when DO file completes.
 TT_CTime=         Specifies correct mode integration time in ms as a floating
                     point number.  Remains in effect when DO file completes.
 TT_Find           Enables Auto-Acquire mode.
 NOTT_Find         Disables Auto-Acquire mode.
 TT_Error          Do not abort on Tip-Tilt errors.
 NOTT_Error        Abort DO file if Tip-Tilt errors encountered.



CASPIR/[NO]TIPTILT

back to top

The /[NO]TIPTILT qualifier controls the use of the 2.3 m Cassegrain Tip-Tilt secondary mirror image correction system. The /TIPTILT qualifier enables control of tip-tilt image correction by DO file commands and in NOD mode. The /NOTIPTILT qualifier causes DO file tip-tilt commands and NOD mode tip-tilt commands to be ignored.



CASPIR/[NO]STAGE_OFFSET

back to top

If the TIPTILT parameter is set, the /STAGE_OFFSET qualifier causes the IMB X-Y stage to be moved in an opposite sense to the telescope during R.A. and Dec. offsets performed within a DO file. By doing so, the reference star is repositioned at the reference position on the tip-tilt sensor to allow guiding or correction on the same object. If the Tip-Tilt system is operated in guide or correct mode, the mosaic offsets will then be defined by the IMB X-Y stage positions, and accurate registration of the images should be possible using the OFFRA and OFFDEC parameters in the FITS file header. The /NOSTAGE_OFFSET qualifier disabled IMB X-Y stage motion. The Tip-Tilt system then attempts to move the correction subframe on the Tip-Tilt sensor to compensate for telescope offsets. If the TIPTILT parameter is not set, the STAGE_OFFSET parameter is ignored.



CASPIR/XY_SCALE_FACTOR=value

back to top

Sets the multiplicative scale factor applied to nominal IMB X-Y stage offsets to accurately move the X-Y stage by the required angular distance on the sky. The nominal image scale for the X-Y stage is 5''/mm.



CASPIR/ABORT

back to top

The /ABORT qualifier aborts the current run and DO sequence.



CASPIR/ISUBTRACT=filename

back to top

Reads an image data file from IR_DATA: and downloads it to the transputers. They will subtract the image from every idle mode image that is uploaded to the VAX for display. This is used for sky subtraction. Specify a filename of `none' to switch off subtraction.



CASPIR/IDIVIDE=filename

back to top

Reads an image data file from IR_DATA: and downloads it to the transputers. They will divide every idle mode image by this image before uploading it to the VAX for display. This is used for flatfield correction. Specify a filename of `none' to switch off division.



CASPIR/IZMINIMUM=value

back to top

Lower bound for transputers to use when scaling idle mode data for display. This qualifier turns off idle Z autoscaling. It cannot be specified with the /ZAUTOSCALE qualifier.



CASPIR/IZMAXIMUM=value

back to top

Upper bound for transputers to use when scaling idle mode data for display. This qualifier turns off idle Z autoscaling. It cannot be specified with the /ZAUTOSCALE qualifier



CASPIR/[NO]IZAUTOSCALE

back to top

The /IZAUTOSCALE qualifier forces the transputers to calculate appropriate values for IZMINIMUM and IZMAXIMUM automatically. It cannot be specified with the /IZMINIMUM or /IZMAXIMUM qualifiers. The /NOIZAUTOSCALE qualifier turns off automatic calculation of minimum and maximum values.



CASPIR/SUBTRACT=filename

back to top

Reads an image data file from IR_DATA: and downloads it to the transputers. They will subtract the image from every run mode image that is uploaded to the VAX for display. This is used for sky subtraction. Specify a filename of `none' to switch off subtraction. Data written to the data file does not have this subtraction performed.



CASPIR/DIVIDE=filename

back to top

Reads an image data file from IR_DATA: and downloads it to the transputers. They will divide every run mode image by this image before uploading it to the VAX for display. This is used for flatfield correction. Specify a filename of `none' to switch off division. Data written to the data file does not have this subtraction performed.



CASPIR/ZMINIMUM=value

back to top

Lower bound for transputers to use when scaling run mode data for display. This qualifier turns off Z autoscaling. It cannot be specified with the /ZAUTOSCALE qualifier



CASPIR/ZMAXIMUM=value

back to top

Upper bound for transputers to use when scaling run mode data for display. This qualifier turns off Z autoscaling. It cannot be specified with the /ZAUTOSCALE qualifier



CASPIR/[NO]ZAUTOSCALE

back to top

The /ZAUTOSCALE qualifier forces the transputers to calculate appropriate values for ZMINIMUM and ZMAXIMUM automatically. It cannot be specified with the /ZMINIMUM or /ZMAXIMUM qualifiers. The /NOZAUTOSCALE qualifier turns off automatic calculation of minimum and maximum values.



CASPIR/SHOW=image_name

back to top

This qualifier selects the type of image that is to be displayed on the CASPIR Run Display. The image names available are:

      CURRENT  - the most recently obtained frame.
      MEAN     - the mean of all repeats in the current run so far.
When Nod mode is used, selecting CASPIR/SHOW=MEAN causes average of the accummulated difference images to be displayed.



CASPIR/DISPLAY [=status_screen]

back to top

Requests that the IR Status display change to the specified display screen. Allowed values for status_screen are:

      COMMUNICATIONS  - the IR communications display
      MAIN            - the CASPIR main display
      MISC            - the CASPIR miscellaneous display
      VOLTAGES        - the CASPIR SBRC voltages display
Specifying /DISPLAY without supplying a value for status_screen is equivalent to specifying /DISPLAY=MAIN



CASPIR/INFORMATION

back to top

Requests that a copy of the CASPIR Main and Miscellaneous display screens be written to the terminal.



CASPIR/OBJECT_NAME=[string]

back to top

Sets the object name for the current (or next) run to the string supplied. The object name appears on the main CASPIR display screen, and is written to the data file at the end of the exposure. If /OBJECT_NAME is not specified, the object name obtained from the telescope system is used. This is the name that was in the coordinate file, or the name that was specified in the coordinate string supplied to the TRACK/COORDINATE command. If no object name is obtained from the telescope system, a default name is generated.

If /OBJECT_NAME is specified without supplying a string, any previously specified object name is cancelled and the name obtained from the telescope system (or a default name) used instead.



CASPIR/VOLTAGES [=keyword]

back to top

Reads back the array voltages from the SBRC box, or switches them off, or back on. Allowed values for voltages_keyword are:

      READ, ON, and OFF.
If /VOLTAGES is specified without a keyword, it is equivalent to /VOLTAGES=READ.

This qualifier cannot be specified with the /DETECTOR, /CSET, /BSET, /VPREAMP, /VSIGOFF or /VREFOFF qualifiers.



CASPIR/BSET=(bias_line=bias_voltage [,...])

back to top

Sets the specifed bias voltage(s) to the specified value(s). Allowed values for bias_line are:

      VDDOUT_ON,  VDDOUT_OFF, VDDUC,      VGG_ON,     VGG_OFF, 
      VDET,       V3

This qualifier cannot be specified with the /VOLTAGES qualifier.



CASPIR/CSET=(clock_name=(high_voltage, low_voltage), [,...])

back to top

Sets the high and low voltages of the specified clock(s) to the specified values. Allowed clock names are:

      PHI_SYNC_SLOW,    PHI_1_SLOW,       PHI_2_SLOW,       
      PHI_SYNC_FAST,    PHI_1_FAST,       PHI_2_FAST,       
      PHI_RESET
This qualifier cannot be specified with the /VOLTAGES qualifier.



CASPIR/DETECTOR=detector_state

back to top

The qualifier /DETECTOR=SHORTED sets the SBRC voltages to OFF, and shorts out the detector (leaving it in a electrically safe state). The qualifier /DETECTOR=ENABLED re-enables the detector for normal observing.

This qualifier cannot be specified with the /VOLTAGES, /BSET, or /CSET qualifiers.



CASPIR/VPREAMP=value

back to top

Sets the Preamp Reset voltage. This qualifier cannot be specified with the /VOLTAGES qualifier.



CASPIR/VREFOFF=value

back to top

Sets the Reference Offset voltage. This qualifier cannot be specified with the /VOLTAGES qualifier.



CASPIR/VSIGOFF=value

back to top

Sets the Signal Offset voltage. This qualifier cannot be specified with the /VOLTAGES qualifier.



CASPIR/[NO]DEBUG

back to top

Turns debugging messages on or off.



CASPIR/HIBERNATE

back to top

Causes CASPIR to relinquish ownership of the IR system and go to sleep.



CASPIR/INITIALIZE

back to top

Reloads SBRC voltages and analog settings from the array parameter file.



CASPIR/LCA

back to top

Downloads a new LCA file to the SBRC box.



CASPIR/TIMING=filename

back to top

Downloads a new timing file to the SBRC box.



CASPIR/RSPEED=readout_speed

back to top

Sets the readout speed to the value specified. The value must be in the range 0-4095.



CASPIR/[NO]DIFFERENCE_MODE

back to top

The /DIFFERENCE_MODE qualifier changes the operating mode of CASPIR to a diagnostic mode in which the Current array (or ICurrent array) is automatically copied directly into the Subtract array (or ISubtract array) at the time that it is uploaded to the VAX. Used in conjunction with the /CHANNEL_STATISTICS qualifier, this enables the transputers to generate statistics about the difference between the current frame and the previous frame.

The /NODIFFERENCE_MODE qualifier restores normal operation.



CASPIR/[NO]CHANNEL_STATISTICS

back to top

The /CHANNEL_STATISTICS qualifier enables transputer statistics calculations. As each frame is uploaded from the transputers to the VAX, the transputers calculate and upload basic statistics, which are broadcast to the messages display. Used in conjunction with the /DIFFERENCE_MODE qualifier this can be useful for noise comparison tests.

The /NOCHANNEL_STATISTICS qualifier disables these calculations (i.e., restores normal operation).



CASPIR/[NO]SLOG

back to top

The /SLOG qualifier causes transputer statistics to be written to a file in the data directory. The /NOSLOG qualifier disables this.



CASPIR/GAIN=gain_value

back to top

Sets the combination of Preamp and Postamp Gains  to achieve the requested gain value. Allowed gain values are:

   2, 5, 10, 20, 50, 100
This qualifier cannot be specifed with the /PREAMP_GAIN qualifier or the /POSTAMP_GAIN qualifier.



CASPIR/POSTAMP_GAIN=gain_value

back to top

Sets the postamp gain  to the value specified. Allowed values are:

    1, 2, 5, 10
This qualifier cannot be specifed with the /GAIN qualifier.



CASPIR/PREAMP_GAIN=gain_value

back to top

Sets the preamp gain  to the value specified. Allowed values are:

    2, 5, 10
This qualifier cannot be specifed with the /GAIN qualifier.



CASPIR/ADC_BW=bandwidth

back to top

Sets the ADC bandwidth to the value specified. Allowed values are:

      LOW,        MEDIUM,     HIGH



CASPIR/[NO]SIMULATE

back to top

Sets the transputers to simulate mode.



CASPIR/SIM0=filename

back to top

Loads the file into the transputers' ''Simulate 0'' array.



CASPIR/SIM1=filename

back to top

Loads the file into the transputers' ''Simulate 1'' array.



CASPIR/SIM2=filename

back to top

Loads the file into the transputers' ''Simulate 2'' array.



CASPIR/SIM3=filename

back to top

Loads the file into the transputers' ''Simulate 3'' array.



CASPIR/SIM4=filename

back to top

Loads the file into the transputers' ''Simulate 4'' array.



CASPIR/SIM5=filename

back to top

Loads the file into the transputers' ''Simulate 5'' array.



CASPIR/PORT=port_number

back to top

Tells the system which IMB port CASPIR is mounted on. This is usually determined by interrogating the hardware on startup.



CASPIR/[NO]TELESCOPE

back to top

If the system is being run in isolation from the telescope, the /NOTELESCOPE qualifier should be used to avoid attempts to issue telescope control commands.