lsst.meas.algorithms.convertReferenceCatalog Namespace Reference

Classes
class	ConvertReferenceCatalogTask

Functions
def	build_argparser ()
def	run_convert (outputDir, configFile, fileglob)
def	main ()

Function Documentation

build_argparser()

def lsst.meas.algorithms.convertReferenceCatalog.build_argparser

(

)

Construct an argument parser for the ``convertReferenceCatalog`` script.

Returns
-------
argparser : `argparse.ArgumentParser`
    The argument parser that defines the ``convertReferenceCatalog``
    command-line interface.

Definition at line 92 of file convertReferenceCatalog.py.

def build_argparser():
    """Construct an argument parser for the ``convertReferenceCatalog`` script.
 
    Returns
    -------
    argparser : `argparse.ArgumentParser`
        The argument parser that defines the ``convertReferenceCatalog``
        command-line interface.
    """
    parser = argparse.ArgumentParser(
        description=__doc__,
        formatter_class=argparse.RawDescriptionHelpFormatter,
        epilog='More information is available at https://pipelines.lsst.io.'
    )
    parser.add_argument("outputDir",
                        help="Path to write the output shard files, configs, and `ingest-files` table to.")
    parser.add_argument("configFile",
                        help="File containing the ConvertReferenceCatalogConfig fields.")
    # Use a "+"-list here, so we can produce a more useful error if the user
    # uses an unquoted glob that gets shell expanded.
    parser.add_argument("fileglob", nargs="+",
                        help="Quoted glob for the files to be read in and converted."
                             " Example (note required quotes to prevent shell expansion):"
                             ' "gaia_source/csv/GaiaSource*"')
    return parser
 
 

main()

def lsst.meas.algorithms.convertReferenceCatalog.main

(

)

Definition at line 154 of file convertReferenceCatalog.py.

def main():
    args = build_argparser().parse_args()
    if len(args.fileglob) > 1:
        raise RuntimeError("Final argument must be a quoted file glob, not a shell-expanded list of files.")
    # Fileglob comes out as a length=1 list, so we can test it above.
    run_convert(args.outputDir, args.configFile, args.fileglob[0])

run_convert()

def lsst.meas.algorithms.convertReferenceCatalog.run_convert	(		outputDir,
			configFile,
			fileglob
	)

Run `ConvertReferenceCatalogTask` on the input arguments.

Parameters
----------
outputDir : `str`
    Path to write the output files to.
configFile : `str`
    File specifying the ``ConvertReferenceCatalogConfig`` fields.
fileglob : `str`
    Quoted glob for the files to be read in and converted.

Definition at line 119 of file convertReferenceCatalog.py.

def run_convert(outputDir, configFile, fileglob):
    """Run `ConvertReferenceCatalogTask` on the input arguments.
 
    Parameters
    ----------
    outputDir : `str`
        Path to write the output files to.
    configFile : `str`
        File specifying the ``ConvertReferenceCatalogConfig`` fields.
    fileglob : `str`
        Quoted glob for the files to be read in and converted.
    """
    # We have to initialize the logger manually when running from the commandline.
    logging.basicConfig(level=logging.INFO, format="{name} {levelname}: {message}", style="{")
 
    config = ConvertReferenceCatalogTask.ConfigClass()
    config.load(configFile)
    config.validate()
    converter = ConvertReferenceCatalogTask(output_dir=outputDir, config=config)
    files = glob.glob(fileglob)
    converter.run(files)
    with open(os.path.join(outputDir, "convertReferenceCatalogConfig.py"), "w") as outfile:
        converter.config.saveToStream(outfile)
    msg = ("Completed refcat conversion.\n\n"
           "Ingest the resulting files with the following commands, substituting the path\n"
           "to your butler repo for `REPO`, and the ticket number you are tracking this\n"
           "ingest on for `DM-NNNNN`:\n"
           f"\n    butler register-dataset-type REPO {config.dataset_config.ref_dataset_name} "
           "SimpleCatalog htm7"
           "\n    butler ingest-files -t direct REPO gaia_dr2 refcats/DM-NNNNN "
           f"{converter.ingest_table_file}"
           "\n    butler collection-chain REPO --mode extend refcats refcats/DM-NNNNN")
    print(msg)