data

Read or fetch test or example data.

DATA_DIR

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Module: data.fetcher

Fetcher based on dipy.

fetch_viz_cubemaps()	Download cube map textures for fury
fetch_viz_icons()	Download icons for fury
fetch_viz_new_icons()	Download the new icons for DrawPanel
fetch_viz_wiki_nw()	Download the following wiki informationInterdisciplinary map of the journals
fetch_viz_models()	Download the models for shader tutorial
fetch_viz_dmri()
fetch_viz_textures()	Download textures for fury
update_progressbar(progress, total_length)	Show progressbar.
copyfileobj_withprogress(fsrc, fdst, ...[, ...])
check_sha(filename, *[, stored_sha256])	Check the generated sha checksum.
fetch_data(files, folder, *[, data_size])	Download files to folder and checks their sha checksums.
fetch_gltf(*[, name, mode])	Download glTF samples from Khronos Group Github.
read_viz_cubemap(name, *[, suffix_type, ext])	Read specific cube map with specific suffix type and extension.
read_viz_icons(*[, style, fname])	Read specific icon from specific style.
read_viz_models(fname)	Read specific model.
read_viz_textures(fname)	Read specific texture.
read_viz_dmri(fname)	Read specific dMRI image.
read_viz_gltf(fname, *[, mode])	Read specific gltf sample.
list_gltf_sample_models()	Return all model name from the glTF-samples repository.

DATA_DIR

fury.data.DATA_DIR

str(object=’’) -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.__str__() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to ‘strict’.

fetch_viz_cubemaps

fury.data.fetcher.fetch_viz_cubemaps

Download cube map textures for fury

fetch_viz_icons

fury.data.fetcher.fetch_viz_icons

Download icons for fury

fetch_viz_new_icons

fury.data.fetcher.fetch_viz_new_icons

Download the new icons for DrawPanel

fetch_viz_wiki_nw

fury.data.fetcher.fetch_viz_wiki_nw

Download the following wiki informationInterdisciplinary map of the journals

fetch_viz_models

fury.data.fetcher.fetch_viz_models

Download the models for shader tutorial

fetch_viz_dmri

fury.data.fetcher.fetch_viz_dmri

fetch_viz_textures

fury.data.fetcher.fetch_viz_textures

Download textures for fury

update_progressbar

fury.data.fetcher.update_progressbar(progress, total_length)

Show progressbar.

Takes a number between 0 and 1 to indicate progress from 0 to 100%.

copyfileobj_withprogress

fury.data.fetcher.copyfileobj_withprogress(fsrc, fdst, total_length, *, length=16384)

check_sha

fury.data.fetcher.check_sha(filename, *, stored_sha256=None)

Check the generated sha checksum.

Parameters:

filenamestr

The path to the file whose checksum is to be compared

stored_sha256str, optional

Used to verify the generated SHA checksum. Default: None, checking is skipped

fetch_data

fury.data.fetcher.fetch_data(files, folder, *, data_size=None)

Download files to folder and checks their sha checksums.

Parameters:

filesdictionary

For each file in files the value should be (url, sha). The file will be downloaded from url if the file does not already exist or if the file exists but the sha checksum does not match.

folderstr

The directory where to save the file, the directory will be created if it does not already exist.

data_sizestr, optional

A string describing the size of the data (e.g. “91 MB”) to be logged to the screen. Default does not produce any information about data size.

Raises:

FetcherError

Raises if the sha checksum of the file does not match the expected value. The downloaded file is not deleted when this error is raised.

fetch_gltf

fury.data.fetcher.fetch_gltf(*, name=None, mode='glTF')

Download glTF samples from Khronos Group Github.

Parameters:

name: str, list, optional

Name of the glTF model (for e.g. Box, BoxTextured, FlightHelmet, etc) KhronosGroup/glTF-Sample-Models Default: None, Downloads essential glTF samples for tests.

mode: str, optional

Type of glTF format. You can choose from different options (e.g. glTF, glTF-Embedded, glTF-Binary, glTF-Draco) Default: glTF, .bin and texture files are stored separately.

Returns:

filenamestuple

tuple of feteched filenames (list) and folder (str) path.

read_viz_cubemap

fury.data.fetcher.read_viz_cubemap(name, *, suffix_type=1, ext='.jpg')

Read specific cube map with specific suffix type and extension.

Parameters:

namestr

suffix_typeint, optional

0 for numeric suffix (e.g., skybox_0.jpg, skybox_1.jpg, etc.), 1 for -p/nC encoding where C is either x, y or z (e.g., skybox-px.jpeg, skybox-ny.jpeg, etc.), 2 for pos/negC where C is either x, y, z (e.g., skybox_posx.png, skybox_negy.png, etc.), and 3 for position in the cube map (e.g., skybox_right.jpg, skybox_front.jpg, etc).

extstr, optional

Image type extension. (.jpg, .jpeg, .png, etc.).

Returns:

list of pathslist

List with the complete paths of the skybox textures.

read_viz_icons

fury.data.fetcher.read_viz_icons(*, style='icomoon', fname='infinity.png')

Read specific icon from specific style.

Parameters:

stylestr

Current icon style. Default is icomoon.

fnamestr

Filename of icon. This should be found in folder HOME/.fury/style/. Default is infinity.png.

Returns:

pathstr

Complete path of icon.

read_viz_models

fury.data.fetcher.read_viz_models(fname)

Read specific model.

Parameters:

fnamestr

Filename of the model. This should be found in folder HOME/.fury/models/.

Returns:

pathstr

Complete path of models.

read_viz_textures

fury.data.fetcher.read_viz_textures(fname)

Read specific texture.

Parameters:

fname: str

Filename of the texture. This should be found in folder HOME/.fury/textures/.

Returns:

pathstr

Complete path of textures.

read_viz_dmri

fury.data.fetcher.read_viz_dmri(fname)

Read specific dMRI image.

Parameters:

fname: str

Filename of the texture. This should be found in folder HOME/.fury/dmri/.

Returns:

pathstr

Complete path of dMRI image.

read_viz_gltf

fury.data.fetcher.read_viz_gltf(fname, *, mode='glTF')

Read specific gltf sample.

Parameters:

fnamestr

Name of the model. This should be found in folder HOME/.fury/models/glTF/.

modestr, optional

Model type (e.g. glTF-Binary, glTF-Embedded, etc) Default : glTF

Returns:

pathstr

Complete path of models.

list_gltf_sample_models

fury.data.fetcher.list_gltf_sample_models()

Return all model name from the glTF-samples repository.

Returns:

model_nameslist

Lists the name of glTF sample from KhronosGroup/glTF-Sample-Models