Skip to content

Commit

Permalink
Fix issues with TIFF docs
Browse files Browse the repository at this point in the history
  • Loading branch information
lauramurgatroyd committed Dec 18, 2024
1 parent a47cb15 commit 7786936
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions Wrappers/Python/cil/io/TIFF.py
Original file line number Diff line number Diff line change
Expand Up @@ -191,7 +191,7 @@ class TIFFStackReader(object):

'''
Basic TIFF reader which loops through all tiff files in a specific
folder and loads them in alphabetic order
folder and loads them in alphabetical order
Parameters
----------
Expand All @@ -202,8 +202,8 @@ class TIFFStackReader(object):
roi : dictionary, default `None`
dictionary with roi to load:
``{'axis_0': (start, end, step),
'axis_1': (start, end, step),
'axis_2': (start, end, step)}``
'axis_1': (start, end, step),
'axis_2': (start, end, step)}``
roi is specified for axes before transpose.
transpose : bool, default False
Expand Down Expand Up @@ -256,8 +256,8 @@ class TIFFStackReader(object):
Alternatively, if TIFFWriter has been used to save data with lossy compression, then you can rescale the
read data to approximately the original data with the following code:
>>> writer = TIFFWriter(file_name = '/path/to/folder', compression='uint8')
>>> writer.write(original_data)
>>> writer = TIFFWriter(file_name = '/path/to/folder', data=original_data, compression='uint8')
>>> writer.write()
>>> reader = TIFFStackReader(file_name = '/path/to/folder')
>>> about_original_data = reader.read_rescaled()
'''
Expand Down

0 comments on commit 7786936

Please sign in to comment.