Target¶
- class dorado.Target(name)[source] [edit on github]¶
Bases:
object
The TOI class represents an astronomical target of interest (TOI) and handles the targets relevent attributes. Unpassed target parameters will be gathered via astroquery (SIMBAD).
- 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
([objectClass])export will record the TOI object into the dorado targets directory for future use and reference.
record
(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. WARNING:: This function is currently not complete and no garentee is given on its compatability or reliability.
- Parameters:
- filter: str
String representation of the relevent filter.
- Returns:
- None
- export(objectClass=None)[source] [edit on github]¶
export will record the TOI object into the dorado targets directory for future use and reference. This function is not implemented yet.
- Parameters:
- 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(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:
- cr: string
The relevent name string of Ceres instance 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