dir_content_diff.comparators.morphio

Extension module to process morphology files with MorphIO and morph-tool.

Functions

register([force])

Register morphology file extensions.

Classes

MorphologyComparator([default_load_kwargs, ...])

Comparator for morphology files.

class dir_content_diff.comparators.morphio.MorphologyComparator(default_load_kwargs=None, default_format_data_kwargs=None, default_diff_kwargs=None, default_filter_kwargs=None, default_format_diff_kwargs=None, default_sort_kwargs=None, default_concat_kwargs=None, default_report_kwargs=None, default_save_kwargs=None)

Bases: BaseComparator

Comparator for morphology files.

diff(ref, comp, *args, **kwargs)

Compare data from two morphology files.

Parameters:
  • ref_path (str) – The path to the reference morphology file.

  • comp_path (str) – The path to the compared morphology file.

  • *args – See morph_tool.diff() for details.

  • **kwargs – See morph_tool.diff() for details.

Returns:

False if the morphologies are considered as equal or a list of strings explaining why they are not considered as equal.

Return type:

bool or list(str)

load(path, **kwargs)

Load a morphology file into a morphio.Morphology object.

dir_content_diff.comparators.morphio.register(force=False)

Register morphology file extensions.