/*
 * streaksremove
 *
 * Convert satellite streak detctions into masks and remove the covered pixels from the
 * input images.
 * Optionally swap the inputs with the outputs so that subsequent references to the original
 * images access the destreaked versions.
 */

#include "streaksremove.h"

static pmConfig *parseArguments(int argc, char **argv);
static bool readAndCopyToOutput(streakFiles *sf, bool exciseAll);
static long exciseNonDiffedPixels(streakFiles *sfiles, psImageMaskType newMaskValue);
static bool diffedPixel(streakFiles *sfiles, int x, int y);
static void excisePixel(streakFiles *sfiles, unsigned int x, unsigned int y, bool streak, psImageMaskType newMaskValue);
static void writeImages(streakFiles *sf, bool exciseImageCube);
static void updateAstrometry(streakFiles *sfiles);
static void censorSources(streakFiles *sfiles, psImageMaskType maskStreak);
static long censorPixels(streakFiles *sfiles, psImage * pixels, bool checkNonDiffedPixels, psU16 maskStreak);

char *streaksProgram = "streaksremove";

// Note: For clarity the flow of this program is in main().
// There is not a lot of error checking is done in main.
// Until the end, where we might be doing Nebulous operations, called functions exit when an error
// is encountered.
int
main(int argc, char *argv[])
{
    bool status;

    psLibInit(NULL);
    psTimerStart("TOTAL_TIME");

    pmConfig *config = parseArguments(argc, argv);
    if (!config) {
        psError(PS_ERR_UNKNOWN, false, "failed to parse arguments\n");
        streaksExit("", PS_EXIT_CONFIG_ERROR);
    }

    psString streaksFileName = psMetadataLookupStr(NULL, config->arguments, "STREAKS");

    // call Paul Sydney's code to parse the streaks file that DetectStreaks produced
    Streaks *streaks = readStreaksFile(streaksFileName);
    if (!streaks) {
        psError(PS_ERR_UNKNOWN, false, "failed to read streaks file: %s", streaksFileName);
        streaksExit("", PS_EXIT_PROG_ERROR);
    }

    // open all of the input and output files, save their descriptions in the streakFiles struct
    streakFiles *sfiles = openFiles(config, true, argv[0]);
    setupAstrometry(sfiles);
    sfiles->stats = psMetadataAlloc();

    // Optionally we can set pixels that are masked to NAN since they couldn't have been
    // examined for streaks. Usually this is done by the distribution system just prior
    // to release
    bool nanForRelease = psMetadataLookupBool(&status, config->arguments, "NAN_FOR_RELEASE");
    if (nanForRelease && (sfiles->inMask == NULL)) {
        psError(PS_ERR_UNKNOWN, true, "mask image must be supplied with -release.");
        streaksExit("", PS_EXIT_PROG_ERROR);
    }

    bool exciseAll = false;
    // --keepnondiffed is a test and debug mode
    bool keepNonDiffedPixels = psMetadataLookupBool(&status, config->arguments, "KEEP_NON_DIFFED");

    // we need to check for non diffed pixels unless we've been asked not to or the stage is diff
    // (By definition pixels in diff images were included in the difference images)
    bool checkNonDiffedPixels = ! (keepNonDiffedPixels || (sfiles->stage == IPP_STAGE_DIFF) );

    if (checkNonDiffedPixels ) {
        // From magic ICD:
        // In the raw and detrended images, the pixels which were not
        // included in any of the streak-processed warps must also be masked.
        // Note that the warp and difference skycells are only generated if more
        // than a small fraction of the pixels are lit by the input image.
        // if no skycells are provided sfiles->exciseAll is set to true

        psTimerStart("COMPUTE_DIFFED_PIXELS");
        if (! computeDiffedPixels(sfiles) ) {
            // we have no choice to excise all pixels
            exciseAll = true;
        }
        psF64 cdp_t = psTimerClear("COMPUTE_DIFFED_PIXELS");
        psMetadataAddF32(sfiles->stats, PS_LIST_TAIL, "COMPUTE_UNDIFFED_PIXELS", PS_META_REPLACE, "time to compute non-diffedpixels", cdp_t);
        psLogMsg("streaksremove", PS_LOG_INFO, "time to compute diffed pixels: %f\n", cdp_t);
    }

    if (sfiles->stage == IPP_STAGE_RAW) {
        // Except for raw stage, all of our (GPC1) files have one image extension.
        // Raw files have a phu and multiple extensions, one per chip
        // Since this is a raw file, copy it's PHU to output files
        copyPHU(sfiles, true);

        // advance to the first image extension
        if (!streakFilesNextExtension(sfiles)) {
            psErrorStackPrint(stderr, "failed to advance to first extension of input images");
            exit (PS_EXIT_PROG_ERROR);
        }
    }

    long totalPixels = 0;
    long totalStreakPixels = 0;
    long nonDiffedPixels = 0;

    // accumulators for the various timers
    psF64 gsp_t = 0;
    psF64 enw_t = 0;
    psF64 rms_t = 0;
    psF64 cs_t = 0;
    psF64 wi_t = 0;
    psF64 ua_t = 0;
    // Iterate through each component of the input (except for raw images there is only one)
    do {
        bool exciseImageCube = false;

        psTimerStart("PROCESS_COMPONENT");

        // read the images and copy the data from the inputs to the outputs
        // This also sets up the astrometry and initializes the recovery image(s)

        if (!readAndCopyToOutput(sfiles, exciseAll)) {
            // false return value indicates that this extension is not an image and
            // the contents has already been copied to the output file.
            // we don't need to process this extesion for streaks.
            continue;
        }

        // now that we've read the input files, lookup the mask values
        strkGetMaskValues(sfiles);

        totalPixels += sfiles->inImage->numRows * sfiles->inImage->numCols;

        if (!exciseAll) {
            // Identify pixels to mask because of streaks

            psTimerStart("GET_STREAK_PIXELS");

            // call Paul Sydney's code to compute the set of pixels that are covered by the detected streaks
            StreakPixels *pixels = streak_on_component(streaks, sfiles->astrom, sfiles->inImage->numCols,
                                                        sfiles->inImage->numRows);
            gsp_t +=  psTimerClear("GET_STREAK_PIXELS");
            psMetadataAddF32(sfiles->stats, PS_LIST_TAIL, "GET_STREAK_PIXELS", PS_META_REPLACE, "", gsp_t);
            psLogMsg("streaksremove", PS_LOG_INFO, "time to get streak pixels: %f\n", psTimerClear("GET_STREAK_PIXELS"));

            // if this extension contained an image, excise the streaked pixels.
            // otherwise it contained an image cube (video cell) which is handled in the if block
            if (sfiles->inImage->image) {
                if (checkNonDiffedPixels) {
                    psTimerStart("EXCISE_NON_DIFFED");

                    // set non-diffed pixels and variance to NAN, mask to maskStreak (since the pixel
                    // is excised as part of the destreaking process)
                    nonDiffedPixels += exciseNonDiffedPixels(sfiles, sfiles->maskStreak);

                    enw_t +=  psTimerClear("EXCISE_NON_DIFFED");
                    psMetadataAddF32(sfiles->stats, PS_LIST_TAIL, "EXCISE_NON_DIFFED", PS_META_REPLACE, "", enw_t);
                    psLogMsg("streaksremove", PS_LOG_INFO, "time to excise non diffed pixels: %f\n", enw_t);
                }

                psTimerStart("REMOVE_STREAKS");

                totalStreakPixels += censorPixels(sfiles, pixels, checkNonDiffedPixels, sfiles->maskStreak);

                rms_t += psTimerClear("REMOVE_STREAKS");
                psMetadataAddF32(sfiles->stats, PS_LIST_TAIL, "REMOVE_STREAKS", PS_META_REPLACE, "", enw_t);
                psLogMsg("streaksremove", PS_LOG_INFO, "time to remove streak pixels: %f\n", rms_t);

                if (nanForRelease) {
                    // set any pixels that were masked, to NAN (unless they are already NAN)
                    setMaskedToNAN(sfiles, sfiles->maskMask, true);
                }

            } else {
                // this component contains an image cube
                // For now excise it completely
                exciseImageCube = true;
            }
            psFree(pixels);
        }

        if (sfiles->stage == IPP_STAGE_CHIP) {
            // as a convience to the user of the output, replace the bogus WCS transform in the
            // chip processed files with the data calcuated by psastro at the camera stage
            // (actually we use a linear approximation)
            psTimerStart("UPDATE_ASTROMETRY");
            updateAstrometry(sfiles);
            ua_t += psTimerClear("UPDATE_ASTROMETRY");
            psMetadataAddF32(sfiles->stats, PS_LIST_TAIL, "UPDATE_ASTROMETRY", PS_META_REPLACE, "", ua_t);
            psLogMsg("streaksremove", PS_LOG_INFO, "time to update astrometry: %f\n", ua_t);
        }

        psTimerStart("CENSOR_SOURCES");
        censorSources(sfiles, sfiles->maskStreak);
        cs_t += psTimerClear("CENSOR_SOURCES");
        psMetadataAddF32(sfiles->stats, PS_LIST_TAIL, "CENSOR_SOURCES", PS_META_REPLACE, "", cs_t);

        // write the destreaked "temporary" images and the recovery images
        psTimerStart("WRITE_IMAGES");
        writeImages(sfiles, exciseImageCube);
        wi_t += psTimerClear("WRITE_IMAGES");
        psMetadataAddF32(sfiles->stats, PS_LIST_TAIL, "WRITE_IMAGES", PS_META_REPLACE, "", wi_t);

        psLogMsg("streaksremove", PS_LOG_INFO, "time to process component %d: %f\n", sfiles->extnum, psTimerClear("PROCESS_COMPONENT"));

    } while (streakFilesNextExtension(sfiles));


    psFree(streaks);

    if (exciseAll) {
        totalStreakPixels = totalPixels;
    }

    psF64 streakFraction = (double) totalStreakPixels / totalPixels;
    psLogMsg("streaksremove", PS_LOG_INFO, "   total pixels:  %8ld\n", totalPixels);
    psLogMsg("streaksremove", PS_LOG_INFO, "  streak pixels:  %8ld %4.2f%%\n", totalStreakPixels, streakFraction * 100);
    psMetadataAddF32(sfiles->stats, PS_LIST_TAIL, "STREAK_FRACTION", PS_META_REPLACE, "", streakFraction);

    psF64 nonDiffedFraction = (double) nonDiffedPixels / totalPixels;
    psLogMsg("streaksremove", PS_LOG_INFO, "nondiffed pixels:  %8ld %4.2f%%\n", nonDiffedPixels, nonDiffedFraction * 100);
    psMetadataAddF32(sfiles->stats, PS_LIST_TAIL, "NONDIFFED_FRACTION", PS_META_REPLACE, "", nonDiffedFraction);

    // check the weight and mask files for extra extensions that might be in files
    // (covariance matrix for example)
    copyExtraExtensions(sfiles);

    // all done close the files. This is where the files are written so it can take a long time.

    psTimerStart("CLOSE_IMAGES");
    closeImages(sfiles);
    psF64 ci_t = psTimerClear("CLOSE_IMAGES");
    psMetadataAddF32(sfiles->stats, PS_LIST_TAIL, "CLOSE_IMAGES", PS_META_REPLACE, "", ci_t);

    psLogMsg("streaksremove", PS_LOG_INFO, "time to close images: %f\n", ci_t);

#ifdef DO_REPLICATE
    psTimerStart("REPLICATE_OUTPUTS");
    if (!replicateOutputs(sfiles)) {
        psErrorStackPrint(stderr, "failed to replicate output files");
        deleteTemps(sfiles);
        exit(PS_EXIT_UNKNOWN_ERROR);
    }
    psF64 ro_t = psTimerClear("REPLICATE_OUTPUTS");
    psMetadataAddF32(sfiles->stats, PS_LIST_TAIL, "REPLICATE_OUTPUTS", PS_META_REPLACE, "", ro_t);
#endif

    // NOTE: from here on we can't just quit if something goes wrong.
    // especially if we're working at the raw stage
    // turn off automatic deletion of output files by streaksExit
    setStreakFiles(NULL);

    if (psMetadataLookupBool(&status, config->arguments, "REPLACE")) {
        //     swap the instances for the input and output
        //     Note this is a nebulous database operation. No file I/O is performed
        psTimerStart("SWAP_INSTANCES");
        if (!swapOutputsToInputs(sfiles)) {
            // It is up to the program that reverts failed destreak runs to insure that
            // any original non-destreaked input files that have been swapped are restored and that the de-streaked
            // versions are deleted.

            psErrorStackPrint(stderr, "failed to swap files");

            // XXX: pick a specific error code for this failure
            exit(PS_EXIT_UNKNOWN_ERROR);
        }
        psF64 si_t = psTimerClear("SWAP_INSTANCES");
        psMetadataAddF32(sfiles->stats, PS_LIST_TAIL, "SWAP_INSTANCES", PS_META_REPLACE, "", si_t);
    }

    psF64 total_time = psTimerClear("TOTAL_TIME");
    psMetadataAddF32(sfiles->stats, PS_LIST_TAIL, "TOTAL_TIME", PS_META_REPLACE, "", total_time);
    psLogMsg("streaksremove", PS_LOG_INFO, "time to run streaksremove: %f\n", total_time);

    if (sfiles->statsFile) {
        const char *statsMDC = psMetadataConfigFormat(sfiles->stats);
        if (!statsMDC || strlen(statsMDC) == 0) {
            psError(PS_ERR_IO, false, "Unable to get statistics MDC file.\n");
        } else {
            fprintf(sfiles->statsFile, "%s", statsMDC);
            psFree(statsMDC);
            fclose(sfiles->statsFile);
            sfiles->statsFile = NULL;
            psFree(sfiles->stats);
            sfiles->stats = NULL;
        }
    }
    // all done. Clean up to look for memory leaks.

    psFree(sfiles);
    psFree(config);
    pmConceptsDone();
    pmModelClassCleanup();
    streaksNebulousCleanup();
    pmConfigDone();
    psLibFinalize();

    fprintf(stderr, "Found %d leaks at %s\n", psMemCheckLeaks (0, NULL, NULL, false), "streaksremove");

    return 0;
}

static long
censorPixels(streakFiles *sfiles, psImage *pixels, bool checkNonDiffedPixels, psU16 maskStreak)
{
    long streakPixels = 0;

    for (int y=0 ; y < sfiles->inImage->numRows; y++) {
        for (int x = 0; x < sfiles->inImage->numCols; x++) {
            if (psImageGet(pixels, x, y)) {
                if (!checkNonDiffedPixels || diffedPixel(sfiles, x, y)) {
                    ++streakPixels;

                    excisePixel(sfiles, x, y, true, maskStreak);

                } else {
                    // This pixel was not included in any warp and has thus already excised
                    // by exciseNonDiffedPixels
                }
            }
        }
    }
    return streakPixels;
}

static void usage()
{
    fprintf(stderr, "USAGE: streaksremove -stage raw|chip|warp|diff -image IMAGE.fits -tmproot directory -streaks streaks_file\n\n");
    fprintf(stderr, "Optional arguments:\n");
    fprintf(stderr, "\t-class_id class_id: class_id (required for raw and chip stages)\n");
    fprintf(stderr, "\t-recovery: directory to save excised pixel images\n");
    fprintf(stderr, "\t-mask MASK.fits mask file to de-streak\n");
    fprintf(stderr, "\t-weight WEIGHT.fits: weight file to de-streak\n");
    fprintf(stderr, "\t-replace: replace the input images with the output\n");
    fprintf(stderr, "\t-keepnondiffed: do not exise pixels that were not part of difference processing\n");
    fprintf(stderr, "\t-transparent val: instead of setting excicsed pixel to NAN add val\n");
    fprintf(stderr, "\t-chip_mask MASK.fits: name of mask for chip stage (camera stage mask is passed tih -mask)\n");

    exit(2);


}
static pmConfig *parseArguments(int argc, char **argv)
{

    pmConfig *config = pmConfigRead(&argc, argv, NULL);
    if (!config) {
        streaksExit("failed to parse arguments", PS_EXIT_CONFIG_ERROR);
    }

    int argnum;
    ippStage stage = IPP_STAGE_NONE;
    if ((argnum = psArgumentGet(argc, argv, "-stage"))) {
        psArgumentRemove(argnum, &argc, argv);
        stage = parseStage(argv[argnum]);
        psMetadataAddS32(config->arguments, PS_LIST_TAIL, "STAGE", 0,
                "pipeline stage for streak removal", stage);
        psArgumentRemove(argnum, &argc, argv);
    } else {
        psError(PS_ERR_UNKNOWN, true, "-stage is required\n");
        usage();
    }

    if ((argnum = psArgumentGet(argc, argv, "-class_id"))) {
        psArgumentRemove(argnum, &argc, argv);
        psMetadataAddStr(config->arguments, PS_LIST_TAIL, "CLASS_ID", 0,
                "class_id", argv[argnum]);
        psArgumentRemove(argnum, &argc, argv);
    } else if ((stage == IPP_STAGE_RAW) || (stage == IPP_STAGE_CHIP)) {
        psError(PS_ERR_UNKNOWN, true, "-class_id is required\n");
        usage();
    }

    if ((argnum = psArgumentGet(argc, argv, "-streaks"))) {
        psArgumentRemove(argnum, &argc, argv);
        psMetadataAddStr(config->arguments, PS_LIST_TAIL, "STREAKS", 0,
                "STREAKS", argv[argnum]);
        psArgumentRemove(argnum, &argc, argv);
    } else {
        psError(PS_ERR_UNKNOWN, true, "-streaks is required\n");
        usage();
    }


    // If input image is in nebulous we require mask, weight, and tmproot to all be
    // nebulous paths
    bool nebulousImage = false;
    if ((argnum = psArgumentGet(argc, argv, "-image"))) {
        // for raw and chip level images we use psFits for I/O and ...
        nebulousImage = IN_NEBULOUS(argv[argnum+1]);
        if (CHIP_LEVEL_INPUT(stage)) {
            psArgumentRemove(argnum, &argc, argv);
            psMetadataAddStr(config->arguments, PS_LIST_TAIL, "INPUT", 0,
                    "name of input image", argv[argnum]);
            psArgumentRemove(argnum, &argc, argv);
        } else  {
            // ... for warped images we use pmFPAfiles
            if (!pmConfigFileSetsMD(config->arguments, &argc, argv, "INPUT", "-image", NULL)) { ;
                psError(PS_ERR_UNKNOWN, false, "failed to process -image");
                usage();
            }
        }
    } else {
        psError(PS_ERR_UNKNOWN, true, "-image is required\n");
        usage();
    }

    bool gotReplace = false;
    if ((argnum = psArgumentGet(argc, argv, "-replace"))) {
        if (!nebulousImage) {
            psError(PS_ERR_UNKNOWN, true, "replace is only supported for nebulous files");
            usage();
        }
        gotReplace = true;
        psArgumentRemove(argnum, &argc, argv);
        psMetadataAddBool(config->arguments, PS_LIST_TAIL, "REPLACE", 0, "replace input files",
            true);
    }

    if ((argnum = psArgumentGet(argc, argv, "-release"))) {
        psArgumentRemove(argnum, &argc, argv);
        psMetadataAddBool(config->arguments, PS_LIST_TAIL, "NAN_FOR_RELEASE", 0, "set masked pixels to NAN",
            true);
    }

    if ((argnum = psArgumentGet(argc, argv, "-keepnondiffed"))) {
        psArgumentRemove(argnum, &argc, argv);
        psMetadataAddBool(config->arguments, PS_LIST_TAIL, "KEEP_NON_DIFFED", 0,
            "skip excising of non diffed pixels", true);
    }

    if ((argnum = psArgumentGet(argc, argv, "-transparent"))) {
        if (gotReplace) {
            psError(PS_ERR_UNKNOWN, true, "cannot make transparent streaks if -replace");
            usage();
        }
        psArgumentRemove(argnum, &argc, argv);
        double transparentStreaks = atof(argv[argnum]);
        psMetadataAddF32(config->arguments, PS_LIST_TAIL, "TRANSPARENT_STREAKS", 0,
            "value to adjust excised pixels", transparentStreaks);
        psArgumentRemove(argnum, &argc, argv);
    }

    // if skycells are not provided then we have to execise all pixels  unless -keepnondiffed
    pmConfigFileSetsMD(config->arguments, &argc, argv, "SKYCELLS", "-skycell", "-skycelllist");

    if (!pmConfigFileSetsMD(config->arguments, &argc, argv, "ASTROM", "-astrom", NULL)) { ;
        if (CHIP_LEVEL_INPUT(stage)) {
            psError(PS_ERR_UNKNOWN, true, "-astrom is required for raw and chip stages\n");
            usage();
        }
    }

    if ((argnum = psArgumentGet(argc, argv, "-mask"))) {
        psArgumentRemove(argnum, &argc, argv);
        bool nebulousMask = IN_NEBULOUS(argv[argnum]);
        // This isn't a strict requirement if stage == IPP_STAGE_CHIP
        if (nebulousMask != nebulousImage) {
            psError(PS_ERR_UNKNOWN, true, "mask image must be %snebulous path with %s image path\n",
                nebulousImage ? "" : "non ", nebulousImage ? "nebulous" : "regular");
            usage();
        }
        psMetadataAddStr(config->arguments, PS_LIST_TAIL, "INPUT.MASK", 0,
                "name of input mask image", argv[argnum]);
        psArgumentRemove(argnum, &argc, argv);
    }

    if ((argnum = psArgumentGet(argc, argv, "-chip_mask"))) {
        if (stage != IPP_STAGE_CHIP) {
            psError(PS_ERR_UNKNOWN, true, "-chip_mask only allowed at chip stage");
            usage();
        }
        psArgumentRemove(argnum, &argc, argv);
        bool nebulousMask = IN_NEBULOUS(argv[argnum]);
        if (nebulousMask != nebulousImage) {
            psError(PS_ERR_UNKNOWN, true, "chip mask image must be %snebulous path with %s image path\n",
                nebulousImage ? "" : "non ", nebulousImage ? "nebulous" : "regular");
            usage();
        }
        psMetadataAddStr(config->arguments, PS_LIST_TAIL, "INPUT.CHMASK", 0,
                "name of input chip mask image", argv[argnum]);
        psArgumentRemove(argnum, &argc, argv);
    }

    if ((argnum = psArgumentGet(argc, argv, "-weight"))) {
        psArgumentRemove(argnum, &argc, argv);
        bool nebulousWeight = IN_NEBULOUS(argv[argnum]);
        if (nebulousWeight != nebulousImage) {
            psError(PS_ERR_UNKNOWN, true, "weight image must have %snebulous path with %s image path\n",
                nebulousImage ? "" : "non ", nebulousImage ? "nebulous" : "regular");
            usage();
        }
        psMetadataAddStr(config->arguments, PS_LIST_TAIL, "INPUT.WEIGHT", 0,
                "name of input weight image", argv[argnum]);
        psArgumentRemove(argnum, &argc, argv);
    }
    if ((argnum = psArgumentGet(argc, argv, "-sources"))) {
        psArgumentRemove(argnum, &argc, argv);
        bool nebulousSources = IN_NEBULOUS(argv[argnum]);
        if (nebulousSources != nebulousImage) {
            psError(PS_ERR_UNKNOWN, true, "sources file must have %snebulous path with %s image path\n",
                nebulousImage ? "" : "non ", nebulousImage ? "nebulous" : "regular");
            usage();
        }
        psMetadataAddStr(config->arguments, PS_LIST_TAIL, "SOURCES", 0,
                "name of input sources file", argv[argnum]);
        psArgumentRemove(argnum, &argc, argv);
    }

    if ((argnum = psArgumentGet(argc, argv, "-stats"))) {
        psArgumentRemove(argnum, &argc, argv);
        psMetadataAddStr(config->arguments, PS_LIST_TAIL, "STATS", 0,
                "name of input stats file", argv[argnum]);
        psArgumentRemove(argnum, &argc, argv);
    }

    if ((argnum = psArgumentGet(argc, argv, "-tmproot"))) {
        psArgumentRemove(argnum, &argc, argv);
        bool nebulousTmp = IN_NEBULOUS(argv[argnum]);
        if (gotReplace && (nebulousTmp != nebulousImage)) {
            psError(PS_ERR_UNKNOWN, true, "tmproot must have %snebulous path with %s image path with -replace\n",
                nebulousImage ? "" : "non ", nebulousImage ? "nebulous" : "regular");
            usage();
        }
        psMetadataAddStr(config->arguments, PS_LIST_TAIL, "OUTPUT", 0, "path for (temporary if replae) output files",
            argv[argnum]);
        psArgumentRemove(argnum, &argc, argv);
    } else {
        psError(PS_ERR_UNKNOWN, true, "-tmproot is required\n");
        usage();
    }

    if ((argnum = psArgumentGet(argc, argv, "-recovery"))) {
        psArgumentRemove(argnum, &argc, argv);
        psMetadataAddStr(config->arguments, PS_LIST_TAIL, "RECOVERY", 0, "path for recovery files",
            argv[argnum]);
        psArgumentRemove(argnum, &argc, argv);
    } else if ((stage == IPP_STAGE_RAW) && gotReplace) {
        psError(PS_ERR_UNKNOWN, true, "-recovery is required for -stage raw with -replace\n");
        usage();
    }

    if (argc != 1) {
        psString unexpectedArguments = NULL;
        for (int i=1; i<argc; i++) {
            psStringAppend(&unexpectedArguments, "%s ", argv[i]);
        }
        psError(PS_ERR_UNKNOWN, true, "unexpected arguments: %s", unexpectedArguments);
        psFree(unexpectedArguments);
        usage();
    }

    return config;
}

static void
updateAstrometry(streakFiles *sf)
{
    if (sf->bilevelAstrometry) {
        if (!linearizeTransforms(sf->astrom)) {
            // fit failed, leave the transform in the file unchanged
            return;
        }
    }
    if (!pmAstromWriteWCS(sf->outImage->header, sf->inAstrom->fpa, sf->chip, 0.001)) {
        psError(PS_ERR_UNKNOWN, false, "failed to update astrometry for extension %d", sf->extnum);
        streaksExit("", PS_EXIT_UNKNOWN_ERROR);
    }
    if (sf->outMask) {
        pmAstromWriteWCS(sf->outMask->header, sf->inAstrom->fpa, sf->chip, 0.001);
    }
    if (sf->outWeight) {
        pmAstromWriteWCS(sf->outWeight->header, sf->inAstrom->fpa, sf->chip, 0.001);
    }
}

static void 
setStreakBits(psImage *maskImage, psU32 maskStreak)
{
    for (int y=0 ; y < maskImage->numRows; y++) {
        for (int x=0 ; x < maskImage->numCols; x++) {
            maskImage->data.PS_TYPE_IMAGE_MASK_DATA[y][x] |= maskStreak;
        }
    }
}

// set the image for the output files to the contents of the corresponding input file.
static bool
readAndCopyToOutput(streakFiles *sf, bool exciseAll)
{
    if (sf->inImage->pmfile) {
        // image data from pmFPAfile (diff or warp file)
        readImageFrom_pmFile(sf);
        sf->astrom = streakSetAstrometry(sf->astrom, sf->stage, sf->inAstrom->fpa,
                sf->chip, true, sf->cell->concepts, sf->inImage->numCols, sf->inImage->numRows);
    } else {
        // image data directly from psFits
        readImage(sf->inImage, sf->extnum, sf->stage, false);
        if (SFILE_IS_IMAGE(sf->inImage)) {
            sf->astrom = streakSetAstrometry(sf->astrom, sf->stage, sf->inAstrom->fpa, sf->chip, false,
                sf->inImage->header, sf->inImage->numCols, sf->inImage->numRows);
        }
    }
    if (!sf->astrom) {
        psError(PS_ERR_UNKNOWN, false, "failed to set up astrometry for extension %d", sf->extnum);
        streaksExit("", PS_EXIT_UNKNOWN_ERROR);
    }
    sf->outImage->header =  psMemIncrRefCounter(sf->inImage->header);
    if (sf->recImage) {
        sf->recImage->header = psMetadataCopy(NULL, sf->inImage->header);
        addRecoveryKeyword(sf->recImage->header);
    }
    addDestreakKeyword(sf->outImage->header);

    if (!SFILE_IS_IMAGE(sf->inImage)) {
        // fprintf(stderr, "skipping extnum: %d not an image\n", sf->extnum);
        // XXX: This extension is probably a video table.
        copyTable(sf->outImage, sf->inImage, sf->extnum);
        return false;
    }

    if (sf->inImage->image) {
        setupImageRefs(sf->outImage, sf->recImage, sf->inImage, sf->extnum, exciseAll);
    }  else {
        // Image cubes are handeled specially
    }

    // set up the compression parameters
    copyFitsOptions(sf->outImage, sf->recImage, sf->inImage, sf->tiles);

    if (sf->inMask) {
        readImage(sf->inMask, sf->extnum, sf->stage, true);
        if (sf->outMask) {
            sf->outMask->header = (psMetadata*) psMemIncrRefCounter(sf->inMask->header);
            if (sf->recMask) {
                sf->recMask->header = psMetadataCopy(NULL, sf->outMask->header);
                addRecoveryKeyword(sf->recMask->header);
            }
            addDestreakKeyword(sf->outMask->header);
            // Note: we don't excise the mask pixels even if exciseAll is true.
            setupImageRefs(sf->outMask, sf->recMask, sf->inMask, sf->extnum, false);
            if (exciseAll) {
                strkGetMaskValues(sf);
                
                // add the STREAK bit to the mask image pixels
                setStreakBits(sf->inMask->image, sf->maskStreak);
            }
            if (sf->outChMask) {
                sf->outChMask->header = (psMetadata *) psMemIncrRefCounter(sf->outMask->header);
                sf->outChMask->image = (psImage *) psMemIncrRefCounter(sf->outMask->image);
                if (sf->recChMask) {
                    sf->recChMask->header = (psMetadata *) psMemIncrRefCounter(sf->recMask->header);
                    sf->recChMask->image = (psImage *) psMemIncrRefCounter(sf->recMask->image);
                }
            }

            copyFitsOptions(sf->outMask, sf->recMask, sf->inMask, sf->tiles);
            if (sf->outChMask) {
                copyFitsOptions(sf->outChMask, sf->recChMask, sf->inMask, sf->tiles);
            }
        }
    }

    if (sf->inWeight) {
        readImage(sf->inWeight, sf->extnum, sf->stage, false);
        sf->outWeight->header = (psMetadata*) psMemIncrRefCounter(sf->inWeight->header);
        if (sf->recWeight) {
            sf->recWeight->header = psMetadataCopy(NULL, sf->outWeight->header);
            addRecoveryKeyword(sf->recWeight->header);
        }
        addDestreakKeyword(sf->outWeight->header);
        setupImageRefs(sf->outWeight, sf->recWeight, sf->inWeight, sf->extnum, exciseAll);

        copyFitsOptions(sf->outWeight, sf->recWeight, sf->inWeight, sf->tiles);
    }

    return true;
}

static void
writeImages(streakFiles *sf, bool exciseImageCube)
{
    psString extname = NULL;
    if (sf->nHDU > 1) {
        bool mdok;
        extname = psMetadataLookupStr(&mdok, sf->inImage->header, "EXTNAME");
    }
    if (sf->inImage->numZPlanes == 0)  {
        // note exciseing complete images is handled in readAndCopyToOutput
        writeImage(sf->outImage, extname, sf->extnum);
        writeImage(sf->recImage, extname, sf->extnum);
    } else {
        // we have an image cube
        if (exciseImageCube) {
            // copy the entire input image to the recovery image
            writeImageCube(sf->recImage, sf->inImage->imagecube, extname, sf->extnum);
        } else {
            // otherwise write it to the output
            writeImageCube(sf->outImage, sf->inImage->imagecube, extname, sf->extnum);
        }

        // Now deal with the other output image
        if (exciseImageCube) {
            // Set the values in the imagecube images to NAN and write them to the output image
            for (int i = 0; i < psArrayLength(sf->inImage->imagecube); i++) {
                psImage *image = psArrayGet (sf->inImage->imagecube, i);
                // XXX: NAN isn't right. It should be the integer equivalent. Should use exciseValue
                // but it isn't set with this code path. Fix that.
                psImageInit(image, 65535);
            }
            writeImageCube(sf->outImage, sf->inImage->imagecube, extname, sf->extnum);
        } else {
            if (sf->recImage) {
                // Set the values in the imagecube images to zero
                for (int i = 0; i < psArrayLength(sf->inImage->imagecube); i++) {
                    psImage *image = psArrayGet (sf->inImage->imagecube, i);
                    psImageInit(image, 0);
                }
                // copy the entire zeroed image to the recovery image
                writeImageCube(sf->recImage, sf->inImage->imagecube, extname, sf->extnum);
            }
        }
        // XXX: check this
        // Assumption: there are no mask and weight images for video cells
        return;
    }
    if (sf->outMask) {
        writeImage(sf->outMask, extname, sf->extnum);
        writeImage(sf->recMask, extname, sf->extnum);
        if (sf->stage == IPP_STAGE_CHIP) {
            writeImage(sf->outChMask, extname, sf->extnum);
            writeImage(sf->recChMask, extname, sf->extnum);
        }
    }
    if (sf->outWeight) {
        writeImage(sf->outWeight, extname, sf->extnum);
        writeImage(sf->recWeight, extname, sf->extnum);
    }
}

static void
excisePixel(streakFiles *sfiles, unsigned int x, unsigned int y, bool streak, psImageMaskType newMaskValue)
{
    double exciseValue = sfiles->inImage->exciseValue;

    // we clip so that the streak calculation code doesn't have to
    if ((x < 0) || (x >= sfiles->inImage->numCols) || (y < 0) || (y >= sfiles->inImage->numRows)) {
        return;
    }

    if (sfiles->inImage->image->type.type == PS_TYPE_U16) {
        psU16 imageValue  = sfiles->inImage->image->data.U16[y][x];
        if (sfiles->recImage && !isExciseValue(imageValue, sfiles->inImage->exciseValue) ) {
            sfiles->recImage->image->data.U16[y][x] = imageValue;
        }

        if (sfiles->transparentStreaks == 0) {
            sfiles->outImage->image->data.U16[y][x] = exciseValue;
        } else {
            if (streak) {
                // as a visualization aid don't mask the pixel, just change the intensity
                sfiles->outImage->image->data.U16[y][x] = imageValue + sfiles->transparentStreaks;
            } else {
                sfiles->outImage->image->data.U16[y][x] = exciseValue;
            }
        }
    } else {
        float imageValue  = sfiles->inImage->image->data.F32[y][x];
        if (sfiles->recImage && !isExciseValue(imageValue, sfiles->inImage->exciseValue) ) {
            sfiles->recImage->image->data.F32[y][x] = imageValue;
        }

        if (sfiles->transparentStreaks == 0) {
            sfiles->outImage->image->data.F32[y][x] = exciseValue;
        } else {
            if (streak) {
                // as a visualization aid don't mask the pixel, just change the intensity
                sfiles->outImage->image->data.F32[y][x] = imageValue + sfiles->transparentStreaks;
            } else {
                sfiles->outImage->image->data.F32[y][x] = exciseValue;
            }
        }
    }

    if (sfiles->outWeight) {
        if (sfiles->recWeight) {
            sfiles->recWeight->image->data.F32[y][x] = sfiles->inWeight->image->data.F32[y][x];
        }
        // Assume that weight images are always a floating point type
        sfiles->outWeight->image->data.F32[y][x] = NAN;
    }
    if (sfiles->outMask) {
        if (sfiles->recMask) {
            sfiles->recMask->image->data.PS_TYPE_IMAGE_MASK_DATA[y][x] =
                sfiles->inMask->image->data.PS_TYPE_IMAGE_MASK_DATA[y][x];
        }
        sfiles->outMask->image->data.PS_TYPE_IMAGE_MASK_DATA[y][x] |= newMaskValue;
    }
}

static long
exciseNonDiffedPixels(streakFiles *sfiles, psImageMaskType newMaskValue)
{
    int cell_x0 = sfiles->astrom->cell_x0;
    int cell_y0 = sfiles->astrom->cell_y0;
    int xParity = sfiles->astrom->xParity;
    int yParity = sfiles->astrom->yParity;
    int numCols = sfiles->inImage->numCols; // for raw images this was calculated from the width of datasec
    int numRows = sfiles->inImage->numRows; // for raw images this was calculated from the height of datasec

    long excisedPixels = 0;

//    printf("%2d x0: %4d y0: %4d xpar: %d ypar: %d\n", sfiles->extnum, cell_x0, cell_y0, xParity, yParity);

    // XXX: in the case of raw images we are making an implicit assumption here
    // that the DATASEC begins at (x, y) = (0, 0) in the array for this image
    // While this is true for GPC1 it isn't necessarily true
    for (int yCell = 0; yCell < numRows; yCell++) {
        int yChip;
        if (yParity == 1) {
            yChip = cell_y0 + yCell;
        } else {
            yChip = cell_y0 - yCell;
        }

        psU8 *pixels = sfiles->diffedPixels->data.U8[yChip];

        if (xParity == 1) {
            pixels += cell_x0;
            for (int xCell = 0; xCell < numCols; xCell++, pixels++) {
                if (! *pixels ) {
                    excisePixel(sfiles, xCell, yCell, false, newMaskValue);
                    excisedPixels++;
                }
            }
        } else {
            // negative parity
            // point to the right most pixel in chip coordinates (lowest in cell coords)
            pixels += cell_x0 - numCols;
            for (int xCell = numCols - 1; xCell >= 0 ; xCell--, pixels++) {
                if (!*pixels) {
                    excisePixel(sfiles, xCell, yCell, false, newMaskValue);
                    excisedPixels++;
                }
            }
        }
    }
    return excisedPixels;
}

static bool
diffedPixel(streakFiles *sfiles, int x, int y)
{
    PixelPos chipCoord;

    if (!CHIP_LEVEL_INPUT(sfiles->stage)) {
        // if we're here on a skycell image by definition this pixel was diffed
        return true;
    }

    // we clip so that the streak calculation code doesn't have to
    // clipping here insures that we don't touch the overscan regions
    if ((x < 0) || (x >= sfiles->inImage->numCols) ||
        (y < 0) || (y >= sfiles->inImage->numRows)) {
        return false;
    }

    cellToChipInt(&chipCoord.x, &chipCoord.y, sfiles->astrom, x, y);

    if (chipCoord.x < 0 || chipCoord.x >= sfiles->diffedPixels->numCols) {
        return false;
    }
    if (chipCoord.y < 0 || chipCoord.y >= sfiles->diffedPixels->numRows) {
        return false;
    }

    return psImageGet(sfiles->diffedPixels, chipCoord.x, chipCoord.y) ? true : false;
}

// read a sources file (.cmf) and remove any rows whose coordinate is convered by a
// streak mask
static void
censorSources(streakFiles *sfiles, psImageMaskType maskStreak)
{
    if ((!sfiles->inSources) || (!sfiles->outMask)) {
        return;
    }
    psImage *maskImage = sfiles->outMask->image;
    if (!maskImage) {
        psError(PS_ERR_IO, false, "maskImage is null!");
        streaksExit("", PS_EXIT_PROG_ERROR);
    }

    sFile *in = sfiles->inSources;
    sFile *out = sfiles->outSources;


    // Primary header, should be "something.hdr"
    {
        psMetadata *header = psFitsReadHeader(NULL, in->fits);
        if (!header) {
            psError(PS_ERR_IO, false, "failed to read header from %s", in->resolved_name);
            streaksExit("", PS_EXIT_DATA_ERROR);
        }

        bool status;
        psString extname = psMetadataLookupStr(&status, header, "EXTNAME");
        if (!extname) {
            psError(PS_ERR_IO, false, "failed to find extname in header of %s", in->resolved_name);
            streaksExit("", PS_EXIT_DATA_ERROR);
        }
        addDestreakKeyword(header);

        if (!psFitsWriteBlank(out->fits, header, extname)) {
            psError(PS_ERR_IO, false, "failed to write blank in header of %s", in->resolved_name);
            streaksExit("", PS_EXIT_DATA_ERROR);
        }
        psFree(header);
    }

    // Extension with PSF fits, should be "something.psf"
    {
        if (!psFitsMoveExtNum(in->fits, 1, true)) {
            psErrorStackPrint(stderr, "failed to read header from %s", in->resolved_name);
            streaksExit("", PS_EXIT_DATA_ERROR);
        }

        psMetadata *header = psFitsReadHeader(NULL, in->fits);
        if (!header) {
            psErrorStackPrint(stderr, "failed to read header from %s", in->resolved_name);
            streaksExit("", PS_EXIT_DATA_ERROR);
        }
        psString extname = psMetadataLookupStr(NULL, header, "EXTNAME");
        if (!extname) {
            psError(PS_ERR_IO, false, "failed to find extname in header of %s", in->resolved_name);
            streaksExit("", PS_EXIT_DATA_ERROR);
        }

        psArray *inTable = psFitsReadTable(in->fits);
        if (!inTable->n) {
            psErrorStackPrint(stderr, "table in %s is empty", in->resolved_name);
            streaksExit("", PS_EXIT_DATA_ERROR);
        }

        psArray *outTable = psArrayAllocEmpty(inTable->n);
        int j = 0;
        int numCensored = 0;
        for (int i = 0 ; i < inTable->n; i++) {
            psMetadata *row = inTable->data[i];

            psF32 x = psMetadataLookupF32(NULL, row, "X_PSF");
            psF32 y = psMetadataLookupF32(NULL, row, "Y_PSF");

            psImageMaskType mask;
            if ((x >= maskImage->numCols) || (y >= maskImage->numRows) || (x <  0) || (y < 0)) {
                mask = maskStreak;
            } else {
                mask = maskImage->data.PS_TYPE_IMAGE_MASK_DATA[(int)y][(int)x];
            }

            // Key the source if the center pixel is not masked with maskStreak
            if (!(mask & maskStreak) ) {
                psArraySet(outTable, j++, row);
            } else {
                numCensored++;
            }
        }

        // get rid of unused elements (don't know if this is necessary)
        psArrayRealloc(outTable, j);

        addDestreakKeyword(header);
        if (psArrayLength(outTable) > 0) {
            printf("Censored %d sources\n", numCensored);
            if (! psFitsWriteTable(out->fits, header, outTable, extname)) {
                psErrorStackPrint(stderr, "failed to write table to %s", out->resolved_name);
                streaksExit("", PS_EXIT_DATA_ERROR);
            }
        } else {
            printf("Censored ALL %d sources\n", numCensored);
            if (! psFitsWriteTableEmpty(out->fits, header, inTable->data[0], extname)) {
                psErrorStackPrint(stderr, "failed to write empty table to %s", out->resolved_name);
                streaksExit("", PS_EXIT_DATA_ERROR);
            }
        }
        psFree(header);
        psFree(outTable);
        psFree(inTable);
    }

    // XXX Will need to update to handle extension with extended sources, etc.

    if (!psFitsClose(out->fits)) {
        psErrorStackPrint(stderr, "failed to close table %s", out->resolved_name);
        streaksExit("", PS_EXIT_DATA_ERROR);
    }
}
