Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix issues with TIFF docs example and render #2018

Merged
merged 1 commit into from
Dec 18, 2024
Merged

Fix issues with TIFF docs example and render #2018

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions Wrappers/Python/cil/io/TIFF.py
View file
Open in desktop
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
Loading