io#

BMPReader

alias of vtkBMPReader

BMPWriter

alias of vtkBMPWriter

ImageData

alias of vtkImageData

ImageFlip

alias of vtkImageFlip

InTemporaryDirectory

alias of TemporaryDirectory

JPEGReader

alias of vtkJPEGReader

JPEGWriter

alias of vtkJPEGWriter

MNIObjectReader

alias of vtkMNIObjectReader

MNIObjectWriter

alias of vtkMNIObjectWriter

OBJReader

alias of vtkOBJReader

PLYReader

alias of vtkPLYReader

PLYWriter

alias of vtkPLYWriter

PNGReader

alias of vtkPNGReader

PNGWriter

alias of vtkPNGWriter

PolyDataReader

alias of vtkPolyDataReader

PolyDataWriter

alias of vtkPolyDataWriter

STLReader

alias of vtkSTLReader

STLWriter

alias of vtkSTLWriter

TIFFReader

alias of vtkTIFFReader

TIFFWriter

alias of vtkTIFFWriter

Texture

alias of vtkTexture

XMLPolyDataReader

alias of vtkXMLPolyDataReader

XMLPolyDataWriter

alias of vtkXMLPolyDataWriter

load_cubemap_texture(fnames[, ...])

Load a cube map texture from a list of 6 images.

load_image(filename[, as_vtktype, use_pillow])

Load an image.

load_polydata(file_name)

Load a vtk polydata to a supported format file.

load_sprite_sheet(sheet_path, nb_rows, nb_cols)

Process and load sprites from a sprite sheet.

load_text(file)

Load a text file.

save_image(arr, filename[, ...])

Save a 2d or 3d image.

save_polydata(polydata, file_name[, binary, ...])

Save a vtk polydata to a supported format file.

set_input(vtk_object, inp)

Set Generic input function which takes into account VTK 5 or 6.

urlretrieve(url[, filename, reporthook, data])

Retrieve a URL into a temporary location on disk.

BMPReader#

fury.io.BMPReader#

alias of vtkBMPReader

BMPWriter#

fury.io.BMPWriter#

alias of vtkBMPWriter

ImageData#

fury.io.ImageData#

alias of vtkImageData

ImageFlip#

fury.io.ImageFlip#

alias of vtkImageFlip

InTemporaryDirectory#

fury.io.InTemporaryDirectory#

alias of TemporaryDirectory

JPEGReader#

fury.io.JPEGReader#

alias of vtkJPEGReader

JPEGWriter#

fury.io.JPEGWriter#

alias of vtkJPEGWriter

MNIObjectReader#

fury.io.MNIObjectReader#

alias of vtkMNIObjectReader

MNIObjectWriter#

fury.io.MNIObjectWriter#

alias of vtkMNIObjectWriter

OBJReader#

fury.io.OBJReader#

alias of vtkOBJReader

PLYReader#

fury.io.PLYReader#

alias of vtkPLYReader

PLYWriter#

fury.io.PLYWriter#

alias of vtkPLYWriter

PNGReader#

fury.io.PNGReader#

alias of vtkPNGReader

PNGWriter#

fury.io.PNGWriter#

alias of vtkPNGWriter

PolyDataReader#

fury.io.PolyDataReader#

alias of vtkPolyDataReader

PolyDataWriter#

fury.io.PolyDataWriter#

alias of vtkPolyDataWriter

STLReader#

fury.io.STLReader#

alias of vtkSTLReader

STLWriter#

fury.io.STLWriter#

alias of vtkSTLWriter

TIFFReader#

fury.io.TIFFReader#

alias of vtkTIFFReader

TIFFWriter#

fury.io.TIFFWriter#

alias of vtkTIFFWriter

Texture#

fury.io.Texture#

alias of vtkTexture

XMLPolyDataReader#

fury.io.XMLPolyDataReader#

alias of vtkXMLPolyDataReader

XMLPolyDataWriter#

fury.io.XMLPolyDataWriter#

alias of vtkXMLPolyDataWriter

load_cubemap_texture#

fury.io.load_cubemap_texture(fnames, interpolate_on=True, mipmap_on=True)[source]#

Load a cube map texture from a list of 6 images.

Parameters:
  • fnames (list of strings) – List of 6 filenames with bmp, jpg, jpeg, png, tif or tiff extensions.

  • interpolate_on (bool, optional) –

  • mipmap_on (bool, optional) –

Returns:

output – Cube map texture.

Return type:

vtkTexture

load_image#

fury.io.load_image(filename, as_vtktype=False, use_pillow=True)[source]#

Load an image.

Parameters:
  • filename (str) – should be png, bmp, jpeg or jpg files

  • as_vtktype (bool, optional) – if True, return vtk output otherwise an ndarray. Default False.

  • use_pillow (bool, optional) – Use pillow python library to load the files. Default True

Returns:

image – desired image array

Return type:

ndarray or vtk output

load_polydata#

fury.io.load_polydata(file_name)[source]#

Load a vtk polydata to a supported format file.

Supported file formats are VTK, VTP, FIB, PLY, STL XML and OBJ

Parameters:

file_name (string) –

Returns:

output

Return type:

vtkPolyData

load_sprite_sheet#

fury.io.load_sprite_sheet(sheet_path, nb_rows, nb_cols, as_vtktype=False)[source]#

Process and load sprites from a sprite sheet.

Parameters:
  • sheet_path (str) – Path to the sprite sheet

  • nb_rows (int) – Number of rows in the sprite sheet

  • nb_cols (int) – Number of columns in the sprite sheet

  • as_vtktype (bool, optional) – If True, the output is a vtkImageData

Return type:

Dict containing the processed sprites.

load_text#

fury.io.load_text(file)[source]#

Load a text file.

Parameters:

file (str) – Path to the text file.

Returns:

text – Text contained in the file.

Return type:

str

save_image#

fury.io.save_image(arr, filename, compression_quality=75, compression_type='deflation', use_pillow=True, dpi=(72, 72))[source]#

Save a 2d or 3d image.

Expect an image with the following shape: (H, W) or (H, W, 1) or (H, W, 3) or (H, W, 4).

Parameters:
  • arr (ndarray) – array to save

  • filename (string) – should be png, bmp, jpeg or jpg files

  • compression_quality (int, optional) – compression_quality for jpeg data. 0 = Low quality, 100 = High quality

  • compression_type (str, optional) – compression type for tiff file select between: None, lzw, deflation (default)

  • use_pillow (bool, optional) – Use imageio python library to save the files.

  • dpi (float or (float, float)) – Dots per inch (dpi) for saved image. Single values are applied as dpi for both dimensions.

save_polydata#

fury.io.save_polydata(polydata, file_name, binary=False, color_array_name=None)[source]#

Save a vtk polydata to a supported format file.

Save formats can be VTK, FIB, PLY, STL and XML.

Parameters:
  • polydata (vtkPolyData) –

  • file_name (string) –

  • binary (bool) –

  • color_array_name (ndarray) –

set_input#

fury.io.set_input(vtk_object, inp)[source]#

Set Generic input function which takes into account VTK 5 or 6.

Parameters:
  • vtk_object (vtk object) –

  • inp (vtkPolyData or vtkImageData or vtkAlgorithmOutput) –

Return type:

vtk_object

Notes

This can be used in the following way::

from fury.utils import set_input poly_mapper = set_input(PolyDataMapper(), poly_data)

urlretrieve#

fury.io.urlretrieve(url, filename=None, reporthook=None, data=None)[source]#

Retrieve a URL into a temporary location on disk.

Requires a URL argument. If a filename is passed, it is used as the temporary file location. The reporthook argument should be a callable that accepts a block number, a read size, and the total file size of the URL target. The data argument should be valid URL encoded data.

If a filename is passed and the URL points to a local resource, the result is a copy from local file to new file.

Returns a tuple containing the path to the newly created data file as well as the resulting HTTPMessage object.