brainglobe
Search…
API documentation

Add remote atlas fetching and version comparison functionalities
to the core Atlas class.
Parameters
----------
atlas_name : str
Name of the atlas to be used.
brainglobe_dir : str or Path object
Default folder for brainglobe downloads.
interm_download_dir : str or Path object
Folder to download the compressed file for extraction.
check_latest : bool (optional)
If true, check if we have the most recent atlas (default=True). Set
this to False to avoid waiting for remote server response on atlas
instantiation and to suppress warnings.
print_authors : bool (optional)
If true, disable default listing of the atlas reference.

Check the source code online
def __init__(self, atlas_name, brainglobe_dir=None,
interm_download_dir=None, check_latest=True, print_authors=True):
  docstring:
no docstring

Check the source code online
def local_version(self):
  docstring:
If atlas is local, return actual version of the downloaded files;
Else, return none.

Check the source code online
def remote_version(self):
  docstring:
Remote version read from GIN conf file. If we are offline, return
None.

Check the source code online
def local_full_name(self):
  docstring:
As we can't know the local version a priori, search candidate dirs
using name and not version number. If none is found, return None.

Check the source code online
def remote_url(self):
  docstring:
Format complete url for download.

Check the source code online
def download_extract_file(self):
  docstring:
Download and extract atlas from remote url.

Check the source code online
def check_latest_version(self):
  docstring:
Checks if the local version is the latest available
and prompts the user to update if not.

Check the source code online
def __repr__(self):
  docstring:
Fancy print for the atlas providing authors information.

Check the source code online
def _version_tuple_from_str(version_str):
  docstring:
no docstring

Check the source code online
def _version_str_from_tuple(version_tuple):
  docstring:
no docstring
Copy link
On this page
Contents
BrainGlobeAtlas
__init__ [#45]
local_version [#87]
remote_version [#99]
local_full_name [#119]
remote_url [#139]
download_extract_file [#147]
check_latest_version [#165]
__repr__ [#183]
_version_tuple_from_str [#13]
_version_str_from_tuple [#17]