# Licensed under a 3-clause BSD style license - see LICENSE.rst
# -*- coding: utf-8 -*-
"""
desispec.io.meta
================
IO metadata functions.
"""
from __future__ import absolute_import, division, print_function
import os
import datetime
import glob
import re
import numpy as np
from desiutil.log import get_logger
from .util import healpix_subdirectory
[docs]def findfile(filetype, night=None, expid=None, camera=None,
tile=None, groupname=None, nside=64,
band=None, spectrograph=None,
survey=None, faprogram=None,
rawdata_dir=None, specprod_dir=None,
download=False, outdir=None, qaprod_dir=None):
"""Returns location where file should be
Args:
filetype : file type, typically the prefix, e.g. "frame" or "psf"
Args depending upon filetype:
night : YEARMMDD string
expid : integer exposure id
camera : 'b0' 'r1' .. 'z9'
tile : integer tile (pointing) number
groupname : spectral grouping name (healpix pixel, tile "cumulative" or "pernight")
nside : healpix nside
band : one of 'b','r','z' identifying the camera band
spectrograph : integer spectrograph number, 0-9
survey : e.g. sv1, sv3, main, special
faprogram : fiberassign program, e.g. dark, bright
Options:
rawdata_dir : overrides $DESI_SPECTRO_DATA
specprod_dir : overrides $DESI_SPECTRO_REDUX/$SPECPROD/
qaprod_dir : defaults to $DESI_SPECTRO_REDUX/$SPECPROD/QA/ if not provided
download : if not found locally, try to fetch remotely
outdir : use this directory for output instead of canonical location
Raises:
ValueError: for invalid file types, and other invalid input
KeyError: for missing environment variables
"""
log = get_logger()
#- NOTE: specprod_dir is the directory $DESI_SPECTRO_REDUX/$SPECPROD,
#- specprod is just the environment variable $SPECPROD
location = dict(
#
# Raw data.
#
raw = '{rawdata_dir}/{night}/{expid:08d}/desi-{expid:08d}.fits.fz',
coordinates = '{rawdata_dir}/{night}/{expid:08d}/coordinates-{expid:08d}.fits',
fiberassign = '{rawdata_dir}/{night}/{expid:08d}/fiberassign-{tile:06d}.fits.gz',
etc = '{rawdata_dir}/{night}/{expid:08d}/etc-{expid:08d}.json',
#
# preproc/
# Note: fibermap files will eventually move to preproc.
#
fibermap = '{specprod_dir}/preproc/{night}/{expid:08d}/fibermap-{expid:08d}.fits',
preproc = '{specprod_dir}/preproc/{night}/{expid:08d}/preproc-{camera}-{expid:08d}.fits',
tilepix = '{specprod_dir}/preproc/{night}/{expid:08d}/tilepix-{tile}.json',
#
# exposures/
# Note: calib has been renamed to fluxcalib, but that has not propagated fully through the pipeline.
# Note: psfboot has been deprecated, but not ready to be removed yet.
#
calib = '{specprod_dir}/exposures/{night}/{expid:08d}/calib-{camera}-{expid:08d}.fits',
cframe = '{specprod_dir}/exposures/{night}/{expid:08d}/cframe-{camera}-{expid:08d}.fits',
fframe = '{specprod_dir}/exposures/{night}/{expid:08d}/fframe-{camera}-{expid:08d}.fits',
fluxcalib = '{specprod_dir}/exposures/{night}/{expid:08d}/fluxcalib-{camera}-{expid:08d}.fits',
frame = '{specprod_dir}/exposures/{night}/{expid:08d}/frame-{camera}-{expid:08d}.fits',
psf = '{specprod_dir}/exposures/{night}/{expid:08d}/psf-{camera}-{expid:08d}.fits',
fitpsf='{specprod_dir}/exposures/{night}/{expid:08d}/fit-psf-{camera}-{expid:08d}.fits',
qframe = '{specprod_dir}/exposures/{night}/{expid:08d}/qframe-{camera}-{expid:08d}.fits',
sframe = '{specprod_dir}/exposures/{night}/{expid:08d}/sframe-{camera}-{expid:08d}.fits',
sky = '{specprod_dir}/exposures/{night}/{expid:08d}/sky-{camera}-{expid:08d}.fits',
skycorr = '{specprod_dir}/exposures/{night}/{expid:08d}/skycorr-{camera}-{expid:08d}.fits',
fiberflat = '{specprod_dir}/exposures/{night}/{expid:08d}/fiberflat-{camera}-{expid:08d}.fits',
fiberflatexp = '{specprod_dir}/exposures/{night}/{expid:08d}/fiberflatexp-{camera}-{expid:08d}.fits',
stdstars = '{specprod_dir}/exposures/{night}/{expid:08d}/stdstars-{spectrograph:d}-{expid:08d}.fits',
calibstars = '{specprod_dir}/exposures/{night}/{expid:08d}/calibstars-{expid:08d}.csv',
psfboot = '{specprod_dir}/exposures/{night}/{expid:08d}/psfboot-{camera}-{expid:08d}.fits',
# qa
exposureqa = '{specprod_dir}/exposures/{night}/{expid:08d}/exposure-qa-{expid:08d}.fits',
tileqa = '{specprod_dir}/tiles/{groupname}/{tile:d}/{night}/tile-qa-{tile:d}-{nightprefix}{night}.fits',
tileqapng = '{specprod_dir}/tiles/{groupname}/{tile:d}/{night}/tile-qa-{tile:d}-{nightprefix}{night}.png',
zmtl = '{specprod_dir}/tiles/{groupname}/{tile:d}/{night}/zmtl-{spectrograph:d}-{tile:d}-{nightprefix}{night}.fits',
#
# calibnight/
#
fiberflatnight = '{specprod_dir}/calibnight/{night}/fiberflatnight-{camera}-{night}.fits',
psfnight = '{specprod_dir}/calibnight/{night}/psfnight-{camera}-{night}.fits',
biasnight = '{specprod_dir}/calibnight/{night}/biasnight-{camera}-{night}.fits.gz',
badfibers = '{specprod_dir}/calibnight/{night}/badfibers-{night}.csv',
badcolumns = '{specprod_dir}/calibnight/{night}/badcolumns-{camera}-{night}.csv',
#
# spectra- healpix based
#
zcatalog = '{specprod_dir}/zcatalog-{specprod}.fits',
coadd_hp = '{specprod_dir}/healpix/{survey}/{faprogram}/{hpixdir}/coadd-{survey}-{faprogram}-{groupname}.fits',
rrdetails_hp = '{specprod_dir}/healpix/{survey}/{faprogram}/{hpixdir}/rrdetails-{survey}-{faprogram}-{groupname}.h5',
spectra_hp = '{specprod_dir}/healpix/{survey}/{faprogram}/{hpixdir}/spectra-{survey}-{faprogram}-{groupname}.fits',
redrock_hp = '{specprod_dir}/healpix/{survey}/{faprogram}/{hpixdir}/redrock-{survey}-{faprogram}-{groupname}.fits',
#
# spectra- tile based
#
coadd_tile='{specprod_dir}/tiles/{groupname}/{tile:d}/{night}/coadd-{spectrograph:d}-{tile:d}-{nightprefix}{night}.fits',
rrdetails_tile='{specprod_dir}/tiles/{groupname}/{tile:d}/{night}/rrdetails-{spectrograph:d}-{tile:d}-{nightprefix}{night}.h5',
spectra_tile='{specprod_dir}/tiles/{groupname}/{tile:d}/{night}/spectra-{spectrograph:d}-{tile:d}-{nightprefix}{night}.fits',
redrock_tile='{specprod_dir}/tiles/{groupname}/{tile:d}/{night}/redrock-{spectrograph:d}-{tile:d}-{nightprefix}{night}.fits',
#
# spectra- single exp tile based
#
coadd_single='{specprod_dir}/tiles/perexp/{tile:d}/{expid:08d}/coadd-{spectrograph:d}-{tile:d}-exp{expid:08d}.fits',
rrdetails_single='{specprod_dir}/tiles/perexp/{tile:d}/{expid:08d}/rrdetails-{spectrograph:d}-{tile:d}-exp{expid:08d}.h5',
spectra_single='{specprod_dir}/tiles/perexp/{tile:d}/{expid:08d}/spectra-{spectrograph:d}-{tile:d}-exp{expid:08d}.fits',
redrock_single='{specprod_dir}/tiles/perexp/{tile:d}/{expid:08d}/redrock-{spectrograph:d}-{tile:d}-exp{expid:08d}.fits',
tileqa_single = '{specprod_dir}/tiles/perexp/{tile:d}/{expid:08d}/tile-qa-{tile:d}-exp{expid:08d}.fits',
tileqapng_single = '{specprod_dir}/tiles/perexp/{tile:d}/{expid:08d}/tile-qa-{tile:d}-exp{expid:08d}.png',
#
# Deprecated QA files below this point.
#
qa_data = '{qaprod_dir}/exposures/{night}/{expid:08d}/qa-{camera}-{expid:08d}.yaml',
qa_data_exp = '{qaprod_dir}/exposures/{night}/{expid:08d}/qa-{expid:08d}.yaml',
qa_bootcalib = '{qaprod_dir}/calib2d/psf/{night}/qa-psfboot-{camera}.pdf',
qa_sky_fig = '{qaprod_dir}/exposures/{night}/{expid:08d}/qa-sky-{camera}-{expid:08d}.png',
qa_skychi_fig = '{qaprod_dir}/exposures/{night}/{expid:08d}/qa-skychi-{camera}-{expid:08d}.png',
qa_s2n_fig = '{qaprod_dir}/exposures/{night}/{expid:08d}/qa-s2n-{camera}-{expid:08d}.png',
qa_flux_fig = '{qaprod_dir}/exposures/{night}/{expid:08d}/qa-flux-{camera}-{expid:08d}.png',
qa_toplevel_html = '{qaprod_dir}/qa-toplevel.html',
qa_calib = '{qaprod_dir}/calib2d/{night}/qa-{camera}-{expid:08d}.yaml',
qa_calib_html = '{qaprod_dir}/calib2d/qa-calib2d.html',
qa_calib_exp = '{qaprod_dir}/calib2d/{night}/qa-{expid:08d}.yaml',
qa_calib_exp_html = '{qaprod_dir}/calib2d/{night}/qa-{expid:08d}.html',
qa_exposures_html = '{qaprod_dir}/exposures/qa-exposures.html',
qa_exposure_html = '{qaprod_dir}/exposures/{night}/{expid:08d}/qa-{expid:08d}.html',
qa_flat_fig = '{qaprod_dir}/calib2d/{night}/qa-flat-{camera}-{expid:08d}.png',
qa_ztruth = '{qaprod_dir}/exposures/{night}/qa-ztruth-{night}.yaml',
qa_ztruth_fig = '{qaprod_dir}/exposures/{night}/qa-ztruth-{night}.png',
ql_fig = '{specprod_dir}/exposures/{night}/{expid:08d}/ql-qlfig-{camera}-{expid:08d}.png',
ql_file = '{specprod_dir}/exposures/{night}/{expid:08d}/ql-qlfile-{camera}-{expid:08d}.json',
ql_mergedQA_file = '{specprod_dir}/exposures/{night}/{expid:08d}/ql-mergedQA-{camera}-{expid:08d}.json',
)
location['desi'] = location['raw']
#- default group is "cumulative" for tile-based files
if groupname is None and tile is not None and filetype in (
'spectra', 'coadd', 'redrock', 'rrdetails', 'tileqa', 'tileqapng', 'zmtl',
'spectra_tile', 'coadd_tile', 'redrock_tile', 'rrdetails_tile',
):
groupname = 'cumulative'
if str(groupname) == "cumulative":
nightprefix = "thru"
elif groupname == 'perexp':
nightprefix = "exp"
else:
nightprefix = ""
if tile is not None:
log.debug("Tile-based files selected; healpix-based files and input will be ignored.")
if groupname == 'perexp':
location['coadd'] = location['coadd_single']
location['redrock'] = location['redrock_single']
location['spectra'] = location['spectra_single']
location['rrdetails'] = location['rrdetails_single']
location['tileqa'] = location['tileqa_single']
location['tileqapng'] = location['tileqapng_single']
else:
location['coadd'] = location['coadd_tile']
location['redrock'] = location['redrock_tile']
location['spectra'] = location['spectra_tile']
location['rrdetails'] = location['rrdetails_tile']
# tileqa/tileqapng default already correct for pernight/cumulative
else:
location['coadd'] = location['coadd_hp']
location['redrock'] = location['redrock_hp']
location['spectra'] = location['spectra_hp']
location['rrdetails'] = location['rrdetails_hp']
if groupname is not None and tile is None:
hpix = int(groupname)
log.debug('healpix_subdirectory(%d, %d)', nside, hpix)
hpixdir = healpix_subdirectory(nside, hpix)
else:
#- set to anything so later logic will trip on groupname not hpixdir
hpixdir = 'hpix'
log.debug("hpixdir = '%s'", hpixdir)
#- Do we know about this kind of file?
if filetype not in location:
raise ValueError("Unknown filetype {}; known types are {}".format(filetype, list(location.keys())))
#- Check for missing inputs, deduplicate via frozenset()
required_inputs = frozenset([i[0] for i in re.findall(r'\{([a-z_]+)(|[:0-9d]+)\}', location[filetype])])
if rawdata_dir is None and 'rawdata_dir' in required_inputs:
rawdata_dir = rawdata_root()
log.debug("rawdata_dir = '%s'", rawdata_dir)
if specprod_dir is None and 'specprod_dir' in required_inputs and outdir is None :
specprod_dir = specprod_root()
log.debug("specprod_dir = '%s'", specprod_dir)
elif outdir is not None :
# if outdir is set, we will replace specprod_dir anyway
# but we may need the variable to be set in the meantime
specprod_dir = "dummy"
if qaprod_dir is None and 'qaprod_dir' in required_inputs:
qaprod_dir = qaprod_root(specprod_dir=specprod_dir)
if 'specprod' in required_inputs and outdir is None :
#- Replace / with _ in $SPECPROD so we can use it in a filename
specprod = os.environ['SPECPROD'].replace('/', '_')
else:
specprod = None
if camera is not None:
camera = camera.lower()
#- Check camera b0, r1, .. z9
if spectrograph is not None and len(camera) == 1 \
and camera in ['b', 'r', 'z']:
raise ValueError('Specify camera=b0,r1..z9, not camera=b/r/z + spectrograph')
if camera != '*' and re.match(r'[brz\*\?][0-9\*\?]', camera) is None:
raise ValueError('Camera {} should be b0,r1..z9, or with ?* wildcards'.format(camera))
actual_inputs = {
'specprod_dir':specprod_dir, 'specprod':specprod, 'qaprod_dir':qaprod_dir,
'night':night, 'expid':expid, 'tile':tile, 'camera':camera, 'groupname':groupname,
'nside':nside, 'hpixdir':hpixdir, 'band':band,
'spectrograph':spectrograph, 'nightprefix':nightprefix,
}
#- survey and faprogram should be lower, but don't trip on None
actual_inputs['survey'] = None if survey is None else survey.lower()
actual_inputs['faprogram'] = None if faprogram is None else faprogram.lower()
if 'rawdata_dir' in required_inputs:
actual_inputs['rawdata_dir'] = rawdata_dir
for i in required_inputs:
if actual_inputs[i] is None:
raise ValueError("Required input '{0}' is not set for type '{1}'!".format(i,filetype))
#- normpath to remove extraneous double slashes /a/b//c/d
filepath = os.path.normpath(location[filetype].format(**actual_inputs))
if outdir:
filepath = os.path.join(outdir, os.path.basename(filepath))
if download:
from .download import download
log.debug("download('%s', single_thread=True)", filepath)
filepath = download(filepath, single_thread=True)[0]
return filepath
[docs]def get_raw_files(filetype, night, expid, rawdata_dir=None):
"""Get files for a specified exposure.
Uses :func:`findfile` to determine the valid file names for the specified
type. Any camera identifiers not matching the regular expression
[brz][0-9] will be silently ignored.
Args:
filetype(str): Type of files to get. Valid choices are 'raw', 'preproc',
'fibermap'.
night(str): Date string for the requested night in the format
YYYYMMDD.
expid(int): Exposure number to get files for.
rawdata_dir(str): [optional] overrides $DESI_SPECTRO_DATA
Returns:
dict: Dictionary of found file names using camera id strings as keys,
which are guaranteed to match the regular expression [brz][0-9].
"""
glob_pattern = findfile(filetype, night, expid, camera='*', rawdata_dir=rawdata_dir)
literals = [re.escape(tmp) for tmp in glob_pattern.split('*')]
re_pattern = re.compile('([brz][0-9])'.join(literals))
listing = glob.glob(glob_pattern)
if len(listing) == 1:
return listing[0]
files = {}
for entry in listing:
found = re_pattern.match(entry)
files[found.group(1)] = entry
return files
[docs]def get_files(filetype, night, expid, specprod_dir=None, qaprod_dir=None, **kwargs):
"""Get files for a specified exposure.
Uses :func:`findfile` to determine the valid file names for the specified
type. Any camera identifiers not matching the regular expression
[brz][0-9] will be silently ignored.
Args:
filetype(str): Type of files to get. Valid choices are 'frame',
'cframe', 'psf', etc.
night(str): Date string for the requested night in the format YYYYMMDD.
expid(int): Exposure number to get files for.
specprod_dir(str): Path containing the exposures/ directory to use. If
the value is None, then the value of :func:`specprod_root` is used
instead. Ignored when raw is True.
Returns:
dict: Dictionary of found file names using camera id strings as keys,
which are guaranteed to match the regular expression [brz][0-9].
"""
glob_pattern = findfile(filetype, night, expid, camera='*', specprod_dir=specprod_dir,
qaprod_dir=qaprod_dir)
literals = [re.escape(tmp) for tmp in glob_pattern.split('*')]
re_pattern = re.compile('([brz][0-9])'.join(literals))
files = { }
for entry in glob.glob(glob_pattern):
found = re_pattern.match(entry)
files[found.group(1)] = entry
return files
[docs]def validate_night(night):
"""Validates a night string and converts to a date.
Args:
night(str): Date string for the requested night in the format YYYYMMDD.
Returns:
datetime.date: Date object representing this night.
Raises:
ValueError: Badly formatted night string.
"""
try:
return datetime.datetime.strptime(night,'%Y%m%d').date()
except ValueError:
raise ValueError('Badly formatted night %s' % night)
[docs]def find_exposure_night(expid, specprod_dir=None):
""" Find the night that has the exposure
Args:
expid: int
specprod_dir: str, optional
Returns:
night: str
"""
# Search for the exposure folder
nights = get_nights(specprod_dir=specprod_dir)
for night in nights:
for exposure in get_exposures(night, specprod_dir=specprod_dir):
if exposure == expid:
return night
[docs]def get_exposures(night, raw=False, rawdata_dir=None, specprod_dir=None):
"""Get a list of available exposures for the specified night.
Exposures are identified as correctly formatted subdirectory names within the
night directory, but no checks for valid contents of these exposure subdirectories
are performed.
Args:
night(str): Date string for the requested night in the format YYYYMMDD.
raw(bool): Returns raw exposures if set, otherwise returns processed exposures.
rawdata_dir(str): [optional] overrides $DESI_SPECTRO_DATA
specprod_dir(str): Path containing the exposures/ directory to use. If the value
is None, then the value of :func:`specprod_root` is used instead. Ignored
when raw is True.
Returns:
list: List of integer exposure numbers available for the specified night. The
list will be empty if no the night directory exists but does not contain
any exposures.
Raises:
ValueError: Badly formatted night date string
IOError: non-existent night.
"""
date = validate_night(night)
if raw:
if rawdata_dir is None:
rawdata_dir = rawdata_root()
night_path = os.path.join(rawdata_dir, night)
else:
if specprod_dir is None:
specprod_dir = specprod_root()
night_path = os.path.join(specprod_dir, 'exposures', night)
if not os.path.exists(night_path):
raise IOError('Non-existent night {0}'.format(night))
exposures = []
for entry in glob.glob(os.path.join(night_path, '*')):
e = os.path.basename(entry)
try:
exposure = int(e)
assert e == "{0:08d}".format(exposure)
exposures.append(exposure)
except (ValueError, AssertionError):
# Silently ignore entries that are not exposure subdirectories.
pass
return sorted(exposures)
[docs]def get_reduced_frames(channels=['b','r','z'], nights=None, ftype='cframe', **kwargs):
""" Loops through a production to find all reduced frames (default is cframes)
One can choose a subset of reduced frames by argument
Args:
channels: list, optional
nights: list, optional
ftype: str, optional
kwargs: passed to get_files()
Returns:
all_frames: list for frame filenames
"""
all_frames = []
# Nights
if nights is None:
nights = get_nights()
# Loop on night
for night in nights:
exposures = get_exposures(night)
for exposure in exposures:
frames_dict = get_files(filetype=ftype, night=night, expid=exposure, **kwargs)
# Restrict on channel
for key in frames_dict.keys():
for channel in channels:
if channel in key:
all_frames.append(frames_dict[key])
# Return
return all_frames
[docs]def get_nights(strip_path=True, specprod_dir=None, sub_folder='exposures'):
""" Generate a list of nights in a given folder (default is exposures/)
Demands an 8 digit name beginning with 20
Args:
strip_path: bool, optional; Strip the path to the nights folders
rawdata_dir:
specprod_dir:
sub_root: str, optional; 'exposures', 'calib2d'
Returns:
nights: list of nights (without or with paths)
"""
# Init
if specprod_dir is None:
specprod_dir = specprod_root()
# Glob for nights
sub_path = os.path.join(specprod_dir, sub_folder)
nights_with_path = glob.glob(sub_path+'/*')
# Strip off path
stripped = [os.path.basename(inight_path) for inight_path in nights_with_path]
# Vet and generate
nights = []
for ii,istrip in enumerate(stripped):
if (istrip[0:2] == '20') and len(istrip) == 8:
if strip_path:
nights.append(istrip)
else:
nights.append(nights_with_path[ii])
# Return
return sorted(nights)
[docs]def shorten_filename(filename):
"""Attempt to shorten filename to fit in FITS header without CONTINUE
Args:
filename (str): input filename
Returns potentially shortened filename
Replaces prefixes from environment variables:
* $DESI_SPECTRO_CALIB -> SPCALIB
* $DESI_SPECTRO_REDUX/$SPECPROD -> SPECPROD
"""
if filename is None : return "None"
spcalib = os.getenv('DESI_SPECTRO_CALIB')
if spcalib is not None and filename.startswith(spcalib):
return filename.replace(spcalib, 'SPCALIB', 1)
try:
specprod = specprod_root()
except KeyError:
specprod = None
if specprod is not None and filename.startswith(specprod):
return filename.replace(specprod, 'SPECPROD', 1)
#- no substitutions
return filename
[docs]def rawdata_root():
"""Returns directory root for raw data, i.e. ``$DESI_SPECTRO_DATA``
Raises:
KeyError: if these environment variables aren't set.
"""
return os.environ['DESI_SPECTRO_DATA']
[docs]def specprod_root(specprod=None):
"""Return directory root for spectro production, i.e.
``$DESI_SPECTRO_REDUX/$SPECPROD``.
Options:
specprod (str): overrides $SPECPROD
Raises:
KeyError: if these environment variables aren't set.
"""
if specprod is None:
specprod = os.environ['SPECPROD']
return os.path.join(os.environ['DESI_SPECTRO_REDUX'], specprod)
[docs]def qaprod_root(specprod_dir=None):
"""Return directory root for spectro production QA, i.e.
``$DESI_SPECTRO_REDUX/$SPECPROD/QA``.
Raises:
KeyError: if these environment variables aren't set.
"""
if specprod_dir is None:
specprod_dir = specprod_root()
return os.path.join(specprod_dir, 'QA')
[docs]def faflavor2program(faflavor):
"""
Map FAFLAVOR keywords to what we wish we had set for FAPRGRM
Args:
faflavor (str or array of str): FAFLAVOR keywords from fiberassign
Returns:
faprgm (str or array of str): what FAPRGM would be if we had set it
(dark, bright, backup, other)
Note: this was standardized by sv3 and main, but evolved during sv1 and sv2
"""
#- Handle scalar or array input, upcasting bytes to str as needed
scalar_input = np.isscalar(faflavor)
faflavor = np.atleast_1d(faflavor).astype(str)
#- Default FAPRGRM is "other"
faprogram = np.tile('other', len(faflavor)).astype('U6')
#- FAFLAVOR options that map to FAPRGM='dark'
#- Note: some sv1 tiles like 80605 had "cmx" in the faflavor name
dark = faflavor == 'cmxelg'
dark |= faflavor == 'cmxlrgqso'
dark |= faflavor == 'sv1elg'
dark |= faflavor == 'sv1elgqso'
dark |= faflavor == 'sv1lrgqso'
dark |= faflavor == 'sv1lrgqso2'
dark |= np.char.endswith(faflavor, 'dark')
#- SV1 FAFLAVOR options that map to FAPRGRM='bright'
bright = faflavor == 'sv1bgsmws'
bright |= (faflavor != 'sv1unwisebluebright') & np.char.endswith(faflavor, 'bright')
#- SV1 FAFLAVOR options that map to FAPRGRM='backup'
backup = faflavor == 'sv1backup1'
backup |= np.char.endswith(faflavor, 'backup')
faprogram[dark] = 'dark'
faprogram[bright] = 'bright'
faprogram[backup] = 'backup'
if scalar_input:
return str(faprogram[0])
else:
return faprogram
[docs]def get_pipe_database():
"""Get the production database location based on the environment.
"""
if "DESI_SPECTRO_DB" in os.environ:
# Use an alternate location for the DB
dbpath = os.environ["DESI_SPECTRO_DB"]
else:
proddir = specprod_root()
dbpath = os.path.join(proddir, "desi.db")
os.environ["DESI_SPECTRO_DB"] = dbpath
return dbpath
[docs]def get_pipe_rundir(specprod_dir=None):
"""
Return the directory path for pipeline runtime files.
Args:
specprod_dir (str): Optional path to production directory. If None,
the this is obtained from :func:`specprod_root`.
Returns (str):
the directory path for pipeline runtime files.
"""
if specprod_dir is None:
specprod_dir = specprod_root()
return os.path.join(os.path.abspath(specprod_dir), "run")
[docs]def get_pipe_scriptdir():
"""
Return the name of the subdirectory containing pipeline scripts.
Returns (str):
The name of the subdirectory.
"""
return "scripts"
[docs]def get_pipe_logdir():
"""
Return the name of the subdirectory containing pipeline logs.
Returns (str):
The name of the subdirectory.
"""
return "logs"
[docs]def get_pipe_nightdir():
"""
Return the name of the subdirectory containing per-night files.
Returns (str):
The name of the subdirectory.
"""
return "night"
[docs]def get_pipe_pixeldir():
"""
Return the name of the subdirectory containing per-pixel files.
Returns (str):
The name of the subdirectory.
"""
return "healpix"