Source code for diffpy.labpdfproc.labpdfprocapp

import argparse
import os
import sys

from gooey import Gooey, GooeyParser

from diffpy.labpdfproc.functions import CVE_METHODS, apply_corr, compute_cve
from diffpy.labpdfproc.tools import (
    WAVELENGTHS,
    load_metadata,
    load_wavelength_from_config_file,
    preprocessing_args,
    set_wavelength,
)
from diffpy.utils.diffraction_objects import XQUANTITIES, DiffractionObject
from diffpy.utils.parsers import load_data


def _running_in_gui():
    """Determine if the application is running in a GUI environment.

    This function checks if the standard output (sys.stdout) is
    connected to a terminal. If not, it assumes the application is
    running in a GUI environment, such as when launched by Gooey. This
    is used to prevent ANSI escape sequences from rendering in the GUI.
    """
    return not sys.stdout.isatty()


def _add_common_args(parser, use_gui=False):
    parser.add_argument(
        "-w",
        "--wavelength",
        help=(
            "X-ray wavelength in angstroms (numeric) or X-ray source name "
            f"(allowed: {', '.join(sorted(WAVELENGTHS.keys()))}). "
            "Will be loaded from config files if not specified."
        ),
        default=None,
    )
    parser.add_argument(
        "-x",
        "--xtype",
        help=(
            "X-axis type (default: tth). Allowed values: "
            f"{', '.join(XQUANTITIES)}"
        ),
        default="tth",
    )
    parser.add_argument(
        "-m",
        "--method",
        help=(
            "Method for cylindrical volume element (CVE) calculation "
            "(default: polynomial_interpolation). Allowed methods: "
            f"{', '.join(CVE_METHODS)}"
        ),
        default="polynomial_interpolation",
        choices=CVE_METHODS,
    )
    parser.add_argument(
        "-o",
        "--output-directory",
        help=(
            "Directory to save corrected files (created if needed). "
            "Defaults to current directory."
        ),
        default=None,
        **({"widget": "DirChooser"} if use_gui else {}),
    )
    parser.add_argument(
        "-f", "--force", help="Overwrite existing files", action="store_true"
    )
    parser.add_argument(
        "-c",
        "--output-correction",
        help="Also output the absorption correction to a separate file",
        action="store_true",
    )
    parser.add_argument(
        "-u",
        "--user-metadata",
        help=(
            "Specify key-value pairs to be loaded into metadata "
            "using the format key=value. "
            "Separate pairs with whitespace, "
            "and ensure no whitespaces before or after the = sign. "
            "Avoid using = in keys. If multiple = signs are present, "
            "only the first separates the key and value. "
            "If a key or value contains whitespace, enclose it in quotes. "
            "For example, facility='NSLS II', "
            "'facility=NSLS II', beamline=28ID-2, "
            "'beamline'='28ID-2', 'favorite color'=blue, "
            "are all valid key=value items."
        ),
        nargs="+",
        metavar="KEY=VALUE",
    )
    _add_credit_args(parser, use_gui)
    return parser


def _add_credit_args(parser, use_gui=False):
    parser.add_argument(
        "--username",
        help=(
            "Your name (optional, for dataset credit). "
            "Will be loaded from config files if not specified."
        ),
        default=None,
        **({"widget": "TextField"} if use_gui else {}),
    )
    parser.add_argument(
        "--email",
        help=(
            "Your email (optional, for dataset credit). "
            "Will be loaded from config files if not specified."
        ),
        default=None,
        **({"widget": "TextField"} if use_gui else {}),
    )
    parser.add_argument(
        "--orcid",
        help=(
            "Your ORCID ID (optional, for dataset credit). "
            "Will be loaded from config files if not specified."
        ),
        default=None,
        **({"widget": "TextField"} if use_gui else {}),
    )


def _save_corrected(corrected, input_path, args):
    outfile = args.output_directory / (f"{input_path.stem}-mud-corrected.chi")
    corrected.metadata = corrected.metadata or {}
    corrected.dump(str(outfile), xtype=args.xtype)
    print(f"Saved corrected data to {outfile}")


def _save_correction(correction, input_path, args):
    corrfile = args.output_directory / (f"{input_path.stem}-cve.chi")
    correction.metadata = correction.metadata or {}
    correction.dump(str(corrfile), xtype=args.xtype)
    print(f"Saved correction data to {corrfile}")


def _load_pattern(path, xtype, wavelength, metadata):
    x, y = load_data(path, unpack=True)
    return DiffractionObject(
        xarray=x,
        yarray=y,
        xtype=xtype,
        wavelength=wavelength,
        scat_quantity="x-ray",
        name=path.stem,
        metadata=metadata,
    )


[docs] def apply_absorption_correction(args): """Process all input files with absorption correction.""" for path in args.input_paths: metadata = load_metadata(args, path) pattern = _load_pattern(path, args.xtype, args.wavelength, metadata) correction = compute_cve( pattern, args.mud, method=args.method, xtype=args.xtype ) correction.metadata = metadata.copy() corrected_data = apply_corr(pattern, correction) corrected_data.name = ( f"Absorption corrected input_data: {pattern.name}" ) corrected_data.metadata = metadata.copy() _save_corrected(corrected_data, path, args) if args.output_correction: _save_correction(correction, path, args)
[docs] def create_parser(use_gui=False): Parser = GooeyParser if use_gui else argparse.ArgumentParser # Force no colors when gui is running to avoid ANSI escape codes # in Gooey output if use_gui or _running_in_gui(): os.environ["NO_COLOR"] = "1" os.environ["CLICOLOR"] = "0" parser = Parser( prog="labpdfproc", description=( "Apply absorption corrections to laboratory X-ray diffraction " "data prior to PDF analysis. Supports manual mu*d, " "z-scan, or sample-based corrections." ), formatter_class=argparse.RawTextHelpFormatter, ) subp = parser.add_subparsers( dest="command", required=True, title="Correction method" ) # MUD parser mud_parser = subp.add_parser( "mud", help="Correct diffraction data using known mu*d value" ) mud_parser.add_argument( "input", nargs="+", help=( "Input X-ray diffraction data file(s) or directory. " "Can specify multiple files, directories, or use wildcards." ), **({"widget": "MultiFileChooser"} if use_gui else {}), ) mud_parser.add_argument( "mud", type=float, help="mu*d value", metavar="mud" ) _add_common_args(mud_parser, use_gui) # ZSCAN parser zscan_parser = subp.add_parser( "zscan", help="Correct diffraction data using a z-scan measurement" ) zscan_parser.add_argument( "input", nargs="+", help=( "Input X-ray diffraction data file(s) or directory. " "Can specify multiple files, directories, or use wildcards." ), **({"widget": "MultiFileChooser"} if use_gui else {}), ) zscan_parser.add_argument( "z_scan_file", help=( "Z-scan measurement file. " "See diffpy.labpdfproc documentation for more information." ), **({"widget": "FileChooser"} if use_gui else {}), ) _add_common_args(zscan_parser, use_gui) # SAMPLE parser sample_parser = subp.add_parser( "sample", help="Correct diffraction data using sample composition/density", ) sample_parser.add_argument( "input", nargs="+", help=( "Input X-ray diffraction data file(s) or directory. " "Can specify multiple files, directories, or use wildcards." ), **({"widget": "MultiFileChooser"} if use_gui else {}), ) sample_parser.add_argument( "sample_composition", help="Chemical formula, e.g. Fe2O3", ) sample_parser.add_argument( "sample_mass_density", type=float, help=( "Sample mass density in capillary (g/cm^3). " "If unsure, a good estimate is ~1/3 of the " "theoretical packing fraction density." ), ) sample_parser.add_argument( "diameter", type=float, help="Outer diameter of the capillary in mm", ) _add_common_args(sample_parser, use_gui) return parser
def _handle_old_api_conversion(args): """Convert `sample` command arguments to previous format so functions can accept them without modification.""" if args.command == "sample": # Convert sample args to theoretical_from_density format args = load_wavelength_from_config_file(args) args = set_wavelength(args) energy_kev = 12.398 / args.wavelength if args.wavelength else None if energy_kev: args.theoretical_from_density = ( f"{args.sample_composition}," f"{energy_kev}," f"{args.sample_mass_density}" ) return args @Gooey( program_name="labpdfproc", required_cols=1, optional_cols=1, show_sidebar=True, ) def get_args_gui(): parser = create_parser(use_gui=True) return parser.parse_args()
[docs] def get_args_cli(override=None): parser = create_parser(use_gui=False) argv = override if override is not None else sys.argv[1:] argv = [arg for arg in argv if arg != "--ignore-gooey"] return parser.parse_args(argv)
[docs] def main(): use_gui = len(sys.argv) == 1 or "--gui" in sys.argv args = get_args_gui() if use_gui else get_args_cli() args = _handle_old_api_conversion(args) args = preprocessing_args(args) apply_absorption_correction(args)
if __name__ == "__main__": main()