opticam.instruments

Classes

`Instrument`	Base class for instruments.
`OPTICAM_MX`	OAN-SPM OPTICAM-MX instrument.
`OPTICAM_MX_UNKNOWN`	OAN-SPM OPTICAM-MX instrument.
`MEXMAN`	OAN-SPM MEXMAN instrument.

Functions

`generate_instrument_json_template`(out_directory)	Generate a template JSON file that can be used to define an Instrument.
`create_template`()	Create an instrument configuration template.

Module Contents

class opticam.instruments.Instrument

Bases: abc.ABC

Base class for instruments.

Parameters

locationEarthLocation: The location of the observatory as an astropy.coordinates.EarthLocation object.
pixel_scalesdict[str, float]: The pixel scales for each camera in arcsec/pixel {camera: pixel scale}.
binning_kwstr, optional: The binning keyword, by default “BINNING”.
camera_kwstr, optional: The keyword that uniquely identifies the camera that took the image, by default “INSTRUME”. For single-camera instruments, this keyword doesn’t matter. For multi-camera instruments, however, it is used to apply calibrations like flats correctly.
dark_curr_kwstr, optional: The dark current keyword, by default “DARKCURR”. Dark current values are assumed to be in electrons/pixel.
dateobs_kwstr, optional: The observation date keyword, by default “DATE-OBS”. By default, observation dates are assumed to be in ISO 8601/FITS format (YYYY-MM-DDTHH:MM:SS[.sss]).
dec_kwstr, optional: The DEC keyword, by default “DEC”. DEC values are assumed to be in units of degrees.
exptime_kwstr, optional: The exposure time keyword, by default “EXPTIME”. Exposure times are assumed to be in units of seconds.
filter_kwstr, optional: The filter keyword, by default “FILTER”.
gain_kwstr, optional: The gain keyword, by default “GAIN”. Gain values are assumed to be in units of electrons/ADU.
ra_kwstr, optional: The RA keyword, by default “RA”. RA values are assumed to be in units of hour angle.
read_noise_kwstr, optional: The read noise keyword, by default “RDNOISE”.

location: astropy.coordinates.EarthLocation

pixel_scales: dict[str, float]

binning_kw: str = 'BINNING'

camera_kw: str = 'INSTRUME'

dark_curr_kw: str = 'DARKCURR'

dateobs_kw: str = 'DATE-OBS'

dec_kw: str = 'DEC'

exptime_kw: str = 'EXPTIME'

filter_kw: str = 'FILTER'

gain_kw: str = 'GAIN'

ra_kw: str = 'RA'

read_noise_kw: str = 'RDNOISE'

run_checks(file, return_errors=False)

Check that the instrument can be used to parse an image’s header.

Parameters

fileMEFSlice | Path: The file to use for checking the instrument. If a Path or str instance is specified, the first HDU of the corresponding FITS file is used.
return_errorsbool, optional: Whether to return the number of errors raised, by default False.

Returns

None | int: If return_errors=True, returns the number of errors raised. Otherwise, nothing is returned.

Raises

ValueError: If the header of the file could not be read.

Parameters:

file (opticam.mef_slice.MEFSlice | pathlib.Path)
return_errors (bool)

Return type:

None | int

get_mjd(file=None, header=None)

Given the path to a FITS file, or its header, parse its observation date into local Modified Julian Date (MJD).

Parameters

fileMEFSlice | None, optional: The MEFSlice instance corresponding to the file, by default None. If None, a Header must be passed to header instead.
headerHeader, optional: The header of the FITS file, by default None. If None, a MEFSlice must be passed to file instead.

Returns

float: The local MJD of the image.

Parameters:

file (opticam.mef_slice.MEFSlice | None)
header (astropy.io.fits.Header | None)

Return type:

float

get_camera(file=None, header=None)

Given the path to a FITS file, get the corresponding camera.

Parameters

fileMEFSlice | None, optional: The MEFSlice instance corresponding to the file, by default None. If None, a Header must be passed to header instead.
headerHeader, optional: The header of the FITS file, by default None. If None, a MEFSlice must be passed to file instead.

Returns

str: A unique identifier for the camera.

Parameters:

file (opticam.mef_slice.MEFSlice | None)
header (astropy.io.fits.Header | None)

Return type:

str

get_sky_coord(file=None, header=None)

Given the path to a FITS file, get the corresponding sky coordinates.

Parameters

fileMEFSlice | None, optional: The MEFSlice instance corresponding to the file, by default None. If None, a Header must be passed to header instead.
headerHeader, optional: The header of the FITS file, by default None. If None, a MEFSlice must be passed to file instead.

Returns

SkyCoord: The sky coordinates of the image.

Parameters:

file (opticam.mef_slice.MEFSlice | None)
header (astropy.io.fits.Header | None)

Return type:

astropy.coordinates.SkyCoord

get_dark_flux(file=None, header=None)

Given the path to a FITS file, get the corresponding dark flux (i.e., the exposure-integrated dark current). If the instrument does not list a dark current in the image headers, the returned dark flux can be None.

Parameters

fileMEFSlice | None, optional: The MEFSlice instance corresponding to the file, by default None. If None, a Header must be passed to header instead.
headerHeader, optional: The header of the FITS file, by default None. If None, a MEFSlice must be passed to file instead.

Returns

float | None: The dark flux in the image.

Parameters:

file (opticam.mef_slice.MEFSlice | None)
header (astropy.io.fits.Header | None)

Return type:

float | None

get_binning(file=None, header=None)

Get the binning of an image using the instrument’s binning_kw attribute.

Parameters

fileMEFSlice | None, optional: The MEFSlice instance corresponding to the file, by default None. If None, a Header must be passed to header instead.
headerHeader, optional: The header of the FITS file, by default None. If None, a MEFSlice must be passed to file instead.

Returns

str: The binning of the image.

Parameters:

file (opticam.mef_slice.MEFSlice | None)
header (astropy.io.fits.Header | None)

Return type:

str

get_filter(file=None, header=None)

Get the filter of an image using the instrument’s filter_kw attribute.

Parameters

fileMEFSlice | None, optional: The MEFSlice instance corresponding to the file, by default None. If None, a Header must be passed to header instead.
headerHeader, optional: The header of the FITS file, by default None. If None, a MEFSlice must be passed to file instead.

Returns

str: The filter of the image.

Parameters:

file (opticam.mef_slice.MEFSlice | None)
header (astropy.io.fits.Header | None)

Return type:

str

get_read_noise(file=None, header=None)

Get the read noise in an image, in electrons per pixel, using the instrument’s read_noise_kw attribute.

Parameters

fileMEFSlice | None, optional: The MEFSlice instance corresponding to the file, by default None. If None, a Header must be passed to header instead.
headerHeader, optional: The header of the FITS file, by default None. If None, a MEFSlice must be passed to file instead.

Returns

float: The read noise in the image.

Parameters:

file (opticam.mef_slice.MEFSlice | None)
header (astropy.io.fits.Header | None)

Return type:

float

classmethod from_json(file_path=None, config=None)

Create an instrument from a configuration file/dictionary.

Parameters

file_pathPath | str | None, optional: The path to the configuration file, by default None. If None, a dictionary must be passed to config. If a value is passed to file_path, config is ignored.
configdict[str, Any] | None, optional: The configuration dictionary, by default None. If None, a path must be passed to file_path. If a value is passed to file_path, config is ignored.

Returns

Instrument: The configured instrument.

Raises

AssertionError: If required keys are missing from the configuration file/dictionary.

Parameters:

file_path (pathlib.Path | str | None)
config (dict[str, Any] | None)

Return type:

Instrument

to_json(file_path)

Export the instrument configuration to a JSON file.

Parameters

file_pathPath | str: The location to which the file is written. If save_path does not include the file name, the file will be saved as instrument_config.json.

Parameters:: file_path (pathlib.Path | str)
Return type:: None

opticam.instruments.generate_instrument_json_template(out_directory)

Generate a template JSON file that can be used to define an Instrument.

Parameters

out_directoryPath | str: The path to the directory to which the template is saved.

Parameters:: out_directory (pathlib.Path | str)
Return type:: None

opticam.instruments.create_template()

Create an instrument configuration template.

Returns

dict[str, Any]: The instrument configuration template.

Return type:: dict[str, Any]

class opticam.instruments.OPTICAM_MX(location=EarthLocation.from_geodetic(lon=-115.463611 * u.deg, lat=31.044167 * u.deg, height=2790 * u.m), pixel_scales={'1': 0.1397, '2': 0.1406, '3': 0.1661}, dateobs_kw='UT', exptime_kw='EXPOSURE')

Bases: Instrument

OAN-SPM OPTICAM-MX instrument.

get_mjd(file=None, header=None)

Get the timestamp of the image in MJD. OPTICAM uses a “UT” keyword to represent an image’s timestamp in ISO format.

Parameters

fileMEFSlice | None, optional: The MEFSlice instance corresponding to the file, by default None. If None, a Header must be passed to header instead.
headerHeader, optional: The header of the FITS file, by default None. If None, a MEFSlice must be passed to file instead.

Returns

float: The timestamp of the image in MJD format.

Parameters:

file (opticam.mef_slice.MEFSlice | None)
header (astropy.io.fits.Header | None)

Return type:

float

get_camera(file=None, header=None)

Given the path to a FITS file, get the corresponding camera.

Parameters

fileMEFSlice | None, optional: The MEFSlice instance corresponding to the file, by default None. If None, a Header must be passed to header instead.
headerHeader, optional: The header of the FITS file, by default None. If None, a MEFSlice must be passed to file instead.

Returns

str: A unique identifier for the camera.

Parameters:

file (opticam.mef_slice.MEFSlice | None)
header (astropy.io.fits.Header | None)

Return type:

str

get_read_noise(file=None, header=None)

Get the read noise in an image, in electrons per pixel, using the instrument’s read_noise_kw attribute.

Parameters

fileMEFSlice | None, optional: The MEFSlice instance corresponding to the file, by default None. If None, a Header must be passed to header instead.
headerHeader, optional: The header of the FITS file, by default None. If None, a MEFSlice must be passed to file instead.

Returns

float: The read noise in the image.

Parameters:

file (opticam.mef_slice.MEFSlice | None)
header (astropy.io.fits.Header | None)

Return type:

float

class opticam.instruments.OPTICAM_MX_UNKNOWN

Bases: OPTICAM_MX

OAN-SPM OPTICAM-MX instrument.

class opticam.instruments.MEXMAN(location=EarthLocation.from_geodetic(lon=-115.463611 * u.deg, lat=31.044167 * u.deg, height=2790 * u.m), pixel_scales={'MEXMAN': 0.24645}, dateobs_kw='JD', binning_kw='CCDSUM')

Bases: Instrument

OAN-SPM MEXMAN instrument.

Parameters:

location (astropy.coordinates.EarthLocation)
pixel_scales (dict[str, float])
dateobs_kw (str)
binning_kw (str)

get_camera(file=None, header=None)

Get the camera used to create the file. Since MEXMAN is a single-camera instrument, the name of the instrument is returned.

Parameters

fileMEFSlice | None, optional: The MEFSlice instance corresponding to the file, by default None. If None, a Header must be passed to header instead.
headerHeader, optional: The header of the FITS file, by default None. If None, a MEFSlice must be passed to file instead.

Returns

str: The camera used to create the file.

Parameters:

file (opticam.mef_slice.MEFSlice | None)
header (astropy.io.fits.Header | None)

Return type:

str

get_mjd(file=None, header=None)

Get the timestamp of the image in MJD. MEXMAN uses a “JD” keyword to represent an image’s timestamp in Julian Date format.

Parameters

fileMEFSlice | None, optional: The MEFSlice instance corresponding to the file, by default None. If None, a Header must be passed to header instead.
headerHeader, optional: The header of the FITS file, by default None. If None, a MEFSlice must be passed to file instead.

Returns

float: The timestamp of the image in MJD format.

Parameters:

file (opticam.mef_slice.MEFSlice | None)
header (astropy.io.fits.Header | None)

Return type:

float