gemini_instruments.gsaoi package

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

Bases: AstroDataGemini

array_name()[source]

Returns a list of the array names of each extension

Returns:

names of the arrays

Return type:

list/str

central_wavelength(asMicrometers=False, asNanometers=False, asAngstroms=False)[source]

Returns the central wavelength in meters or the specified units

Parameters:
  • asMicrometers (bool) – If True, return the wavelength in microns

  • asNanometers (bool) – If True, return the wavelength in nanometers

  • asAngstroms (bool) – If True, return the wavelength in Angstroms

Returns:

The central wavelength setting

Return type:

float

gain()

Returns the gain (electrons/ADU) for each extension

Returns:

Gains used for the observation

Return type:

list of floats/float

group_id()[source]

Returns a string representing a group of data that are compatible with each other. This is used when stacking, for example. Each instrument and mode of observation will have its own rules.

Returns:

A group ID for compatible data

Return type:

str

is_coadds_summed()[source]

Tells whether or not the co-adds have been summed. If not, they have been averaged. GSAOI averages them.

Returns:

True if the data has been summed. False if it has been averaged.

Return type:

bool

nominal_photometric_zeropoint()[source]

Returns the nominal zeropoints (i.e., the magnitude corresponding to a pixel value of 1) for the extensions in an AD object. Zeropoints in table are for electrons, so subtract 2.5*lg(gain) if the data are in ADU

Returns:

zeropoint values, one per SCI extension

Return type:

float/list

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

read_noise()

Returns the read noise in electrons for each extension. A list is returned unless called on a single-extension slice, when a float

Returns:

the read noise

Return type:

float/list of floats

read_speed_setting()[source]

Returns a string describing the read speed setting, as used in the OT

Returns:

read speed setting

Return type:

str

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

wcs_dec()[source]

Returns the Declination of the center of the field based on the WCS rather than the DEC keyword. This just uses the CRVAL2 keyword.

Returns:

declination in degrees

Return type:

float

wcs_ra()[source]

Returns the Right Ascension of the center of the field based on the WCS rather than the RA keyword. This just uses the CRVAL1 keyword.

Returns:

right ascension in degrees

Return type:

float

Submodules

gemini_instruments.gsaoi.adclass module

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

Bases: AstroDataGemini

array_name()[source]

Returns a list of the array names of each extension

Returns:

names of the arrays

Return type:

list/str

central_wavelength(asMicrometers=False, asNanometers=False, asAngstroms=False)[source]

Returns the central wavelength in meters or the specified units

Parameters:
  • asMicrometers (bool) – If True, return the wavelength in microns

  • asNanometers (bool) – If True, return the wavelength in nanometers

  • asAngstroms (bool) – If True, return the wavelength in Angstroms

Returns:

The central wavelength setting

Return type:

float

gain()

Returns the gain (electrons/ADU) for each extension

Returns:

Gains used for the observation

Return type:

list of floats/float

group_id()[source]

Returns a string representing a group of data that are compatible with each other. This is used when stacking, for example. Each instrument and mode of observation will have its own rules.

Returns:

A group ID for compatible data

Return type:

str

is_coadds_summed()[source]

Tells whether or not the co-adds have been summed. If not, they have been averaged. GSAOI averages them.

Returns:

True if the data has been summed. False if it has been averaged.

Return type:

bool

nominal_photometric_zeropoint()[source]

Returns the nominal zeropoints (i.e., the magnitude corresponding to a pixel value of 1) for the extensions in an AD object. Zeropoints in table are for electrons, so subtract 2.5*lg(gain) if the data are in ADU

Returns:

zeropoint values, one per SCI extension

Return type:

float/list

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

read_noise()

Returns the read noise in electrons for each extension. A list is returned unless called on a single-extension slice, when a float

Returns:

the read noise

Return type:

float/list of floats

read_speed_setting()[source]

Returns a string describing the read speed setting, as used in the OT

Returns:

read speed setting

Return type:

str

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

wcs_dec()[source]

Returns the Declination of the center of the field based on the WCS rather than the DEC keyword. This just uses the CRVAL2 keyword.

Returns:

declination in degrees

Return type:

float

wcs_ra()[source]

Returns the Right Ascension of the center of the field based on the WCS rather than the RA keyword. This just uses the CRVAL1 keyword.

Returns:

right ascension in degrees

Return type:

float

gemini_instruments.gsaoi.lookup module

class gemini_instruments.gsaoi.lookup.ArrayProperties(readnoise, gain, welldepth, linlimit, coeffs, nonlinlimit)

Bases: tuple

coeffs

Alias for field number 4

gain

Alias for field number 1

linlimit

Alias for field number 3

nonlinlimit

Alias for field number 5

readnoise

Alias for field number 0

welldepth

Alias for field number 2