Tutorial - Part #1 - The SingleImage Class

In this first tutorial the basics of the methods and properties of the SingleImage class are explained.

This object class represents the basic unit of data which we will manipulate. Basically it starts containing pixel data, with its mask. First lets create an instance of this class with a numpy array.



In [1]:

    
import numpy as np
import matplotlib.pyplot as plt

from properimage import single_image as s

%matplotlib inline



In [2]:

    
pixel = np.random.random((128,128))*5.
# Add some stars to it
star = [[35, 38, 35],
        [38, 90, 39],
        [35, 39, 34]]
for i in range(25):
    x, y = np.random.randint(120, size=2)
    pixel[x:x+3,y:y+3] = star

mask = np.random.randint(2, size=(128,128)) 
for i in range(10):
    mask = mask & np.random.randint(2, size=(128,128))
    
img  = s.SingleImage(pixel, mask)

We can see that the img object created automatically produces an output displaying the number of sources found.
This just accounts for sources good enough for PSF estimation, which is the first step for any processing ProperImage is intended for.

If we try to print the instance, (or obtain the representation output) we find that the explicit origin of the pixeldata is being displayed



In [3]:

    
print(img)









    



SingleImage instance for ndarray

If you would like to acces the data inside the object img just ask for pixeldata.



In [4]:

    
img.pixeldata









    Out[4]:





masked_array(
  data=[[3.861593008041382, 2.0196776390075684, 0.27352550625801086, ...,
         0.9212844371795654, 1.024159550666809, 2.9505748748779297],
        [3.7319023609161377, 1.8368569612503052, 3.98307466506958, ...,
         1.6425279378890991, 2.501436948776245, 0.09672260284423828],
        [1.8395156860351562, 4.079310894012451, 4.96801233291626, ...,
         4.896277904510498, 3.7164015769958496, 3.0924389362335205],
        ...,
        [1.3202760219573975, 1.7492672204971313, 1.7223570346832275, ...,
         2.6584722995758057, 0.4502115845680237, 2.220259428024292],
        [3.9587104320526123, 2.361539363861084, 4.72817850112915, ...,
         4.584884166717529, 0.1298598051071167, 1.552980661392212],
        [2.8541738986968994, 3.7570996284484863, 4.125792980194092, ...,
         2.8061201572418213, 0.9075712561607361, 1.8762856721878052]],
  mask=[[False, False, False, ..., False, False, False],
        [False, False, False, ..., False, False, False],
        [False, False, False, ..., False, False, False],
        ...,
        [False, False, False, ..., False, False, False],
        [False, False, False, ..., False, False, False],
        [False, False, False, ..., False, False, False]],
  fill_value=1e+20,
  dtype=float32)

As can be seen it is a numpy masked array, with bad pixels flagged.



In [5]:

    
plt.figure(figsize=(6,6))
plt.imshow(img.pixeldata, cmap='Greys')









    Out[5]:





<matplotlib.image.AxesImage at 0x7f180d10afd0>

We can check the best sources extracted.



In [6]:

    
img.best_sources[['x', 'y', 'cflux']]









    Out[6]:





array([( 58.00277026,   7.99782687, 268.58624268),
       ( 70.99991538,   8.99658983, 270.16235352),
       ( 63.00255254,  22.99469012, 266.30847168),
       (108.00106874,  24.00427352, 269.51828003),
       ( 19.99780805,  24.99978873, 266.05368042),
       ( 24.99983997,  31.00205361, 265.97857666),
       ( 47.00216523,  37.99432643, 268.41726685),
       (119.99700901,  46.00093685, 267.47576904),
       ( 36.00033251,  83.00039817, 266.6668396 ),
       ( 92.00367497,  89.00045462, 267.4937439 ),
       ( 38.99966331,  95.00173673, 267.0223999 ),
       ( 91.00323326,  96.99981811, 270.17242432),
       ( 98.00121345, 101.9978166 , 267.44610596),
       ( 86.00078336, 116.99608498, 266.30340576)],
      dtype={'names':['x','y','cflux'], 'formats':['<f8','<f8','<f8'], 'offsets':[56,64,168], 'itemsize':240})

And also obtain the estimation of PSF.

As the PSF may vary across the field, we use the method described in Lauer T. (2002) for spatially variant PSF.
The methodology returns a series of image-sized coefficients $a_i$ and a series of basis PSF elements $p_i$.



In [7]:

    
a_fields, psf_basis = img.get_variable_psf()









    



updating stamp shape to (15,15)
(14, 14) (225, 14)

As in our simple example we don't vary the PSF we obtain only a PSF element, and a None coefficient.



In [8]:

    
len(psf_basis), psf_basis[0].shape









    Out[8]:





(1, (15, 15))



In [9]:

    
a_fields









    Out[9]:





[None]

We may check the looks of the psf_basis single element.



In [10]:

    
plt.imshow(psf_basis[0])









    Out[10]:





<matplotlib.image.AxesImage at 0x7f180b3fb358>