aicoPhot

class dorado.aicoPhot

Bases: object

Methods Summary

align(cr, filter[, alignto, getWCS, cache, ...])	align aligns a filter stack within a specified ceres object to a specified frame (default is first frame).
apPhot(cr, filter, toid[, control_toid, ...])	apPhot performs basic aperture photometry based on photutils.aperture_photometry on a target within stack.
calBase(cr, filter)	calBase calibrates a base image for a stack by computing a 2D background for the image and removing it from the base image.
calibrate(cr, filter[, use_med_cr_removal, ...])	calibrate performs 'pre-processing' CCDData calibration to a data stack within a ceres object.
differential_magnitude(flux1, flux2, mag2)	Probably could use target class inputs and uncertainties
getWCS(cr, filter[, alignto, cache])	getWCS obtains WCS information for an image either via previously solved data in the cache or by passing the image to astrometryNet via dorado.plate_solve().
imarith(cr, filter, operator, operand)	imarith is a basic replication of the IRAF image arithmatic tool imarith. Parameters ---------- cr: string The relevent name string of Ceres instance to perform image arithmatic on. filter: str String representation of the relevent filter. operator: string String of operator to be used for arithmatic. Supported operations are '+', '-', '/', and '*'.
mkBase(cr, filter[, sigClip, minmax])	mkBase stacks filter data within a ceres object to produce a base or 'average' stacked image.

Methods Documentation

align(cr, filter, alignto=None, getWCS=True, cache=False, ds=2, ma=5)

align aligns a filter stack within a specified ceres object to a specified frame (default is first frame). align can optionally retrieve the corresponding WCS data for the aligned stack.

Parameters:

cr: string

The relevent name string of Ceres instance to align.

filter: str

String representation of the relevent filter.

alignto: int

Index of image to use as reference. Default is stack.alignto

getWCS: boolean

Controls whether to obtain WCS information for stack.

cache: boolean

Controls whether to call astrometryNet for solve or use solved result stored in cache from previous run. Default is True.

ds: int or float

Sets the detection sigma value for astroalign.register. Default is 2.

ma: int or float

Sets the minimum area value for astroalign.register. Default is 5.

apPhot(cr, filter, toid, control_toid=None, shape=21, unc=0.1)

apPhot performs basic aperture photometry based on photutils.aperture_photometry on a target within stack. Target photometry can optionally be compared to a control target within the stack via the differential photometry method.

Parameters:

cr: string

The relevent name string of Ceres instance to perform aperture photometry on.

filter: str

String representation of the relevent filter.

toid: string

control_toid: string

shape: int

unc: float

calBase(cr, filter)

calBase calibrates a base image for a stack by computing a 2D background for the image and removing it from the base image.

Parameters:

cr: string

The relevent name string of Ceres instance to perform base image calibration on.

filter: str

String representation of the relevent filter.

calibrate(cr, filter, use_med_cr_removal=False, rb=0, use_lac_cr_removal=False, scln=False, scln_xy=[1, -1, 1, -1])

calibrate performs ‘pre-processing’ CCDData calibration to a data stack within a ceres object. This involves Bias and Flatfield correction and optional median value based cosmic ray removal based on the ccdprocx.cosmicray_median() method.

Parameters:

cr: string

The relevent name string of Ceres instance to calibrate.

filter: str

String representation of the relevent filter.

use_med_cr_removal: boolean

controls whether to use cosmic ray removal in calibration, may affect runtime. Default is False.

rb: int

the rbox value for ccdprocx.cosmicray_median(). Default is 0.

use_lac_cr_removalboolean

controls whether to use lacosmic ray removal in calibration, may affect runtime. Default is False ::NOTE:: the package ccdproc is required.

scln: boolean

controls whether to crop out scanlines. Default is False

scln_xy: array

array of position values for line cropping. [xmin, xmax, ymin, ymax]. Default is [1, -1, 1, -1]

differential_magnitude(flux1, flux2, mag2)

Probably could use target class inputs and uncertainties

getWCS(cr, filter, alignto=None, cache=True)

getWCS obtains WCS information for an image either via previously solved data in the cache or by passing the image to astrometryNet via dorado.plate_solve().

Parameters:

cr: string

The relevent name string of Ceres instance to get WCS information for.

filter: str

String representation of the relevent filter.

alignto: int

Index of image to use as reference. Default is stack.alignto

cache: boolean

Controls whether to call astrometryNet for solve or use solved result stored in cache from previous run. Default is True.

imarith(cr, filter, operator, operand)

imarith is a basic replication of the IRAF image arithmatic tool imarith. Parameters ———- cr: string

The relevent name string of Ceres instance to perform image arithmatic on.

filter: str

String representation of the relevent filter.

operator: string

String of operator to be used for arithmatic. Supported operations are ‘+’, ‘-’, ‘/’, and ‘*’

mkBase(cr, filter, sigClip=False, minmax=False)

mkBase stacks filter data within a ceres object to produce a base or ‘average’ stacked image.

Parameters:

cr: string

The relevent name string of Ceres instance to create a base stacked image for.

filter: str

String representation of the relevent filter.

sigClip: boolean

minmax: boolean