Fake Convergence Beam Electron Diffraction (fakecbed)
fakecbed is a Python library for generating quickly images that imitate
convergent beam electron diffraction patterns.
Setting up fakecbed
For instructions on installing the fakecbed library, see the
Installation instructions page.
Learning how to use fakecbed
For those new to the fakecbed library, it is recommended that they take a
look at the Examples page, which contain code examples that show how
one can use the fakecbed library. While going through the examples, readers
can consult the fakecbed reference guide to understand what each line of code
is doing.
Contents
- Home
- 1. Installation instructions
- 2. Reference
- 2.1. fakecbed.discretized
- 2.1.1. fakecbed.discretized.CBEDPattern
CBEDPatternCBEDPattern.core_attrsCBEDPattern.de_pre_serialization_funcsCBEDPattern.de_pre_serialize()CBEDPattern.deviceCBEDPattern.disk_absence_registryCBEDPattern.disk_clipping_registryCBEDPattern.disk_overlap_mapCBEDPattern.disk_supportsCBEDPattern.dump()CBEDPattern.dumps()CBEDPattern.get_core_attrs()CBEDPattern.get_de_pre_serialization_funcs()CBEDPattern.get_disk_absence_registry()CBEDPattern.get_disk_clipping_registry()CBEDPattern.get_disk_overlap_map()CBEDPattern.get_disk_supports()CBEDPattern.get_illumination_support()CBEDPattern.get_image()CBEDPattern.get_pre_serialization_funcs()CBEDPattern.get_signal()CBEDPattern.get_validation_and_conversion_funcs()CBEDPattern.illumination_supportCBEDPattern.imageCBEDPattern.image_has_been_overriddenCBEDPattern.load()CBEDPattern.loads()CBEDPattern.num_disksCBEDPattern.override_image_then_reapply_mask()CBEDPattern.pre_serialization_funcsCBEDPattern.pre_serialize()CBEDPattern.signalCBEDPattern.update()CBEDPattern.validation_and_conversion_funcs
- 2.1.1. fakecbed.discretized.CBEDPattern
- 2.2. fakecbed.shapes
- 2.2.1. fakecbed.shapes.Arc
ArcArc.core_attrsArc.de_pre_serialization_funcsArc.de_pre_serialize()Arc.dump()Arc.dumps()Arc.eval()Arc.get_core_attrs()Arc.get_de_pre_serialization_funcs()Arc.get_pre_serialization_funcs()Arc.get_validation_and_conversion_funcs()Arc.load()Arc.loads()Arc.pre_serialization_funcsArc.pre_serialize()Arc.update()Arc.validation_and_conversion_funcs
- 2.2.2. fakecbed.shapes.Band
BandBand.core_attrsBand.de_pre_serialization_funcsBand.de_pre_serialize()Band.dump()Band.dumps()Band.eval()Band.get_core_attrs()Band.get_de_pre_serialization_funcs()Band.get_pre_serialization_funcs()Band.get_validation_and_conversion_funcs()Band.load()Band.loads()Band.pre_serialization_funcsBand.pre_serialize()Band.update()Band.validation_and_conversion_funcs
- 2.2.3. fakecbed.shapes.BaseShape
BaseShapeBaseShape.core_attrsBaseShape.de_pre_serialization_funcsBaseShape.de_pre_serialize()BaseShape.dump()BaseShape.dumps()BaseShape.eval()BaseShape.get_core_attrs()BaseShape.get_de_pre_serialization_funcs()BaseShape.get_pre_serialization_funcs()BaseShape.get_validation_and_conversion_funcs()BaseShape.load()BaseShape.loads()BaseShape.pre_serialization_funcsBaseShape.pre_serialize()BaseShape.update()BaseShape.validation_and_conversion_funcs
- 2.2.4. fakecbed.shapes.Circle
CircleCircle.core_attrsCircle.de_pre_serialization_funcsCircle.de_pre_serialize()Circle.dump()Circle.dumps()Circle.eval()Circle.get_core_attrs()Circle.get_de_pre_serialization_funcs()Circle.get_pre_serialization_funcs()Circle.get_validation_and_conversion_funcs()Circle.load()Circle.loads()Circle.pre_serialization_funcsCircle.pre_serialize()Circle.update()Circle.validation_and_conversion_funcs
- 2.2.5. fakecbed.shapes.Ellipse
EllipseEllipse.core_attrsEllipse.de_pre_serialization_funcsEllipse.de_pre_serialize()Ellipse.dump()Ellipse.dumps()Ellipse.eval()Ellipse.get_core_attrs()Ellipse.get_de_pre_serialization_funcs()Ellipse.get_pre_serialization_funcs()Ellipse.get_validation_and_conversion_funcs()Ellipse.load()Ellipse.loads()Ellipse.pre_serialization_funcsEllipse.pre_serialize()Ellipse.update()Ellipse.validation_and_conversion_funcs
- 2.2.6. fakecbed.shapes.GenericBlob
GenericBlobGenericBlob.core_attrsGenericBlob.de_pre_serialization_funcsGenericBlob.de_pre_serialize()GenericBlob.dump()GenericBlob.dumps()GenericBlob.eval()GenericBlob.get_core_attrs()GenericBlob.get_de_pre_serialization_funcs()GenericBlob.get_pre_serialization_funcs()GenericBlob.get_validation_and_conversion_funcs()GenericBlob.load()GenericBlob.loads()GenericBlob.pre_serialization_funcsGenericBlob.pre_serialize()GenericBlob.update()GenericBlob.validation_and_conversion_funcs
- 2.2.7. fakecbed.shapes.Lune
LuneLune.core_attrsLune.de_pre_serialization_funcsLune.de_pre_serialize()Lune.dump()Lune.dumps()Lune.eval()Lune.get_core_attrs()Lune.get_de_pre_serialization_funcs()Lune.get_pre_serialization_funcs()Lune.get_validation_and_conversion_funcs()Lune.load()Lune.loads()Lune.pre_serialization_funcsLune.pre_serialize()Lune.update()Lune.validation_and_conversion_funcs
- 2.2.8. fakecbed.shapes.NonuniformBoundedShape
NonuniformBoundedShapeNonuniformBoundedShape.core_attrsNonuniformBoundedShape.de_pre_serialization_funcsNonuniformBoundedShape.de_pre_serialize()NonuniformBoundedShape.dump()NonuniformBoundedShape.dumps()NonuniformBoundedShape.eval()NonuniformBoundedShape.get_core_attrs()NonuniformBoundedShape.get_de_pre_serialization_funcs()NonuniformBoundedShape.get_pre_serialization_funcs()NonuniformBoundedShape.get_validation_and_conversion_funcs()NonuniformBoundedShape.load()NonuniformBoundedShape.loads()NonuniformBoundedShape.pre_serialization_funcsNonuniformBoundedShape.pre_serialize()NonuniformBoundedShape.update()NonuniformBoundedShape.validation_and_conversion_funcs
- 2.2.9. fakecbed.shapes.Orbital
OrbitalOrbital.core_attrsOrbital.de_pre_serialization_funcsOrbital.de_pre_serialize()Orbital.dump()Orbital.dumps()Orbital.eval()Orbital.get_core_attrs()Orbital.get_de_pre_serialization_funcs()Orbital.get_pre_serialization_funcs()Orbital.get_validation_and_conversion_funcs()Orbital.load()Orbital.loads()Orbital.pre_serialization_funcsOrbital.pre_serialize()Orbital.update()Orbital.validation_and_conversion_funcs
- 2.2.10. fakecbed.shapes.Peak
PeakPeak.core_attrsPeak.de_pre_serialization_funcsPeak.de_pre_serialize()Peak.dump()Peak.dumps()Peak.eval()Peak.get_core_attrs()Peak.get_de_pre_serialization_funcs()Peak.get_pre_serialization_funcs()Peak.get_validation_and_conversion_funcs()Peak.load()Peak.loads()Peak.pre_serialization_funcsPeak.pre_serialize()Peak.update()Peak.validation_and_conversion_funcs
- 2.2.11. fakecbed.shapes.PlaneWave
PlaneWavePlaneWave.core_attrsPlaneWave.de_pre_serialization_funcsPlaneWave.de_pre_serialize()PlaneWave.dump()PlaneWave.dumps()PlaneWave.eval()PlaneWave.get_core_attrs()PlaneWave.get_de_pre_serialization_funcs()PlaneWave.get_pre_serialization_funcs()PlaneWave.get_validation_and_conversion_funcs()PlaneWave.load()PlaneWave.loads()PlaneWave.pre_serialization_funcsPlaneWave.pre_serialize()PlaneWave.update()PlaneWave.validation_and_conversion_funcs
- 2.2.1. fakecbed.shapes.Arc
- 2.3. fakecbed.tds
- 2.3.1. fakecbed.tds.Model
ModelModel.core_attrsModel.de_pre_serialization_funcsModel.de_pre_serialize()Model.dump()Model.dumps()Model.eval()Model.get_core_attrs()Model.get_de_pre_serialization_funcs()Model.get_pre_serialization_funcs()Model.get_validation_and_conversion_funcs()Model.load()Model.loads()Model.pre_serialization_funcsModel.pre_serialize()Model.update()Model.validation_and_conversion_funcs
- 2.3.1. fakecbed.tds.Model
- 2.4. fakecbed.version
- 2.1. fakecbed.discretized
- 3. Examples
- 4. Literature
- 5. License