SortHistogram

class tools.sort.sort_methods.SortHistogram(arguments: Namespace, is_group: bool = False)

Bases: SortMethod

Sort by image histogram similarity or dissimilarity

Parameters:
  • arguments (Namespace) – The command line arguments passed to the sort process

  • is_group (bool) – Set to True if this class is going to be called exclusively for binning. Default: False

Attributes Summary

bin_names

The name of each created bin, if they exist, otherwise an empty list

binned

List of bins (list) containing the filenames belonging to the bin.

loader_type

The loader that this sorter uses

sorted_filelist

List of sorted filenames for given sorter in a single list.

Methods Summary

binning()

Group into bins by histogram

score_image(filename, image, alignments)

Collect the histogram for the given face

sort()

Sort by histogram.

Attributes Documentation

bin_names

The name of each created bin, if they exist, otherwise an empty list

binned

List of bins (list) containing the filenames belonging to the bin. The binning process is called when this property is first accessed

loader_type

The loader that this sorter uses

Type:

[“face”, “meta”, “all”]

sorted_filelist

List of sorted filenames for given sorter in a single list. The sort process is called when this property is first accessed

Methods Documentation

binning() list[list[str]]

Group into bins by histogram

Return type:

list[list[str]]

score_image(filename: str, image: np.ndarray | None, alignments: PNGAlignments | None) None

Collect the histogram for the given face

Parameters:
  • filename (str) – The filename of the currently processing image

  • image (np.ndarray | None) – A face image loaded from disk

  • alignments (PNGAlignments | None) – The alignments dictionary for the aligned face or None

Return type:

None

sort() None

Sort by histogram.

Return type:

None

binning() list[list[str]]

Group into bins by histogram

Return type:

list[list[str]]

score_image(filename: str, image: np.ndarray | None, alignments: PNGAlignments | None) None

Collect the histogram for the given face

Parameters:
  • filename (str) – The filename of the currently processing image

  • image (np.ndarray | None) – A face image loaded from disk

  • alignments (PNGAlignments | None) – The alignments dictionary for the aligned face or None

Return type:

None

sort() None

Sort by histogram.

Return type:

None