autocti.Layout2DCI#
- class autocti.Layout2DCI(shape_2d: Tuple[int, int], region_list: Union[List[Region2D], List[Tuple[int, int, int, int]]], original_roe_corner: Tuple[int, int] = (1, 0), parallel_overscan: Optional[Union[Region2D, Tuple[int, int, int, int]]] = None, serial_prescan: Optional[Union[Region2D, Tuple[int, int, int, int]]] = None, serial_overscan: Optional[Union[Region2D, Tuple[int, int, int, int]]] = None, electronics: Optional[ElectronicsCI] = None)[source]#
A charge injection layout, which defines the regions charge injections appear on a charge injection image.
It also contains over regions of the image, for example the serial prescan, overscan and paralle overscan.
- Parameters:
shape_2d – The two dimensional shape of the charge injection imaging, corresponding to the number of rows (pixels in parallel direction) and columns (pixels in serial direction).
region_list – Integer pixel coordinates specifying the corners of each charge injection region (top-row, bottom-row, left-column, right-column).
original_roe_corner – The original read-out electronics corner of the charge injeciton imaging, which is internally rotated to a common orientation in PyAutoCTI.
parallel_overscan – Integer pixel coordinates specifying the corners of the parallel overscan (top-row, bottom-row, left-column, right-column).
serial_prescan – Integer pixel coordinates specifying the corners of the serial prescan (top-row, bottom-row, left-column, right-column).
serial_overscan – Integer pixel coordinates specifying the corners of the serial overscan (top-row, bottom-row, left-column, right-column).
electronics – The charge injection electronics parameters of the image (e.g. the IG1 and IG2 voltages).
- __init__(shape_2d: Tuple[int, int], region_list: Union[List[Region2D], List[Tuple[int, int, int, int]]], original_roe_corner: Tuple[int, int] = (1, 0), parallel_overscan: Optional[Union[Region2D, Tuple[int, int, int, int]]] = None, serial_prescan: Optional[Union[Region2D, Tuple[int, int, int, int]]] = None, serial_overscan: Optional[Union[Region2D, Tuple[int, int, int, int]]] = None, electronics: Optional[ElectronicsCI] = None)[source]#
A charge injection layout, which defines the regions charge injections appear on a charge injection image.
It also contains over regions of the image, for example the serial prescan, overscan and paralle overscan.
- Parameters:
shape_2d – The two dimensional shape of the charge injection imaging, corresponding to the number of rows (pixels in parallel direction) and columns (pixels in serial direction).
region_list – Integer pixel coordinates specifying the corners of each charge injection region (top-row, bottom-row, left-column, right-column).
original_roe_corner – The original read-out electronics corner of the charge injeciton imaging, which is internally rotated to a common orientation in PyAutoCTI.
parallel_overscan – Integer pixel coordinates specifying the corners of the parallel overscan (top-row, bottom-row, left-column, right-column).
serial_prescan – Integer pixel coordinates specifying the corners of the serial prescan (top-row, bottom-row, left-column, right-column).
serial_overscan – Integer pixel coordinates specifying the corners of the serial overscan (top-row, bottom-row, left-column, right-column).
electronics – The charge injection electronics parameters of the image (e.g. the IG1 and IG2 voltages).
Methods
__init__(shape_2d, region_list[, ...])A charge injection layout, which defines the regions charge injections appear on a charge injection image.
extract_parallel_overscan_array_2d_from(array)Extract an arrays of all of the parallel trails in the parallel overscan region, that are to the side of a charge-injection scans from a charge injection frame_ci.
extract_region_from(array, region)extract_region_noise_map_from(array, region)extract_serial_overscan_array_from(array)Extract an arrays of all of the serial trails in the serial overscan region, that are to the side of a charge-injection scans from a charge injection frame_ci.
from_euclid_fits_header(ext_header)layout_extracted_from(extraction_region)The charge injection layout after an extraction is performed on its associated charge injection image, where the extraction is defined by a region of pixel coordinates:
new_rotated_from(roe_corner)noise_map_non_uniform_from(...[, read_noise])Use this charge injection layout to generate the noise-map of a charge injection image.
noise_map_non_uniform_via_lists_from(...[, ...])Use this charge injection layout to generate the noise-map of a charge injection image.
original_orientation_from(array)parallel_overscan_binned_array_1d_from(array)pre_cti_data_non_uniform_from(...[, row_slope])Use this charge injection layout to generate a pre-cti charge injection image.
pre_cti_data_non_uniform_via_lists_from(...)Use this charge injection layout to generate a pre-cti charge injection image.
pre_cti_data_uniform_from(norm, pixel_scales)Use this charge injection layout to generate a pre-cti charge injection image.
rotated_from_roe_corner(roe_corner, shape_native)serial_overscan_binned_array_1d_from(array)with_extracted_regions(extraction_region)Attributes
extractparallel_rows_between_regionsReturns a list where each entry is the number of pixels a charge injection region and its neighboring charge injection region.
parallel_rows_to_array_edgeThe number of pixels from the edge of the parallel EPERs to the edge of the array.
parallel_rows_within_regionsReturns a list where each entry is the number of pixels a charge injection region and its neighboring charge injection region.
serial_eper_pixelssmallest_parallel_rows_between_ci_regionsThe smallest number of pixels between any two charge injection regions, or the distance of the last charge injection region to the edge of the charge injeciton image (e.g.
smallest_parallel_rows_within_ci_regionsThe smallest number of pixels within any of the charge injection regions.