Inheritance diagram for sourcextractor.config.measurement_images.MeasurementImage:

[legend]

Collaboration diagram for sourcextractor.config.measurement_images.MeasurementImage:

Public Member Functions
	__init__ (self, fits_file, psf_file=None, weight_file=None, gain=None, gain_keyword='GAIN', saturation=None, saturation_keyword='SATURATE', flux_scale=None, flux_scale_keyword='FLXSCALE', weight_type='none', weight_absolute=False, weight_scaling=1., weight_threshold=None, constant_background=None, image_hdu=0, psf_hdu=None, weight_hdu=None, psf_renormalize=True)
	__str__ (self)

Public Attributes
dict	meta
int	gain = float(self.meta[gain_keyword])
int	saturation = float(self.meta[saturation_keyword])
int	flux_scale = float(self.meta[flux_scale_keyword])
bool	has_weight_threshold = False
bool	is_background_constant = True
int	constant_background_value = -1
	psf_renormalize = psf_renormalize
	id
	image_hdu
	psf_hdu
	weight_hdu

Protected Member Functions
	_set_checked (self, attr_name, value)

Detailed Description

A MeasurementImage is the processing unit for SourceXtractor++. Measurements and model fitting can be done
over one, or many, of them. It models the image, plus its associated weight file, PSF, etc.

Parameters
----------
fits_file : str or FitsFile object
The path to a FITS image, or an instance of FitsFile
psf_file : str
The path to a PSF. It can be either a FITS image, or a PSFEx model.
weight_file : str or FitsFile
The path to a FITS image with the pixel weights, or an instance of FitsFile
gain : float
Image gain. If None, `gain_keyword` will be used instead.
gain_keyword : str
Keyword for the header containing the gain.
saturation : float
Saturation value. If None, `saturation_keyword` will be used instead.
saturation_keyword : str
Keyword for the header containing the saturation value.
flux_scale : float
Flux scaling. Each pixel value will be multiplied by this. If None, `flux_scale_keyword` will be used
instead.
flux_scale_keyword : str
Keyword for the header containing the flux scaling.
weight_type : str
The type of the weight image. It must be one of:

- none
The image itself is used to compute internally a constant variance (default)
- background
The image itself is used to compute internally a variance map
- rms
The weight image must contain a weight-map in units of absolute standard deviations
(in ADUs per pixel).
- variance
The weight image must contain a weight-map in units of relative variance.
- weight
The weight image must contain a weight-map in units of relative weights. The data are converted
to variance units.
weight_absolute : bool
If False, the weight map will be scaled according to an absolute variance map built from the image itself.
weight_scaling : float
Apply an scaling to the weight map.
weight_threshold : float
Pixels with weights beyond this value are treated just like pixels discarded by the masking process.
constant_background : float
If set a constant background of that value is assumed for the image instead of using automatic detection
image_hdu : int
For multi-extension FITS file specifies the HDU number for the image. Default 0 (primary HDU)
psf_hdu : int
For multi-extension FITS file specifies the HDU number for the psf. Defaults to the same value as image_hdu
weight_hdu : int
For multi-extension FITS file specifies the HDU number for the weight. Defaults to the same value as image_hdu
psf_renormalize : bool
If True, the PSF will be renormalized to have a total flux of 1.0. Default True

Definition at line 55 of file measurement_images.py.

Constructor & Destructor Documentation

◆ init()

sourcextractor.config.measurement_images.MeasurementImage.__init__	(	self,
		fits_file,
		psf_file = None,
		weight_file = None,
		gain = None,
		gain_keyword = 'GAIN',
		saturation = None,
		saturation_keyword = 'SATURATE',
		flux_scale = None,
		flux_scale_keyword = 'FLXSCALE',
		weight_type = 'none',
		weight_absolute = False,
		weight_scaling = 1.,
		weight_threshold = None,
		constant_background = None,
		image_hdu = 0,
		psf_hdu = None,
		weight_hdu = None,
		psf_renormalize = True )

Constructor.

Definition at line 122 of file measurement_images.py.

References __init__().

Referenced by __init__().

Here is the call graph for this function:

Member Function Documentation

◆ str()

sourcextractor.config.measurement_images.MeasurementImage.__str__ ( self )

Returns
-------
str
    Human readable representation for the object

Definition at line 209 of file measurement_images.py.

◆ _set_checked()

sourcextractor.config.measurement_images.MeasurementImage._set_checked	(	self,
		attr_name,
		value )

protected

Definition at line 114 of file measurement_images.py.

Member Data Documentation

◆ constant_background_value

int sourcextractor.config.measurement_images.MeasurementImage.constant_background_value = -1

Definition at line 193 of file measurement_images.py.

◆ flux_scale

int sourcextractor.config.measurement_images.MeasurementImage.flux_scale = float(self.meta[flux_scale_keyword])

Definition at line 175 of file measurement_images.py.

◆ gain

int sourcextractor.config.measurement_images.MeasurementImage.gain = float(self.meta[gain_keyword])

Definition at line 161 of file measurement_images.py.

◆ has_weight_threshold

bool sourcextractor.config.measurement_images.MeasurementImage.has_weight_threshold = False

Definition at line 183 of file measurement_images.py.

◆ id

sourcextractor.config.measurement_images.MeasurementImage.id

Definition at line 217 of file measurement_images.py.

◆ image_hdu

sourcextractor.config.measurement_images.MeasurementImage.image_hdu

Definition at line 217 of file measurement_images.py.

◆ is_background_constant

bool sourcextractor.config.measurement_images.MeasurementImage.is_background_constant = True

Definition at line 189 of file measurement_images.py.

◆ meta

dict sourcextractor.config.measurement_images.MeasurementImage.meta

Initial value:

=  {
            'IMAGE_FILENAME': self.file,
            'PSF_FILENAME': self.psf_file,
            'WEIGHT_FILENAME': self.weight_file
        }

Definition at line 150 of file measurement_images.py.

◆ psf_hdu

sourcextractor.config.measurement_images.MeasurementImage.psf_hdu

Definition at line 218 of file measurement_images.py.

◆ psf_renormalize

sourcextractor.config.measurement_images.MeasurementImage.psf_renormalize = psf_renormalize

Definition at line 207 of file measurement_images.py.

◆ saturation

int sourcextractor.config.measurement_images.MeasurementImage.saturation = float(self.meta[saturation_keyword])

Definition at line 168 of file measurement_images.py.

◆ weight_hdu

sourcextractor.config.measurement_images.MeasurementImage.weight_hdu

Definition at line 219 of file measurement_images.py.

The documentation for this class was generated from the following file:

SEImplementation/python/sourcextractor/config/measurement_images.py

Public Member Functions

Public Attributes

Protected Member Functions