UV-Vis

UVVisBlock ¶

UVVisBlock(item_id: str | None = None, collection_id: str | None = None, init_data: dict | None = None, unique_id: str | None = None)

Bases: DataBlock

Parameters:

Name	Type	Description	Default
`item_id`	`str \| None`	The item to which the block is attached, or	`None`
`collection_id`	`str \| None`	The collection to which the block is attached.	`None`
`init_data`	`dict \| None`	A dictionary of data to initialise the block with.	`None`
`unique_id`	`str \| None`	A unique id for the block, used in the DOM and database.	`None`

Attributes:

Name	Type	Description
`accepted_file_extensions`
`block_db_model`
`block_id`
`blocktype`
`data`
`defaults`	`dict[str, Any]`	Any default values that should be set if they are not
`description`
`multi_file`	`bool`	Whether this block can accept multiple files as input.
`name`
`plot_functions`
`version`	`str`	The implementation version of this particular block.

accepted_file_extensions ¶

accepted_file_extensions = ('.Raw8.txt', '.txt')

block_db_model ¶

block_db_model = DataBlockResponse

block_id ¶

block_id = unique_id or generate_random_id()

blocktype ¶

blocktype = 'uv-vis'

data ¶

data = {'item_id': item_id, 'collection_id': collection_id, 'blocktype': blocktype, 'block_id': block_id, None: defaults}

defaults ¶

defaults: dict[str, Any] = {}

Any default values that should be set if they are not supplied during block init.

description ¶

description = 'This block can plot UV-Vis data from a .txt file. Two files are required, the scan to plot and the background scan.\nThe first file in the order will be treated as the background scan, and subsequent files as the sample scans.'

multi_file ¶

multi_file: bool = False

Whether this block can accept multiple files as input.

name ¶

name = 'UV-Vis'

plot_functions ¶

plot_functions

version ¶

version: str = __version__

The implementation version of this particular block.

event_names ¶

event_names() -> set[str]

Return a list of event names supported by this block.

events_by_name ¶

events_by_name() -> dict[str, Callable]

Returns a dict of registered events for this block.

from_web ¶

from_web(data: dict)

Initialise the block state from data passed via web request with a given item, collection and block ID.

Parameters:

Name	Type	Description	Default
`data`	`dict`	The block data to initialiaze the block with.	required

generate_absorbance_plot ¶

generate_absorbance_plot()

null_event ¶

null_event(**kwargs)

A null debug event that does nothing but logs its kwargs and overwrites the data dict with the args.

process_events ¶

process_events(events: list[dict] | dict)

Handle any supported events passed to the block.

to_db ¶

to_db() -> dict

returns a dictionary with the data for this block, ready to be input into mongodb

to_web ¶

to_web() -> dict[str, Any]

Returns a JSON serializable dictionary to render the data block on the web.

update_from_web ¶

update_from_web(data: dict)

Update the block with validated data received from a web request. Will strip any fields that are "computed" or otherwise not controllable by the user.

Parameters:

Name	Type	Description	Default
`data`	`dict`	A dictionary of data to update the block with.	required