Skip to content
Snippets Groups Projects
Commit 9f10aff0 authored by Federico Montesino Pouzols's avatar Federico Montesino Pouzols
Browse files

clarify text, link WorkspaceGroup and fix ws in test, re #10965

parent 5ebb5471
No related branches found
No related tags found
No related merge requests found
......@@ -9,16 +9,16 @@
Description
-----------
Load FITS files, which typically contain images, into workspaces. FITS
stands for Flexible Image Transport System, see
http://en.wikipedia.org/wiki/FITS. A new workspace (of type
:ref:`Workspace2D <Workspace2D>`) is created for every FITS file
loaded with this algorithm, and these workspaces are added into a
group workspace. The group workspace is named as indicated in the
OutputWorkspace input property. The workspaces included in the group
are named with the same name and an appendix _1, _2, etc., incremented
sequentially as new files are loaded with the same OutputWorkspace
property.
Load FITS files, which typically contain images, into a
:ref:`WorkspaceGroup <WorkspaceGroup>`. FITS stands for Flexible Image
Transport System, see http://en.wikipedia.org/wiki/FITS. A new
workspace (of type :ref:`Workspace2D <Workspace2D>`) is created for
every FITS file loaded with this algorithm, and these workspaces are
added into a :ref:`WorkspaceGroup <WorkspaceGroup>`. The group
workspace is named as indicated in the OutputWorkspace input
property. The workspaces included in the group are named with the same
name and an appendix _1, _2, etc., incremented sequentially as new
files are loaded with the same OutputWorkspace property.
The current implementation of this algorithm only supports 2D files
(FITS images with two axes), and it should in principle be able to
......@@ -58,7 +58,8 @@ Usage
.. testcode:: LoadFITS
ws_name = 'FITSws'
ws = LoadFITS(Filename='FITS_small_01.fits', OutputWorkspace=ws_name)
wsg = LoadFITS(Filename='FITS_small_01.fits', OutputWorkspace=ws_name)
ws = wsg.getItem(0)
# A couple of standard FITS header entries
bpp_log = 'BITPIX'
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment