Inheritance diagram for sourcextractor.config.measurement_images.MeasurementImage:
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) | |
| __str__ (self) | |
Public Attributes | |
| meta | |
| file | |
| psf_file | |
| gain | |
| saturation | |
| flux_scale | |
| has_weight_threshold | |
| is_background_constant | |
| constant_background_value | |
| 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
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 ) |
Constructor.
Reimplemented in sourcextractor.config.measurement_images.DataCubeSlice.
Definition at line 120 of file measurement_images.py.
References sourcextractor.config.measurement_images.MeasurementImage.__init__().
Referenced by sourcextractor.config.measurement_images.MeasurementImage.__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
Reimplemented in sourcextractor.config.measurement_images.DataCubeSlice.
Definition at line 205 of file measurement_images.py.
◆ _set_checked()
|
protected |
Definition at line 112 of file measurement_images.py.
Member Data Documentation
◆ constant_background_value
| sourcextractor.config.measurement_images.MeasurementImage.constant_background_value |
Definition at line 191 of file measurement_images.py.
◆ file
| sourcextractor.config.measurement_images.MeasurementImage.file |
Definition at line 149 of file measurement_images.py.
◆ flux_scale
| sourcextractor.config.measurement_images.MeasurementImage.flux_scale |
Definition at line 173 of file measurement_images.py.
◆ gain
| sourcextractor.config.measurement_images.MeasurementImage.gain |
Definition at line 159 of file measurement_images.py.
◆ has_weight_threshold
| sourcextractor.config.measurement_images.MeasurementImage.has_weight_threshold |
Definition at line 181 of file measurement_images.py.
◆ id
| sourcextractor.config.measurement_images.MeasurementImage.id |
Definition at line 213 of file measurement_images.py.
◆ image_hdu
| sourcextractor.config.measurement_images.MeasurementImage.image_hdu |
Definition at line 213 of file measurement_images.py.
◆ is_background_constant
| sourcextractor.config.measurement_images.MeasurementImage.is_background_constant |
Definition at line 187 of file measurement_images.py.
◆ meta
| sourcextractor.config.measurement_images.MeasurementImage.meta |
Definition at line 148 of file measurement_images.py.
◆ psf_file
| sourcextractor.config.measurement_images.MeasurementImage.psf_file |
Definition at line 150 of file measurement_images.py.
◆ psf_hdu
| sourcextractor.config.measurement_images.MeasurementImage.psf_hdu |
Definition at line 214 of file measurement_images.py.
◆ saturation
| sourcextractor.config.measurement_images.MeasurementImage.saturation |
Definition at line 166 of file measurement_images.py.
◆ weight_hdu
| sourcextractor.config.measurement_images.MeasurementImage.weight_hdu |
Definition at line 215 of file measurement_images.py.
The documentation for this class was generated from the following file:
- SEImplementation/python/sourcextractor/config/measurement_images.py
