from asap._asap import sdreader

class reader(sdreader):
    """
    This class allows the user to import single dish files
    (rpfits,sdfits,ms).
    Available functions are:

    read(integrations)
    summary    CURRENTLY DISABLED

    Example:
        r = reader('/tmp/P389.rpf')
        scans r.read() # reads in the complete file into 'scans'
        print scans    # summarises the contents
        del r          # destroys the reader
    """

    def __init__(self, filename):
        """
        Parameters:
            filename:    the name of an rpfits/sdfits/ms file on disk
        Example:
            r = reader('/tmp/2001-09-01_0332_P363.rpf')
        """
        sdreader.__init__(self, filename)

    def read(self,integrations=None):
        """
        Reads in an returns a specified sequence of integrations.
        If no list is given all integrations a read in.
        Parameters:
            integrations:    a 'range' of integration numbers, e.g.
                             range(100) or [0,1,2,3,4,10,11,100]
        Example:
            r.read([0,1,2,3,4])    # reads in the first 5 integatrions
                                   # NOT scans
            r.read(range(100))     # read in the first 100 integrations
        """
        from asap import scantable
        if integrations is None:
            integrations = [-1]
        sdreader.read(self,integrations)
        tbl = sdreader.getdata(self)
        return scantable(tbl)

    def summary(self):
        print "Disabled"
        return
        sdreader.reset(self)
        sdreader.read([-1])
        sdreader.reset(self)
        tbl = sdreader.getdata(self)
        print tbl.summary()