afmformats.afm_group

Classes

class afmformats.afm_group.AFMGroup(path=None, meta_override=None, callback=None, modality=None, data_classes_by_modality=None)[source]

Container for afmformats.afm_data.AFMData

Parameters:

  • path (str or pathlib.Path or None) – If this option is specified, then an AFMGroup is generated directly from a datafile.

  • meta_override (dict) – Dictionary with metadata that is used when loading the data in path.

  • callback (callable or None) – A method that accepts a float between 0 and 1 to externally track the process of loading the data.

  • data_classes_by_modality (dict) – Override the default AFMData class to use for managing the data (see default_data_classes_by_modality): This is e.g. used by index to pass Indentation (which is a subclass of the default AFMForceDistance) for handling “force-indentation” data.

Inheritance

digraph inheritance91b4f124fc { bgcolor=transparent; rankdir=LR; size="8.0, 12.0"; "AFMGroup" [URL="#afmformats.afm_group.AFMGroup",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Container for :class:`afmformats.afm_data.AFMData`"]; }
append(afmdata)[source]

Append an AFMData instance

Parameters:

afmdata (afmformats.afm_data.AFMData) – AFM data

get_enum(enum)[source]

Return the AFMData curve with this enum value

Raises:

  • ValueError if multiple curves with the same enum value exist. –

  • KeyError if the enum value is not found –

subgroup_with_path(path)[source]

Return a subgroup with AFMData matching path