Mondaic Documentation
www.mondaic.com
Mondaic
Version:
No results found.
python_api
/
salvus
/
flow
/
collections
/
event_data_collection_proxy

salvus.flow.collections.event_data_collection_proxy

salvus.flow.collections.event_data_collection_proxy salvus flow collections event_data_collection_proxy
EventData collection object.

Classes

EventDataCollectionProxy

A data proxy describes how to get data from external sources. This could be external files or a web service or something else completely.
SIGNATURE
class EventDataCollectionProxy(builtins.object):
    def __init__(
        self, proxy_type: str, config: dict, proxy_import: str | None = None
    ): ...
ARGUMENTS
Required
proxy_type
Type:str
Description:
The name of the proxy as a string.
Required
config
Type:dict
Description:
The proxy configuration.
Optional
proxy_import
Type:str | None
Default value:None
Description:
External proxies might require to be imported. Optionally specify the to-be-imported module here.

Class Methods

EventDataCollectionProxy.read()
Read an event data collection proxy.
SIGNATURE
def read(filename: pathlib.Path | str) -> EventDataCollectionProxy: ...
ARGUMENTS
Required
filename
Type:pathlib.Path | str
Description:
Path to the file on disc.

Methods

EventDataCollectionProxy.get_event_data()
Load the data for a given event.
SIGNATURE
def get_event_data(self, event: Event) -> EventData: ...
ARGUMENTS
Required
event
Type:Event
Description:
The event to load the data for.
EventDataCollectionProxy.write()
Write the proxy configuration to a file.
SIGNATURE
def write(self, filename: pathlib.Path | str) -> None: ...
ARGUMENTS
Required
filename
Type:pathlib.Path | str
Description:
Output filename.
Previous
event_data_collection
Next
event_misfit
We use cookies to analyze our traffic, but won't track you until explicit consent is given. Using our contact form will create relevant cookies and transmit data to third party services to keep track of your request. Read more about how we use personal information in our Privacy Policy.
PAGE CONTENTS