resolvit 0.1.0__py3-none-any.whl

resolvit/__init__.py

@@ -0,0 +1,11 @@
+from .resolvit import (
+    process_observation,
+    process_events_list,
+    __version__,
+)
+
+__all__ = [
+    "process_observation",
+    "process_events_list",
+    "__version__",
+]

resolvit/cli.py

@@ -0,0 +1,60 @@
+import argparse
+
+from .resolvit import (
+    process_observation,
+    DEFAULT_BIN_SIZE,
+    DEFAULT_TOTAL_EVENTS_FRACTION,
+    __version__,
+)
+
+
+def main():
+
+    parser = argparse.ArgumentParser(
+        prog="resolvit",
+        description=(
+            "Improve the PSF of UVIT Level2 event lists and "
+            "generate Resolvit data products."
+        ),
+    )
+
+    parser.add_argument(
+        "observation_dir",
+        help="Path to UVIT Level2 observation directory",
+    )
+
+    parser.add_argument(
+        "--version",
+        action="version",
+        version=f"%(prog)s {__version__}",
+    )
+
+    parser.add_argument(
+        "--bin-size",
+        type=float,
+        default=DEFAULT_BIN_SIZE,
+        metavar="SECONDS",
+        help=(f"Time bin size in seconds (default: {DEFAULT_BIN_SIZE})"),
+    )
+
+    parser.add_argument(
+        "--event-fraction",
+        type=float,
+        default=DEFAULT_TOTAL_EVENTS_FRACTION,
+        metavar="FRACTION",
+        help=(
+            f"Fraction of median events required for a bin (default: {DEFAULT_TOTAL_EVENTS_FRACTION})"
+        ),
+    )
+
+    args = parser.parse_args()
+
+    process_observation(
+        args.observation_dir,
+        bin_size=args.bin_size,
+        total_events_fraction=args.event_fraction,
+    )
+
+
+if __name__ == "__main__":
+    main()

resolvit/resolvit.py

@@ -0,0 +1,734 @@
+#!/usr/bin/env python3
+
+import numpy as np
+import matplotlib.pyplot as plt
+
+from glob import glob
+from shutil import copy
+from pathlib import Path
+from astropy.io import fits
+from astropy.wcs import WCS
+from astropy.convolution import Gaussian2DKernel, convolve, Box2DKernel
+from datetime import datetime
+from scipy import interpolate
+
+
+__version__ = "0.1.0"
+
+DEFAULT_BIN_SIZE = 100.0
+DEFAULT_ITERATION_OFFSETS = [0, 1 / 2, 1 / 4, 1 / 3]
+DEFAULT_TOTAL_EVENTS_FRACTION = 0.75
+DEFAULT_UPPER_LIMIT = 10  # sub-pixels
+
+
+def write_processing_log(
+    paths,
+    events_list,
+    bin_size,
+    total_events_fraction,
+    iteration_offsets,
+):
+    with open(paths.log_file, "w") as logfile:
+
+        logfile.write("Product information\n")
+        logfile.write("-------------------\n")
+        logfile.write(f"Product ID       : {paths.product_id}\n")
+        logfile.write(f"Input file       : {events_list}\n")
+        logfile.write(f"Output file      : {paths.corrected_events_list}\n")
+
+        logfile.write("\n")
+
+        logfile.write("Run information\n")
+        logfile.write("---------------\n")
+        logfile.write(f"Resolvit version : {__version__}\n")
+        logfile.write(f"Run time         : " f"{datetime.utcnow().isoformat()} UTC\n")
+
+        logfile.write("\n")
+
+        logfile.write("Algorithm parameters\n")
+        logfile.write("--------------------\n")
+        logfile.write(f"Bin size         : {bin_size}\n")
+        logfile.write(f"Event fraction   : " f"{total_events_fraction}\n")
+        logfile.write(f"Iterations       : " f"{len(iteration_offsets)}\n")
+
+        for i, offset in enumerate(
+            iteration_offsets,
+            start=1,
+        ):
+            logfile.write(f"Iteration {i} offset : " f"{offset}\n")
+
+
+class ResolvitProductPaths:
+    def __init__(self, events_list):
+
+        self.events_list = Path(events_list)
+
+        self.channel_dir = self.events_list.parent
+
+        self.uvit_dir = self.events_list.parents[2]
+
+        self.resolvit_products_dir = self.uvit_dir / "resolvit_data_products"
+
+        self.channel_name = self.channel_dir.name
+
+        self.resolvit_channel_dir = self.resolvit_products_dir / self.channel_name
+
+        self.resolvit_channel_dir.mkdir(
+            parents=True,
+            exist_ok=True,
+        )
+
+        self.product_id = self.events_list.name.replace("_l2ce.fits", "")
+
+        self.diagnostics_dir = (
+            self.resolvit_products_dir / "diagnostics" / self.product_id
+        )
+
+        self.diagnostics_dir.mkdir(
+            parents=True,
+            exist_ok=True,
+        )
+
+        self.corrected_events_list = self.resolvit_channel_dir / self.events_list.name
+
+    def correlation_plot(
+        self,
+        iteration_no,
+        bin_size,
+        t_mid,
+    ):
+        return (
+            self.diagnostics_dir
+            / f"{iteration_no}_{bin_size:.0f}_{t_mid:.0f}_correlations.png"
+        )
+
+    def residual_plot(
+        self,
+        iteration_no,
+    ):
+        return self.diagnostics_dir / f"residuals_iteration_{iteration_no}.png"
+
+    def residual_file(
+        self,
+        iteration_no,
+    ):
+        return self.diagnostics_dir / f"residuals_iteration_{iteration_no}.txt"
+
+    @property
+    def log_file(self):
+        return self.diagnostics_dir / "resolvit.log"
+
+    @property
+    def instrument_image(self):
+        return self.resolvit_channel_dir / (
+            self.events_list.name.replace(
+                "_l2ce.fits",
+                "I_l2img.fits",
+            )
+        )
+
+    @property
+    def instrument_error(self):
+        return self.resolvit_channel_dir / (
+            self.events_list.name.replace(
+                "_l2ce.fits",
+                "I_l2err.fits",
+            )
+        )
+
+    @property
+    def astronomical_image(self):
+        return self.resolvit_channel_dir / (
+            self.events_list.name.replace(
+                "_l2ce.fits",
+                "A_l2img.fits",
+            )
+        )
+
+    @property
+    def astronomical_error(self):
+        return self.resolvit_channel_dir / (
+            self.events_list.name.replace(
+                "_l2ce.fits",
+                "A_l2err.fits",
+            )
+        )
+
+    @property
+    def instrument_exposure(self):
+        return self.resolvit_channel_dir / (
+            self.events_list.name.replace(
+                "_l2ce.fits",
+                "I_l2exp.fits",
+            )
+        )
+
+    @property
+    def astronomical_exposure(self):
+        return self.resolvit_channel_dir / (
+            self.events_list.name.replace(
+                "_l2ce.fits",
+                "A_l2exp.fits",
+            )
+        )
+
+
+def copy_exposure_maps(events_list, paths):
+
+    exposure_maps = [
+        str(events_list).replace(
+            "_l2ce.fits",
+            "I_l2exp.fits",
+        ),
+        str(events_list).replace(
+            "_l2ce.fits",
+            "A_l2exp.fits",
+        ),
+    ]
+
+    for exposure_map in exposure_maps:
+
+        exposure_map = Path(exposure_map)
+
+        if exposure_map.exists():
+
+            destination = paths.resolvit_channel_dir / exposure_map.name
+
+            copy(
+                exposure_map,
+                destination,
+            )
+
+
+def read_and_filter_events(events_list_hdu):
+    time = events_list_hdu[1].data["MJD_L2"]
+    fx = events_list_hdu[1].data["Fx"]
+    fy = events_list_hdu[1].data["Fy"]
+    photons = events_list_hdu[1].data["EFFECTIVE_NUM_PHOTONS"]
+    bad_flag = events_list_hdu[1].data["BAD FLAG"]
+    mask = photons > 0
+    mask = np.logical_and(mask, bad_flag)
+    time = time[mask]
+    fx = fx[mask]
+    fy = fy[mask]
+    photons = photons[mask]
+    photons = photons / np.median(photons)
+    return time, fx, fy, photons
+
+
+class EventListCorrelator:
+    def __init__(self, reference_events_list, to_match_events_list):
+        self.reference_events_list = reference_events_list
+        self.to_match_events_list = to_match_events_list
+        self.upper_limit = DEFAULT_UPPER_LIMIT
+
+    def get_columns(self, data):
+        time = data["time"]
+        fx = data["fx"]
+        fy = data["fy"]
+        photons = data["photons"]
+        return time, fx, fy, photons
+
+    def get_image(self, hdu, bins):
+        time, fx, fy, photons = self.get_columns(hdu)
+        ndarray, yedges, xedges = np.histogram2d(
+            fy, fx, bins=(bins, bins), weights=photons
+        )
+        return ndarray
+
+    def get_lag(self, correlations, shift_range):
+        f = interpolate.interp1d(shift_range, correlations, kind="quadratic")
+        new_range = np.linspace(
+            shift_range[0],
+            shift_range[-1],
+            num=(self.upper_limit * 2 + 1) * 100,
+            endpoint=True,
+        )
+        interpolated_correlations = f(new_range)
+        max_index = np.argmax(interpolated_correlations)
+        peak_position = new_range[max_index]
+        return peak_position
+
+    def get_shifts(self, bin_size=1, correlation_plot=None):
+        # To get shifts
+        bins = np.arange(0, 4801, bin_size)
+        reference_image = self.get_image(self.reference_events_list, bins)
+        to_match_image = self.get_image(self.to_match_events_list, bins)
+
+        box_kernel = Box2DKernel(5)
+        boxed_reference_image = convolve(reference_image, box_kernel)
+        reference_image_background_mask = boxed_reference_image <= (4 / 25)
+        reference_image[reference_image_background_mask] = 0
+
+        boxed_to_match_image = convolve(to_match_image, box_kernel)
+        to_match_image_background_mask = boxed_to_match_image <= (4 / 25)
+        to_match_image[to_match_image_background_mask] = 0
+
+        kernel = Gaussian2DKernel(x_stddev=1)
+        smoothed_reference_image = convolve(reference_image, kernel)
+        smoothed_to_match_image = convolve(to_match_image, kernel)
+
+        smoothed_reference_image = smoothed_reference_image / np.std(
+            smoothed_reference_image
+        )
+        smoothed_to_match_image = smoothed_to_match_image / np.std(
+            smoothed_to_match_image
+        )
+
+        smoothed_reference_image[smoothed_reference_image < 0] = 0
+        smoothed_to_match_image[smoothed_to_match_image < 0] = 0
+
+        smoothed_reference_X = np.sum(smoothed_reference_image, axis=0)
+        smoothed_reference_Y = np.sum(smoothed_reference_image, axis=1)
+
+        smoothed_to_match_X = np.sum(smoothed_to_match_image, axis=0)
+        smoothed_to_match_Y = np.sum(smoothed_to_match_image, axis=1)
+
+        shift_limit = int(self.upper_limit / bin_size)
+        shift_range = np.arange(-shift_limit, shift_limit + 1)
+
+        X_correlations = []
+        Y_correlations = []
+        for shift in shift_range:
+            X_product = np.sum(
+                smoothed_reference_X * np.roll(smoothed_to_match_X, shift)
+            )
+            Y_product = np.sum(
+                smoothed_reference_Y * np.roll(smoothed_to_match_Y, shift)
+            )
+            X_correlations.append(X_product)
+            Y_correlations.append(Y_product)
+
+        x_shift = self.get_lag(X_correlations, shift_range) * bin_size
+        y_shift = self.get_lag(Y_correlations, shift_range) * bin_size
+
+        fig, ax = plt.subplots()
+        ax.plot(shift_range, X_correlations, label="X correlations")
+        ax.plot(shift_range, Y_correlations, label="Y correlations")
+        ax.set_xlabel("Shifts in sub-pixels")
+        ax.set_ylabel("Correlation")
+        ax.legend()
+        if correlation_plot is not None:
+            fig.savefig(correlation_plot, dpi=150)
+        plt.close(fig)
+
+        return x_shift, y_shift
+
+
+def plot_residuals(residuals, figure_name):
+    t_array = np.array([(b["t_start"] + b["t_end"]) / 2 for b in residuals])
+    dx_array = np.array([b["dx"] for b in residuals])
+    dy_array = np.array([b["dy"] for b in residuals])
+
+    fig, ax = plt.subplots()
+    ax.plot(t_array, dx_array, label="X", marker=".", alpha=0.8)
+    ax.plot(t_array, dy_array, label="Y", marker=".", alpha=0.8)
+
+    ax.set_ylim(-3, 3)
+    ax.set_xlabel("MJD")
+    ax.set_ylabel("Residual (sub-pixels)")
+    ax.legend()
+
+    fig.savefig(figure_name, dpi=150)
+    plt.close(fig)
+
+
+def save_residuals_to_file(residuals, filename):
+    data = np.array(
+        [
+            [r["t_start"], r["t_end"], r["total_events"], r["dx"], r["dy"]]
+            for r in residuals
+        ]
+    )
+
+    np.savetxt(
+        filename,
+        data,
+        header="t_start t_end total_events dx dy",
+        fmt=["%.6f", "%.6f", "%d", "%.6f", "%.6f"],
+    )
+
+
+def calculate_residuals(
+    events_list,
+    bin_size,
+    start_offset,
+    total_events_fraction,
+    iteration_no,
+    paths,
+):
+
+    with fits.open(events_list) as events_list_hdu:
+        time, fx, fy, photons = read_and_filter_events(events_list_hdu)
+
+    # Define bin edges
+    t_start = time.min() + start_offset
+    t_end = time.max()
+    bins = np.arange(t_start, t_end + bin_size, bin_size)
+
+    # Digitize: assign each event to a bin index
+    bin_indices = np.digitize(time, bins)
+
+    binned_data = []
+    for i in range(1, len(bins)):
+        mask = bin_indices == i
+
+        if np.any(mask):
+            binned_data.append(
+                {
+                    "t_start": bins[i - 1],
+                    "t_end": bins[i],
+                    "total_events": len(fx[mask]),
+                    "time": time[mask],
+                    "fx": fx[mask],
+                    "fy": fy[mask],
+                    "photons": photons[mask],
+                }
+            )
+
+    total_events = np.array([b["total_events"] for b in binned_data])
+    total_events_threshold = np.median(total_events) * total_events_fraction
+
+    reference_data = None
+    residuals = []
+    for data in binned_data:
+        if data["total_events"] > total_events_threshold:
+            if reference_data is None:
+                reference_data = {
+                    "time": data["time"],
+                    "fx": data["fx"],
+                    "fy": data["fy"],
+                    "photons": data["photons"],
+                }
+
+                residuals.append(
+                    {
+                        "t_start": data["t_start"],
+                        "t_end": data["t_end"],
+                        "total_events": data["total_events"],
+                        "dx": 0,
+                        "dy": 0,
+                    }
+                )
+            else:
+                to_match_data = {
+                    "time": data["time"],
+                    "fx": data["fx"],
+                    "fy": data["fy"],
+                    "photons": data["photons"],
+                }
+
+                init_correlation = EventListCorrelator(reference_data, to_match_data)
+                t_mid = (data["t_start"] + data["t_end"]) / 2
+                dx, dy = init_correlation.get_shifts(
+                    correlation_plot=paths.correlation_plot(
+                        iteration_no,
+                        bin_size,
+                        t_mid,
+                    )
+                )
+
+                residuals.append(
+                    {
+                        "t_start": data["t_start"],
+                        "t_end": data["t_end"],
+                        "total_events": data["total_events"],
+                        "dx": dx,
+                        "dy": dy,
+                    }
+                )
+
+    plot_residuals(
+        residuals,
+        paths.residual_plot(iteration_no),
+    )
+
+    save_residuals_to_file(
+        residuals,
+        paths.residual_file(iteration_no),
+    )
+
+    return residuals
+
+
+def apply_residual_corrections(
+    events_list,
+    residuals,
+    corrected_events_list,
+    bin_size,
+    total_events_fraction,
+    iteration_offsets,
+):
+    with fits.open(events_list) as events_list_hdu:
+        time = events_list_hdu[1].data["MJD_L2"]
+        fx = events_list_hdu[1].data["Fx"]
+        fy = events_list_hdu[1].data["Fy"]
+        dx_events = np.zeros_like(fx)
+        dy_events = np.zeros_like(fx)
+
+        dx_array = np.array([b["dx"] for b in residuals])
+        dy_array = np.array([b["dy"] for b in residuals])
+        total_events_array = np.array([b["total_events"] for b in residuals])
+
+        offset_dx = np.average(dx_array, weights=total_events_array)
+        offset_dy = np.average(dy_array, weights=total_events_array)
+
+        for r in residuals:
+            t0 = r["t_start"]
+            t1 = r["t_end"]
+            dx = r["dx"] - offset_dx
+            dy = r["dy"] - offset_dy
+
+            mask = (time >= t0) & (time < t1)
+
+            dx_events[mask] = dx
+            dy_events[mask] = dy
+
+        fx_corr = fx + dx_events
+        fy_corr = fy + dy_events
+
+        events_list_hdu[1].data["Fx"] = fx_corr
+        events_list_hdu[1].data["Fy"] = fy_corr
+
+        instrument_exposure = Path(
+            str(events_list).replace(
+                "_l2ce.fits",
+                "I_l2exp.fits",
+            )
+        )
+
+        with fits.open(instrument_exposure) as exp_hdu:
+            w = WCS(exp_hdu[0].header)
+            PC1_1 = exp_hdu[0].header["PC1_1"]
+            PC1_2 = exp_hdu[0].header["PC1_2"]
+            PC2_1 = exp_hdu[0].header["PC2_1"]
+            PC2_2 = exp_hdu[0].header["PC2_2"]
+            CDELT1 = exp_hdu[0].header["CDELT1"]
+            CDELT2 = exp_hdu[0].header["CDELT2"]
+
+        sky = w.pixel_to_world(
+            fx_corr,
+            fy_corr,
+        )
+
+        events_list_hdu[1].data["Sky_RA"] = sky.ra.degree
+        events_list_hdu[1].data["Sky_DEC"] = sky.dec.degree
+
+        if CDELT1 > 0:
+            PC1_1 = -1 * PC1_1
+            PC1_2 = -1 * PC1_2
+
+        if CDELT2 < 0:
+            PC2_1 = -1 * PC2_1
+            PC2_2 = -1 * PC2_2
+
+        (
+            events_list_hdu[1].data["Fx_astronomical"],
+            events_list_hdu[1].data["Fy_astronomical"],
+        ) = instrument_to_astronomical(
+            fx_corr,
+            fy_corr,
+            PC1_1,
+            PC1_2,
+            PC2_1,
+            PC2_2,
+        )
+
+        events_list_hdu.writeto(corrected_events_list, overwrite=True)
+
+
+def instrument_to_astronomical(fx, fy, PC1_1, PC1_2, PC2_1, PC2_2):
+    fx_prime = (PC1_1 * (fx - 2400)) + (PC1_2 * (fy - 2400)) + 2400
+    fy_prime = (PC2_1 * (fx - 2400)) + (PC2_2 * (fy - 2400)) + 2400
+    return fx_prime, fy_prime
+
+
+def generate_image_products(
+    events_list,
+    exposure_map,
+    image_file,
+    error_file,
+    astronomical=False,
+):
+
+    if astronomical:
+        fx_keyword = "Fx_astronomical"
+        fy_keyword = "Fy_astronomical"
+    else:
+        fx_keyword = "Fx"
+        fy_keyword = "Fy"
+
+    with fits.open(events_list) as events_hdu, fits.open(exposure_map) as exp_hdu:
+
+        framecount_per_sec = events_hdu[0].header["AVGFRMRT"]
+
+        fx = events_hdu[1].data[fx_keyword]
+        fy = events_hdu[1].data[fy_keyword]
+        photons = events_hdu[1].data["EFFECTIVE_NUM_PHOTONS"]
+
+        image_header = exp_hdu[0].header.copy()
+        for key in events_hdu[0].header:
+            if key.startswith("RSLV") or key == "RESOLVIT":
+                image_header[key] = events_hdu[0].header[key]
+
+        bins = np.arange(-0.5, 4800.5, 1)
+
+        events, _, _ = np.histogram2d(
+            fy,
+            fx,
+            bins=(bins, bins),
+            weights=photons,
+        )
+
+        counts, _, _ = np.histogram2d(
+            fy,
+            fx,
+            bins=(bins, bins),
+        )
+
+        exposure = exp_hdu[0].data
+
+        with np.errstate(divide="ignore", invalid="ignore"):
+            cps = events / (exposure * framecount_per_sec)
+            cps_error = cps / np.sqrt(counts)
+
+        cps[exposure == 0] = 0
+        cps_error[exposure == 0] = 0
+        cps_error[counts == 0] = 0
+
+        cps = cps.astype(np.float32)
+        cps_error = cps_error.astype(np.float32)
+
+        image_hdu = fits.PrimaryHDU(cps)
+        image_hdu.header.update(image_header)
+        image_hdu.header["DATATYPE"] = "count-rate image"
+
+        error_hdu = fits.PrimaryHDU(cps_error)
+        error_hdu.header.update(image_header)
+        error_hdu.header["DATATYPE"] = "count-rate error image"
+
+        image_hdu.writeto(
+            image_file,
+            overwrite=True,
+        )
+
+        error_hdu.writeto(
+            error_file,
+            overwrite=True,
+        )
+
+
+def process_observation(
+    observation_dir,
+    bin_size=DEFAULT_BIN_SIZE,
+    iteration_offsets=None,
+    total_events_fraction=DEFAULT_TOTAL_EVENTS_FRACTION,
+):
+
+    if iteration_offsets is None:
+        iteration_offsets = DEFAULT_ITERATION_OFFSETS
+
+    events_lists = glob(
+        f"{observation_dir}/**/data_products/*_data/**/AS1*l2ce.fits",
+        recursive=True,
+    )
+
+    events_lists = sorted(events_lists)
+
+    for events_list in events_lists:
+        process_events_list(
+            events_list, bin_size, iteration_offsets, total_events_fraction
+        )
+
+
+def process_events_list(
+    events_list, bin_size, iteration_offsets, total_events_fraction
+):
+
+    print(f"Processing {Path(events_list).name}")
+
+    paths = ResolvitProductPaths(events_list)
+
+    write_processing_log(
+        paths,
+        events_list,
+        bin_size,
+        total_events_fraction,
+        iteration_offsets,
+    )
+
+    current_file = events_list
+
+    for i, frac in enumerate(
+        iteration_offsets,
+        start=1,
+    ):
+
+        offset = bin_size * frac
+
+        residuals = calculate_residuals(
+            current_file,
+            bin_size,
+            offset,
+            total_events_fraction,
+            i,
+            paths,
+        )
+
+        apply_residual_corrections(
+            current_file,
+            residuals,
+            paths.corrected_events_list,
+            bin_size,
+            total_events_fraction,
+            iteration_offsets,
+        )
+
+        current_file = paths.corrected_events_list
+
+    with fits.open(paths.corrected_events_list, mode="update") as events_list_hdu:
+        events_list_hdu[0].header.add_blank()
+        events_list_hdu[0].header.add_comment("Resolvit processing information")
+        events_list_hdu[0].header.add_blank()
+
+        events_list_hdu[0].header["RESOLVIT"] = (True, "Processed using Resolvit")
+        events_list_hdu[0].header["RSLV_VER"] = (__version__, "Resolvit version")
+        events_list_hdu[0].header["RSLV_BIN"] = (bin_size, "Time bin size (s)")
+
+        events_list_hdu[0].header["RSLV_FR"] = (
+            total_events_fraction,
+            "Event fraction threshold",
+        )
+
+        events_list_hdu[0].header["RSLV_ITL"] = (
+            len(iteration_offsets),
+            "Number of iterations",
+        )
+
+        for i, offset in enumerate(iteration_offsets, start=1):
+            events_list_hdu[0].header[f"RSLV_IT{i}"] = (
+                float(offset),
+                f"Iteration {i} offset fraction",
+            )
+
+        events_list_hdu.flush()
+
+    copy_exposure_maps(
+        events_list,
+        paths,
+    )
+
+    generate_image_products(
+        paths.corrected_events_list,
+        paths.instrument_exposure,
+        paths.instrument_image,
+        paths.instrument_error,
+    )
+
+    generate_image_products(
+        paths.corrected_events_list,
+        paths.astronomical_exposure,
+        paths.astronomical_image,
+        paths.astronomical_error,
+        astronomical=True,
+    )

resolvit-0.1.0.dist-info/METADATA

@@ -0,0 +1,99 @@
+Metadata-Version: 2.4
+Name: resolvit
+Version: 0.1.0
+Summary: Improve the PSF of UVIT data products
+Project-URL: Homepage, https://github.com/prajwel/resolvit
+Project-URL: Issues, https://github.com/prajwel/resolvit/issues
+Author-email: Prajwel Joseph <prajwel.pj@gmail.com>
+License-Expression: Apache-2.0
+License-File: LICENSE
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.9
+Requires-Dist: astropy
+Requires-Dist: matplotlib
+Requires-Dist: numpy
+Requires-Dist: scipy
+Description-Content-Type: text/markdown
+
+# Resolvit
+
+Resolvit improves the point spread function (PSF) of UVIT Level2 products by applying sub-pixel corrections to the Level2 events list and generating a new set of derived data products.
+
+The corrected events list is treated as the primary Resolvit product. All other Resolvit products are derived from it.
+
+## Installation
+
+```bash
+pip install resolvit
+```
+
+## Python usage
+
+```python
+from resolvit import process_observation
+
+process_observation(
+    "20160101_A01_123T01_0123456789_level2"
+)
+```
+
+### Custom parameters
+
+```python
+from resolvit import process_observation
+
+process_observation(
+    "20160101_A01_123T01_0123456789_level2",
+    bin_size=50,
+)
+```
+
+## Command-line usage
+
+Process a UVIT Level2 observation directory:
+
+```bash
+resolvit 20160101_A01_123T01_0123456789_level2
+```
+
+Specify a custom time bin size:
+
+```bash
+resolvit 20160101_A01_123T01_0123456789_level2 \
+    --bin-size 50
+```
+
+Show the installed version:
+
+```bash
+resolvit --version
+```
+
+## Output products
+
+Resolvit creates a new directory alongside the original UVIT products:
+
+```text
+uvit/
+├── data_products/
+└── resolvit_data_products/
+```
+
+The original UVIT products are never modified.
+
+## Diagnostics
+
+Resolvit generates diagnostic plots and residual tables for each channel-filter-window combination:
+
+```text
+resolvit_data_products/
+└── diagnostics/
+    └── <product_id>/
+        ├── resolvit.log
+        ├── residuals_iteration_1.txt
+        ├── residuals_iteration_1.png
+        ├── residuals_iteration_2.txt
+        ├── residuals_iteration_2.png
+        └── *_correlations.png
+```

resolvit-0.1.0.dist-info/RECORD

@@ -0,0 +1,8 @@
+resolvit/__init__.py,sha256=t5xiTnUMJynNvRvS6ECSBQ7hJF5Qv37RvZQFyHvNhls,181
+resolvit/cli.py,sha256=lPrzaZPZIcrEosx1eE0Zk9I853yaBuYt7NQBI9-K6go,1317
+resolvit/resolvit.py,sha256=D5Zs_KSLQKp93Pj4TN-XieAGNzUnI9YUQvvnwKcQjew,21151
+resolvit-0.1.0.dist-info/METADATA,sha256=WFWhCU2c3RgjallUHHyy9c2S89K9xrVsplFKe5EkG6U,2221
+resolvit-0.1.0.dist-info/WHEEL,sha256=mffPy8wBnZQn2VnJUU5jE99KsxaSfiyMHV9Yt0aLVxs,87
+resolvit-0.1.0.dist-info/entry_points.txt,sha256=Vc3DO6JPPbqrQdnssifJ26fv3Gfq3cVkKCfz17gYZ4s,47
+resolvit-0.1.0.dist-info/licenses/LICENSE,sha256=z8d0m5b2O9McPEK1xHG_dWgUBT6EfBDz6wA0F7xSPTA,11358
+resolvit-0.1.0.dist-info/RECORD,,

resolvit-0.1.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.30.1
+Root-Is-Purelib: true
+Tag: py3-none-any

resolvit-0.1.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+resolvit = resolvit.cli:main

resolvit-0.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.