File Readers

This section provides detailed documentation for the available file readers in the hermes_rheo.file_readers module.

Note

This reader was designed to read .txt files generated via the “Export to LIMS” command in TRIOS.

TRIOS .txt Reader

class hermes_rheo.file_readers.trios_rheo_txt.TriosRheoReader[source]

Bases: FileReader

This class provides a reader for TA Rheometers files that have been exported as .txt format using the TRIOS export to LIMS functionality.

By default, both the independent and dependent variables are set to “Temperature.” This setting is chosen as temperature is the only rheological variable consistently present across the various measurements provided by TRIOS software. For users seeking to further analyze or manipulate the rheological measurements, the TriosRheoReader class is compatible with a range of transformations available through the hermes package (https://github.com/3mcloud/hermes-rheo).

DATA_HEADER_REGEX = '\\[step\\]'

X_VALUES_COLUMN_LABEL = 'Temperature'

Y_VALUES_COLUMN_LABEL = 'Temperature': The label for the x-values column.

Y_VALUES_COLUMN_LABELS = {'Amplitude sweep': {'1/temperature': '1/temperature', 'Angular frequency': 'angular frequency', 'Axial force': 'axial force', 'Complex compliance': 'complex compliance', 'Complex modulus': 'complex modulus', 'Complex viscosity': 'complex viscosity', 'Date and time': 'date and time', 'Dynamic viscosity': 'dynamic viscosity', 'Frequency': 'frequency', 'G*.sin(delta)': 'G*.sin(delta)', 'G*/sin(delta)': 'G*/sin(delta)', 'Gap': 'gap', 'Loss compliance': 'loss compliance', 'Loss modulus': 'loss modulus', 'Normal stress': 'normal stress', 'Normal stress coefficient': 'normal stress coefficient', 'Oscillation displacement': 'oscillation displacement', 'Oscillation strain': 'oscillation strain', 'Oscillation strain (cmd)': 'oscillation strain (cmd)', 'Oscillation strain rate': 'oscillation strain rate', 'Oscillation stress': 'oscillation stress', 'Oscillation stress (cmd)': 'oscillation stress (cmd)', 'Oscillation torque': 'oscillation torque', 'Oscillation torque (sample)': 'oscillation torque (sample)', 'Out of phase component of η*': 'out of phase component of η*', 'Phase angle': 'phase angle', 'Raw phase': 'raw phase', 'Run time': 'run time', 'Shear rate': 'shear rate', 'Step time': 'step time', 'Stiffness': 'stiffness', 'Storage compliance': 'storage compliance', 'Storage modulus': 'storage modulus', 'Strain constant': 'strain constant', 'Stress': 'stress', 'Stress (step)': 'stress (step)', 'Tan(delta)': 'tan(delta)', 'Temperature': 'temperature', 'Time': 'time', 'Torque': 'torque', 'Torque (step)': 'torque (step)', 'Velocity': 'velocity', 'Viscosity': 'viscosity'}, 'Arbitrary Wave': {'Compliance': 'compliance', 'Modulus': 'modulus', 'Normal stress': 'normal stress', 'Shear rate': 'shear rate', 'Step time': 'step time', 'Strain': 'strain', 'Strain (step)': 'strain (step)', 'Strain constant': 'strain constant', 'Stress': 'stress', 'Stress (step)': 'stress (step)', 'Temperature': 'temperature', 'Time': 'time', 'Torque': 'torque', 'Velocity': 'velocity', 'Viscosity': 'viscosity'}, 'Creep': {'Axial force': 'axial force', 'Compliance': 'compliance', 'Displacement': 'displacement', 'Gap': 'gap', 'Modulus': 'modulus', 'Shear rate': 'shear rate', 'Step time': 'step time', 'Strain': 'strain', 'Stress': 'stress', 'Temperature': 'temperature', 'Time': 'time', 'Velocity': 'velocity'}, 'Flow ramp': {'1/temperature': '1/temperature', 'Axial force': 'axial force', 'Compliance': 'compliance', 'Date and time': 'date and time', 'Displacement': 'displacement', 'Displacement (step)': 'displacement (step)', 'Gap': 'gap', 'Modulus': 'modulus', 'Normal stress': 'normal stress', 'Normal stress coefficient': 'normal stress coefficient', 'Run time': 'run time', 'Shear rate': 'shear rate', 'Step time': 'step time', 'Strain': 'strain', 'Strain (step)': 'strain (step)', 'Strain constant': 'strain constant', 'Stress': 'stress', 'Stress (step)': 'stress (step)', 'Temperature': 'temperature', 'Termination reason': 'termination reason', 'Time': 'time', 'Torque': 'torque', 'Torque (step)': 'torque (step)', 'Velocity': 'velocity', 'Viscosity': 'viscosity'}, 'Frequency DMA': {'1/temperature': '1/temperature', 'Angular frequency': 'angular frequency', 'Axial force': 'axial force', 'Complex compliance': 'complex compliance', 'Complex modulus': 'complex modulus', 'Date and time': 'date and time', 'Delta length': 'delta length', 'Drive Position': 'drive position', 'Frequency': 'frequency', 'Gap': 'gap', 'Loss compliance': 'loss compliance', 'Loss modulus': 'loss modulus', 'Normal transducer': 'normal transducer', 'Oscillation Force (Drive)': 'oscillation force (drive)', 'Oscillation displacement': 'oscillation displacement', 'Oscillation displacement (cmd)': 'oscillation displacement (cmd)', 'Oscillation displacement (drive': 'oscillation displacement (drive', 'Oscillation force': 'oscillation force', 'Oscillation normal force average': 'oscillation normal force average', 'Oscillation strain': 'oscillation strain', 'Oscillation strain (cmd)': 'oscillation strain (cmd)', 'Oscillation stress': 'oscillation stress', 'Phase angle': 'phase angle', 'Pretension ratio': 'pretension ratio', 'Raw phase (displacement)': 'raw phase (displacement)', 'Run time': 'run time', 'Status bits': 'status bits', 'Status bits 2': 'status bits 2', 'Step time': 'step time', 'Stiffness': 'stiffness', 'Storage compliance': 'storage compliance', 'Storage modulus': 'storage modulus', 'Strain constant (linear)': 'strain constant (linear)', 'Strain ratio': 'strain ratio', 'Tan(delta)': 'tan(delta)', 'Temperature': 'temperature', 'Time': 'time', 'Transducer range': 'transducer range', 'X-ducer Displacement': 'x-ducer displacement', 'X-ducer stiffness': 'x-ducer stiffness'}, 'Frequency sweep': {'Angular frequency': 'angular frequency', 'Complex compliance': 'complex compliance', 'Complex modulus': 'complex modulus', 'Complex viscosity': 'complex viscosity', 'Dynamic viscosity': 'dynamic viscosity', 'Frequency': 'frequency', 'Loss compliance': 'loss compliance', 'Loss modulus': 'loss modulus', 'Oscillation displacement': 'oscillation displacement', 'Oscillation strain': 'oscillation strain', 'Oscillation strain rate': 'oscillation strain rate', 'Oscillation stress': 'oscillation stress', 'Phase angle': 'phase angle', 'Shear rate': 'shear rate', 'Step time': 'step time', 'Storage compliance': 'storage compliance', 'Storage modulus': 'storage modulus', 'Strain constant': 'strain constant', 'Strain ratio': 'strain ratio', 'Stress': 'stress', 'Stress (step)': 'stress (step)', 'Tan(delta)': 'tan(delta)', 'Temperature': 'temperature', 'Time': 'time', 'Torque': 'torque', 'Velocity': 'velocity', 'Viscosity': 'viscosity'}, 'Master Curve - master curve': {'1/temperature': '1/temperature', 'Angular frequency': 'angular frequency', 'Complex compliance': 'complex compliance', 'Complex modulus': 'complex modulus', 'Complex viscosity': 'complex viscosity', 'Dynamic viscosity': 'dynamic viscosity', 'Frequency': 'frequency', 'G*.sin(delta)': 'G*.sin(delta)', 'G*/sin(delta)': 'G*/sin(delta)', 'Loss compliance': 'loss compliance', 'Loss modulus': 'loss modulus', 'Out of phase component of η*': 'out of phase component of η*', 'Phase angle': 'phase angle', 'Storage compliance': 'storage compliance', 'Storage modulus': 'storage modulus', 'Tan(delta)': 'tan(delta)'}, 'Master Curve - shift factors': {'1/temperature': '1/temperature', 'Temperature': 'temperature', 'aT (x variable)': 'aT', 'bT (y variables)': 'bT', 'bT base': 'bt base', 'bT delta': 'bT delta', 'sample density': 'density'}, 'Multiwave': {'Angular frequency': 'angular frequency', 'Complex compliance': 'complex compliance', 'Complex modulus': 'complex modulus', 'Complex viscosity': 'complex viscosity', 'Dynamic viscosity': 'dynamic viscosity', 'Frequency': 'frequency', 'Loss compliance': 'loss compliance', 'Loss modulus': 'Loss modulus', 'Oscillation strain': 'oscillation strain', 'Oscillation strain rate': 'Oscillation strain rate', 'Oscillation stress': 'oscillation stress', 'Shear rate': 'shear rate', 'Step time': 'step time', 'Stiffness': 'stiffness', 'Storage modulus': 'storage modulus', 'Strain': 'strain', 'Strain ratio': 'strain ratio', 'Stress': 'stress', 'Stress (step)': 'stress (step)', 'Tan(delta)': 'tan(delta)', 'Temperature': 'temperature', 'Time': 'time', 'Torque': 'torque', 'Velocity': 'velocity'}, 'Recovery': {'1/temperature': '1/temperature', 'Date and time': 'data and time', 'Delta length': 'drive length', 'Displacement': 'displacement', 'Displacement(step)': 'displacement (step)', 'Drive Position': 'drive position', 'Force': 'force', 'Modulus': 'modulus', 'Normal transducer': 'normal transducer', 'Position': 'position', 'Recoverable compliance': 'recoverable compliance', 'Recoverable strain': 'recoverable strain', 'Recovered Strain': 'recovered strain', 'Relative Stress': 'relative stress', 'Run time': 'run time', 'Status bits': 'status bits', 'Step time': 'step time', 'Strain': 'strain', 'Strain (step)': 'strain (step)', 'Strain constant (linear)': 'strain constant (linear)', 'Stress': 'stress', 'Temperature': 'temperature', 'Temperature set point': 'temperature set point', 'Thickness': 'thickness', 'Time': 'time', 'Total Displacement': 'total displacement', 'Total Force': 'total force', 'Total Stress': 'total stress', 'Variables': 'variables', 'Velocity': 'velocity'}, 'Stress Relaxation': {'Compliance': 'compliance', 'Modulus': 'modulus', 'Step time': 'step time', 'Strain': 'strain', 'Strain (step)': 'strain (step)', 'Strain constant (linear)': 'strain constant (linear)', 'Stress': 'stress', 'Temperature': 'temperature', 'Time': 'time', 'Velocity': 'velocity'}, 'Temperature ramp': {'Angular frequency': 'angular frequency', 'Complex compliance': 'complex compliance', 'Complex modulus': 'complex modulus', 'Complex viscosity': 'complex viscosity', 'Dynamic viscosity': 'dynamic viscosity', 'Frequency': 'frequency', 'Loss compliance': 'loss compliance', 'Loss modulus': 'loss modulus', 'Oscillation displacement': 'oscillation displacement', 'Oscillation strain': 'oscillation strain', 'Oscillation strain rate': 'oscillation strain rate', 'Oscillation stress': 'oscillation stress', 'Phase angle': 'phase angle', 'Shear rate': 'shear rate', 'Step time': 'step time', 'Storage compliance': 'storage compliance', 'Storage modulus': 'storage modulus', 'Strain constant': 'strain constant', 'Strain ratio': 'strain ratio', 'Stress': 'stress', 'Stress (step)': 'stress (step)', 'Tan(delta)': 'tan(delta)', 'Temperature': 'temperature', 'Time': 'time', 'Torque': 'torque', 'Velocity': 'velocity', 'Viscosity': 'viscosity'}, 'Temperature ramp ISO Force': {'Axial force': 'axial force', 'Compliance': 'compliance', 'Gap': 'gap', 'Modulus': 'modulus', 'Normal stress': 'normal stress', 'Run time': 'run time', 'Step time': 'step time', 'Strain': 'strain', 'Strain constant': 'strain constant', 'Stress': 'stress', 'Temperature': 'temperature', 'Time': 'time'}, 'Temperature sweep': {'1/temperature': '1/temperature', 'Angular frequency': 'angular frequency', 'Axial displacement': 'axial displacement', 'Axial force': 'axial force', 'Axial strain': 'axial strain', 'Axial strain %': 'axial strain %', 'Complex compliance': 'complex compliance', 'Complex modulus': 'complex modulus', 'Date and time': 'date and time', 'Frequency': 'frequency', 'Gap': 'gap', 'Loss compliance': 'loss compliance', 'Loss modulus': 'loss modulus', 'Oscillation displacement': 'oscillation displacement', 'Oscillation force': 'oscillation force', 'Oscillation strain': 'oscillation strain', 'Oscillation stress': 'oscillation stress', 'Phase angle': 'phase angle', 'Raw phase': 'raw phase', 'Run time': 'run time', 'Step time': 'step time', 'Storage compliance': 'storage compliance', 'Storage modulus': 'storage modulus', 'Strain': 'strain', 'Strain (step)': 'strain (step)', 'Strain constant (linear)': 'strain constant (linear)', 'Tan(delta)': 'tan(delta)', 'Temperature': 'temperature', 'Time': 'time'}}: The comprehensive sets of traces present in each of the types of supported file.

data_from_filepath(filepath: str, **read_kwargs) → MeasurementSet[source]

Convert the file at the given path into appropriate measurement(s).

Parameters:: filepath (str) – The path to the file to convert to a measurement set.
Returns:: The set of measurements in the file.
Return type:: piblin.data.data_collections.measurement_set.MeasurementSet

property default_mode: str: The default mode in which to read the file.

property encoding: str: The default encoding to use to read the file.

supported_extensions: ClassVar[Set[str]] = {'txt'}