synthpic2.recipe.blueprints

Module for blueprint classes.

Submodules

• synthpic2.recipe.blueprints.blueprints

Package Contents

Classes

MeasurementTechnique	Class to store the features of a measurement technique.
MeasurementTechniqueBlueprint	Class to combine a measurement_technique_prototype and a material_prototype
Particle	Class to represent an object, invoked by a particle blueprint.
ParticleBlueprint	Class to combine a geometry_prototype and a material_prototype to a

class synthpic2.recipe.blueprints.MeasurementTechnique

Bases: _InvokedObject

Class to store the features of a measurement technique.

property _registry: synthpic2.recipe.registries.Registry

blueprint: MeasurementTechniqueBlueprint

__attrs_post_init__() → None

prepare_for_render(rendering_mode: str) → None

assign_material_prototype_to_object(material_prototype: synthpic2.recipe.prototypes.prototypes.MaterialPrototype, object_name: str) → None

class synthpic2.recipe.blueprints.MeasurementTechniqueBlueprint

Bases: _Blueprint

Class to combine a measurement_technique_prototype and a material_prototype to a particle.

property _registry: synthpic2.recipe.registries.Registry

_target_: str = 'synthpic2.recipe.blueprints.MeasurementTechniqueBlueprint'

measurement_technique_prototype_name: str

measurement_volume_material_prototype_name: str = 'vacuum'

background_material_prototype_name: str = 'vacuum'

name: str = 'MeasurementTechnique'

custom_features: Features | None

__attrs_post_init__() → None

_gather_feature_subsets() → List[None | Features | synthpic2.recipe.registries.Registry]

invoke() → None

Load a measurement_technique_prototype, assign a measurement_volume_material_prototype and optionally assign a background_material_prototype.

class synthpic2.recipe.blueprints.Particle

Bases: _InvokedObject

Class to represent an object, invoked by a particle blueprint.

property _registry: synthpic2.recipe.registries.Registry

property md5: str

blueprint: ParticleBlueprint

class synthpic2.recipe.blueprints.ParticleBlueprint

Bases: _Blueprint

Class to combine a geometry_prototype and a material_prototype to a particle.

property _registry: synthpic2.recipe.registries.Registry

_target_: str = 'synthpic2.recipe.blueprints.ParticleBlueprint'

geometry_prototype_name: str

material_prototype_name: str = 'default'

parent: str = 'MeasurementVolume'

number: int

__attrs_post_init__() → None

_gather_feature_subsets() → List[None | Features | synthpic2.recipe.registries.Registry]

invoke() → None

Create the specified number of particles, according to the blueprint.