Color Tools
  • color_tools.conversions
    • hex_to_rgb()
    • rgb_to_hex()
    • rgb_to_xyz()
    • xyz_to_lab()
    • rgb_to_lab()
    • lab_to_xyz()
    • xyz_to_rgb()
    • lab_to_rgb()
    • lab_to_lch()
    • lch_to_lab()
    • lch_to_rgb()
    • rgb_to_lch()
    • rgb_to_hsl()
    • rgb_to_winhsl240()
    • rgb_to_winhsl255()
    • rgb_to_winhsl()
    • hsl_to_rgb()
    • rgb_to_cmy()
    • cmy_to_rgb()
    • rgb_to_cmyk()
    • cmyk_to_rgb()
  • color_tools.distance
    • euclidean()
    • hue_diff_deg()
    • hsl_euclidean()
    • delta_e_76()
    • delta_e_94()
    • delta_e_2000()
    • delta_e_2000_array()
    • delta_e_cmc()
    • delta_e_hyab()
  • color_tools.gamut
    • is_in_srgb_gamut()
    • find_nearest_in_gamut()
    • clamp_to_gamut()
  • color_tools.harmony
    • HarmonyColor
      • HarmonyColor.hue_offset
      • HarmonyColor.ideal_lch
      • HarmonyColor.was_in_gamut
      • HarmonyColor.mapped_lch
      • HarmonyColor.rgb
      • HarmonyColor.hex
      • HarmonyColor.gamut_delta_e
    • HarmonyResult
      • HarmonyResult.scheme
      • HarmonyResult.base_lch
      • HarmonyResult.colors
      • HarmonyResult.mood
      • HarmonyResult.tone
      • HarmonyResult.grade_base
    • generate_harmony_lch()
    • generate_harmony()
  • color_tools.constants
    • ColorConstants
      • ColorConstants.D65_WHITE_X
      • ColorConstants.D65_WHITE_Y
      • ColorConstants.D65_WHITE_Z
      • ColorConstants.SRGB_TO_XYZ_R
      • ColorConstants.SRGB_TO_XYZ_G
      • ColorConstants.SRGB_TO_XYZ_B
      • ColorConstants.XYZ_TO_SRGB_X
      • ColorConstants.XYZ_TO_SRGB_Y
      • ColorConstants.XYZ_TO_SRGB_Z
      • ColorConstants.SRGB_GAMMA_THRESHOLD
      • ColorConstants.SRGB_GAMMA_LINEAR_SCALE
      • ColorConstants.SRGB_GAMMA_OFFSET
      • ColorConstants.SRGB_GAMMA_DIVISOR
      • ColorConstants.SRGB_GAMMA_POWER
      • ColorConstants.SRGB_INV_GAMMA_THRESHOLD
      • ColorConstants.LAB_DELTA
      • ColorConstants.LAB_KAPPA
      • ColorConstants.LAB_OFFSET
      • ColorConstants.LAB_A_SCALE
      • ColorConstants.LAB_B_SCALE
      • ColorConstants.DE94_K1
      • ColorConstants.DE94_K2
      • ColorConstants.DE2000_POW7_BASE
      • ColorConstants.DE2000_HUE_OFFSET_1
      • ColorConstants.DE2000_HUE_WEIGHT_1
      • ColorConstants.DE2000_HUE_MULT_2
      • ColorConstants.DE2000_HUE_WEIGHT_2
      • ColorConstants.DE2000_HUE_MULT_3
      • ColorConstants.DE2000_HUE_OFFSET_3
      • ColorConstants.DE2000_HUE_WEIGHT_3
      • ColorConstants.DE2000_HUE_MULT_4
      • ColorConstants.DE2000_HUE_OFFSET_4
      • ColorConstants.DE2000_HUE_WEIGHT_4
      • ColorConstants.DE2000_DRO_MULT
      • ColorConstants.DE2000_DRO_CENTER
      • ColorConstants.DE2000_DRO_DIVISOR
      • ColorConstants.DE2000_L_WEIGHT
      • ColorConstants.DE2000_L_OFFSET
      • ColorConstants.DE2000_L_DIVISOR
      • ColorConstants.DE2000_C_WEIGHT
      • ColorConstants.DE2000_H_WEIGHT
      • ColorConstants.CMC_L_THRESHOLD
      • ColorConstants.CMC_L_LOW
      • ColorConstants.CMC_L_SCALE
      • ColorConstants.CMC_L_DIVISOR
      • ColorConstants.CMC_C_SCALE
      • ColorConstants.CMC_C_DIVISOR
      • ColorConstants.CMC_C_OFFSET
      • ColorConstants.CMC_HUE_MIN
      • ColorConstants.CMC_HUE_MAX
      • ColorConstants.CMC_T_IN_RANGE
      • ColorConstants.CMC_T_COS_MULT_IN
      • ColorConstants.CMC_T_HUE_OFFSET_IN
      • ColorConstants.CMC_T_OUT_RANGE
      • ColorConstants.CMC_T_COS_MULT_OUT
      • ColorConstants.CMC_T_HUE_OFFSET_OUT
      • ColorConstants.CMC_F_POWER
      • ColorConstants.CMC_F_DIVISOR
      • ColorConstants.CMC_L_DEFAULT
      • ColorConstants.CMC_C_DEFAULT
      • ColorConstants.HUE_CIRCLE_DEGREES
      • ColorConstants.HUE_HALF_CIRCLE_DEGREES
      • ColorConstants.RGB_MIN
      • ColorConstants.RGB_MAX
      • ColorConstants.NORMALIZED_MIN
      • ColorConstants.NORMALIZED_MAX
      • ColorConstants.XYZ_SCALE_FACTOR
      • ColorConstants.WIN_HSL_MAX
      • ColorConstants.WIN_HSL240_HUE_MAX
      • ColorConstants.WIN_HSL240_SL_MAX
      • ColorConstants.WIN_HSL255_HUE_MAX
      • ColorConstants.WIN_HSL255_SL_MAX
      • ColorConstants.AB_MIN
      • ColorConstants.AB_MAX
      • ColorConstants.CHROMA_MIN
      • ColorConstants.CHROMA_MAX
      • ColorConstants.COLORS_JSON_FILENAME
      • ColorConstants.FILAMENTS_JSON_FILENAME
      • ColorConstants.MAKER_SYNONYMS_JSON_FILENAME
      • ColorConstants.LAB_DELTA_CUBED
      • ColorConstants.LAB_F_SCALE
      • ColorConstants.LAB_F_OFFSET
      • ColorConstants.verify_integrity()
      • ColorConstants.COLORS_JSON_HASH
      • ColorConstants.FILAMENTS_JSON_HASH
      • ColorConstants.MAKER_SYNONYMS_JSON_HASH
      • ColorConstants.APPLE2_PALETTE_HASH
      • ColorConstants.CGA4_PALETTE_HASH
      • ColorConstants.CGA16_PALETTE_HASH
      • ColorConstants.COMMODORE64_PALETTE_HASH
      • ColorConstants.CRAYOLA_PALETTE_HASH
      • ColorConstants.EGA16_PALETTE_HASH
      • ColorConstants.EGA64_PALETTE_HASH
      • ColorConstants.GAMEBOY_PALETTE_HASH
      • ColorConstants.GAMEBOY_COLOR_PALETTE_HASH
      • ColorConstants.GAMEBOY_DMG_PALETTE_HASH
      • ColorConstants.GAMEBOY_GBL_PALETTE_HASH
      • ColorConstants.GAMEBOY_MGB_PALETTE_HASH
      • ColorConstants.MACINTOSH_PALETTE_HASH
      • ColorConstants.NES_PALETTE_HASH
      • ColorConstants.PICO8_PALETTE_HASH
      • ColorConstants.SMS_PALETTE_HASH
      • ColorConstants.TANDY16_PALETTE_HASH
      • ColorConstants.VGA_PALETTE_HASH
      • ColorConstants.VIRTUALBOY_PALETTE_HASH
      • ColorConstants.WEB_PALETTE_HASH
      • ColorConstants.USER_COLORS_JSON_FILENAME
      • ColorConstants.USER_FILAMENTS_JSON_FILENAME
      • ColorConstants.USER_SYNONYMS_JSON_FILENAME
      • ColorConstants.OWNED_FILAMENTS_JSON_FILENAME
      • ColorConstants.MATRICES_EXPECTED_HASH
      • ColorConstants.verify_data_file()
      • ColorConstants.verify_all_data_files()
      • ColorConstants.verify_matrices_integrity()
      • ColorConstants.generate_user_data_hash()
      • ColorConstants.save_user_data_hash()
      • ColorConstants.verify_user_data_file()
      • ColorConstants.verify_all_user_data()
  • color_tools.matrices
    • PROTANOPIA_SIMULATION
    • DEUTERANOPIA_SIMULATION
    • TRITANOPIA_SIMULATION
    • ALL_SIMULATION
    • PROTANOPIA_CORRECTION
    • DEUTERANOPIA_CORRECTION
    • TRITANOPIA_CORRECTION
    • ALL_CORRECTION
    • multiply_matrix_vector()
    • get_simulation_matrix()
    • get_correction_matrix()
  • color_tools.config
    • ColorConfig
    • set_dual_color_mode()
    • get_dual_color_mode()
    • set_gamut_tolerance()
    • get_gamut_tolerance()
    • set_gamut_max_iterations()
    • get_gamut_max_iterations()
  • color_tools.palette
    • ColorRecord
      • ColorRecord.name
      • ColorRecord.hex
      • ColorRecord.rgb
      • ColorRecord.hsl
      • ColorRecord.lab
      • ColorRecord.lch
      • ColorRecord.source
      • ColorRecord.__str__()
    • load_colors()
    • load_palette()
    • Palette
      • Palette.load_default()
      • Palette.find_by_name()
      • Palette.find_by_rgb()
      • Palette.find_by_hsl()
      • Palette.find_by_lab()
      • Palette.find_by_lch()
      • Palette.nearest_color()
      • Palette.nearest_colors()
      • Palette.get_override_info()
  • color_tools.filament_palette
    • FilamentRecord
      • FilamentRecord.id
      • FilamentRecord.maker
      • FilamentRecord.type
      • FilamentRecord.finish
      • FilamentRecord.color
      • FilamentRecord.hex
      • FilamentRecord.td_value
      • FilamentRecord.other_names
      • FilamentRecord.source
      • FilamentRecord.hex2
      • FilamentRecord.__post_init__()
      • FilamentRecord.rgb
      • FilamentRecord.lab
      • FilamentRecord.__str__()
    • load_filaments()
    • load_maker_synonyms()
    • load_owned_filaments()
    • save_owned_filaments()
    • FilamentPalette
      • FilamentPalette.load_default()
      • FilamentPalette.find_by_maker()
      • FilamentPalette.find_by_type()
      • FilamentPalette.find_by_color()
      • FilamentPalette.find_by_rgb()
      • FilamentPalette.find_by_finish()
      • FilamentPalette.filter()
      • FilamentPalette.nearest_filament()
      • FilamentPalette.nearest_filaments()
      • FilamentPalette.makers
      • FilamentPalette.types
      • FilamentPalette.finishes
      • FilamentPalette.get_override_info()
      • FilamentPalette.get_filament_by_id()
      • FilamentPalette.list_owned()
      • FilamentPalette.add_owned()
      • FilamentPalette.remove_owned()
      • FilamentPalette.save_owned()
  • color_tools.filament_collections
    • FilamentCollections
      • FilamentCollections.BAMBU_PLA_BASIC
      • FilamentCollections.BAMBU_PLA_MATTE
      • FilamentCollections.BAMBU_PLA_BASICMATTE
  • color_tools.naming
    • get_lightness_modifier()
    • get_saturation_modifier()
    • get_hue_with_ish()
    • determine_base_hue()
    • get_generic_hue()
    • is_unique_near_claim()
    • generate_color_name()
  • color_tools.validation
    • ColorValidationRecord
      • ColorValidationRecord.is_match
      • ColorValidationRecord.name_match
      • ColorValidationRecord.name_confidence
      • ColorValidationRecord.hex_value
      • ColorValidationRecord.suggested_hex
      • ColorValidationRecord.delta_e
      • ColorValidationRecord.message
      • ColorValidationRecord.__str__()
    • validate_color()
  • color_tools.color_deficiency
    • simulate_cvd()
    • simulate_protanopia()
    • simulate_deuteranopia()
    • simulate_tritanopia()
    • simulate_all_cvd()
    • correct_cvd()
    • correct_protanopia()
    • correct_deuteranopia()
    • correct_tritanopia()
    • correct_all_cvd()
  • color_tools.export
    • list_export_formats()
    • generate_filename()
    • export_filaments_autoforge()
    • export_filaments_csv()
    • export_filaments_json()
    • export_colors_csv()
    • export_colors_json()
    • export_filaments()
    • export_colors()
  • color_tools.exporters
    • AutoForgeExporter
      • AutoForgeExporter.metadata
    • ASEExporter
      • ASEExporter.metadata
    • CSVExporter
      • CSVExporter.COLOR_FIELDS
      • CSVExporter.metadata
    • ExporterDependency
      • ExporterDependency.package
      • ExporterDependency.import_name
      • ExporterDependency.extra
    • ExporterMetadata
      • ExporterMetadata.name
      • ExporterMetadata.description
      • ExporterMetadata.file_extension
      • ExporterMetadata.supports_colors
      • ExporterMetadata.supports_filaments
      • ExporterMetadata.supports_palette_metadata
      • ExporterMetadata.is_binary
      • ExporterMetadata.is_image
      • ExporterMetadata.dependencies
      • ExporterMetadata.options_type
      • ExporterMetadata.__post_init__()
    • GPLExporter
      • GPLExporter.metadata
    • HexExporter
      • HexExporter.metadata
    • JascPalExporter
      • JascPalExporter.metadata
    • JSONExporter
      • JSONExporter.metadata
    • LospecExporter
      • LospecExporter.metadata
    • MissingExporterDependencyError
    • PaintNetExporter
      • PaintNetExporter.MAX_COLORS
      • PaintNetExporter.metadata
    • PaintNetExportOptions
      • PaintNetExportOptions.pad_to_96
    • PaletteExporter
      • PaletteExporter.metadata
      • PaletteExporter.missing_dependencies
      • PaletteExporter.is_available
      • PaletteExporter.export_colors()
      • PaletteExporter.export_palette()
      • PaletteExporter.export_filaments()
      • PaletteExporter.generate_filename()
    • PaletteLutExporter
      • PaletteLutExporter.metadata
    • RiffPalExporter
      • RiffPalExporter.PALETTE_VERSION
      • RiffPalExporter.metadata
    • CSSExporter
      • CSSExporter.metadata
    • SketchPaletteExporter
      • SketchPaletteExporter.COMPATIBLE_VERSION
      • SketchPaletteExporter.PLUGIN_VERSION
      • SketchPaletteExporter.metadata
    • SOCExporter
      • SOCExporter.OFFICE_NS
      • SOCExporter.DRAW_NS
      • SOCExporter.XLINK_NS
      • SOCExporter.SVG_NS
      • SOCExporter.OOO_NS
      • SOCExporter.metadata
    • ScribusExporter
      • ScribusExporter.metadata
    • KPLExporter
      • KPLExporter.MIMETYPE
      • KPLExporter.FORMAT_VERSION
      • KPLExporter.DEFAULT_COLUMNS
      • KPLExporter.metadata
    • SwatchImageExporter
      • SwatchImageExporter.IMAGE_WIDTH
      • SwatchImageExporter.OUTER_MARGIN
      • SwatchImageExporter.HEADER_GAP
      • SwatchImageExporter.CARD_WIDTH
      • SwatchImageExporter.CARD_GAP
      • SwatchImageExporter.CARD_PADDING
      • SwatchImageExporter.CARD_RADIUS
      • SwatchImageExporter.SWATCH_HEIGHT
      • SwatchImageExporter.SWATCH_RADIUS
      • SwatchImageExporter.SWATCH_BORDER_WIDTH
      • SwatchImageExporter.TITLE_FONT_SIZE
      • SwatchImageExporter.DESCRIPTION_FONT_SIZE
      • SwatchImageExporter.NAME_FONT_SIZE
      • SwatchImageExporter.VALUE_FONT_SIZE
      • SwatchImageExporter.INDEX_FONT_SIZE
      • SwatchImageExporter.NAME_VALUE_GAP
      • SwatchImageExporter.VALUE_LINE_GAP
      • SwatchImageExporter.CARD_BOTTOM_PADDING
      • SwatchImageExporter.BACKGROUND
      • SwatchImageExporter.CARD_BACKGROUND
      • SwatchImageExporter.TEXT_PRIMARY
      • SwatchImageExporter.TEXT_SECONDARY
      • SwatchImageExporter.SWATCH_BORDER
      • SwatchImageExporter.INDEX_BACKGROUND
      • SwatchImageExporter.INDEX_TEXT
      • SwatchImageExporter.metadata
    • PythonExporter
      • PythonExporter.metadata
    • PythonExportOptions
      • PythonExportOptions.representation
      • PythonExportOptions.value_format
      • PythonExportOptions.normalized
      • PythonExportOptions.include_alpha
      • PythonExportOptions.include_metadata
      • PythonExportOptions.include_names_as_comments
      • PythonExportOptions.variable_name
      • PythonExportOptions.precision
      • PythonExportOptions.__post_init__()
    • get_exporter()
    • list_export_formats()
    • register_exporter()
  • color_tools.exporters.base
    • ExporterDependency
      • ExporterDependency.package
      • ExporterDependency.import_name
      • ExporterDependency.extra
    • ExporterMetadata
      • ExporterMetadata.name
      • ExporterMetadata.description
      • ExporterMetadata.file_extension
      • ExporterMetadata.supports_colors
      • ExporterMetadata.supports_filaments
      • ExporterMetadata.supports_palette_metadata
      • ExporterMetadata.is_binary
      • ExporterMetadata.is_image
      • ExporterMetadata.dependencies
      • ExporterMetadata.options_type
      • ExporterMetadata.__post_init__()
    • MissingExporterDependencyError
    • PaletteExporter
      • PaletteExporter.metadata
      • PaletteExporter.missing_dependencies
      • PaletteExporter.is_available
      • PaletteExporter.export_colors()
      • PaletteExporter.export_palette()
      • PaletteExporter.export_filaments()
      • PaletteExporter.generate_filename()
  • color_tools.exporters.export_options_base
    • ExportOptionsBase
  • color_tools.exporters.palette_export_data
    • PaletteExportData
      • PaletteExportData.colors
      • PaletteExportData.metadata
  • color_tools.exporters.palette_metadata
    • PaletteMetadata
      • PaletteMetadata.name
      • PaletteMetadata.author
      • PaletteMetadata.description
      • PaletteMetadata.columns
      • PaletteMetadata.tags
      • PaletteMetadata.properties
      • PaletteMetadata.__post_init__()
      • PaletteMetadata.has_metadata
  • color_tools.exporters.registry
    • register_exporter()
    • get_exporter()
    • list_export_formats()
    • get_export_formats_dict()
  • color_tools.exporters.ase_exporter
    • ASEExporter
      • ASEExporter.metadata
  • color_tools.exporters.autoforge_exporter
    • AutoForgeExporter
      • AutoForgeExporter.metadata
  • color_tools.exporters.css_exporter
    • CSSExporter
      • CSSExporter.metadata
  • color_tools.exporters.csv_exporter
    • CSVExporter
      • CSVExporter.COLOR_FIELDS
      • CSVExporter.metadata
  • color_tools.exporters.gpl_exporter
    • GPLExporter
      • GPLExporter.metadata
  • color_tools.exporters.hex_exporter
    • HexExporter
      • HexExporter.metadata
  • color_tools.exporters.jascpal_exporter
    • JascPalExporter
      • JascPalExporter.metadata
  • color_tools.exporters.json_exporter
    • JSONExporter
      • JSONExporter.metadata
  • color_tools.exporters.kpl_exporter
    • KPLExporter
      • KPLExporter.MIMETYPE
      • KPLExporter.FORMAT_VERSION
      • KPLExporter.DEFAULT_COLUMNS
      • KPLExporter.metadata
  • color_tools.exporters.lospec_exporter
    • LospecExporter
      • LospecExporter.metadata
  • color_tools.exporters.paintnet_exporter
    • PaintNetExportOptions
      • PaintNetExportOptions.pad_to_96
    • PaintNetExporter
      • PaintNetExporter.MAX_COLORS
      • PaintNetExporter.metadata
  • color_tools.exporters.palette_lut_exporter
    • PaletteLutExporter
      • PaletteLutExporter.metadata
  • color_tools.exporters.python_exporter
    • PythonExportOptions
      • PythonExportOptions.representation
      • PythonExportOptions.value_format
      • PythonExportOptions.normalized
      • PythonExportOptions.include_alpha
      • PythonExportOptions.include_metadata
      • PythonExportOptions.include_names_as_comments
      • PythonExportOptions.variable_name
      • PythonExportOptions.precision
      • PythonExportOptions.__post_init__()
    • PythonExporter
      • PythonExporter.metadata
  • color_tools.exporters.riffpal_exporter
    • RiffPalExporter
      • RiffPalExporter.PALETTE_VERSION
      • RiffPalExporter.metadata
  • color_tools.exporters.scribus_exporter
    • ScribusExporter
      • ScribusExporter.metadata
  • color_tools.exporters.sketchpalette_exporter
    • SketchPaletteExporter
      • SketchPaletteExporter.COMPATIBLE_VERSION
      • SketchPaletteExporter.PLUGIN_VERSION
      • SketchPaletteExporter.metadata
  • color_tools.exporters.soc_exporter
    • SOCExporter
      • SOCExporter.OFFICE_NS
      • SOCExporter.DRAW_NS
      • SOCExporter.XLINK_NS
      • SOCExporter.SVG_NS
      • SOCExporter.OOO_NS
      • SOCExporter.metadata
  • color_tools.exporters.swatch_image_exporter
    • SwatchImageOptions
      • SwatchImageOptions.show_index
      • SwatchImageOptions.show_hex
      • SwatchImageOptions.show_rgb
      • SwatchImageOptions.show_hsl
      • SwatchImageOptions.show_lab
      • SwatchImageOptions.show_lch
    • SwatchImageExporter
      • SwatchImageExporter.IMAGE_WIDTH
      • SwatchImageExporter.OUTER_MARGIN
      • SwatchImageExporter.HEADER_GAP
      • SwatchImageExporter.CARD_WIDTH
      • SwatchImageExporter.CARD_GAP
      • SwatchImageExporter.CARD_PADDING
      • SwatchImageExporter.CARD_RADIUS
      • SwatchImageExporter.SWATCH_HEIGHT
      • SwatchImageExporter.SWATCH_RADIUS
      • SwatchImageExporter.SWATCH_BORDER_WIDTH
      • SwatchImageExporter.TITLE_FONT_SIZE
      • SwatchImageExporter.DESCRIPTION_FONT_SIZE
      • SwatchImageExporter.NAME_FONT_SIZE
      • SwatchImageExporter.VALUE_FONT_SIZE
      • SwatchImageExporter.INDEX_FONT_SIZE
      • SwatchImageExporter.NAME_VALUE_GAP
      • SwatchImageExporter.VALUE_LINE_GAP
      • SwatchImageExporter.CARD_BOTTOM_PADDING
      • SwatchImageExporter.BACKGROUND
      • SwatchImageExporter.CARD_BACKGROUND
      • SwatchImageExporter.TEXT_PRIMARY
      • SwatchImageExporter.TEXT_SECONDARY
      • SwatchImageExporter.SWATCH_BORDER
      • SwatchImageExporter.INDEX_BACKGROUND
      • SwatchImageExporter.INDEX_TEXT
      • SwatchImageExporter.metadata
  • color_tools.importers
    • ImporterDependency
      • ImporterDependency.package
      • ImporterDependency.import_name
      • ImporterDependency.extra
    • ImporterMetadata
      • ImporterMetadata.name
      • ImporterMetadata.description
      • ImporterMetadata.file_extensions
      • ImporterMetadata.is_binary
      • ImporterMetadata.dependencies
      • ImporterMetadata.__post_init__()
    • MissingImporterDependencyError
    • PaletteImporter
      • PaletteImporter.metadata
      • PaletteImporter.missing_dependencies
      • PaletteImporter.is_available
      • PaletteImporter.import_palette()
      • PaletteImporter.can_import()
    • register_importer()
    • get_importer()
    • get_importers_for_extension()
    • detect_importer()
    • import_palette()
    • list_import_formats()
    • GPLImporter
      • GPLImporter.metadata
    • HexImporter
      • HexImporter.metadata
    • JascPalImporter
      • JascPalImporter.metadata
    • RiffPalImporter
      • RiffPalImporter.metadata
  • color_tools.importers.base
    • ImporterDependency
      • ImporterDependency.package
      • ImporterDependency.import_name
      • ImporterDependency.extra
    • ImporterMetadata
      • ImporterMetadata.name
      • ImporterMetadata.description
      • ImporterMetadata.file_extensions
      • ImporterMetadata.is_binary
      • ImporterMetadata.dependencies
      • ImporterMetadata.__post_init__()
    • MissingImporterDependencyError
    • PaletteImporter
      • PaletteImporter.metadata
      • PaletteImporter.missing_dependencies
      • PaletteImporter.is_available
      • PaletteImporter.import_palette()
      • PaletteImporter.can_import()
  • color_tools.importers.registry
    • register_importer()
    • get_importer()
    • list_import_formats()
    • get_importers_for_extension()
    • detect_importer()
    • import_palette()
  • color_tools.importers.gpl_importer
    • GPLImporter
      • GPLImporter.metadata
  • color_tools.importers.hex_importer
    • HexImporter
      • HexImporter.metadata
  • color_tools.importers.jascpal_importer
    • JascPalImporter
      • JascPalImporter.metadata
  • color_tools.importers.riffpal_importer
    • RiffPalImporter
      • RiffPalImporter.metadata
  • color_tools.image
    • Example:
    • SimplePNGWriter
      • SimplePNGWriter.save()
      • SimplePNGWriter.to_bytes()
    • ColorCluster
      • ColorCluster.centroid_rgb
      • ColorCluster.centroid_lab
      • ColorCluster.pixel_indices
      • ColorCluster.pixel_count
      • ColorCluster.__str__()
    • ColorChange
      • ColorChange.original_rgb
      • ColorChange.original_lch
      • ColorChange.new_rgb
      • ColorChange.new_lch
      • ColorChange.delta_e
      • ColorChange.hueforge_layer
      • ColorChange.__str__()
    • DominantColor
      • DominantColor.rgb
      • DominantColor.lab
      • DominantColor.population
      • DominantColor.dominance
      • DominantColor.global_salience
      • DominantColor.local_contrast
      • DominantColor.spatial_distribution
      • DominantColor.spatial_coherence
      • DominantColor.lightness_contrast
      • DominantColor.focal_importance
      • DominantColor.hex
    • DominanceAnalysis
      • DominanceAnalysis.colors
      • DominanceAnalysis.focal_center
      • DominanceAnalysis.focal_radius
      • DominanceAnalysis.neutral_pixel_fraction
      • DominanceAnalysis.neutral_cluster_fraction
      • DominanceAnalysis.population_weighted_mean_chroma
      • DominanceAnalysis.high_chroma_pixel_fraction
      • DominanceAnalysis.accent_chroma_separation
      • DominanceAnalysis.color_pop_strength
      • DominanceAnalysis.coarse_dimensions
      • DominanceAnalysis.saliency_map
      • DominanceAnalysis.diagnostics
    • extract_unique_colors()
    • extract_color_clusters()
    • quantize_image_hyab()
    • redistribute_luminance()
    • format_color_change_report()
    • l_value_to_hueforge_layer()
    • count_unique_colors()
    • get_color_histogram()
    • get_dominant_color()
    • is_indexed_mode()
    • analyze_brightness()
    • analyze_contrast()
    • analyze_noise_level()
    • analyze_dynamic_range()
    • analyze_dominant_colors()
    • dominant_colors()
    • dominant_colors_to_palette()
    • transform_image()
    • simulate_cvd_image()
    • correct_cvd_image()
    • quantize_image_to_palette()
    • add_text_watermark()
    • add_image_watermark()
    • add_svg_watermark()
    • convert_image()
    • get_supported_formats()
    • blend_images()
  • color_tools.image.analysis
    • ColorCluster
      • ColorCluster.centroid_rgb
      • ColorCluster.centroid_lab
      • ColorCluster.pixel_indices
      • ColorCluster.pixel_count
      • ColorCluster.__str__()
    • l_value_to_hueforge_layer()
    • ColorChange
      • ColorChange.original_rgb
      • ColorChange.original_lch
      • ColorChange.new_rgb
      • ColorChange.new_lch
      • ColorChange.delta_e
      • ColorChange.hueforge_layer
      • ColorChange.__str__()
    • extract_color_clusters()
    • extract_unique_colors()
    • quantize_image_hyab()
    • redistribute_luminance()
    • format_color_change_report()
  • color_tools.image.basic
    • Example:
    • count_unique_colors()
    • is_indexed_mode()
    • get_color_histogram()
    • get_dominant_color()
    • analyze_brightness()
    • analyze_contrast()
    • analyze_noise_level()
    • analyze_dynamic_range()
    • transform_image()
    • simulate_cvd_image()
    • correct_cvd_image()
    • quantize_image_to_palette()
  • color_tools.image.blend
    • Primary API:
    • Example:
    • normal()
    • dissolve()
    • darken()
    • multiply()
    • color_burn()
    • linear_burn()
    • darker_color()
    • lighten()
    • screen()
    • color_dodge()
    • linear_dodge()
    • lighter_color()
    • overlay()
    • soft_light()
    • hard_light()
    • vivid_light()
    • linear_light()
    • pin_light()
    • hard_mix()
    • difference()
    • exclusion()
    • subtract()
    • divide()
    • hue()
    • saturation()
    • color()
    • luminosity()
    • blend_images()
  • color_tools.image.conversion
    • convert_image()
    • get_supported_formats()
  • color_tools.image.dominance
    • DominantColor
      • DominantColor.rgb
      • DominantColor.lab
      • DominantColor.population
      • DominantColor.dominance
      • DominantColor.global_salience
      • DominantColor.local_contrast
      • DominantColor.spatial_distribution
      • DominantColor.spatial_coherence
      • DominantColor.lightness_contrast
      • DominantColor.focal_importance
      • DominantColor.hex
    • DominantColorDiagnostic
      • DominantColorDiagnostic.rgb
      • DominantColorDiagnostic.lab
      • DominantColorDiagnostic.population
      • DominantColorDiagnostic.population_score
      • DominantColorDiagnostic.coarse_support
      • DominantColorDiagnostic.coarse_support_mean
      • DominantColorDiagnostic.coarse_support_ratio
      • DominantColorDiagnostic.coarse_scale_persistence
      • DominantColorDiagnostic.structural_support
      • DominantColorDiagnostic.structural_penalty
      • DominantColorDiagnostic.global_salience
      • DominantColorDiagnostic.local_contrast
      • DominantColorDiagnostic.spatial_coherence
      • DominantColorDiagnostic.lightness_contrast
      • DominantColorDiagnostic.chroma
      • DominantColorDiagnostic.chromatic_prominence
      • DominantColorDiagnostic.neutrality
      • DominantColorDiagnostic.neutral_penalty
      • DominantColorDiagnostic.focal_saliency_share
      • DominantColorDiagnostic.mean_saliency
      • DominantColorDiagnostic.normalized_mean_saliency
      • DominantColorDiagnostic.focal_importance
      • DominantColorDiagnostic.base_dominance
      • DominantColorDiagnostic.dominance
      • DominantColorDiagnostic.selected_rank
      • DominantColorDiagnostic.selection_score
      • DominantColorDiagnostic.nearest_selected_distance
      • DominantColorDiagnostic.diversity_multiplier
      • DominantColorDiagnostic.hex
    • DominanceAnalysis
      • DominanceAnalysis.colors
      • DominanceAnalysis.focal_center
      • DominanceAnalysis.focal_radius
      • DominanceAnalysis.neutral_pixel_fraction
      • DominanceAnalysis.neutral_cluster_fraction
      • DominanceAnalysis.population_weighted_mean_chroma
      • DominanceAnalysis.high_chroma_pixel_fraction
      • DominanceAnalysis.accent_chroma_separation
      • DominanceAnalysis.color_pop_strength
      • DominanceAnalysis.coarse_dimensions
      • DominanceAnalysis.saliency_map
      • DominanceAnalysis.diagnostics
    • dominant_colors_to_palette()
    • analyze_dominant_colors()
    • format_dominance_diagnostics()
    • dominant_colors()
  • color_tools.image.watermark
    • Functions:
    • Example:
    • add_text_watermark()
    • add_image_watermark()
    • add_svg_watermark()
  • color_tools.cli
    • build_parser()
    • main()
  • color_tools.cli_commands
    • handle_name_command()
    • handle_validate_command()
    • handle_cvd_command()
    • handle_color_command()
    • handle_harmony_command()
    • handle_filament_command()
    • handle_convert_command()
    • handle_image_command()
    • validate_color_input_exclusivity()
    • get_rgb_from_args()
    • parse_hex_or_exit()
    • is_valid_lab()
    • is_valid_lch()
    • get_program_name()
    • show_override_report()
    • generate_user_hashes()
    • get_available_palettes()
    • handle_verification_flags()
  • color_tools.cli_commands.utils
    • validate_color_input_exclusivity()
    • get_rgb_from_args()
    • parse_hex_or_exit()
    • is_valid_lab()
    • is_valid_lch()
    • get_program_name()
  • color_tools.cli_commands.reporting
    • show_override_report()
    • generate_user_hashes()
    • get_available_palettes()
    • handle_verification_flags()
  • color_tools.cli_commands.handlers
    • handle_name_command()
    • handle_validate_command()
    • handle_cvd_command()
    • handle_color_command()
    • handle_harmony_command()
    • handle_filament_command()
    • handle_convert_command()
    • handle_image_command()
  • color_tools.cli_commands.handlers.color
    • handle_color_command()
  • color_tools.cli_commands.handlers.convert
    • handle_convert_command()
  • color_tools.cli_commands.handlers.cvd
    • handle_cvd_command()
  • color_tools.cli_commands.handlers.harmony
    • handle_harmony_command()
  • color_tools.cli_commands.handlers.filament
    • handle_filament_command()
  • color_tools.cli_commands.handlers.image
    • handle_image_command()
  • color_tools.cli_commands.handlers.name
    • handle_name_command()
  • color_tools.cli_commands.handlers.validate
    • handle_validate_command()
  • color_tools.logging_config
    • LOG_LEVEL
    • CONSOLE_LEVEL
    • setup_logging()
    • get_logger()
    • log_debug()
    • log_info()
    • log_warning()
    • log_error()
    • log_critical()
  • color_tools.interactive_manager
    • run_interactive_manager()
    • check_prompt_toolkit()
    • show_install_message()
  • color_tools.interactive_wizard
    • run_interactive_wizard()
    • check_prompt_toolkit()
    • show_install_message()
Color Tools
  • Search

© Copyright 2024-2026, David Terracino.

Built with Sphinx using a theme provided by Read the Docs.