BaseCorrector (corrections.BaseCorrector)

The basic correction class for the TASOC Photomety pipeline. All other specific correction classes will inherit from BaseCorrector.

Code author: Lindsey Carboneau

Code author: Rasmus Handberg <rasmush@phys.au.dk>

Code author: Filipe Pereira

class corrections.BaseCorrector(input_folder, plot=False)[source]

Bases: object

The basic correction class for the TASOC Photometry pipeline. All other specific correction classes will inherit from BaseCorrector.

plot

Boolean indicating if plotting is enabled.

Type:boolean
data_folder

Path to directory where auxillary data for the corrector should be stored.

Type:string

Code author: Lindsey Carboneau

Code author: Rasmus Handberg <rasmush@phys.au.dk>

__init__(input_folder, plot=False)[source]

Initialize the corrector.

Parameters:
  • input_folder (string) –
  • plot (boolean, optional) –
Raises:
  • IOError – If (target ID) could not be found (TODO: other values as well?)
  • ValueError – (TODO: on a lot of places)

Code author: Rasmus Handberg <rasmush@phys.au.dk>

close()[source]

Close correction object.

correct(task)[source]

Run correction.

Parameters:task (dict) – Dictionary defining a task/lightcurve to process.
Returns:Result dictionary containing information about the processing.
Return type:dict

Code author: Rasmus Handberg <rasmush@phys.au.dk>

do_correction(lightcurve)[source]

Apply corrections to target lightcurve.

Parameters:lightcurve (lightkurve.TessLightCurve object) – Lightcurve of the target star to be corrected.
Returns:The status of the corrections and the corrected lightcurve object.
Raises:NotImplementedError
load_lightcurve(task)[source]

Load lightcurve from task ID or full task dictionary.

Parameters:task (integer or dict) –
Returns:Lightcurve for the star in question.
Return type:lightkurve.TessLightCurve
Raises:ValueError – On invalid file format.

Code author: Rasmus Handberg <rasmush@phys.au.dk>

plot_folder(lc)[source]

Return folder path where plots for a given lightcurve should be saved.

Parameters:lc (lightkurve.TessLightCurve) – Lightcurve to return plot path for.
Returns:Path to directory where plots should be saved.
Return type:string

Code author: Rasmus Handberg <rasmush@phys.au.dk>

save_lightcurve(lc, output_folder=None)[source]

Save generated lightcurve to file.

Parameters:output_folder (string, optional) – Path to directory where to save lightcurve. If None the directory specified in the attribute output_folder is used.
Returns:Path to the generated file.
Return type:string

Code author: Rasmus Handberg <rasmush@phys.au.dk>

search_database(select=None, search=None, order_by=None, limit=None, distinct=False)[source]

Search list of lightcurves and return a list of tasks/stars matching the given criteria.

Parameters:
  • search (list of strings or None) – Conditions to apply to the selection of stars from the database
  • order_by (list, string or None) – Column to order the database output by.
  • limit (int or None) – Maximum number of rows to retrieve from the database. If limit is None, all the rows are retrieved.
  • distinct (boolean) – Boolean indicating if the query should return unique elements only.
Returns:

Returns all stars retrieved by the call to the database as dicts/tasks that can be consumed directly by load_lightcurve

Return type:

list of dicts

Code author: Rasmus Handberg <rasmush@phys.au.dk>

Correction Status (corrections.STATUS)

class corrections.STATUS[source]

Status indicator of the status of the correction.

ABORT = 4

The calculation was aborted.

ERROR = 2

Encountered a catastrophic error that I could not recover from.

OK = 1

Everything has gone well.

SKIPPED = 5

The target was skipped because the algorithm found that to be the best solution.

STARTED = 6

The calculation has started, but not yet finished.

UNKNOWN = 0

The status is unknown. The actual calculation has not started yet.

WARNING = 3

Something is a bit fishy. Maybe we should try again with a different algorithm?