Dorado_core

class dorado.Dorado_core

Bases: object

Methods Summary

cere(key)
enter_dordir()	enter_dordir changes the workin directory to self.dordir which by default is '$user/.dorado/'.
exit_dordir()	exit_dordir changes the workin directory to the starting directory at runtime.
getDateString(cr[, utc])	getDateString computes the date string for the given ceres object.
init_dir([tess])	init_dir initializes the dorado home directory '$user/.dorado/'.
mkceres(date[, name, sub, target, ...])	mkceres is a wrapper function for self.reader.mkceres with an additional arguement for setting the keyname for the ceres instance in self.ceres_keys.
mktrgt(name[, constructor])	mktrgt takes a target name and constructs a dorado.target object that is returned to self.targets.
mkwrk(cr)	mkwrk produces a working folder for saving a ceres object to the dorado data working directory for later use.
saveBase(cr[, filters])	saveBase save the base frame of a ceres object if any. Parameters ---------- cr: string ceres key string for relevent ceres object. filters: str or list of str filters to save base frame of a ceres object. Returns -------.
saveWCS(cr[, filters])	saveWCS takes a ceres object and an optional filters argument and saves the contained WCS data to the ceres objects working directory.
savewrk(cr[, filters])	savewrk is a wrapper function for self.reader.savewrk.
target(key)

Methods Documentation

cere(key)

enter_dordir()

enter_dordir changes the workin directory to self.dordir which by default is ‘$user/.dorado/’.

Parameters:

Returns:

exit_dordir()

exit_dordir changes the workin directory to the starting directory at runtime.

Parameters:

Returns:

getDateString(cr, utc=None)

getDateString computes the date string for the given ceres object. ceres time is represented in UTC while datestring is represented in local time. A UTC offset must be provided either by self.UTCoffest or by the utc arguement.

Parameters:

crstr

the ceres object key to get the date string for.

utc: float

utc offset to apply to the date string. Default is None.

Returns:

init_dir(tess=False)

init_dir initializes the dorado home directory ‘$user/.dorado/’.

Parameters:

tess: boolean

Whether to initialize a TESS data directory in ‘./data/’

Returns

——-

mkceres(date, name=None, sub='raw', target=None, calibrated=False, aligned=False)

mkceres is a wrapper function for self.reader.mkceres with an additional arguement for setting the keyname for the ceres instance in self.ceres_keys. The default keyname is the datestring for the ceres instance.

Parameters:

name: string

keyname for the ceres instance. Default is the datestring for the ceres instance.

self.reader.mkceres args**

Returns:

mktrgt(name, constructor=<class 'dorado.target.targetClass.Target'>)

mktrgt takes a target name and constructs a dorado.target object that is returned to self.targets.

Parameters:

name: string

target name as found in SIMBAD

Returns

——-

mkwrk(cr)

mkwrk produces a working folder for saving a ceres object to the dorado data working directory for later use.

Parameters:

crstr

ceres key for ceres instance to create working directory for.

Returns

——-

saveBase(cr, filters=None)

saveBase save the base frame of a ceres object if any. Parameters ———- cr: string

ceres key string for relevent ceres object.

filters: str or list of str

filters to save base frame of a ceres object.

Returns

saveWCS(cr, filters=None)

saveWCS takes a ceres object and an optional filters argument and saves the contained WCS data to the ceres objects working directory.

Parameters:

crstr

ceres object key string for the relevent ceres object.

filtersstr or list of str

filters of WCS data to be saved.

Returns:

savewrk(cr, filters=None)

savewrk is a wrapper function for self.reader.savewrk. Parameters ———-

self.reader.savewrk args** Returns ——-

target(key)