autocti.Clocker2D#

class autocti.Clocker2D(iterations: int = 5, parallel_roe: Optional[ROE] = None, parallel_express: int = 0, parallel_window_offset: int = 0, parallel_window_start: int = 0, parallel_window_stop: int = -1, parallel_time_start=0, parallel_time_stop=-1, parallel_prune_n_electrons=1e-18, parallel_prune_frequency=0, parallel_poisson_traps: bool = False, parallel_fast_mode: Optional[bool] = False, serial_roe: Optional[ROE] = None, serial_express: int = 0, serial_window_offset: int = 0, serial_window_start: int = 0, serial_window_stop: int = -1, serial_time_start=0, serial_time_stop=-1, serial_prune_n_electrons=1e-18, serial_prune_frequency=0, serial_fast_mode: Optional[bool] = None, allow_negative_pixels=1, verbosity: int = 0, poisson_seed: int = -1)[source]#

Performs clocking of a 2D image via the c++ arctic algorithm.

This corresponds to a full read out of a CCD including clocking in the parallel and / or serial direction.

Parameters:

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

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

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

  • parallel_window_offset – The number of pixels before parallel clocking begins, thereby extending the length over which clocking is performed in the parallel direction and increasing CTI.

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

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

  • parallel_poisson_traps – If True, the density of every trap species (which in the Trap objects is defined as the mean density of that species) are drawn from a Poisson distribution for every column of data.

  • parallel_fast_mode – If input, parallel CTI is added via arctic efficiently by determining all unique columns in the input data, calling arctic once per unique column and mapping the 1D output over the full 2D image. This requires many column in the image to have the same signal to be efficient, for example charge injection calibration data.

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

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

  • serial_window_offset – The number of pixels before serial clocking begins, thereby extending the length over which clocking is performed in the serial direction and increasing CTI.

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

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

  • serial_fast_mode – If input, serial CTI is added via arctic efficiently by calling arctic once and mapping the 1D output over the full 2D image. This requires every row in the image has the same signal (such that each column gives an identical arctic output).

  • allow_negative_pixels – If True, negative electrons in a pixel are allowed and modeled via arCTIc, if Falss they are explicitly not allowed.

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

  • poisson_seed – A seed for the random number generator which draws the Poisson trap densities from a Poisson distribution.

__init__(iterations: int = 5, parallel_roe: Optional[ROE] = None, parallel_express: int = 0, parallel_window_offset: int = 0, parallel_window_start: int = 0, parallel_window_stop: int = -1, parallel_time_start=0, parallel_time_stop=-1, parallel_prune_n_electrons=1e-18, parallel_prune_frequency=0, parallel_poisson_traps: bool = False, parallel_fast_mode: Optional[bool] = False, serial_roe: Optional[ROE] = None, serial_express: int = 0, serial_window_offset: int = 0, serial_window_start: int = 0, serial_window_stop: int = -1, serial_time_start=0, serial_time_stop=-1, serial_prune_n_electrons=1e-18, serial_prune_frequency=0, serial_fast_mode: Optional[bool] = None, allow_negative_pixels=1, verbosity: int = 0, poisson_seed: int = -1)[source]#

Performs clocking of a 2D image via the c++ arctic algorithm.

This corresponds to a full read out of a CCD including clocking in the parallel and / or serial direction.

Parameters:

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

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

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

  • parallel_window_offset – The number of pixels before parallel clocking begins, thereby extending the length over which clocking is performed in the parallel direction and increasing CTI.

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

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

  • parallel_poisson_traps – If True, the density of every trap species (which in the Trap objects is defined as the mean density of that species) are drawn from a Poisson distribution for every column of data.

  • parallel_fast_mode – If input, parallel CTI is added via arctic efficiently by determining all unique columns in the input data, calling arctic once per unique column and mapping the 1D output over the full 2D image. This requires many column in the image to have the same signal to be efficient, for example charge injection calibration data.

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

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

  • serial_window_offset – The number of pixels before serial clocking begins, thereby extending the length over which clocking is performed in the serial direction and increasing CTI.

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

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

  • serial_fast_mode – If input, serial CTI is added via arctic efficiently by calling arctic once and mapping the 1D output over the full 2D image. This requires every row in the image has the same signal (such that each column gives an identical arctic output).

  • allow_negative_pixels – If True, negative electrons in a pixel are allowed and modeled via arCTIc, if Falss they are explicitly not allowed.

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

  • poisson_seed – A seed for the random number generator which draws the Poisson trap densities from a Poisson distribution.

Methods

__init__([iterations, parallel_roe, ...])

Performs clocking of a 2D image via the c++ arctic algorithm.

add_cti(data, cti[, preloads])

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

add_cti_parallel_fast(data, cti[, preloads])

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

add_cti_poisson_traps(data, cti)

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

add_cti_serial_fast(data, cti[, preloads])

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

ccd_from(ccd_phase)

Returns a CCD object from a CCDPhase object.

fast_indexes_from(data, for_parallel)

For 2D images where the same signal is repeated over many columns (e.g.

from_json(file_path)

output_to_json(file_path)

remove_cti(data, cti)

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