B&C GUI Software Documentation

The Observatories of the Carnegie Institution for Science (Carnegie Observatories), Pasadena, CA

Version 3.1

Christoph C. Birk (birk AT carnegiescience DOT edu)


Location of this document: http://instrumentation.obs.carnegiescience.edu/Software/BNC/bnc3gui.html


  • News
  • GUI Documentation

  • The official B&C User Manual (LCO)
  • bncgui (deprecated X11 GUI)
  • CCDserver documentation


    News

    3.1.1 (2019-06-21)
  • Deployment target macOS 10.13 (HighSierra).
  • Some minor bug fixes.
  • v3.1 (2018-05-24)
  • Modified the "subraster" record of the FITS header to indicate the actual subraster geometry even if the full ('0' padded) frame is saved.
  • SUBRASTR='[x1:x2,y1:y2]'
  • "Trim bias section from loaded FITS files" option on the Preferences/QuickLook pane.
  • This allows to display the bias sections (overscan and biaslines) in the QuickLookTool for FITS files loaded from disk (not for data directly read from the array).
    Release Notes


    Screen Shots and GUI Documentation

    Configuration - Main Menu - B&C-GUI - QuickLook - Preferences - Scripting


    Configuration Window

    Observer: observer's name
    CCD: {Marconi#1} is currently the only choice for the B&C instrument.
    Overscan: number of overscan pixels at the end of the readout line.
    Biaslines: number of bias lines after the CCD lines.
    CCD: {online,simulator}
    Status of the CCD electronics.
    B&C: {online,offline}
    Status of the BnC hardware (prism and decker controller).
    Telescope/TCS: {online,offline}
    Provides telescope coordinates for the FITS header.
    M2-GUI: {online,offline}
    Provides focus and flat-field lamp status for the FITS header.

    CCD-Server: host name of the computer that is running the 'bncserver'.
    B&C: host name of the duPont IMB electronics.
    TCS: host name of the duPont telescope control system.
    M2-GUI: host name of the computer where the M2-GUI is running.


    Main Menu

    Preferences: Opens the Preferences window.
    Load FITS: Load a FITS file into the QuickLook tool.
    Show Logfile: Displays the B&C logfile in the Console application.
    Show DataFolder: Opens the data path folder(s) in a Finder window.
    Show AppSupport: Opens the Application Support folder in a Finder window.
    This folder is the default location for Subrasters and Scripts.
    DataPaths: Opens a window that allows to set the data path for the FITS files.
    QuickLook Tool: Opens the QuickLook window.
    Dewar Status: Opens the Dewar Status window.
    CCD Hardhat: Opens the CCD Hardhat window.
    File Number: Makes the File number edit window on the B&C-GUI editable.
    Please press the Enter key after you change the file number.
    Software Documentation: Opens this document in a web-browser.
    User Manual: Opens the official B&C user manual in a web-browser.


    B&C Camera/Instrument Window

    DataPaths - DewarStatus - CCD Hardhat

    ExpTime: sets the exposure time (1..8200 seconds)
    Loops: number of exposures per sequence
    ExpType: sets the exposure type
    { Object, Bias, Dark, Flat }
    Readout: sets the readout mode
    { Full, Subraster }
    Binning: sets the binning for the X,Y directions
    { 1, 2, 3, 4 }
    Speed: sets the readout speed/gain combination

    Decker: move the Decker to the position indicated by the button/edit.
    Prism: move the Prism to the position indicated by the button/edit.
    H-C,Neon,HeAr: turn on/off the calibrations lamps.
    Auto: Automatically moves the prism to the '0' position whenever any calibration lamp is turned on,
    and to '100' when the last lamp is turned off .

    Object: OBJECT value in the FITS header
    Comment: COMMENT value in the FITS header
    Start: starts a loop sequence of Loops exposures
    Snap: takes a single exposure in NxM binning.
    The binning (NxM) may be set on the Preferences window.
    After the exposure the previous settings are automatically restored
    File: next file name number (ccdNNNN.fits).
    This number may be manually changed via the Camera--FileNumber entry of the Main Menu.
    Pause: close the shutter and stop the exposure timer.
    Resume: open the shutter and re-start the exposure timer.
    Stop: stops the current exposure, the shutter closes and the readout will start immediately.
    Abort: aborts the current readout (frame will be lost)

    Disk(s): disk status (left: primary, right: secondary)


    Data Paths

    Select the data path(s) for the FITS files.
    The Default button automatically sets the path following the standard at the duPont telescope.
    The Browse button opens a file selector that allows to set an optional secondary data path (eg. an external USB disk).


    Dewar Status

    Displays the status of the CCD temperature controller (run by the DSP code).


    CCD Hardhat

    Reset DSP/CCD-Server: Re-Load the DSP code.

    The controls below require the software to be in Engineering mode should only be used by the instrument specialists.
    CCD Voltages:
    CDST/Gain:


    Quick-Look Tool

    Left mouse button: moves the Magnifier window.
    Right mouse button: adjusts the contrast and level of the color map (SAOimage, DS9).
    Cursor keys: moves the Magnifier window by 1 pixel.
    If the shift or option key are held down the magnifier moves 5 pixels (25 if both are held down).
    Space-key: estimates the FWHM and flux of the object at the cursor position.
    a-key: adds a subraster at the cursor position if the Readmode is Subraster.
    r-key: removes the closest subraster to the cursor position if the Readmode is Subraster.
    Color: sets the color lookup table
    { Gray, BBdy, Rain, InvG }
    Stretch: sets the dynamic range of the scaling algorithm
  • cuts: manual data range (edit-boxes at the top and bottom)
  • med3: -3..+3 sigma around the background (median of frame)
  • med5: -5..+3 sigma around the background
  • 3/10: -3..+10 sigma around the background
  • mima: full data range
  • Pixel: The current cursor coordinates (center of the aperture and magnifier) and pixel value at the cursor position.
    Min/Max: Minimum and maxium pixel value within the aperture.
    Ave/Sig: Average and standard deviation within the aperture.
    FWHM/Flux: FWHM and flux estimate.
    Press the 'space' key while centered on a star to calculate an estimated FWHM and flux.
    Magnification: Magnification factor of the Magnifier window.
    Radius: Sets the radius for the aperture statistics (MinMax, AveSig above).


    Preferences

    Speak Error Messages: Makes the computer voice say "invalid exposure time" or similar.
    Engineering Mode: Certain features (eg. CCD-Voltages) are not available in user mode.
    The password which will be requested when switching to engineering mode.
    Email: The GUI sends an email if the CCD temperature rises more than 3 [C] above the setpoint.
    Shutter Closed: sound (text) that plays after the shutter closes.
    If the string is enclosed in single quotes it will be spoken by the computer,
    otherwise it will be interpreted as a path of a soundfile.
    Exposure Done: sound (text) that plays after the exposure has finished readout.
    Script Done: at the end of a (macro) script.
    Snap Binning: binning for Snap exposures.
    Saturation Level: pixels above this threshold will be displayed in red.
    Default Subraster: subraseter geometry when created by the QuickLook tool.
    Clear Display Before Readout: clears (black) the data display before the readout starts.
    If this option is not set, the new data just overwrites the previous display data as each line is readout.


    Scripting

    Macro scripts are simple ASCII files that will be executed sequentially; there are no loops or conditional branches.
    Any parameter that is not set within the script defaults to the current GUI value.

    If the filename starts with a '/' it is assumed to be an absolute path and is used directly as the macro file.
    If not, the GUI first looks in this path (common to all users!):

      /Users/Shared/Library/Application Support/BnC/Scripts
    
    If the file is not there, the GUI looks in the current home directory.

    When you create a new macro script please ensure its read/write privileges are set to chmod a+rw so that all observers may modify the script.

    exptime #
    set the exposure time to '#' seconds.
    loops
    set the number of exposures for the next exposure loop.
    exptype { Object , Bias, Dark, Flat }
    set the exposure type.
    object name
    set the object record in the FITS header to 'name'.
    comment text
    set the comment record in the FITS header to 'text'.
    start
    start the next exposure loop.
    move dx dy
    move the telescope by 'dx,dy' arc-seconds.
    coord dx dy
    move the telescope by 'dx,dy' arc-seconds and the guider box by '-dx,-dy'.


    Instrument Software Documentation Index


    2016-08-30, Christoph C. Birk, Carnegie Observatories