sparclur.utils package

Module contents

exception sparclur.utils._tools.InputError(message)

Bases: Exception

Exception raised for errors in the input.

message -- explanation of the error

sparclur.utils._tools.ahash_sim(pil1, pil2, hash_size=128)

sparclur.utils._tools.ccoeff_sim(pil1, pil2)

sparclur.utils._tools.ccorr_sim(pil1, pil2)

sparclur.utils._tools.create_file_list(files, recurse=False, base_path=None, extension=None)

sparclur.utils._tools.dhash_sim(pil1, pil2, hash_size=128)

sparclur.utils._tools.display_raw(file)

sparclur.utils._tools.entropy(a)

sparclur.utils._tools.entropy_sim(a, b)

sparclur.utils._tools.fix_splits(message)

sparclur.utils._tools.gen_flatten(iterables)

sparclur.utils._tools.get_num_pages(doc_path, verbose=False)

sparclur.utils._tools.hash_file(file)

sparclur.utils._tools.if_dir_not_exists(directory)

sparclur.utils._tools.image_compare(p1: PIL.PngImagePlugin.PngImageFile, p2: PIL.PngImagePlugin.PngImageFile, full: bool = False) → sparclur._prc_sim.PRCSim

Function to compute the structural similarity of two pngs.

Parameters

• p1 (PngImageFile or array_like) –

• p2 (PngImageFile or array_like) –

• full (bool) – Flag that indicates the difference of the comparison should be returned

Return type

PRCSim

sparclur.utils._tools.image_highlight(p1: PIL.PngImagePlugin.PngImageFile, p2: PIL.PngImagePlugin.PngImageFile, min_region: int = 40, prc: typing.Optional[sparclur._prc_sim.PRCSim] = None, info_loss: float = 1.0, display: bool = True, display_height: int = 10, display_width: int = 10, renderer: str = '', left_file: str = '', left_label: str = '', right_file: str = '', right_label: str = '', save_display: typing.Optional[str] = None, verbose: bool = True) -> (<class 'PIL.PngImagePlugin.PngImageFile'>, <class 'PIL.PngImagePlugin.PngImageFile'>)

sparclur.utils._tools.is_pdf(file)

sparclur.utils._tools.jac_dist(set1, set2)

sparclur.utils._tools.jac_sim(set1, set2)

sparclur.utils._tools.lev_dist(s1, s2)

sparclur.utils._tools.orientation_sim(pil1, pil2)

sparclur.utils._tools.pad_images(pil1, pil2)

sparclur.utils._tools.phash_sim(pil1, pil2, hash_size=128)

sparclur.utils._tools.pil_to_hex_array(pil)

sparclur.utils._tools.scrape_pdfs(base_dir, extension=None)

sparclur.utils._tools.shingler(s, shingle_size)

sparclur.utils._tools.size_sim(pil1, pil2)

sparclur.utils._tools.stringify_dict(d)

sparclur.utils._tools.sum_square_sim(pil1, pil2)

sparclur.utils._tools.whash_sim(pil1, pil2, hash_size=128)