pyHarm.Substructures.SubDataReader.GenericReader¶

Classes¶

GenericReader

Generic read is the basic substructure reader in pyHarm. It can read '.mat', '.h5' files and complete the input dictionary as well as reading already completed input dictionary (containing all the matrices)

Module Contents¶

class pyHarm.Substructures.SubDataReader.GenericReader.GenericReader¶

Bases: pyHarm.Substructures.SubDataReader.ABCReader.ABCReader

Generic read is the basic substructure reader in pyHarm. It can read ‘.mat’, ‘.h5’ files and complete the input dictionary as well as reading already completed input dictionary (containing all the matrices)

factory_keyword¶

keyword to be called when instantiating the object through the factory.

Type:: str

factory_keyword = 'generic'¶: Factory keyword to be used when instantiating a reader

data_complete(data: dict) → dict¶

Reads and completes the input dictionary from the file.

Parameters:: data (dict) – input dictionary.
Returns:: Returns a completed version of the input data dictionary.
Return type:: dict

read_and_complete_matrix(data)¶

Reads and completes the ‘matrix’ input dictionary value from the input dictionary.

Parameters:: data (dict) – input dictionary.
Returns:: Returns a completed version of the input data dictionary.
Return type:: dict

read_mat_files(filename, data)¶

Reads and completes the ‘matrix’ input dictionary value from the input dictionary when a .mat file is required to be read.

Parameters:: data (dict) – input dictionary.
Returns:: Returns a completed version of the input data dictionary.
Return type:: dict

read_h5_files(filename, data)¶

Reads and completes the ‘matrix’ input dictionary value from the input dictionary when a .h5 file is required to be read.

Parameters:: data (dict) – input dictionary.
Returns:: Returns a completed version of the input data dictionary.
Return type:: dict