gemini_instruments.nifs package¶
-
class
gemini_instruments.nifs.
AstroDataNifs
(provider)[source]¶ Bases:
gemini_instruments.gemini.adclass.AstroDataGemini
-
filter_name
(stripID=False, pretty=False)[source]¶ Returns the name of the filter(s) used. The component ID can be removed with either ‘stripID’ or ‘pretty’. If ‘pretty’ is True, filter positions such as ‘Open’, ‘Dark’, ‘blank’, and others are removed leaving only the relevant filters in the string.
Parameters: Returns: The name of the filter with or without the component ID.
Return type:
-
gain
()[source]¶ Returns the gain used for the observation. A lookup table is uses to compare the bias value in the headers to the bias values associate with the various gain settings.
Returns: Gain used for the observation. Return type: float
-
gcal_lamp
()[source]¶ Returns the name of the GCAL lamp being used, or “Off” if no lamp is in used. This applies to flats and arc observations when a lamp is used. For other types observation, None is returned.
This overrides the gemini level descriptor, as NIFS has more lamp names than are accommodated by that descriptor function.
Returns: lamps – Name of the GCAL lamp, or “Off” Return type: <str>
-
non_linear_level
()[source]¶ Returns the level at which the array becomes non-linear. The return units are ADUs. A lookup table is used. Whether the data has been corrected for non-linearity or not is taken into account. A list is returned unless called on a single-extension slice.
Returns: Level in ADU at which the non-linear regime starts. Return type: int/list
-
pixel_scale
()[source]¶ Returns the pixel scale in arc seconds. A lookup table indexed on focal_plane_mask, disperser, and filter_name is used.
Returns: Pixel scale in arcsec. Return type: lfloat
-
read_mode
()[source]¶ Returns the read mode for the observation. The read mode is directly associated with the LNRS header keyword value.
Returns: Read mode for the observation. Return type: str
-
read_noise
()[source]¶ Returns the detector read noise, in electrons. A lookup table is used. The read noise depends on the gain setting and is affected by the number of coadds and non-destructive pairs. A list is returned unless called on a single-extension slice.
Returns: Detector read noise in electrons. Return type: list/float
-
Submodules¶
gemini_instruments.nifs.adclass module¶
-
class
gemini_instruments.nifs.adclass.
AstroDataNifs
(provider)[source]¶ Bases:
gemini_instruments.gemini.adclass.AstroDataGemini
-
filter_name
(stripID=False, pretty=False)[source]¶ Returns the name of the filter(s) used. The component ID can be removed with either ‘stripID’ or ‘pretty’. If ‘pretty’ is True, filter positions such as ‘Open’, ‘Dark’, ‘blank’, and others are removed leaving only the relevant filters in the string.
Parameters: Returns: The name of the filter with or without the component ID.
Return type:
-
gain
()[source]¶ Returns the gain used for the observation. A lookup table is uses to compare the bias value in the headers to the bias values associate with the various gain settings.
Returns: Gain used for the observation. Return type: float
-
gcal_lamp
()[source]¶ Returns the name of the GCAL lamp being used, or “Off” if no lamp is in used. This applies to flats and arc observations when a lamp is used. For other types observation, None is returned.
This overrides the gemini level descriptor, as NIFS has more lamp names than are accommodated by that descriptor function.
Returns: lamps – Name of the GCAL lamp, or “Off” Return type: <str>
-
non_linear_level
()[source]¶ Returns the level at which the array becomes non-linear. The return units are ADUs. A lookup table is used. Whether the data has been corrected for non-linearity or not is taken into account. A list is returned unless called on a single-extension slice.
Returns: Level in ADU at which the non-linear regime starts. Return type: int/list
-
pixel_scale
()[source]¶ Returns the pixel scale in arc seconds. A lookup table indexed on focal_plane_mask, disperser, and filter_name is used.
Returns: Pixel scale in arcsec. Return type: lfloat
-
read_mode
()[source]¶ Returns the read mode for the observation. The read mode is directly associated with the LNRS header keyword value.
Returns: Read mode for the observation. Return type: str
-
read_noise
()[source]¶ Returns the detector read noise, in electrons. A lookup table is used. The read noise depends on the gain setting and is affected by the number of coadds and non-destructive pairs. A list is returned unless called on a single-extension slice.
Returns: Detector read noise in electrons. Return type: list/float
-
gemini_instruments.nifs.lookup module¶
-
class
gemini_instruments.nifs.lookup.
Config
(mdf, offsetsection, pixscale, mode)¶ Bases:
tuple
-
mdf
¶ Alias for field number 0
-
mode
¶ Alias for field number 3
-
offsetsection
¶ Alias for field number 1
-
pixscale
¶ Alias for field number 2
-
-
class
gemini_instruments.nifs.lookup.
Constants
(readnoise, gain, well, linearlimit, coeff1, coeff2, coeff3, nonlinearlimit)¶ Bases:
tuple
-
coeff1
¶ Alias for field number 4
-
coeff2
¶ Alias for field number 5
-
coeff3
¶ Alias for field number 6
-
gain
¶ Alias for field number 1
-
linearlimit
¶ Alias for field number 3
-
nonlinearlimit
¶ Alias for field number 7
-
readnoise
¶ Alias for field number 0
-
well
¶ Alias for field number 2
-