PipeControl

class pipe.PipeControl(pipe_params)

Bases: object

Methods Summary

combine_psf_lists(visit_list[, lib_num])	From a list of visits, this method reads the corresponding PSF library files and merges them, with the merged list of PSFs returned.
load_binary_im()	Load binary imagette lightcurve, returns dict data structure (if it exists)
load_binary_sa()	Load binary subarray lightcurve, returns dict data structure (if it exists)
load_drp([desc])	Reads lightcurve extracted by the CHEOPS Data Reduction Pipeline.
load_im()	Load imagette lightcurve, returns dict data structure (if it exists)
load_lc([postfix])	Load lightcurve, returns dict data structure (if it exists)
load_sa()	Load subarray lightcurve, returns dict data structure (if it exists)
make_binary_psfs(lib_num[, klip, phase, ...])	Produces one library of PSFs for each component of a binary.
make_eigen(psf_lib, out_num)	From a list of PSFs, produce a list of principal component functions and save in a file ("eigen library"), enumerated by out_num.
make_psf_lib([lib_num, klip, phase, sub_orbits])	Produces a library of PSFs.
pre_binary()	Initialise PsfPhot class and do pre-processing on data (i.e.
pre_proc([pproc])	Initialise PsfPhot class and do pre-processing on data (i.e.
process_binary()	Extract photometry of a binary from the subarrays and the imagettes, if they exist.
process_eigen()	Process PSF photometry as defined by the pipe_param parameters, on both subarrays and imagettes (if they exist).
process_eigen_im()	Process PSF photometry as defined by the pipe_param parameters, on imagettes.
process_eigen_sa()	Process PSF photometry as defined by the pipe_param parameters, on subarrays.

Methods Documentation

combine_psf_lists(visit_list, lib_num=0)

From a list of visits, this method reads the corresponding PSF library files and merges them, with the merged list of PSFs returned. This list can then be used to derive an eigen library of principal PSF components.

load_binary_im()

Load binary imagette lightcurve, returns dict data structure (if it exists)

load_binary_sa()

Load binary subarray lightcurve, returns dict data structure (if it exists)

load_drp(desc='DEFAULT')

Reads lightcurve extracted by the CHEOPS Data Reduction Pipeline. Returns DRP dict.

load_im()

Load imagette lightcurve, returns dict data structure (if it exists)

load_lc(postfix='_sa')

Load lightcurve, returns dict data structure (if it exists)

load_sa()

Load subarray lightcurve, returns dict data structure (if it exists)

make_binary_psfs(lib_num, klip=None, phase=None, sub_orbits=1)

Produces one library of PSFs for each component of a binary. The data series is divided into orbits, with one PSF determined per orbit. if phase is defined, the orbits are selected to start at phase rather than the first data point. sub_orbits can be defined to divide the orbits into smaller data sets, to e.g. check if there are systematic PSF differences with roll angle.

make_eigen(psf_lib, out_num)

From a list of PSFs, produce a list of principal component functions and save in a file (“eigen library”), enumerated by out_num. The eigen library list is also returned.

make_psf_lib(lib_num=None, klip=None, phase=None, sub_orbits=1)

Produces a library of PSFs. The data series is divided into orbits, with one PSF determined per orbit. If phase is defined, the orbits are selected to start at phase rather than the first data point. sub_orbits can be defined to divide the orbits into smaller data sets, to e.g. check if there are systematic PSF differences with roll angle.

pre_binary()

Initialise PsfPhot class and do pre-processing on data (i.e. basic processing before photometric PSF extraction).

pre_proc(pproc=True)

Initialise PsfPhot class and do pre-processing on data (i.e. basic processing before photometric PSF extraction). If pproc is False, the pre-processing step is skipped.

process_binary()

Extract photometry of a binary from the subarrays and the imagettes, if they exist. Saves PSF models for the two components to class variables.

process_eigen()

Process PSF photometry as defined by the pipe_param parameters, on both subarrays and imagettes (if they exist). klip is how many principal components should be used in PSF fit. sigma_clip is the clipping factor to mask bad pixels. For poor PSF fits, sigma_clip should be high in order to not mask perfectly valid but poorly fit pixels.

process_eigen_im()

Process PSF photometry as defined by the pipe_param parameters, on imagettes. klip is how many principal components should be used in PSF fit. sigma_clip is the clipping factor to mask bad pixels. For poor PSF fits, sigma_clip should be high in order to not mask perfectly valid but poorly fit pixels.

process_eigen_sa()

Process PSF photometry as defined by the pipe_param parameters, on subarrays. klip is how many principal components should be used in PSF fit. sigma_clip is the clipping factor to mask bad pixels. For poor PSF fits, sigma_clip should be high in order to not mask perfectly valid but poorly fit pixels.