vibesketcher.server.diffraction¶
REST routes for powder diffraction planning and overlays (#207).
Every route reads; none changes a document. A calculated pattern comes from a document’s periodic structure or from posted CIF text; a measured pattern is posted as text or base64 bytes with its file name and stated axis, and its provenance (SHA-256 of the posted bytes, axis, wavelength, instrument fields as given) is returned with the points and printed on the overlay.
Functions
|
Classes
|
|
|
|
|
A measured file: |
|
- class vibesketcher.server.diffraction.PatternRequest(*, structure, settings=<factory>)[source]¶
Bases:
BaseModel- model_config = {'extra': 'forbid'}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- class vibesketcher.server.diffraction.CifPatternRequest(*, cif, settings=<factory>, block=None, setting=None)[source]¶
Bases:
BaseModel- Parameters:
- model_config = {'extra': 'forbid'}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- class vibesketcher.server.diffraction.MeasuredRequest(*, filename, text=None, data_base64=None, settings, points=True)[source]¶
Bases:
BaseModelA measured file:
textordata_base64(the original bytes), and its name.- Parameters:
- model_config = {'extra': 'forbid'}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- class vibesketcher.server.diffraction.FigureRequest(*, structure=None, cif=None, block=None, setting=None, settings=<factory>, measured=None, options=<factory>, format='svg', dpi=300)[source]¶
Bases:
BaseModel- Parameters:
- model_config = {'extra': 'forbid'}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- measured: MeasuredRequest | None¶
- format: Literal['svg', 'pdf', 'png']¶