SourceXtractorPlusPlus  0.11
Please provide a description of the project.
Classes | Functions | Variables
sourcextractor.config.measurement_images Namespace Reference

Classes

class  ByKeyword
 
class  ByPattern
 
class  ImageCacheEntry
 
class  ImageGroup
 
class  MeasurementGroup
 
class  MeasurementImage
 

Functions

def print_measurement_images (file=sys.stderr)
 
def load_fits_image (image, psf=None, weight=None, **kwargs)
 
def load_fits_images (images, psfs=None, weights=None, **kwargs)
 

Variables

dictionary measurement_images = {}
 
dictionary _image_cache = {}
 

Function Documentation

◆ load_fits_image()

def sourcextractor.config.measurement_images.load_fits_image (   image,
  psf = None,
  weight = None,
**  kwargs 
)
Creates an image group with the images of a (possibly multi-HDU) single FITS file.

If image is multi-hdu, psf and weight can either be multi hdu or lists of individual files.
 
In any case, they are matched in order and HDUs not containing images (two dimensional arrays) are ignored.
 
:param image: The FITS file containing the image(s)
:param psf: psf file or list of psf files
:param weight: FITS file for the weight image or a list of such files

:return: A ImageGroup representing the images

Definition at line 463 of file measurement_images.py.

Referenced by sourcextractor.config.measurement_images.load_fits_images().

◆ load_fits_images()

def sourcextractor.config.measurement_images.load_fits_images (   images,
  psfs = None,
  weights = None,
**  kwargs 
)
Creates an image group for the given images.
 
Parameters
----------
images : list of str
    A list of relative paths to the images FITS files. Can also be single string in which case,
     this function acts like load_fits_image 
psfs : list of str
    A list of relative paths to the PSF FITS files (optional). It must match the length of image_list or be None.
weights : list of str
    A list of relative paths to the weight files (optional). It must match the length of image_list or be None.
 
Returns
-------
ImageGroup
    A ImageGroup representing the images
 
Raises
------
ValueError
    In case of mismatched list of files

Definition at line 512 of file measurement_images.py.

References sourcextractor.config.measurement_images.load_fits_image().

Here is the call graph for this function:

◆ print_measurement_images()

def sourcextractor.config.measurement_images.print_measurement_images (   file = sys.stderr)
Print a human-readable representation of the configured measurement images.

Parameters
----------
file : file object
    Where to print the representation. Defaults to sys.stderr

Definition at line 218 of file measurement_images.py.

Variable Documentation

◆ _image_cache

dictionary sourcextractor.config.measurement_images._image_cache = {}
private

Definition at line 461 of file measurement_images.py.

◆ measurement_images

dictionary sourcextractor.config.measurement_images.measurement_images = {}

Definition at line 34 of file measurement_images.py.