Zellars¶
-
class
dorado.
Zellars
(name)[source] [edit on github]¶ Bases:
object
The Zellars class represents an astronomical target and handles the targets relevent attributes. Unpassed target parameters will be gathered via astroquery (SIMBAD).
The name is a reference to the now defunct Canadian store chain, Zellars, which many Canadians saw as the Canadian version of the American store chain, Target.
- Attributes
- name: str
name of target in string format.
Methods Summary
calcmag
(filter)calcmag converts the targets flux and associated uncertainty into an instrumental magnitude and uncertainty.
export
(clippy[, objectClass])export will record the Zellars object into the dorado targets directory for future use and reference.
record
(clippy, cr[, saveType])record writes each filters timeseries to the dorado working data directory for the relevent date and target.
Methods Documentation
-
calcmag
(filter)[source] [edit on github]¶ calcmag converts the targets flux and associated uncertainty into an instrumental magnitude and uncertainty.
- Parameters
- filter: str
String representation of the relevent filter.
- Returns
- self.ts[filter][‘mag’], self.ts[filter][‘mag_unc’]
-
export
(clippy, objectClass=None)[source] [edit on github]¶ export will record the Zellars object into the dorado targets directory for future use and reference. This function is not implemented yet.
- Parameters
- clippy: Clippy instance
The active instance of clippy to handle writing the target file
- objectClass: str
Class of object to save the target under.
Notes
Examples of object classes may be: ‘star’, ‘galaxy’, ‘exoplanet’, ‘minor planet’, ‘satellite’, ‘white dwarf’, ‘nebula’, ‘messier_object’, ‘O_star’, ‘binary’, ‘globular_cluster’, ‘open_cluster’, ‘galaxy_cluster’, ‘quasar’, ‘AGN’.
Users can craft their own object naming schemes.
-
record
(clippy, cr, saveType='fits')[source] [edit on github]¶ record writes each filters timeseries to the dorado working data directory for the relevent date and target.
- Parameters
- clippy: Clippy instance
The active instance of clippy to handle writing the file
- cr: Ceres instance
The relevent instance of Ceres for which the timeseries was derived. The save location will be the working directory for this instance.
- saveType: str
String representation of the file extension to save to. Default is ‘fits’. See ‘astropy.table - write()’ for acceptable values.
- Returns
- None