mxcubecore.model.common#

Classes

BeamlineParameters(*, energy, transmission, ...)

CommonCollectionParamters(*, ...)

ISPYBCollectionParameters(*, flux_start, ...)

LegacyParameters(*, take_dark_current, ...)

PathParameters(*, prefix, subdir, ...)

StandardCollectionParameters(*, num_images, ...)

class mxcubecore.model.common.BeamlineParameters(*, energy: float, transmission: float, resolution: float, wavelength: float, detector_distance: float, beam_x: float, beam_y: float, beam_size_x: float, beam_size_y: float, beam_shape: str, energy_bandwidth: float)[source]#

Bases: BaseModel

Parameters:
model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}#

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}#

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'beam_shape': FieldInfo(annotation=str, required=True), 'beam_size_x': FieldInfo(annotation=float, required=True), 'beam_size_y': FieldInfo(annotation=float, required=True), 'beam_x': FieldInfo(annotation=float, required=True), 'beam_y': FieldInfo(annotation=float, required=True), 'detector_distance': FieldInfo(annotation=float, required=True), 'energy': FieldInfo(annotation=float, required=True), 'energy_bandwidth': FieldInfo(annotation=float, required=True), 'resolution': FieldInfo(annotation=float, required=True), 'transmission': FieldInfo(annotation=float, required=True), 'wavelength': FieldInfo(annotation=float, required=True)}#

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

class mxcubecore.model.common.CommonCollectionParamters(*, skip_existing_images: bool, take_snapshots: int, type: str, label: str)[source]#

Bases: BaseModel

Parameters:

  • skip_existing_images (bool) –

  • take_snapshots (int) –

  • type (str) –

  • label (str) –

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}#

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}#

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'label': FieldInfo(annotation=str, required=True), 'skip_existing_images': FieldInfo(annotation=bool, required=True), 'take_snapshots': FieldInfo(annotation=int, required=True), 'type': FieldInfo(annotation=str, required=True)}#

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

class mxcubecore.model.common.ISPYBCollectionParameters(*, flux_start: float, flux_end: float, start_time: datetime, end_time: datetime, chip_model: str, mono_stripe: str, number_of_rows: int, number_of_columns: int)[source]#

Bases: BaseModel

Parameters:

  • flux_start (float) –

  • flux_end (float) –

  • start_time (datetime) –

  • end_time (datetime) –

  • chip_model (str) –

  • mono_stripe (str) –

  • number_of_rows (int) –

  • number_of_columns (int) –

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}#

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}#

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'chip_model': FieldInfo(annotation=str, required=True), 'end_time': FieldInfo(annotation=datetime, required=True), 'flux_end': FieldInfo(annotation=float, required=True), 'flux_start': FieldInfo(annotation=float, required=True), 'mono_stripe': FieldInfo(annotation=str, required=True), 'number_of_columns': FieldInfo(annotation=int, required=True), 'number_of_rows': FieldInfo(annotation=int, required=True), 'start_time': FieldInfo(annotation=datetime, required=True)}#

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

class mxcubecore.model.common.LegacyParameters(*, take_dark_current: int, inverse_beam: bool, num_passes: int, overlap: float)[source]#

Bases: BaseModel

Parameters:

  • take_dark_current (int) –

  • inverse_beam (bool) –

  • num_passes (int) –

  • overlap (float) –

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}#

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'extra': 'ignore'}#

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'inverse_beam': FieldInfo(annotation=bool, required=True), 'num_passes': FieldInfo(annotation=int, required=True), 'overlap': FieldInfo(annotation=float, required=True), 'take_dark_current': FieldInfo(annotation=int, required=True)}#

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

class mxcubecore.model.common.PathParameters(*, prefix: str, subdir: str, experiment_name: str | None)[source]#

Bases: BaseModel

Parameters:

  • prefix (str) –

  • subdir (str) –

  • experiment_name (str | None) –

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}#

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'extra': 'ignore'}#

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'experiment_name': FieldInfo(annotation=Union[str, NoneType], required=True), 'prefix': FieldInfo(annotation=str, required=True), 'subdir': FieldInfo(annotation=str, required=True)}#

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

class mxcubecore.model.common.StandardCollectionParameters(*, num_images: int, osc_start: float | None, osc_range: float | None, energy: float, transmission: float, resolution: float, first_image: int, kappa: float | None, kappa_phi: float | None, beam_size: float, shutterless: bool, selection: list = [], shape: str = '')[source]#

Bases: BaseModel

Parameters:

  • num_images (int) –

  • osc_start (float | None) –

  • osc_range (float | None) –

  • energy (float) –

  • transmission (float) –

  • resolution (float) –

  • first_image (int) –

  • kappa (float | None) –

  • kappa_phi (float | None) –

  • beam_size (float) –

  • shutterless (bool) –

  • selection (list) –

  • shape (str) –

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}#

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'extra': 'ignore'}#

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'beam_size': FieldInfo(annotation=float, required=True), 'energy': FieldInfo(annotation=float, required=True), 'first_image': FieldInfo(annotation=int, required=True), 'kappa': FieldInfo(annotation=Union[float, NoneType], required=True), 'kappa_phi': FieldInfo(annotation=Union[float, NoneType], required=True), 'num_images': FieldInfo(annotation=int, required=True), 'osc_range': FieldInfo(annotation=Union[float, NoneType], required=True), 'osc_start': FieldInfo(annotation=Union[float, NoneType], required=True), 'resolution': FieldInfo(annotation=float, required=True), 'selection': FieldInfo(annotation=list, required=False, default=[]), 'shape': FieldInfo(annotation=str, required=False, default=''), 'shutterless': FieldInfo(annotation=bool, required=True), 'transmission': FieldInfo(annotation=float, required=True)}#

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.