gemini_instruments.nifs package

class gemini_instruments.nifs.AstroDataNifs(nddata=None, tables=None, phu=None, indices=None, is_single=False)[source]

Bases: 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:
  • stripID (bool) – If True, removes the component ID and returns only the name of the filter.

  • pretty (bool) – Same as for stripID. Pretty here does not do anything more.

Returns:

The name of the filter with or without the component ID.

Return type:

str

gain()

Returns the gain (electrons/ADU) for each extension

Returns:

Gains used for the observation

Return type:

list of floats/float

non_linear_level()

Returns the level at which the data become non-linear, in ADU. This is expected to be overridden by the individual instruments, so at the Gemini level it returns the values of the NONLINEA keywords (or None)

Returns:

non-linearity level level in ADU

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

saturation_level()

Returns the saturation level of the data, in the units of the data. This is expected to be overridden by the individual instruments, so at the Gemini level it returns the values of the SATLEVEL keyword (or None).

Returns:

saturation level (in units of the data)

Return type:

list/float

Submodules

gemini_instruments.nifs.adclass module

class gemini_instruments.nifs.adclass.AstroDataNifs(nddata=None, tables=None, phu=None, indices=None, is_single=False)[source]

Bases: 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:
  • stripID (bool) – If True, removes the component ID and returns only the name of the filter.

  • pretty (bool) – Same as for stripID. Pretty here does not do anything more.

Returns:

The name of the filter with or without the component ID.

Return type:

str

gain()

Returns the gain (electrons/ADU) for each extension

Returns:

Gains used for the observation

Return type:

list of floats/float

non_linear_level()

Returns the level at which the data become non-linear, in ADU. This is expected to be overridden by the individual instruments, so at the Gemini level it returns the values of the NONLINEA keywords (or None)

Returns:

non-linearity level level in ADU

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

saturation_level()

Returns the saturation level of the data, in the units of the data. This is expected to be overridden by the individual instruments, so at the Gemini level it returns the values of the SATLEVEL keyword (or None).

Returns:

saturation level (in units of the data)

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