Luxpy package structure

Luxpy package structure:

• Utils sub-package
  • get_Axes3D_module()
  • np2d()
  • np3d()
  • np2dT()
  • np3dT()
  • put_args_in_db()
  • vec_to_dict()
  • loadtxt()
  • savetxt()
  • getdata()
  • dictkv()
  • meshblock()
  • asplit()
  • ajoin()
  • broadcast_shape()
  • todim()
  • read_excel()
  • write_excel()
  • show_luxpy_tree()
  • is_importable()
  • get_function_kwargs()
  • profile_fcn()
  • unique()
  • save_pkl()
  • load_pkl()
  • imread()
  • imsave()
  • lazy_import()
  • tree()
• Math sub-package
  • Module with useful math functions
    • NOT IMPORTED in math-namespace (to minimize dependencies)
  • normalize_3x3_matrix()
  • symmM_to_posdefM()
  • check_symmetric()
  • in_hull()
  • check_posdef()
  • positive_arctan()
  • line_intersect()
  • erf()
  • erfinv()
  • histogram()
  • pol2cart()
  • cart2pol()
  • spher2cart()
  • cart2spher()
  • bvgpdf()
  • mahalanobis2()
  • dot23()
  • rms()
  • geomean()
  • polyarea()
  • magnitude_v()
  • angle_v1v2()
  • v_to_cik()
  • cik_to_v()
  • fmod()
  • remove_outliers()
  • fit_ellipse()
  • fit_cov_ellipse()
  • linterp()
  • interpolatedunivariatespline()
  • interp1_sprague5()
  • interp1_sprague_cie224_2017()
  • interp1_lagrange()
  • interp1()
  • ndinterp1()
  • ndinterp1_scipy()
  • box_m()
  • pitman_morgan()
  • stress()
  • stress_F_test()
  • mean_distance_weighted()
  • round()
  • _interpolate_with_nans()
  • _extrap_y()
  • minimizebnd()
  • vec3/
  • DEMO/
• Spectrum sub-package
  • spectrum: sub-package supporting basic spectral calculations
    • spectrum/cmf.py
    • spectrum/spectral.py
    • spectrum/spectral_databases.py
    • spectrum/illuminants.py
    • spectrum/spdx_iestm2714.py
    • References
  • getwlr()
  • getwld()
  • spd_normalize()
  • spectral_interp()
  • cie_interp()
  • spd()
  • xyzbar()
  • vlbar()
  • vlbar_cie_mesopic()
  • get_cie_mesopic_adaptation()
  • spd_to_xyz()
  • spd_to_xyz_barebones()
  • spd_to_ler()
  • spd_to_power()
  • detect_peakwl()
  • create_spectral_interpolator()
  • wls_shift()
  • spd_to_xyz_legacy()
  • cri_ref()
  • blackbody()
  • spd_to_indoor()
  • daylightlocus()
  • daylightphase()
  • get_daylightloci_parameters()
  • get_daylightphase_Mi_coeffs()
  • read_spdx()
  • write_spdx()
  • SPD class
    • SPD
• Color sub-package
  • utils/
    • Module with functions related to plotting of color data
    • get_cmap()
    • get_subplot_layout()
    • plotSL()
    • plotDL()
    • plotBB()
    • plot_color_data()
    • plotceruleanline()
    • plotUH()
    • plotcircle()
    • plotellipse()
    • plot_chromaticity_diagram_colors()
    • plot_spectrum_colors()
    • plot_rfl_color_patches()
    • plot_rgb_color_patches()
    • plot_cmfs()
  • ctf/
    • Module with functions related to basic colorimetry
    • xyz_to_Yxy()
    • Yxy_to_xyz()
    • xyz_to_Yuv()
    • Yuv_to_xyz()
    • xyz_to_Yuv76()
    • Yuv76_to_xyz()
    • xyz_to_Yuv60()
    • Yuv60_to_xyz()
    • xyz_to_wuv()
    • wuv_to_xyz()
    • xyz_to_xyz()
    • xyz_to_lms()
    • lms_to_xyz()
    • xyz_to_lab()
    • lab_to_xyz()
    • xyz_to_luv()
    • luv_to_xyz()
    • xyz_to_Vrb_mb()
    • Vrb_mb_to_xyz()
    • xyz_to_ipt()
    • ipt_to_xyz()
    • xyz_to_Ydlep()
    • Ydlep_to_xyz()
    • xyz_to_srgb()
    • srgb_to_xyz()
    • Extension of basic colorimetry module
    • colortf()
  • cct/
    • cct: Module with functions related to correlated color temperature calculations
    • cct_to_mired()
    • xyz_to_cct_mcamy1992()
    • xyz_to_cct_hernandez1999()
    • xyz_to_cct_robertson1968()
    • xyz_to_cct_ohno2014()
    • xyz_to_cct_li2016()
    • xyz_to_cct_li2022()
    • xyz_to_cct_zhang2019()
    • xyz_to_cct_fibonacci()
    • xyz_to_cct()
    • cct_to_xyz()
    • calculate_lut()
    • generate_luts()
    • get_tcs4()
    • _get_lut()
    • _generate_tcs()
    • _generate_lut()
    • _generate_lut_ohno2014()
    • _generate_lut_li2022()
    • calculate_cct_luts()
    • xyz_to_cct_ohno2011()
    • _get_ccts_for_lut_bf()
    • generate_lut_bf()
    • xyz_to_cct_bruteforce()
  • cct/robertson1968
    • Standalone (no luxpy required) module with (updated, 2022) Robertson1968 CCT functions
    • save_pkl()
    • load_pkl()
    • get_tcs4()
    • calculate_lut()
    • loadtxt()
    • xyz_to_cct()
    • xyz_to_duv()
    • cct_to_xyz()
  • cat/
    • cat: Module supporting chromatic adaptation transforms (corresponding colors)
    • check_dimensions()
    • get_transfer_function()
    • get_degree_of_adaptation()
    • smet2017_D()
    • parse_x1x2_parameters()
    • apply()
    • apply_vonkries1()
    • apply_vonkries2()
    • apply_vonkries()
    • apply_ciecat94()
  • cam/
    • cam: sub-package with color appearance models
    • Module for CAM “front-end” cmf adaptation
    • hue_angle()
    • naka_rushton()
    • deltaH()
    • hue_quadrature()
    • _update_parameter_dict()
    • _setup_default_adaptation_field()
    • _massage_input_and_init_output()
    • _massage_output_data_to_original_shape()
    • _get_absolute_xyz_xyzw()
    • _simple_cam()
    • ciecam02()
    • xyz_to_jabM_ciecam02()
    • jabM_ciecam02_to_xyz()
    • xyz_to_jabC_ciecam02()
    • jabC_ciecam02_to_xyz()
    • cam02ucs()
    • xyz_to_jab_cam02ucs()
    • jab_cam02ucs_to_xyz()
    • xyz_to_jab_cam02lcd()
    • jab_cam02lcd_to_xyz()
    • xyz_to_jab_cam02scd()
    • jab_cam02scd_to_xyz()
    • ciecam16()
    • xyz_to_jabM_ciecam16()
    • jabM_ciecam16_to_xyz()
    • xyz_to_jabC_ciecam16()
    • jabC_ciecam16_to_xyz()
    • cam16ucs()
    • xyz_to_jab_cam16ucs()
    • jab_cam16ucs_to_xyz()
    • xyz_to_jab_cam16lcd()
    • jab_cam16lcd_to_xyz()
    • xyz_to_jab_cam16scd()
    • jab_cam16scd_to_xyz()
    • zcam()
    • xyz_to_jabz()
    • jabz_to_xyz()
    • xyz_to_jabM_zcam()
    • jabM_zcam_to_xyz()
    • xyz_to_jabC_zcam()
    • jabC_zcam_to_xyz()
    • cam15u()
    • xyz_to_qabW_cam15u()
    • qabW_cam15u_to_xyz()
    • cam_sww16()
    • xyz_to_lab_cam_sww16()
    • lab_cam_sww16_to_xyz()
    • cam18sl()
    • xyz_to_qabM_cam18sl()
    • qabM_cam18sl_to_xyz()
    • xyz_to_qabS_cam18sl()
    • qabS_cam18sl_to_xyz()
    • camXucs()
  • deltaE/
    • Module for color difference calculations
    • deltaH()
    • DE_camucs()
    • DE2000()
    • DE_cspace()
    • get_discrimination_ellipse()
    • get_macadam_ellipse()
    • get_brown1957_ellipse()
    • get_gij_fmc()
    • get_fmc_discrimination_ellipse()
    • discrimination_hotelling_t2()
  • whiteness/
    • Module with Smet et al. (2018) neutral white loci
    • xyz_to_neutrality_smet2018()
    • cct_to_neutral_loci_smet2018()
  • cri/
    • cri: sub-package suppporting color rendition calculations (colorrendition.py)
    • linear_scale()
    • log_scale()
    • psy_scale()
    • _get_hue_bin_data()
    • spd_to_jab_t_r()
    • spd_to_rg()
    • spd_to_DEi()
    • optimize_scale_factor()
    • spd_to_cri()
    • _hue_bin_data_to_rxhj()
    • _hue_bin_data_to_rfi()
    • _hue_bin_data_to_rg()
    • spd_to_ciera()
    • spd_to_cierf()
    • spd_to_ciera_133_1995()
    • spd_to_cierf_224_2017()
    • spd_to_iesrf()
    • spd_to_iesrg()
    • spd_to_iesrf_tm30()
    • spd_to_iesrg_tm30()
    • spd_to_iesrf_tm30_15()
    • spd_to_iesrg_tm30_15()
    • spd_to_iesrf_tm30_18()
    • spd_to_iesrg_tm30_18()
    • spd_to_iesrf_tm30_20()
    • spd_to_iesrg_tm30_20()
    • spd_to_cri2012()
    • spd_to_cri2012_hl17()
    • spd_to_cri2012_hl1000()
    • spd_to_cri2012_real210()
    • spd_to_mcri()
    • spd_to_cqs()
    • spd_to_fci()
    • spd_to_thornton_cpi()
    • plot_hue_bins()
    • plot_ColorVectorGraphic()
    • spd_to_ies_tm30_metrics()
    • _tm30_process_spd()
    • plot_tm30_cvg()
    • plot_tm30_Rfi()
    • plot_tm30_Rxhj()
    • plot_tm30_Rcshj()
    • plot_tm30_Rhshj()
    • plot_tm30_Rfhj()
    • plot_tm30_spd()
    • plot_tm30_report()
    • spd_to_tm30_report()
    • plot_cri_graphics()
    • spd_to_tm30_fast()
    • cri_ref_fast()
    • xyz_to_jab_cam02ucs_fast()
  • cri/VFPX/
    • get_poly_model()
    • apply_poly_model_at_x()
    • generate_vector_field()
    • VF_colorshift_model()
    • initialize_VF_hue_angles()
    • generate_grid()
    • calculate_shiftvectors()
    • plot_shift_data()
    • plotcircle()
    • get_pixel_coordinates()
    • PX_colorshift_model()
    • calculate_VF_PX_models()
    • subsample_RFL_set()
    • plot_VF_PX_models()
  • XYZ,LAB classes
    • XYZ
    • LAB
• Toolboxes
  • photbiochem/
    • Module for calculating CIE (S026:2018 & TN003:2015) photobiological quantities
    • Module for calculation of cyanosis index (AS/NZS 1680.2.5:1997)
    • Module for Blue light hazard calculations
    • spd_to_aopicE()
    • spd_to_aopicEDI()
    • spd_to_aopicDER()
    • spd_to_aopicELR()
    • spd_to_COI_ASNZS1680()
    • spd_to_CS_CLa_lrc()
    • CLa_to_CS()
    • spd_to_blh_eff()
  • indvcmf/
    • Module for Individual Observer lms-CMFs (Asano, 2016 and CIE TC1-97)
    • load_database()
    • init()
    • query_state()
    • cie2006cmfsEx()
    • getMonteCarloParam()
    • genMonteCarloObs()
    • getCatObs()
    • compute_cmfs()
    • add_to_cmf_dict()
    • plot_cmfs()
    • my_round()
    • chop()
    • sign_figs()
  • spdbuild/
    • Module for building and optimizing SPDs
    • Module for building and optimizing SPDs (2)
  • hypspcim/
    • Module for hyper spectral image simulation
    • render_image()
    • xyz_to_rfl()
    • get_superresolution_hsi()
    • hsi_to_rgb()
    • rfl_to_rgb()
  • dispcal/
    • Module for display characterization
    • _parse_rgbxyz_input()
    • find_index_in_rgb()
    • _plot_target_vs_predicted_lab()
    • _plot_DEs_vs_digital_values()
    • calibrate()
    • calibration_performance()
    • rgb_to_xyz()
    • xyz_to_rgb()
    • DisplayCalibration
    • TR_ggo()
    • TRi_ggo()
    • TR_gog()
    • TRi_gog()
    • TR_gogo()
    • TRi_gogo()
    • TR_sigmoid()
    • TRi_sigmoid()
    • correct_for_black()
    • _rgb_linearizer()
    • _rgb_delinearizer()
    • estimate_tr()
    • optimize_3x3_transfer_matrix()
    • get_3x3_transfer_matrix_from_max_rgb()
    • generate_training_data()
    • generate_test_data()
    • split_ramps_from_cube()
    • is_random_sampling_of_pure_rgbs()
    • plot_rgb_xyz_lab_of_set()
    • ramp_data_to_cube_data()
    • GGO_GOG_GOGO_PLI
    • MLPR
    • POR
    • LUTNNLI
    • LUTQHLI
    • VirtualDisplay
  • rgb2spec/
    • rgb_to_spec_smits()
    • convert()
  • iolidfiles/
    • Module for reading and writing IES and LDT files.
    • read_lamp_data()
    • get_uv_texture()
    • save_texture()
    • draw_lid()
    • render_lid()
    • luminous_intensity_to_luminous_flux()
  • spectro/
    • Package for spectral measurements
    • init()
    • get_spd()
  • sherbrooke_spectral_indices/
    • spd_to_msi()
    • spd_to_ipi()
    • spd_to_sli()
  • spectral_mismatch_and_uncertainty/
    • Toolbox for spectral mismatch and measurement uncertainty calculations
    • f1prime()
    • get_spectral_mismatch_correction_factors()
  • technoteamlmk/
    • get_labsoft_path()
    • define_lens()
    • lmkActiveX
    • kill_lmk4_process()
    • read_pcf()
    • write_pcf()
    • plot_pcf()
    • pcf_to_xyz()
    • xyz_to_pcf()
    • ciergb_to_xyz()
    • xyz_to_ciergb()
    • Defisheye
  • stereoscopicviewer/
    • CreateSphereModel()
    • CreatePlaneModel()
    • create_material()
    • update_material_texture()
    • makeColorTex()
    • split_SingleSphericalTex()
    • Shader
    • Scene
    • Camera
    • Material
    • Screen
    • Eye
    • HmdStereoViewer
    • generate_stimulus_tex_list()
    • generate_rgba_texs_iml()
    • get_rgbFromTexPaths()
    • getRectMask()
    • getRoiImage()
    • get_xyz_from_xyzmap_roi()
    • get_rgb_from_rgbtexpath()