PFIS Home > Documents > Code 3170: Operations

This is a concept for the XML (eXtensible Markup Language) documents that will be produced by the PFIS PI Planning Tool (PIPT), stored in the Project Data Base (PDB), and sent to the PFIS Control System (PCS). So you could say this is the SALT PFIS PIPT/PDB/PCS XML (SPPPPX) concept specification

I don't know XML very well yet, so this is "pseudo-xml".

• Observation
• Modes
• Procedures
• Examples
• PIPT Inputs and Outputs
• Slitmask Definition Documents

A PFIS Observation would look like this:

• <observation>
  • <observation-id>string</observation-id>
  • <header>
    • <proposal-id>string</proposal-id>
    • <pi-name>string</pi-name>
    • <pi-institution>string</pi-institution>
  • </header>
  • <configuration>
    • <mode-im -sp -fp>
      • <comment>mode elements appear here</comment>
    • </mode-xx>
    • <pol-mode>none, linear, circular, all-stokes</pol-mode>
    • <slitmask-name>string</slitmask-name>
    • <filter-name>string</filter-name>
    • <focus-position>float</focus-position>
    • <ccd>
      • <binning>string</binning>
      • <speed>string</speed>
      • <windows>
        • <window>
          • <x>int</x>
          • <y>int</y>
          • <dx>int</dx>
          • <dy>int</dy>
        • </window>
      • </windows>
    • </ccd>
  • </configuration>
  • <procedure>
    • <interactive>yes/no</interactive>
    • <proc-nro, -ftr, -dsr, -pol, -f-p, -k-t, -foc>
    • </proc-xxx>
  • </procedure>
• </observation>

Modes

PFIS has 3 mutually exclusive mechanical configurations:

• Imaging
• Grating Spectroscopy
• Fabry-Perot Spectroscopy.

One of the following would appear:

• <mode-im>
  • <comment there are no special features for this mode>
• </mode-im>

or

• <mode-sp>
  • <grating-name>string</grating-name>
  • <grating-angle>float</grating-angle>
  • <articulation-station>string</articulation-station>
• </mode-sp>

or

• <mode-fp>
  • <fp-mode>low, medium, high</fp-mode>
• </mode-fp>

Procedures

Seven procedures suffice to describe PFIS observing styles

• proc-nro - normal readout imaging or grating spectroscopy
• proc-ftr - frame transfer (high-speed) readout imaging or grating spectroscopy
• proc-dsr - drift-scan readout imaging or grating spectroscopy
• proc-pol - normal readout polarimetric imaging or grating spectroscopy
• proc-f-p - normal readout fabry-perot spectroscopy
• proc-k-t - normal readout polarimetric fabry-perot spectroscopy
• proc-foc - normal readout focus sequence

The first 3 procedures are alike because they only differ in CCD usage. No PFIS parts are moved during these procedures. The last 4 procedures each operate PFIS mechanisms during the procedure.

Use one of the following:

• <proc-nro>
  • <comment>normal readout imaging or grating spectroscopy</comment>
  • <frame-count>int</frame-count>
  • <exposure-time>int</exposure-time>
• </proc-nro>

or

• <proc-ftr>
  • <comment>frame transfer readout imaging or grating spectroscopy</comment>
  • <frame-count>int</frame-count>
  • <frame-time>int</frame-time>
  • <frame-size>int</frame-size>
• </proc-ftr>

or

• <proc-dsr>
  • <comment>drift-scan readout imaging or grating spectroscopy</comment>
  • <exp-time = int>
  • <drift-rate = int>
• </proc-dsr>

or

• <proc-pol> // normal readout polarimetric imaging or grating spectroscopy
  • <rep-count>int</rep-count>
  • <frame-count>int</frame-count>
  • <exposure-time>int</exposure-time>
  • <hwp-pattern>
    • <station>int</station>
    • <station>int</station>
    • <station>int</station>
    • <station>int</station>
  • </hwp-pattern>
  • <qwp-pattern>
    • <station>int</station>
    • <station>int</station>
    • <station>int</station>
    • <station>int</station>
  • </qwp-pattern>
• </proc-pol>

or

• <proc-f-p>
• <comment>normal readout fabry-perot spectroscopy</comment>
  • <rep-count>int</rep-count>
  • <frame-count>int</frame-count>
  • <exposure-time>int</exposure-time>
  • <et1-pattern>
    • <wavelength-start>int</wavelength-start>
    • <wavelength-step>int</wavelength-step>
  • </et1-pattern>
  • <et2-pattern>
  • • <wavelength-start>int</wavelength-start>
    • <wavelength-step>int</wavelength-step>
  • </et2-pattern>
• </proc-f-p>

or

• <proc-k-t>
  • <comment>normal readout polarimetric fabry-perot spectroscopy </comment>
  • <rep-count>int</rep-count>
  • <frame-count>int</frame-count>
  • <exposure-time>int</exposure-time>
  • <hwp-pattern>
    • <station>int</station>
    • <station>int</station>
    • <station>int</station>
    • <station>int</station>
  • </hwp-pattern>
  • <qwp-pattern>
    • <station>int</station>
    • <station>int</station>
    • <station>int</station>
    • <station>int</station>
  • </qwp-pattern>
  • <et1-pattern>
    • <wavelength-start>int</wavelength-start>
    • <wavelength-step>int</wavelength-step>
  • </et1-pattern>
  • <et2-pattern>
  • • <wavelength-start>int</wavelength-start>
    • <wavelength-step>int</wavelength-step>
  • </et2-pattern>
• </proc-k-t>

or

• <proc-foc>
  • <comment>normal readout focus sequence</comment>
  • <rep-count>int</rep-count>
  • <frame-count>int</frame-count>
  • <exposure-time>int</exposure-time>
  • <focus-pattern>
    • <focus-start>float</focus-start>
    • <focus-step>float</focus-step>
  • </focus-pattern>
• </proc-foc>

Example Observations

1. Simple Image, using defaults

• <observation>
  • <procedure>
    • <proc-nro>
      • <exposure-time>30</exposure-time>
    • </proc-nro>
  • </procedure>
• </observation>

2. Simple Image, changing some defaults

• <observation>
  • <configuration>
    • <ccd>
      • <binning>2x2</binning>
    • </ccd>
  • </configuration>
  • <procedure>
    • <proc-nro>
      • <frame-count>2</frame-count>
      • <comment>for cosmic-ray splitting</comment>
      • <exposure-time>30</exposure-time>
    • </proc-nro>
  • </procedure>
• </observation>

3. Simple Grating Spectroscopy

• <observation>
  • <configuration>
    • <mode>sp</mode>
      • <mode-sp>
      • • <grating-name>3000</grating-name>
        • <grating-angle>29 degrees></grating-angle>
        • <articulation-station>76 (58.00 degrees)</articulation-station>
      • </mode-sp>
    • </mode>
  • </configuration>
  • <procedure>
    • <proc-nro>
      • <exposure-time>900</exposure-time>
    • </proc-nro>
  • </procedure>
• </observation>

4. High-Speed Grating Spectroscopy

• <observation>
  • <configuration>
    • <mode>
      • <mode-sp>
        • <grating-name>3000</grating-name>
        • <grating-angle>29 degrees</grating-angle>
        • <articulation-station>76 (58.00 degrees)</articulation-station>
      • </mode-sp>
    • </mode>
    • <mask-name>FT-64</mask-name>
    • <ccd>
      • <speed>high</speed>
    • </ccd>
  • </configuration>
  • <procedure>
    • <proc-ftr>
      • <frame-count>1000</frame-count>
      • <frame-time>10</frame-time>
      • <frame-size>64</frame-size>
    • </proc-ftr>
  • </procedure>
• </observation>

5. Simple Imaging Circular Polarimetry

• <observation>
  • <configuration>
    • <pol-mode>circular</pol-mode>
  • </configuration>
  • <procedure>
    • <proc-pol>
      • <rep-count>8</rep-count>
      • <frame-count>2</frame-count>
      • <exposure-time>30</exposure-time>
    • </proc-pol>
  • </procedure>
• </observation>

6. Polarimetric Fabry-Perot Polarimetric Spectroscopy, changing many defaults

• <observation>
  • <configuration>
    • <mode>
      • <mode-fp>
        • <fp-mode>hi</fp-mode>
      • </mode-fp>
    • </mode>
    • <pol-mode>circular</pol-mode>
    • <mask-name>POL</make-name>
    • <filter-name>IF-1</filter-name>
    • <ccd>
      • <binning>1x2</binning>
    • </ccd>
  • </configuration>
  • <procedure>
    • <proc-k-t>
      • <rep-count>8</rep-count>
      • <hwp-pattern = 0, 0, 2, 2, 4, 4, 6, 6>
      • <hwp-pattern>
        • <station>0</station>
        • <station>0</station>
        • <station>2</station>
        • <station>2</station>
        • <station>4</station>
        • <station>4</station>
        • <station>6</station>
        • <station>6</station>
      • </hwp-pattern>
      • <qwp-pattern>
        • <station>0</station>
        • <station>0</station>
        • <station>2</station>
        • <station>2</station>
        • <station>4</station>
        • <station>4</station>
        • <station>6</station>
        • <station>6</station>
      • </qwp-pattern>
      • <frame-count>2</frame-count>
      • <exposure-time>10</exposure-time>
    • </proc-k-t>
  • </procedure>
• </observation>

PIPT Inputs and Outputs

The PFIS PI Proposal Tool will be embedded in the SALT PIPT. The SALT PIPT will pass parameters describing the observation into the PFIS PIPT. The Phase I PFIS PIPT will simulate a target observation and calculate details such as signal-to-noise ratios, exposure times, and so on. The Phase II PFIS PIPT will produce detailed products such as observation control documents (see above) and slitmask definition files.

PIPT Input:

• <target>
  • <target-name>string</target-name>
  • <exposure-time>float</exposure-time>
  • <effective-area>float</effective-area>
  • <track (for center of track)>
    • <julian-date>float</julian-date>
    • <zenith-distance>float</zenith-distance>
    • <ll>float</ll> <comment>ecliptic longitude</comment>>
    • <lb>float</lb> <comment>ecliptic latitude</comment>
    • <lunar-z>float</lunar-z> <comment>lunar zenith angle</comment>
    • <lunar-beta>float <comment>lunar phase angle, 0 = full</comment>
    • <target-rho>float</target-rho> <comment>target-moon separation</comment>>
  • </track>
• </target>

PIPT Output:

• <pipt>
  • <spectrum>
    • <wavelength, spectrum-flux, spectrum-snr, sky-flux, sky-snr>
    • ...
  • </spectrum>
  • <observation>
    • <see above>
  • </observation>
  • <slitmask-definition-doc>
    • <see below>
  • </slitmask-definition-doc>
• </pipt>

Slitmask Definition Documents

(I forget what Daniel has for this. Until we talk, this is just a starter)

• <slitmask-definition-doc>
  • <slitmask-name>string</slitmask-name>
  • <header>
    • <see above>
  • </header>
  • <slits>
    • <slit>
      • <x>float</x>
      • <y>float</y>
      • <dx>float</dx>
      • <dy>float</dx>
    • </slit>
  • </slits>
  • <arcs>
    • <arc>
      • <x>float</x>
      • <y>float</y>
      • <radius>float</radius>
      • <angle>float</angle>
    • </arc>
  • </arcs>
• </slitmask-definition-doc>