defdap.file_readers module

class defdap.file_readers.EBSDDataLoader

Bases: ABC

Class containing methods for loading and checking EBSD data

static get_loader(data_type, file_name)

Return type:

Type[EBSDDataLoader]

check_metadata()

Checks that the number of phases from metadata matches the amount of phases loaded.

Return type:

None

check_data()

Return type:

None

abstract load(file_name)

Return type:

None

class defdap.file_readers.OxfordTextLoader

Bases: EBSDDataLoader

load(file_name)

Read an Oxford Instruments .ctf file, which is a HKL single orientation file.

Parameters:

file_name (Path) – Path to file

Return type:

None

class defdap.file_readers.EdaxAngLoader

Bases: EBSDDataLoader

load(file_name)

Read an EDAX .ang file.

Parameters:

file_name (Path) – Path to file

Return type:

None

static parse_phase(lines)

Return type:

Phase

class defdap.file_readers.OxfordBinaryLoader

Bases: EBSDDataLoader

load(file_name)

Read Oxford Instruments .cpr/.crc file pair.

Parameters:

file_name (Path) – Path to file

Return type:

None

load_oxford_cpr(file_name)

Read an Oxford Instruments .cpr file, which is a metadata file describing EBSD data.

Parameters:

file_name (Path) – Path to file

Return type:

None

load_oxford_crc(file_name)

Read binary EBSD data from an Oxford Instruments .crc file

Parameters:

file_name (Path) – Path to file

Return type:

None

class defdap.file_readers.PythonDictLoader

Bases: EBSDDataLoader

load(data_dict)

Construct EBSD data from a python dictionary.

Parameters:

data_dict (Dict[str, Any]) –

Dictionary with keys:

’step_size’ ‘phases’ ‘phase’ ‘euler_angle’ ‘band_contrast’

Return type:

None

class defdap.file_readers.DICDataLoader(file_type='')

Bases: ABC

Class containing methods for loading and checking HRDIC data

static get_loader(data_type)

Return type:

Type[DICDataLoader]

checkMetadata()

Return type:

None

check_data()

Calculate size of map from loaded data and check it matches values from metadata.

Return type:

None

abstract load(file_name)

Return type:

None

class defdap.file_readers.DavisLoader(file_type='')

Bases: DICDataLoader

load(file_name)

Load from Davis .txt file.

Parameters:

file_name (Path) – Path to file

Return type:

None

static load_davis_image_data(file_name)

A .txt file from DaVis containing a 2D image

Parameters:

file_name (Path) – Path to file

Returns:

Array of data.

Return type:

np.ndarray

class defdap.file_readers.OpenPivTextLoader(file_type='')

Bases: DICDataLoader

load(file_name)

Load from Open PIV .txt file.

Parameters:

file_name (Path) – Path to file

Return type:

None

class defdap.file_readers.OpenPivBinaryLoader(file_type='')

Bases: DICDataLoader

load(file_name)

Load from Open PIV .npz file.

Parameters:

file_name (Path) – Path to file

Return type:

None

class defdap.file_readers.PyValeLoader(file_type='')

Bases: DICDataLoader

load(file_name)

Load from PyVale csv or binary file.

Parameters:

file_name (Path) – Path to file

Return type:

None

class defdap.file_readers.MatflowLoader(file_type='')

Bases: DICDataLoader

load(data_dict, step_index=0)

Load from matflow workflow element output.

Parameters:

data_dict (Dict[str, Any]) –

Dictionary with keys:

’ss_x’ ‘ss_y’ ‘u’ ‘v’

Return type:

None

defdap.file_readers.read_until_string(file, term_string, comment_char='*', line_process=None, exact=False)

Read lines in a file until a line starting with the termString is encountered. The file position is returned before the line starting with the termString when found. Comment and empty lines are ignored.

Parameters:

• file (TextIO) – An open python text file object.

• term_string (str) – String to terminate reading.

• comment_char (str) – Character at start of a comment line to ignore.

• line_process (Optional[Callable[[str], Any], None]) – Function to apply to each line when loaded.

• exact (bool) – A line must exactly match termString to stop.

Returns:

List of processed lines loaded from file.

Return type:

list