eclipse.cube
index
/astro-wise/AWEHOME/x86_64/AWBASE/astro/lib/python2.5/site-packages/eclipse/cube.py

 
Modules
       
eclipse.c_eclipse

 
Classes
       
__builtin__.list(__builtin__.object)
cube

 
class cube(__builtin__.list)
    
Method resolution order:
cube
__builtin__.list
__builtin__.object

Methods defined here:
__add__(self, other)
__div__(self, other)
__iadd__(self, other)
__idiv__(self, other)
__imul__(self, other)
__init__(self, image_list)
__ipow__(self, other, modulo=None)
__isub__(self, other)
__mul__(self, other)
__neg__(self)
__pow__(self, other)
__radd__(self, other)
__rdiv__(self, other)
__rmul__(self, other)
__rpow__(self, other)
__rsub__(self, other)
__sub__(self, other)
arithmetic_op(self, other, op)
average(self)
Do a straight average of all images in the cube
average_with_rejection(self, low_reject, high_reject)
Average the planes in the cube
 
low_reject, and high_reject give the number lowest and highest pixels
to reject for the average of each pixel
average_with_sigma_clip(self, n_cycle, nmin, bias, scaling, thresh, badval, rn, gain)
Average with sigma-clipping rejection:
takes in input a cube and run n_cycle times  a rejection
excluding pixels value large than (thresh*sigma).
Sigma is given by  sigma=sqrt((rn/gain)^2 + median/gain)
 
Arguments
  n_cycle  -- number of iterations 
  nmin     -- Minimum number of pixels used for final average
  bias     -- if in input are bias frames then is setted at 1
  scaling  -- compute the scaling factors internally
  thresh   -- threshold
  badval   -- badvalue (not considered)
  rn       -- Read out noise
  Gain     -- gain
 
Returns an image that contains the sigma-clipped average.
in_place_op(self, other, op)
median(self)
Do a median average of all images in the cube
normalize_absolute_flux(self, pixmap=None, pixrange=None, zone=None, scale=1.0)
Normalize the images to an absolute flux of 1.0.
 
The absolute flux can be computed in a restricted area. This
function modifies the image in-place
 
Arguments:
pixmap -- map of valid pixelsd (default=None)
pixrange -- a range of valid values [low, high] (default=None)
zone -- a valid zone [xmin, xmax, ymin, ymax]
scale -- normalize to a different scale (default=1.0)
normalize_flux(self, pixmap=None, pixrange=None, zone=None, scale=1.0)
Normalize the images to a flux of 1.0.
 
The flux can be computed in a restricted area. This function
modifies the image in-place
 
Arguments:
pixmap -- map of valid pixelsd (default=None)
pixrange -- a range of valid values [low, high] (default=None)
zone -- a valid zone [xmin, xmax, ymin, ymax]
scale -- normalize to a different scale (default=1.0)
normalize_mean(self, pixmap=None, pixrange=None, zone=None, scale=1.0)
Normalize the images to a mean of 1.0.
 
The mean can be computed in a restricted area. This function
modifies the image in-place
 
Arguments:
pixmap -- map of valid pixelsd (default=None)
pixrange -- a range of valid values [low, high] (default=None)
zone -- a valid zone [xmin, xmax, ymin, ymax]
scale -- normalize to a different scale (default=1.0)
normalize_median(self, pixmap=None, pixrange=None, zone=None, scale=1.0)
Normalize the images to a median of 1.0.
 
The median can be computed in a restricted area. This function
modifies the image in-place
 
Arguments:
pixmap -- map of valid pixelsd (default=None)
pixrange -- a range of valid values [low, high] (default=None)
zone -- a valid zone [xmin, xmax, ymin, ymax]
scale -- normalize to a different scale (default=1.0)
normalize_range(self, pixmap=None, pixrange=None, zone=None, scale=1.0)
Normalize the images to a range of values between 0.0 and 1.0.
 
The range can be computed in a restricted area. This function
modifies the image in-place
 
Arguments:
pixmap -- map of valid pixelsd (default=None)
pixrange -- a range of valid values [low, high] (default=None)
zone -- a valid zone [xmin, xmax, ymin, ymax]
scale -- normalize to a different maximum (default=1.0)
stdev(self, mean=None)
Compute the standard deviation of each pixel in the z direction
 
Arguments:
   mean -- An image to be used for the average (default=None)
 
This procedure computes the mean deviation from a mean
image. The mean image can be passed as an optional
parameter. If no parameter is passed, the mean is computed
first.
sum(self)
Sum all images in the cube to a single image

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)

Methods inherited from __builtin__.list:
__contains__(...)
x.__contains__(y) <==> y in x
__delitem__(...)
x.__delitem__(y) <==> del x[y]
__delslice__(...)
x.__delslice__(i, j) <==> del x[i:j]
 
Use of negative indices is not supported.
__eq__(...)
x.__eq__(y) <==> x==y
__ge__(...)
x.__ge__(y) <==> x>=y
__getattribute__(...)
x.__getattribute__('name') <==> x.name
__getitem__(...)
x.__getitem__(y) <==> x[y]
__getslice__(...)
x.__getslice__(i, j) <==> x[i:j]
 
Use of negative indices is not supported.
__gt__(...)
x.__gt__(y) <==> x>y
__hash__(...)
x.__hash__() <==> hash(x)
__iter__(...)
x.__iter__() <==> iter(x)
__le__(...)
x.__le__(y) <==> x<=y
__len__(...)
x.__len__() <==> len(x)
__lt__(...)
x.__lt__(y) <==> x<y
__ne__(...)
x.__ne__(y) <==> x!=y
__repr__(...)
x.__repr__() <==> repr(x)
__reversed__(...)
L.__reversed__() -- return a reverse iterator over the list
__setitem__(...)
x.__setitem__(i, y) <==> x[i]=y
__setslice__(...)
x.__setslice__(i, j, y) <==> x[i:j]=y
 
Use  of negative indices is not supported.
append(...)
L.append(object) -- append object to end
count(...)
L.count(value) -> integer -- return number of occurrences of value
extend(...)
L.extend(iterable) -- extend list by appending elements from the iterable
index(...)
L.index(value, [start, [stop]]) -> integer -- return first index of value
insert(...)
L.insert(index, object) -- insert object before index
pop(...)
L.pop([index]) -> item -- remove and return item at index (default last)
remove(...)
L.remove(value) -- remove first occurrence of value
reverse(...)
L.reverse() -- reverse *IN PLACE*
sort(...)
L.sort(cmp=None, key=None, reverse=False) -- stable sort *IN PLACE*;
cmp(x, y) -> -1, 0, 1

Data and other attributes inherited from __builtin__.list:
__new__ = <built-in method __new__ of type object at 0x720020>
T.__new__(S, ...) -> a new object with type S, a subtype of T

 
Functions
       
average_with_sigma_clip(data_cube, errors, threshold, niter=1)
Iteratively compute the mean of images with given errors, rejecting outliers
 
Arguments
   data_cube -- A cube of images
   errors    -- A cube of error images, or an array of errors
   threshold -- The sigma-clipping threshold (default = 5.0)
   niter     -- The number of iterations (default = 1)
 
This algorithm assumes that the errors are given a-priori
 
The algorithm first uses the median of data_cube to estimate the
mean, and then computes the mean of the pixels for each data-plane
in data_cube for which
 
     (data-mean)/error > threshold
 
This gives a new estimate of the mean, which can be used to reject
additional pixels. This would however normally not be necessary.

 
Data
        FAILURE = -1