lsst.cp.pipe.script.plot_ptc_dataset Namespace Reference

Functions
def	build_argparser ()
def	main ()

Function Documentation

build_argparser()

def lsst.cp.pipe.script.plot_ptc_dataset.build_argparser

(

)

Construct an argument parser for the ``plot_ptc_dataset.py`` script.
Returns
-------
argparser : `argparse.ArgumentParser`
    The argument parser that defines the ``plot_ptc_dataset.py``
    command-line interface.

Definition at line 29 of file plot_ptc_dataset.py.

def build_argparser():
    """Construct an argument parser for the ``plot_ptc_dataset.py`` script.
    Returns
    -------
    argparser : `argparse.ArgumentParser`
        The argument parser that defines the ``plot_ptc_dataset.py``
        command-line interface.
    """
    parser = argparse.ArgumentParser(description='Rewrite native FITS files from the test '
                                                 'stand to a standard format')
    parser.add_argument('datasetFilename', help="datasetPtc (lsst.ip.isr.PhotonTransferCurveDataset) file"
                        "name (fits)", type=str)
    parser.add_argument('--linearizerFileName', help="linearizer (isr.linearize.Linearizer) file"
                        "name (fits)", type=str, default=None)
    parser.add_argument('--outDir', type=str,
                        help="Root directory to which to write outputs", default='.')
    parser.add_argument('--detNum', type=int,
                        help="Detector number",
                        default=999)
    parser.add_argument('--signalElectronsRelativeA', type=float,
                        help="Signal value for relative systematic bias between different"
                        "methods of estimating a_ij(Fig. 15 of Astier+19)",
                        default=75000)
    parser.add_argument('--plotNormalizedCovariancesNumberOfBins', type=int,
                        help="Number of bins in `plotNormalizedCovariancesNumber` function "
                        "(Fig. 8, 10., of Astier+19)",
                        default=10)
 
    return parser
 
 

main()

def lsst.cp.pipe.script.plot_ptc_dataset.main

(

)

Examples

forEachPixel.cc, image1.cc, image2.cc, imageStatistics.cc, maskedImage1.cc, maskedImage2.cc, and splineInterpolate.cc.

Definition at line 60 of file plot_ptc_dataset.py.

def main():
    args = build_argparser().parse_args()
    try:
        plotPtc = PlotPhotonTransferCurveTask(
            args.datasetFilename,
            linearizerFileName=args.linearizerFileName,
            outDir=args.outDir, detNum=args.detNum,
            signalElectronsRelativeA=args.signalElectronsRelativeA,
            plotNormalizedCovariancesNumberOfBins=args.plotNormalizedCovariancesNumberOfBins)
 
        plotPtc.runDataRef()
    except Exception as e:
        print(f"{e}", file=sys.stderr)
        return 1
    return 0