1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584
|
from configparser import ConfigParser
from typing import Dict, Any, Union
import h5py
import numpy as np
import warnings
from collections import deque
from ont_fast5_api.compression_settings import VBZ, raise_missing_vbz_error_read, raise_missing_vbz_error_write
from ont_fast5_api.data_sanitisation import _sanitize_data_for_reading, _sanitize_data_for_writing, _clean
from ont_fast5_api.static_data import LEGACY_COMPONENT_NAMES
class AbstractFast5:
def __enter__(self):
return self
def __exit__(self, exception_type, exception_value, traceback):
self.close()
return False
def get_reads(self):
raise NotImplementedError()
def get_read_ids(self):
raise NotImplementedError()
def get_read(self, read_id):
raise NotImplementedError()
@property
def _is_open(self):
return repr(self.handle) != u'<Closed HDF5 file>'
def assert_open(self):
if not self._is_open:
raise IOError("Fast5 file is not open: {}".format(self.filename))
def assert_writeable(self):
self.assert_open()
if self.mode == 'r':
raise IOError("Fast5 file is in read-only mode '{}' {}".format(self.mode, self.filename))
def close(self):
""" Closes the object.
"""
if self._is_open:
self.mode = None
if self.handle:
self.handle.close()
self.handle = None
self.filename = None
self.status = None
class Fast5Read(AbstractFast5):
global_key = "" # This is for single Fast5File compatibility
def __init__(self, parent, read_id):
self.parent = parent
self.mode = parent.mode
self.filename = parent.filename
self.handle = parent.handle["read_" + read_id]
self.read_id = read_id
def get_run_id(self):
DeprecationWarning("'read.get_run_id()' will be deprecated. Use the property 'read.run_id' instead")
return self.run_id
def get_read_id(self):
DeprecationWarning("'read.get_read_id()' will be deprecated. Use the property 'read.read_id' instead")
return self.read_id
@property
def raw_dataset_name(self):
return self.raw_dataset_group_name + "/Signal"
@property
def raw_dataset_group_name(self):
return 'Raw'
@property
def raw_compression_filters(self):
return self.handle[self.raw_dataset_name]._filters
@property
def run_id(self):
return self.handle[self.global_key + 'tracking_id'].attrs['run_id']
def add_raw_data(self, data, attrs=None, compression=VBZ):
""" Add raw data for a read.
:param data: The raw data DAQ values (16 bit integers).
The read must already exist in the file. It must not already
have raw data.
"""
self.assert_writeable()
if self.raw_dataset_group_name not in self.handle:
self.handle.create_group(self.raw_dataset_group_name)
if self.raw_dataset_name in self.handle:
msg = "Fast5 file already has raw data for read '{}' in: {}"
raise KeyError(msg.format(self.read_id, self.filename))
try:
self.handle[self.raw_dataset_group_name].create_dataset('Signal', data=data, dtype='i2',
**vars(compression))
except ValueError as e:
raise_missing_vbz_error_read(e)
if attrs is not None:
self._add_attributes(self.raw_dataset_group_name, attrs, clear=True)
def add_channel_info(self, attrs, clear=False):
""" Add channel info data to the channel_id group.
:param data: A dictionary of key/value pairs. Keys must be strings.
Values can be strings or numeric values.
:param clear: If set, any existing channel info data will be removed.
"""
self.assert_writeable()
if 'channel_id' not in self.handle:
self.handle.create_group('channel_id')
self._add_attributes('channel_id', attrs, clear)
def add_tracking_id(self, attrs, clear=False):
self.assert_writeable()
if 'tracking_id' not in self.handle:
self.handle.create_group("tracking_id")
self.set_tracking_id(attrs, clear)
def add_analysis(self, component, group_name, attrs, config=None):
""" Add a new analysis group to the file.
:param component: The component name.
:param group_name: The name to use for the group. Must not already
exist in the file e.g. 'Test_000'.
:param attrs: A dictionary containing the key-value pairs to
put in the analysis group as attributes. Keys must be strings,
and values must be strings or numeric types.
:param config: A dictionary of dictionaries. The top level keys
should be the name of analysis steps, and should contain
key value pairs for analysis parameters used.
"""
self.assert_writeable()
if "Analyses" not in self.handle:
self.handle.create_group("Analyses")
group = 'Analyses/{}'.format(group_name)
cfg_group = '{}/Configuration'.format(group)
group_attrs = attrs.copy()
group_attrs['component'] = component
self._add_group(group, group_attrs)
self.handle[group].create_group('Summary')
self.handle[group].create_group('Configuration')
if config is not None:
self._add_attribute_tree(cfg_group, config)
def get_raw_data(self, read_number=None, start=None, end=None, scale=False):
if read_number:
warnings.warn("Read number is not used for MultiReadFast5")
return self._load_raw(self.raw_dataset_name, start, end, scale)
def list_analyses(self, component=None):
""" Provides a list of all analyses groups.
:param component: Optional component name. If provided, only
analyses of that component will be returned.
:returns: A list of component-name/group-name pairs (tuples).
"""
self.assert_open()
analyses = []
if 'Analyses' not in self.handle:
return analyses
ana_groups = self.handle['Analyses'].keys()
for group_name in ana_groups:
group_attrs = self.handle['Analyses/{}'.format(group_name)].attrs
if 'component' in group_attrs:
comp = _clean(group_attrs['component'])
elif group_name[:-4] in LEGACY_COMPONENT_NAMES:
comp = LEGACY_COMPONENT_NAMES[group_name[:-4]]
else:
# We don't know anything about this component!
comp = None
if comp is not None and (component is None or comp == component):
analyses.append((comp, group_name))
return analyses
def get_latest_analysis(self, group_base, increment=False):
""" Return the latest analysis group with the specified
base name.
:param group_base: The name of the analysis group, excluding
the _### at the end e.g. 'Alignment' rather than 'Alignment_000'
:param increment: If set, this will find the name of the latest
analysis group, increment the index by 1, and return
the results. If there aren't any, it will give an index
of 000.
:returns: The group name with the highest index, or None if
there are no analyses with the specified base name.
"""
self.assert_open()
all_analyses = self.list_analyses()
selected = []
for analysis in all_analyses:
if analysis[1][:-4] == group_base:
selected.append(analysis[1])
if len(selected) == 0:
result = None
if increment:
result = '{}_000'.format(group_base)
return result
result = sorted(selected)[-1]
if increment:
count = int(result[-3:]) + 1
result = '{}_{}'.format(group_base, str(count).zfill(3))
return result
def add_chain(self, group_name, component_map):
"""
Adds the component chain to ``group_name`` in the fast5.
These are added as attributes to the group.
:param group_name: The group name you wish to add chaining data to,
e.g. ``Test_000``
:param component_map: The set of components and corresponding
group names or group paths that contribute data to the analysis.
If group names are provided, these will be converted into group
paths.
If ``Test_000`` uses data from the results of
``first_component`` stored at ``Analyses/First_000/``
the component_map could be ``{'first_component': 'First_000'}`` or
``{'first_component': 'Analyses/First_000'}``.
"""
self.assert_writeable()
for component, path in component_map.items():
if not path.startswith('Analyses/'):
path = 'Analyses/{}'.format(path)
component_map[component] = path
self.add_analysis_attributes(group_name, component_map)
def get_chain(self, group_name):
""" Provides the component and group names for an analysis chain.
:param group_name: The group name of the last step in the analysis
chain e.g. 'Basecall_1D_000'
:returns: A list of component-name/group-name pairs (tuples). This
will include each component of the chain, in order.
"""
self.assert_open()
endgroup = 'Analyses/{}'.format(group_name)
attr = self.handle[endgroup].attrs
if 'component' in attr:
component = attr['component']
else:
component = LEGACY_COMPONENT_NAMES[group_name[:-4]]
chain = deque()
chain.append((component, group_name))
groups_to_check = deque()
groups_to_check.append(endgroup)
while len(groups_to_check) > 0:
group = groups_to_check.popleft()
attr = self.handle[group].attrs
for key, value in attr.items():
if str(value).startswith('Analyses/'):
chain_entry = (key, value[9:])
# We need to maintain the order of the components, so
# we'll move any we see again to the end of the chain.
if chain_entry in chain:
chain.remove(chain_entry)
chain.append(chain_entry)
groups_to_check.append(value)
return list(chain)
def get_tracking_id(self):
""" Returns a dictionary of tracking-id key/value pairs.
"""
self.assert_open()
tracking = self.handle[self.global_key + 'tracking_id'].attrs.items()
tracking = {key: _clean(value) for key, value in tracking}
return tracking
def set_tracking_id(self, data, clear=False):
""" Add tracking-id data to the tracking_id group.
:param data: A dictionary of key/value pairs. Keys must be strings.
Values can be strings or numeric values.
:param clear: If set, any existing tracking-id data will be removed.
"""
self.assert_writeable()
self._add_attributes(self.global_key + 'tracking_id', data, clear)
return
def get_channel_info(self):
""" Returns a dictionary of channel information key/value pairs.
"""
self.assert_open()
channel_info = self.handle[self.global_key + 'channel_id'].attrs.items()
channel_info = {key: _clean(value) for key, value in channel_info}
channel_info['channel_number'] = int(channel_info['channel_number'])
return channel_info
@property
def has_context_tags(self):
return 'context_tags' in self.handle
def get_context_tags(self):
""" Returns a dictionary of context tag key/value pairs.
"""
self.assert_open()
if self.has_context_tags:
tags = self.handle[self.global_key + 'context_tags'].attrs.items()
return {key: _clean(value) for key, value in tags}
return {}
def add_context_tags(self, data, clear=False):
""" Replaces any existing context tag data with the provided values.
:param data: A dictionary of key/value pairs. Keys must be strings.
Values can be strings or numeric values.
:param clear: If set, any existing context tag data will be removed.
"""
self.assert_writeable()
if self.has_context_tags:
self._add_attributes(self.global_key + 'context_tags', data, clear)
else:
self._add_group(self.global_key + 'context_tags', data)
def add_read(self, read_number, read_id, start_time, duration, mux, median_before):
raise NotImplementedError("Cannot add_existing_read() to a Fast5Read(). "
"Use MultiFast5File.create_empty_read() instead")
def add_log(self, group_name, field_name, log_string):
""" Add a log the file.
:param group_name: Global group name. Cave: No 'Analyses' is prepended.
:param field_name: A field {group_name}/{field_name} will be written.
:param log_string: content to be written.
"""
self.assert_writeable()
if group_name not in self.handle:
self._add_group(group_name, {})
sanitized_data = _sanitize_data_for_writing(log_string)
self.handle[group_name].create_dataset(field_name, data=sanitized_data)
def set_summary_data(self, group_name, section_name, data):
""" Set the summary data for an analysis group.
:param group_name: The name of the analysis group.
:param section_name: The analysis step. This will become a
subfolder in the Summary section.
:param data: A dictionary containing keys which are the summary
fields, and values which are the summary values.
"""
self.assert_writeable()
group = 'Analyses/{}/Summary/{}'.format(group_name, section_name)
self._add_group(group, data)
def set_analysis_config(self, group_name, config):
""" Set Configuration data for analysis group. The ``config`` can
be passed as a dict of dicts e.g. ``{'section': {'key': 'value'}}``
or can be passed directly as a ConfigParser object.
:param group_name: The name of the analysis group e.g. Example_000
:param config: Representation of configuration as ConfigParser or
dict of dicts.
:raises KeyError: if group_name does not exist in fast5 or
fast5 is not open for writing
:raises TypeError: if ``config`` is not ConfigParser or dict obj.
"""
self.assert_writeable()
if 'Analyses/{}'.format(group_name) not in self.handle:
msg = 'Dataset cannot be added to non-existent group: Analyses/{} in {}'
raise KeyError(msg.format(group_name, self.filename))
if isinstance(config, ConfigParser):
config_dict = {}
for section in config.sections():
config_dict[section] = {k: v for k, v in config.items(section)}
elif isinstance(config, dict):
config_dict = config
else:
raise TypeError('config must be a ConfigParser or dict not {}'.format(type(config)))
config_path = 'Analyses/{}/Configuration'.format(group_name)
self._add_attribute_tree(config_path, config_dict)
def get_analysis_config(self, group_name):
""" Gets any config data saved for the analysis.
:param group_name: The name of the analysis group.
:returns: A dictionary of dictionaries. Each key represents
an analysis step. Each value is a dictionary containing the
analysis parameters as key/value pairs. Returns None if no
configuration exists for the analysis.
"""
self.assert_open()
group = 'Analyses/{}/Configuration'.format(group_name)
config = None
if group in self.handle:
config = self._parse_attribute_tree(group)
return config
def get_summary_data(self, group_name):
""" Get the summary data for an analysis group.
:param group_name: The name of the analysis group to pull summary
data for.
:returns: A dictionary whose keys are analysis steps, and whose
values are dictionaries of key/value pairs for the results of
that step.
"""
self.assert_open()
group = 'Analyses/{}/Summary'.format(group_name)
summary = None
if group in self.handle:
summary = self._parse_attribute_tree(group)
return summary
def add_analysis_subgroup(self, group_name, subgroup_name, attrs=None):
""" Add a new subgroup to an existing analysis group.
:param group_name: The name of the analysis group you are adding to.
:param subgroup_name: The name of the new subgroup.
:param attrs: A dictionary representing the attributes to assign to
the subgroup.
The new subgroup must not already exist.
The subgroup name can be a nested name, such as "Template/Data". This
will create the "Template" subgroup (if it does not exist), and the
"Data" subgroup below it.
"""
self.assert_writeable()
group = 'Analyses/{}/{}'.format(group_name, subgroup_name)
self._add_group(group, attrs)
def add_analysis_attributes(self, group_name, attrs, clear=False):
""" Add attributes on the group or dataset specified.
:param group_name: The name of the group (or dataset).
:param attrs: A dictionary representing the attributes to add.
:param clear: If set, any existing attributes will be cleared.
The specified group name can be any existing path (relative to the
"Analyses" group. It can be a group or a dataset.
"""
self.assert_writeable()
group = 'Analyses/{}'.format(group_name)
self._add_attributes(group, attrs, clear)
def get_analysis_attributes(self, group_name):
""" Returns the attributes for the specified group or dataset.
:param group_name: The path of the group or dataset, relative to the
"Analyses" group.
:returns: A dictionary representing the attributes (if any).
"""
self.assert_open()
group = 'Analyses/{}'.format(group_name)
attr = None
if group in self.handle:
attr = self.handle[group].attrs.items()
attr = {key: _clean(value) for key, value in attr}
return attr
def add_analysis_dataset(self, group_name, dataset_name, data, attrs=None):
""" Add a dataset to the specified group.
:param group_name: The path of the group the dataset will be added to,
relative to the "Analyses" group.
:param dataset_name: The name of the new dataset.
:param data: A numpy array representing the data to be written.
:param attrs: A dictionary of attributes to be added to the dataset.
:raises KeyError: If dataset is being added to non-existant group or
if file is not open for writing.
"""
self.assert_writeable()
group_path = 'Analyses/{}'.format(group_name)
if group_path not in self.handle:
msg = 'Dataset cannot be added to non-existent group: Analyses/{} in {}'
raise KeyError(msg.format(group_name, self.filename))
sanitized_data = _sanitize_data_for_writing(data)
if np.shape(sanitized_data) == (): # We can't compress scalar datasets
self.handle[group_path].create_dataset(dataset_name,
data=sanitized_data)
else:
self.handle[group_path].create_dataset(dataset_name,
data=sanitized_data,
compression='gzip')
if attrs is not None:
path = '{}/{}'.format(group_path, dataset_name)
self._add_attributes(path, attrs)
def get_analysis_dataset(self, group_name, dataset_name, skip_decoding=False):
""" Return the specified dataset, as a numpy array.
:param group_name: The path of the group containing the dataset,
relative to the "Analyses" group.
:param dataset_name: The name of the dataset.
:param skip_decoding: If True, this will directly return the h5py dataset.
If False, it will load the data into a Numpy array and decode any byte-strings
:return: A numpy array containing the data. Returns None if the dataset
does not exist.
"""
self.assert_open()
dataset_name = 'Analyses/{}/{}'.format(group_name, dataset_name)
data = None
if dataset_name in self.handle:
data = self.handle[dataset_name]
if not skip_decoding:
data = _sanitize_data_for_reading(data)
return data
@staticmethod
def read_summary_data(fname, component):
raise NotImplementedError("read_summary_data() is not implemented for MultiFast5 reads")
@staticmethod
def update_legacy_file(fname):
raise NotImplementedError("Cannot update legacy file for a MultiFast5Read")
def _load_raw(self, dataset_name, start, end, scale):
try:
raw = self.handle[dataset_name][start:end]
except OSError as err:
raise_missing_vbz_error_write(err)
if scale:
channel_info = self.handle[self.global_key + 'channel_id'].attrs
digi = channel_info['digitisation']
parange = channel_info['range']
offset = channel_info['offset']
scaling = parange / digi
# python slice syntax allows None, https://docs.python.org/3/library/functions.html#slice
raw = np.array(scaling * (raw + offset), dtype=np.float32)
return raw
def _add_group(self, group, attrs):
"""
:param group: group_name
:param attrs:
:return:
"""
self.handle.create_group(group)
if attrs is not None:
self._add_attributes(group, attrs)
def _add_attributes(self, path, attrs, clear=False):
path_grp = self.handle[path]
path_attr = path_grp.attrs
if clear:
for key in path_attr.keys():
del path_attr[key]
copy_attributes(attrs, path_grp)
def _add_attribute_tree(self, group, config):
for folder, data in config.items():
path = '{}/{}'.format(group, folder)
self._add_group(path, data)
def _parse_attribute_tree(self, group):
data = {}
folders = self.handle[group].keys()
for folder in folders:
path = '{}/{}'.format(group, folder)
attr = self.handle[path].attrs.items()
data[folder] = {key: _clean(value) for key, value in attr}
return data
def copy_attributes(input_attrs: Union[h5py.AttributeManager, Dict[Any, Any]], output_group: h5py.Group):
""" Copy the members of a given h5py.AttributeManager into an output h5py.Group"""
if isinstance(input_attrs, h5py.AttributeManager):
# Ensure h5py data types (e.g. enumerations) are retained during copy
for name, data in input_attrs.items():
dtype = input_attrs.get_id(name).dtype
output_group.attrs.create(name=name, data=data, dtype=dtype)
else:
# Simple dictionary copy into the output group attributes
for name, data in input_attrs.items():
output_group.attrs[name] = data
|