autocti.Clocker1D#

class autocti.Clocker1D(iterations: int = 5, roe: Optional[ROE] = None, express: int = 0, window_start: int = 0, window_stop: int = -1, time_start=0, time_stop=-1, prune_n_electrons=1e-18, prune_frequency=20, allow_negative_pixels=1, pixel_bounce=None, verbosity: int = 0)[source]#

Performs clocking of a 1D signal via the c++ arctic algorithm.

This corresponds to a single row or column of a CCD in the parallel or serial direction. Given the notion of parallel and serial are not relevent in 1D, these prefixes are dropped from parameters (unlike the Clocker2D) object.

Parameters:

  • iterations – The number of iterations used to correct CTI from an image.

  • roe – Contains parameters describing the read-out electronics of the CCD (e.g. CCD dwell times, charge injection clocking, etc.).

  • express – An integer factor describing how pixel-to-pixel transfers are combined into single transfers for efficiency (see: https://academic.oup.com/mnras/article/401/1/371/1006825).

  • window_start – The pixel index of the input image where arCTIc clocking begins, for example if window_start=10 the first 10 pixels are omitted and not clocked.

  • window_start – The pixel index of the input image where arCTIc clocking ends, for example if window_start=20 any pixels after the 20th pixel are omitted and not clocked.

  • verbosity – Whether to silence print statements and output from the c++ arctic call.

__init__(iterations: int = 5, roe: Optional[ROE] = None, express: int = 0, window_start: int = 0, window_stop: int = -1, time_start=0, time_stop=-1, prune_n_electrons=1e-18, prune_frequency=20, allow_negative_pixels=1, pixel_bounce=None, verbosity: int = 0)[source]#

Performs clocking of a 1D signal via the c++ arctic algorithm.

This corresponds to a single row or column of a CCD in the parallel or serial direction. Given the notion of parallel and serial are not relevent in 1D, these prefixes are dropped from parameters (unlike the Clocker2D) object.

Parameters:

  • iterations – The number of iterations used to correct CTI from an image.

  • roe – Contains parameters describing the read-out electronics of the CCD (e.g. CCD dwell times, charge injection clocking, etc.).

  • express – An integer factor describing how pixel-to-pixel transfers are combined into single transfers for efficiency (see: https://academic.oup.com/mnras/article/401/1/371/1006825).

  • window_start – The pixel index of the input image where arCTIc clocking begins, for example if window_start=10 the first 10 pixels are omitted and not clocked.

  • window_start – The pixel index of the input image where arCTIc clocking ends, for example if window_start=20 any pixels after the 20th pixel are omitted and not clocked.

  • verbosity – Whether to silence print statements and output from the c++ arctic call.

Methods

__init__([iterations, roe, express, ...])

Performs clocking of a 1D signal via the c++ arctic algorithm.

add_cti(data, cti)

Add CTI to a 1D dataset by passing it from the c++ arctic clocking algorithm.

ccd_from(ccd_phase)

Returns a CCD object from a CCDPhase object.

check_ccd(ccd_list)

Checks that there are trap species passed to the clocking algorithm and raises an exception if not.

check_traps(trap_list_0[, trap_list_1])

Checks that there are trap species passed to the clocking algorithm and raises an exception if not.

dict()

A dictionary representation of the instance comprising a type field which contains the entire class path by which the type can be imported and constructor arguments.

from_dict(cls_dict)

Instantiate an instance of a class from its dictionary representation.

from_json(file_path)

Load the dictable object to a .json file, whereby all attributes are converted from the .json file's dictionary representation to create the instance of the object

output_to_json(file_path)

Output the dictable object to a .json file, whereby all attributes are converted to a dictionary representation first.

remove_cti(data, cti)

Add CTI to a 1D dataset by passing it from the c++ arctic clocking algorithm.