ObjectMasker¶
This module is only used if a star catalogue is used via the command line option –cc. The catalogue is expected to be a comma separated CSV file with the following header and columns:
`objID, ra, dec, psfMag_r, type`
Where ObjId is the object ID, RA is the right ascension, DEC is the Declination, psfMAG_r is the PSF magnitude for the r band, and type is the object type from {STAR, GALAXY, COSMICRAY, UNKNOWN}.
The function simply reads in the star catalogue and checks for which object to match with. By default this is only STAR, however the other types can be enabled. The function then converts RA DEC pairs to pixel coordinates and uses these to check if the object is in the image. If the object is in the image it then checks to see if occludes the segmentation map.
-
pawlikMorphLSST.objectMasker.
objectOccluded
(mask: numpy.ndarray, radec: Tuple[float, float], catalogue: str, header, galaxy=False, cosmicray=False, unknown=False) → Tuple[bool, List[float]] Function gets list of objects near the object of interest, and determines if that objects light occludeds the object of interest light.
- Parameters
mask (np.ndarray) – Object mask
radec (Tuple[float, float]) – Tuple of ra, dec
catalogue (str) – Name of object catalogue to check against Expected format is objID: float, ra: float, dec: float, type: str
header – fits image header
galaxy (bool, optional) – Option to include galaxy objects
cosmicray (bool, optional) – Option to include cosmic rays
unknown (bool, optional) – Option to include unknown objects
- Returns
Returns true alongside list of objects that occlude object mask. Otherwise returns false and an empty list
- Return type
Tuple[bool, List[float]]