brainglobe
Search…
API documentation

Contents

BrainGlobeAtlas

1
Add remote atlas fetching and version comparison functionalities
2
to the core Atlas class.
3
4
Parameters
5
----------
6
atlas_name : str
7
Name of the atlas to be used.
8
brainglobe_dir : str or Path object
9
Default folder for brainglobe downloads.
10
interm_download_dir : str or Path object
11
Folder to download the compressed file for extraction.
12
check_latest : bool (optional)
13
If true, check if we have the most recent atlas (default=True). Set
14
this to False to avoid waiting for remote server response on atlas
15
instantiation and to suppress warnings.
16
print_authors : bool (optional)
17
If true, disable default listing of the atlas reference.
Copied!

__init__ [#45]

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

local_version [#87]

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

remote_version [#99]

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

local_full_name [#119]

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

remote_url [#139]

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

download_extract_file [#147]

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

check_latest_version [#165]

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

__repr__ [#183]

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

_version_tuple_from_str [#13]

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

_version_str_from_tuple [#17]

Check the source code online
1
def _version_str_from_tuple(version_tuple):
Copied!
  docstring:
no docstring
Last modified 1yr ago