OGIP sample notebook.ipynb

{
 "cells": [
  {
   "cell_type": "code",
   "execution_count": 1,
   "metadata": {
    "collapsed": false
   },
   "outputs": [],
   "source": [
    "# put the ogip.py file in your $PYTHON_PATH\n",
    "\n",
    "#from ogip.ogip_dictionary import *\n",
    "from ogip.ogip_dictionary import *\n"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 2,
   "metadata": {
    "collapsed": false
   },
   "outputs": [],
   "source": [
    "# this will return the docstring help describing this python function\n",
    "ogip_dictionary?"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 3,
   "metadata": {
    "collapsed": true
   },
   "outputs": [],
   "source": [
    "# this returns the dictionary schema defining the \n",
    "# FITS TIMING file format - the only one that currently works!\n",
    "timing_dictionary=ogip_dictionary('TIMING') "
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 4,
   "metadata": {
    "collapsed": false
   },
   "outputs": [
    {
     "data": {
      "text/plain": [
       "['REFERENCE', 'GTI', 'TIMEREF', 'RATE', 'ENEBAND', 'EVENTS']"
      ]
     },
     "execution_count": 4,
     "metadata": {},
     "output_type": "execute_result"
    }
   ],
   "source": [
    "# the keys of the dictionary are the possible file extensions\n",
    "# \n",
    "timing_dictionary.keys()\n"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 5,
   "metadata": {
    "collapsed": false
   },
   "outputs": [
    {
     "data": {
      "text/plain": [
       "'OGIP/93-003'"
      ]
     },
     "execution_count": 5,
     "metadata": {},
     "output_type": "execute_result"
    }
   ],
   "source": [
    "timing_dictionary['REFERENCE']"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 6,
   "metadata": {
    "collapsed": false
   },
   "outputs": [
    {
     "data": {
      "text/plain": [
       "['TIME', 'RATE|COUNTS']"
      ]
     },
     "execution_count": 6,
     "metadata": {},
     "output_type": "execute_result"
    }
   ],
   "source": [
    "# get the  required columns.  \n",
    "# Allowed variants of required columns are separated by a pipe \"|\"\n",
    "timing_dictionary['RATE']['COLUMNS']['REQUIRED']"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 7,
   "metadata": {
    "collapsed": false
   },
   "outputs": [
    {
     "data": {
      "text/plain": [
       "['TELESCOP',\n",
       " 'INSTRUME',\n",
       " 'DATE-OBS',\n",
       " 'DATE-END',\n",
       " 'ONTIME',\n",
       " 'TIMEZERO|TIMEZERI+TIMEZERF',\n",
       " 'TSTART|TSTARTI+TSTARTF',\n",
       " 'TSTOP|TSTOPI+TSTOPF',\n",
       " 'TIMESYS',\n",
       " 'TIMEUNIT',\n",
       " 'TIMEREF',\n",
       " 'HDUCLASS[OGIP]',\n",
       " 'HDUCLAS1[LIGHTCURVE]']"
      ]
     },
     "execution_count": 7,
     "metadata": {},
     "output_type": "execute_result"
    }
   ],
   "source": [
    "# get the required keywords\n",
    "# Allowed variants of required columns are separated by a pipe \"|\"\n",
    "# values for compound variants are separated by \"+\"\n",
    "# for example you can specify TSTART or TSTARTI+TSTARTF as header keywords\n",
    "#\n",
    "timing_dictionary['RATE']['KEYWORDS']['REQUIRED'] "
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 11,
   "metadata": {
    "collapsed": false
   },
   "outputs": [],
   "source": [
    "filename=\"/Users/mcorcora/Downloads/rp200069n00_ltc.fits\"\n",
    "hdu=pyfits.open(filename)"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 17,
   "metadata": {
    "collapsed": false
   },
   "outputs": [
    {
     "data": {
      "text/plain": [
       "'LC0031'"
      ]
     },
     "execution_count": 17,
     "metadata": {},
     "output_type": "execute_result"
    }
   ],
   "source": [
    "hdu[2].header['EXTNAME']\n"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 18,
   "metadata": {
    "collapsed": false
   },
   "outputs": [
    {
     "name": "stdout",
     "output_type": "stream",
     "text": [
      "Filename: /Users/mcorcora/Downloads/rp200069n00_ltc.fits\n",
      "No.    Name         Type      Cards   Dimensions   Format\n",
      "0    PRIMARY     PrimaryHDU      47   ()              \n",
      "1    STDGTI      BinTableHDU     75   4R x 3C      [1D, 1D, 1I]   \n",
      "2    LC0031      BinTableHDU    214   39R x 6C     [1E, 1E, 1E, 1E, 1E, 1E]   \n",
      "3    LC0042      BinTableHDU    214   39R x 6C     [1E, 1E, 1E, 1E, 1E, 1E]   \n",
      "4    LC0044      BinTableHDU    214   39R x 6C     [1E, 1E, 1E, 1E, 1E, 1E]   \n",
      "5    LC0055      BinTableHDU    214   39R x 6C     [1E, 1E, 1E, 1E, 1E, 1E]   \n",
      "6    LC0064      BinTableHDU    214   39R x 6C     [1E, 1E, 1E, 1E, 1E, 1E]   \n",
      "7    LC0075      BinTableHDU    214   39R x 6C     [1E, 1E, 1E, 1E, 1E, 1E]   \n",
      "8    LC0084      BinTableHDU    214   39R x 6C     [1E, 1E, 1E, 1E, 1E, 1E]   \n"
     ]
    }
   ],
   "source": [
    "hdu.info()"
   ]
  }
 ],
 "metadata": {
  "kernelspec": {
   "display_name": "Python 2",
   "language": "python",
   "name": "python2"
  },
  "language_info": {
   "codemirror_mode": {
    "name": "ipython",
    "version": 2
   },
   "file_extension": ".py",
   "mimetype": "text/x-python",
   "name": "python",
   "nbconvert_exporter": "python",
   "pygments_lexer": "ipython2",
   "version": "2.7.11"
  }
 },
 "nbformat": 4,
 "nbformat_minor": 0
}