The Format

The current (as of March 2017) format of FRAMEID is the following.

　"%3s%1s%08d" % (instrument, data_type, frame_number)

• instrument - A three (3) letter instrument code. This is the primary key to distinguish instruments in the database. Here is the current instrument codes.

    Facility Instruments
    Instrument      instrument code
  ----------------------------------------
  　　AO188           AON
  　　COMICS          COM
  　　FOCAS           FCS
  　　HDS             HDS
  　　HSC             HSC
  　　IRCS            IRC
  　　MOIRCS          MCS
  　　PFS             PFS
  　　VGW             VGW
  
    Visitor Instruments
    Instrument 	  instrument code
  ----------------------------------------
     CHARIS           CRS
     HiCIAO           HIC
     IRD              IRD
     MIMIZUKU         MZK
     SCExAO           SCX
     SWIMS            SWS
  
    Decommissioned Facility Instruments
    Instrument      instrument code
  ----------------------------------------
      AO36            AOS
      CIAO            CIA
      CISCO/OHS       OHS
      FMOS            FMS
      SUKA            SUK
      Suprime-Cam     SUP
  
    Decommissioned Visitor Instruments
    Instrument      instrument code
  ----------------------------------------
      Kyoto3D-II      K3D
      RAVEN           
  
    Test Instruments
    Instrument      instrument code
  ----------------------------------------
      CAC             CAC
      MIRTOS          MIR
      VTOS            VTO1
  

  
  note: The instrument code VTOS1 for decommissioned instrument VTOS is treated as the only exception.

• data_type - A single letter code to define the data type of each FITS file. Letters allowed for data_type should be pre-defined for each instrument in a dictionary and there are pre-defined letters, {'A': 'raw frame', 'E': reserved for EXP-ID key, 'Q': 'quickly-processed frame', 'Z': 'reserved by SMOKA'}. E and Z cannot be used in any case. It is not mandatory for instruments to use A and Q, but A and Q cannot be used for different data types when used. Each instrument team must define a dictionary of the data_type in advance of the first data transfer test, and make an agreement with the Subaru Telescope. Here is a description on instrument-specific data_type dictionaries.

  
  

  Datatype Dictionaries
  
  　　Default Use
  
        Letter      Datatype
      ----------------------------------------
          A           raw frame
          Q           quickly-processed frame
  
  
  　　Non-default dictionaries
  
  　　　・HSC
  
             Letter  Datatype
           ------------------------------------
               A       raw frame
               B       raw frame
               Q       quickly-processed frame
  
  
  　　　・PFS
  
  　　　　  TBD
  
  
  　　　・SWIMS
  
  　　　　   Letter  Datatype
  　　　　----------------------------------------------------------------------
               B       raw science frame from the blue channel
               C       MEF file containing two FITS cubes from the blue channel
               R       raw science frame from the red channel
               S       MEF file containing two FITS cubes from the red channel
  

• frame_number - A 8 digit incremental frame number in the decimal system. frame_number must be unique to each frame taken with an instrument. The largest significant digit has reserved numbers as follows.

  ・

  0 to 6 - Raw frames

  ・

  7 and 8 - Simulated frames

  ・

  9 - Engineering frames

  Engineering frames that require a special discussion by the Subaru Telescope to be made publicly accessible.

  ・

  Default use
  If an instrument generates only one FITS file per exposure, frame_number is simply an incremental 8digit number with the decimal system. For example, the frame_number of the next exposure of frame_number = 00000100 is 00000101.

  
  
  
  

  ・

  Instrument-Specific use
  Some of the instruments at the Subaru Telescope produce more than one frames per exposure. In this case, the structure and increment of frame_number may be instrument-dependent. Some examples are described below.

  ◆

  HSC
  HSC produces 116 FITS files (4 of them will not be distributed) per exposure separated into two 58 sequences. The two last significant digits of frame_number are used to specify each CCD, while the third last significant digit is used to distinguish the 58 number sequence. The first six digit number is also used to identify the exposure as well as the sequence if it is an even number. If the first six digit number is an odd number, it indicates the other sequence. Therefore, frame_number of HSC is incremented by 200 per exposure. For the detailed information, please refer the CCD information of the instrument's web site (https://www.naoj.org/Observing/Instruments/HSC/index.html).

  ◆

  MOIRCS
  MOIRCS produces two FITS files corresponding to those taken with channel-1 and channel-2. These two FITS files are saved separately with odd and even number frame_number corresponding to channel-1 and channel-2, respectively.

  ◆

  Suprime-Cam
  Suprime-Cam produces ten FITS files per exposure. The last significant digit of frame_number is assigned to specify each CCD. The frame_number of Suprime-Cam, therefore, consists of the first 7 digits to identify the exposure and the last digit to identify the CCD, and frame_number is incremented by ten per exposure. See the CCD information of the instrument's web site (https://www.naoj.org/Observing/Instruments/SCam/index.html) for the details.