fplane – Focal plane

Base class for fplane file parsing and IFU.

This module provides a basic parser for the focal plane file and an object containing the informations about the IFU from the focal plane.

The focal plane is expected to be:

##IFUID x["]   y["] xpos ypos specid
001 -450.0  150.0 1 3 001
002 -450.0   50.0 1 4 002

Commented lines are ignored.

Use

The simplest use is to create a fplane instance passing the name of the focal plane file:

>>> fplane = FPlane("fplane.txt")  
>>> print(fplane.difus)  
{'001': <pyhetdex.het.fplane.IFU object at 0x7ff6a493c1d0>,
 '002': <pyhetdex.het.fplane.IFU object at 0x7ff6a493d1d0>, ...}

IFU Customisation

If you need to customise the IFU object, without changing the constructor signature, you can do something like this:

>>> class MyIFU(IFU):
...     def __init__(self, ifuid, x, y, xid, yid, specid):
...         super(MyIFU, self).__init__(ifuid, x, y, xid, yid, specid)
...         # do something else
...     def new_method(self, a_variable):
...         # implement
...         pass
>>> fplane = FPlane("fplane.txt", ifu_class=MyIFU)  

FPlane customisation

For more complex customisations, when you use a different way of storing the IFU informations, e.g. a list, a different __init__ signature, ..., you can override the FPlane.add_ifu() method:

>>> class MyFPlane(FPlane):
...     def add_ifu(self, line):
...         # reimplement at need
...         pass

Implementation

class pyhetdex.het.fplane.IFU(ifuid, x, y, xid, yid, specid)

Contain the information for the IFU from the focal plane file.

Parameters:

ifuid : string

id of the ifu

x, y : string or float

x and y position of the ifu in the focal plane

xid, yid : string or int

x (column) and y (row) id of the ifu in the ifu head mounting plate (IHMP)

specid : string

id of the spectrograph where the ifu is plugged into

Attributes

ifuid, x, y, xid, yid, specid	(as before)
ihmpid	(string) id of the IHMP seat address

class pyhetdex.het.fplane.FPlane(fplane_file, ifu_class=<class 'pyhetdex.het.fplane.IFU'>)

Focal plane.

Contains the dictionary of IFU instance (or derived or others), with the ifu id as key.

Parameters:

fplane_file : string

name of the file containing the ids and position of the IFUs

ifu_class : IFU instance (or anything else)

class definition containing the IFU information.

Attributes

ids	list of ifu ids
ifus	list of IFU instances
difus	dictionary of ifus; key: ifuid; value: IFU instance

_load_fplane(fname)

Load the focal plane file and creates the IFU instances

Parameters:

fname : string

name of the focal plane file

add_ifu(line)

Parse a fplane line and add the IFU to the internal dictionary.

Make sure that the ifuid, specid are a three digit string. Override this method if the ifu class constructor is not as the one of IFU.

Parameters:

line : string

line of the fplane file

difus

dictionary of ifus; key: ifuid; value: IFU instance

ids

list of ifu ids

ifus

list of IFU instances