gemini_instruments.igrins package

class gemini_instruments.igrins.AstroDataIgrins(provider)[source]

Bases: AstroDataGemini

airmass()[source]

Returns the airmass of the observation.

Returns: Airmass value.
Return type: float

dec()[source]

Returns the declination of observation.

Returns: decd – Declination
Return type: <str>

detector_name(pretty=False)[source]

Returns the name of the detector

Returns: Detector name
Return type: <str>

filter_name(pretty=False)[source]

IGRINS has no filters or filter names. But this descriptor is used to display ‘WaveBand’ in the archive. So, IGRINS data needs to “fake it.” wavelength_band() returns a string exactly equal to a call on filter_name(pretty=True).

Parameters: pretty (<bool>) – This keyword parameter is present for API purposes. It has no effect for this descriptor.
Returns: wavelength band substituting for filter_name(pretty=True)
Return type: <str>

instrument(generic=False)[source]

Returns the name of the instrument making the observation

Parameters: generic (<bool>) – Request the generic instrument name, if applicable.
Returns: instrument name
Return type: <str>

observation_class()[source]

Returns ‘class’ the observation; one of,

‘science’, ‘acq’, ‘projCal’, ‘dayCal’, ‘partnerCal’, ‘acqCal’

An ‘acq’ is defined by BAND == ‘S’, where ‘S’ indicates a slit image.

Returns: oclass – One of the above enumerated names for observation class.
Return type: <str>

observation_type()[source]

Returns ‘type’ the observation. For IGRINS, this will be one of,

‘OBJECT’, ‘DARK’, ‘FLAT’, ‘ARC’

Returns: otype – Observation type.
Return type: <str>

ra()[source]

Returns the RA of the observation.

Returns: rad – Right Ascension
Return type: <str>

target_dec()[source]

Returns the Declination of the target in degrees. Optionally, the telescope offsets can be applied. The proper motion can also be applied if requested. Finally, the RA can be converted to ICRS coordinates.

Parameters

offset (bool) – If True, applies the telescope offsets.
pm (bool) – If True, applies proper motion parameters.
icrs (bool) – If True, convert the Declination to the ICRS coordinate system.

Returns

Declination of the target in degrees.

Return type

float

target_ra()[source]

Returns the Right Ascension of the target in degrees. Optionally, the telescope offsets can be applied. The proper motion can also be applied if requested. Finally, the RA can be converted to ICRS coordinates.

Parameters

offset (bool) – If True, applies the telescope offsets.
pm (bool) – If True, applies proper motion parameters.
icrs (bool) – If True, convert the RA to the ICRS coordinate system.

Returns

Right Ascension of the target in degrees.

Return type

float

wavelength_band()[source]

Returns the name of the bandpass of the observation.

Returns: Name of the bandpass.
Return type: <str>

Submodules

gemini_instruments.igrins.adclass module

class gemini_instruments.igrins.adclass.AstroDataIgrins(provider)[source]

Bases: AstroDataGemini

airmass()[source]

Returns the airmass of the observation.

Returns: Airmass value.
Return type: float

dec()[source]

Returns the declination of observation.

Returns: decd – Declination
Return type: <str>

detector_name(pretty=False)[source]

Returns the name of the detector

Returns: Detector name
Return type: <str>

filter_name(pretty=False)[source]

IGRINS has no filters or filter names. But this descriptor is used to display ‘WaveBand’ in the archive. So, IGRINS data needs to “fake it.” wavelength_band() returns a string exactly equal to a call on filter_name(pretty=True).

Parameters: pretty (<bool>) – This keyword parameter is present for API purposes. It has no effect for this descriptor.
Returns: wavelength band substituting for filter_name(pretty=True)
Return type: <str>

instrument(generic=False)[source]

Returns the name of the instrument making the observation

Parameters: generic (<bool>) – Request the generic instrument name, if applicable.
Returns: instrument name
Return type: <str>

observation_class()[source]

Returns ‘class’ the observation; one of,

‘science’, ‘acq’, ‘projCal’, ‘dayCal’, ‘partnerCal’, ‘acqCal’

An ‘acq’ is defined by BAND == ‘S’, where ‘S’ indicates a slit image.

Returns: oclass – One of the above enumerated names for observation class.
Return type: <str>

observation_type()[source]

Returns ‘type’ the observation. For IGRINS, this will be one of,

‘OBJECT’, ‘DARK’, ‘FLAT’, ‘ARC’

Returns: otype – Observation type.
Return type: <str>

ra()[source]

Returns the RA of the observation.

Returns: rad – Right Ascension
Return type: <str>

target_dec()[source]

Returns the Declination of the target in degrees. Optionally, the telescope offsets can be applied. The proper motion can also be applied if requested. Finally, the RA can be converted to ICRS coordinates.

Parameters

offset (bool) – If True, applies the telescope offsets.
pm (bool) – If True, applies proper motion parameters.
icrs (bool) – If True, convert the Declination to the ICRS coordinate system.

Returns

Declination of the target in degrees.

Return type

float

target_ra()[source]

Returns the Right Ascension of the target in degrees. Optionally, the telescope offsets can be applied. The proper motion can also be applied if requested. Finally, the RA can be converted to ICRS coordinates.

Parameters

offset (bool) – If True, applies the telescope offsets.
pm (bool) – If True, applies proper motion parameters.
icrs (bool) – If True, convert the RA to the ICRS coordinate system.

Returns

Right Ascension of the target in degrees.

Return type

float

wavelength_band()[source]

Returns the name of the bandpass of the observation.

Returns: Name of the bandpass.
Return type: <str>