SourceXtractorPlusPlus
0.10
Please provide a description of the project.
|
Public Member Functions | |
def | __init__ |
def | __str__ |
Private Member Functions | |
def | _load_header_file |
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 The path to a FITS image. Only primary HDU images are supported. psf_file : str The path to a PSF. It can be either a FITS image, or a PSFEx model. weight_file : str The path to a FITS image with the pixel weights. 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 1 (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 37 of file measurement_images.py.
def 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 = 1 , |
|||
psf_hdu = None , |
|||
weight_hdu = None |
|||
) |
Constructor.
Definition at line 100 of file measurement_images.py.
def sourcextractor.config.measurement_images.MeasurementImage.__str__ | ( | self | ) |
Returns ------- str Human readable representation for the object
Definition at line 200 of file measurement_images.py.
References std::locale::id.id(), std::thread::id.id(), SourceXtractor::PyId.id, sourcextractor.config.measurement_images.MeasurementImage.image_hdu, sourcextractor.config.measurement_images.MeasurementImage.meta, sourcextractor.config.measurement_images.MeasurementImage.psf_hdu, and sourcextractor.config.measurement_images.MeasurementImage.weight_hdu.
|
private |
Definition at line 177 of file measurement_images.py.
References sourcextractor.config.measurement_images.MeasurementImage.meta.
sourcextractor.config.measurement_images.MeasurementImage.constant_background_value |
Definition at line 155 of file measurement_images.py.
sourcextractor.config.measurement_images.MeasurementImage.flux_scale |
Definition at line 138 of file measurement_images.py.
sourcextractor.config.measurement_images.MeasurementImage.gain |
Definition at line 124 of file measurement_images.py.
sourcextractor.config.measurement_images.MeasurementImage.has_weight_threshold |
Definition at line 148 of file measurement_images.py.
sourcextractor.config.measurement_images.MeasurementImage.image_hdu |
Definition at line 161 of file measurement_images.py.
Referenced by sourcextractor.config.measurement_images.MeasurementImage.__str__().
sourcextractor.config.measurement_images.MeasurementImage.is_background_constant |
Definition at line 154 of file measurement_images.py.
sourcextractor.config.measurement_images.MeasurementImage.meta |
Definition at line 111 of file measurement_images.py.
Referenced by sourcextractor.config.measurement_images.MeasurementImage.__str__(), and sourcextractor.config.measurement_images.MeasurementImage._load_header_file().
sourcextractor.config.measurement_images.MeasurementImage.psf_hdu |
Definition at line 164 of file measurement_images.py.
Referenced by sourcextractor.config.measurement_images.MeasurementImage.__str__().
sourcextractor.config.measurement_images.MeasurementImage.saturation |
Definition at line 131 of file measurement_images.py.
sourcextractor.config.measurement_images.MeasurementImage.weight_absolute |
Definition at line 145 of file measurement_images.py.
sourcextractor.config.measurement_images.MeasurementImage.weight_hdu |
Definition at line 169 of file measurement_images.py.
Referenced by sourcextractor.config.measurement_images.MeasurementImage.__str__().
sourcextractor.config.measurement_images.MeasurementImage.weight_scaling |
Definition at line 146 of file measurement_images.py.
sourcextractor.config.measurement_images.MeasurementImage.weight_threshold |
Definition at line 151 of file measurement_images.py.
sourcextractor.config.measurement_images.MeasurementImage.weight_type |
Definition at line 144 of file measurement_images.py.