vitrio 0.1.4
High-throughput image I/O for Cryo-Electron Microscopy (CryoEM)
Loading...
Searching...
No Matches
Public Member Functions | List of all members
vitrio::file_detector_event_timeline_reader_provider Class Referencefinal

A provider that reads files of detector events. It opens each file through a format selector, every time it is asked for one. More...

#include <vitrio/file_detector_event_timeline_reader_provider.hpp>

Inheritance diagram for vitrio::file_detector_event_timeline_reader_provider:
Inheritance graph
[legend]
Collaboration diagram for vitrio::file_detector_event_timeline_reader_provider:
Collaboration graph
[legend]

Public Member Functions

 file_detector_event_timeline_reader_provider (std::shared_ptr< const detector_event_timeline_file_read_format_selector > formats)
 Construct a provider opening through a format selector.
 
std::shared_ptr< const detector_event_timeline_reader > acquire (const std::string &key) override
 Get the reader a key names.
 
- Public Member Functions inherited from vitrio::detector_event_timeline_reader_provider
 detector_event_timeline_reader_provider (const detector_event_timeline_reader_provider &other)=delete
 
 detector_event_timeline_reader_provider (detector_event_timeline_reader_provider &&other)=delete
 
detector_event_timeline_reader_provider & operator= (const detector_event_timeline_reader_provider &other)=delete
 
detector_event_timeline_reader_provider & operator= (detector_event_timeline_reader_provider &&other)=delete
 

Detailed Description

A provider that reads files of detector events. It opens each file through a format selector, every time it is asked for one.

It keeps nothing: every reader it returns is newly opened through the format selector it was constructed with, so a key asked for twice is opened twice and the two readers are unrelated.

A key is handed to the selector as the path of the file.

See also
file_image_reader_provider
detector_event_timeline_file_read_format_selector

Constructor & Destructor Documentation

◆ file_detector_event_timeline_reader_provider()

vitrio::file_detector_event_timeline_reader_provider::file_detector_event_timeline_reader_provider ( std::shared_ptr< const detector_event_timeline_file_read_format_selector >  formats)
explicit

Construct a provider opening through a format selector.

Parameters
formatsThe formats a file may be opened with.
Exceptions
std::invalid_argumentIf formats is null.

Member Function Documentation

◆ acquire()

std::shared_ptr< const detector_event_timeline_reader > vitrio::file_detector_event_timeline_reader_provider::acquire ( const std::string &  key)
overridevirtual

Get the reader a key names.

Parameters
keyKey of the acquisition to read, such as the path of its file.
Returns
std::shared_ptr<const detector_event_timeline_reader> The reader, never null.
Exceptions
image_file_errorIf the file does not exist or can not be read.
unsupported_operation_errorIf no format can read the file.
image_file_format_errorIf the file is malformed or truncated.

Implements vitrio::detector_event_timeline_reader_provider.


The documentation for this class was generated from the following file: