diff --git a/ophyd/.doctr-files b/ophyd/.doctr-files deleted file mode 100644 index 52246ea762..0000000000 --- a/ophyd/.doctr-files +++ /dev/null @@ -1,445 +0,0 @@ -ophyd/OEP/OEP_001.html -ophyd/OEP/index.html -ophyd/_images/inheritance-15bc9368c2f46f77d1599b9d515a6682240bfc8b.png -ophyd/_images/inheritance-15bc9368c2f46f77d1599b9d515a6682240bfc8b.png.map -ophyd/_images/inheritance-3ead649a59595e814a12c6fc7d6708f6b9d28ff2.png -ophyd/_images/inheritance-3ead649a59595e814a12c6fc7d6708f6b9d28ff2.png.map -ophyd/_images/inheritance-56ba088399d2c0103e2f5f0b87e1a5c50075c3fd.png -ophyd/_images/inheritance-56ba088399d2c0103e2f5f0b87e1a5c50075c3fd.png.map -ophyd/_images/inheritance-5970b9d36cbddbb5c755c5f0bae788be51abe4f9.png -ophyd/_images/inheritance-5970b9d36cbddbb5c755c5f0bae788be51abe4f9.png.map -ophyd/_images/inheritance-5a622bdec20ce63c25d8c373388d172ce9d499e5.png -ophyd/_images/inheritance-5a622bdec20ce63c25d8c373388d172ce9d499e5.png.map -ophyd/_images/inheritance-77ecbb618f5cdbc91401d379f808279e6fa77e9a.png -ophyd/_images/inheritance-77ecbb618f5cdbc91401d379f808279e6fa77e9a.png.map -ophyd/_images/inheritance-93ab69f3c211deb5155033d05233120f5a03b15c.png -ophyd/_images/inheritance-93ab69f3c211deb5155033d05233120f5a03b15c.png.map -ophyd/_images/inheritance-9b988caf02abedc54423afddfe2feb0f3b822846.png -ophyd/_images/inheritance-9b988caf02abedc54423afddfe2feb0f3b822846.png.map -ophyd/_sources/OEP/OEP_001.rst.txt -ophyd/_sources/OEP/index.rst.txt -ophyd/_sources/api.rst.txt -ophyd/_sources/architecture.rst.txt -ophyd/_sources/area-detector.rst.txt -ophyd/_sources/builtin-devices.rst.txt -ophyd/_sources/debugging.rst.txt -ophyd/_sources/device-overview.rst.txt -ophyd/_sources/docker.rst.txt -ophyd/_sources/generated/ophyd.areadetector.base.ADBase.get_asyn_digraph.rst.txt -ophyd/_sources/generated/ophyd.areadetector.base.ADBase.get_asyn_port_dictionary.rst.txt -ophyd/_sources/generated/ophyd.areadetector.base.ADBase.get_plugin_by_asyn_port.rst.txt -ophyd/_sources/generated/ophyd.areadetector.base.ADBase.missing_plugins.rst.txt -ophyd/_sources/generated/ophyd.areadetector.base.ADBase.rst.txt -ophyd/_sources/generated/ophyd.areadetector.base.ADBase.validate_asyn_ports.rst.txt -ophyd/_sources/generated/ophyd.areadetector.base.ADBase.visualize_asyn_digraph.rst.txt -ophyd/_sources/generated/ophyd.areadetector.base.ADComponent.rst.txt -ophyd/_sources/generated/ophyd.areadetector.base.EpicsSignalWithRBV.rst.txt -ophyd/_sources/generated/ophyd.areadetector.base.ad_group.rst.txt -ophyd/_sources/generated/ophyd.areadetector.base.rst.txt -ophyd/_sources/generated/ophyd.areadetector.cam.AdscDetectorCam.rst.txt -ophyd/_sources/generated/ophyd.areadetector.cam.Andor3DetectorCam.rst.txt -ophyd/_sources/generated/ophyd.areadetector.cam.AndorDetectorCam.rst.txt -ophyd/_sources/generated/ophyd.areadetector.cam.BrukerDetectorCam.rst.txt -ophyd/_sources/generated/ophyd.areadetector.cam.CamBase.rst.txt -ophyd/_sources/generated/ophyd.areadetector.cam.FirewireLinDetectorCam.rst.txt -ophyd/_sources/generated/ophyd.areadetector.cam.FirewireWinDetectorCam.rst.txt -ophyd/_sources/generated/ophyd.areadetector.cam.LightFieldDetectorCam.rst.txt -ophyd/_sources/generated/ophyd.areadetector.cam.Mar345DetectorCam.rst.txt -ophyd/_sources/generated/ophyd.areadetector.cam.MarCCDDetectorCam.rst.txt -ophyd/_sources/generated/ophyd.areadetector.cam.PSLDetectorCam.rst.txt -ophyd/_sources/generated/ophyd.areadetector.cam.PcoDetectorCam.rst.txt -ophyd/_sources/generated/ophyd.areadetector.cam.PcoDetectorIO.rst.txt -ophyd/_sources/generated/ophyd.areadetector.cam.PcoDetectorSimIO.rst.txt -ophyd/_sources/generated/ophyd.areadetector.cam.PerkinElmerDetectorCam.rst.txt -ophyd/_sources/generated/ophyd.areadetector.cam.PilatusDetectorCam.rst.txt -ophyd/_sources/generated/ophyd.areadetector.cam.PixiradDetectorCam.rst.txt -ophyd/_sources/generated/ophyd.areadetector.cam.PointGreyDetectorCam.rst.txt -ophyd/_sources/generated/ophyd.areadetector.cam.ProsilicaDetectorCam.rst.txt -ophyd/_sources/generated/ophyd.areadetector.cam.PvcamDetectorCam.rst.txt -ophyd/_sources/generated/ophyd.areadetector.cam.RoperDetectorCam.rst.txt -ophyd/_sources/generated/ophyd.areadetector.cam.SimDetectorCam.rst.txt -ophyd/_sources/generated/ophyd.areadetector.cam.URLDetectorCam.rst.txt -ophyd/_sources/generated/ophyd.areadetector.cam.rst.txt -ophyd/_sources/generated/ophyd.areadetector.detectors.AdscDetector.rst.txt -ophyd/_sources/generated/ophyd.areadetector.detectors.Andor3Detector.rst.txt -ophyd/_sources/generated/ophyd.areadetector.detectors.AndorDetector.rst.txt -ophyd/_sources/generated/ophyd.areadetector.detectors.AreaDetector.rst.txt -ophyd/_sources/generated/ophyd.areadetector.detectors.BrukerDetector.rst.txt -ophyd/_sources/generated/ophyd.areadetector.detectors.DetectorBase.dispatch.rst.txt -ophyd/_sources/generated/ophyd.areadetector.detectors.DetectorBase.make_data_key.rst.txt -ophyd/_sources/generated/ophyd.areadetector.detectors.DetectorBase.rst.txt -ophyd/_sources/generated/ophyd.areadetector.detectors.FirewireLinDetector.rst.txt -ophyd/_sources/generated/ophyd.areadetector.detectors.FirewireWinDetector.rst.txt -ophyd/_sources/generated/ophyd.areadetector.detectors.LightFieldDetector.rst.txt -ophyd/_sources/generated/ophyd.areadetector.detectors.Mar345Detector.rst.txt -ophyd/_sources/generated/ophyd.areadetector.detectors.MarCCDDetector.rst.txt -ophyd/_sources/generated/ophyd.areadetector.detectors.PSLDetector.rst.txt -ophyd/_sources/generated/ophyd.areadetector.detectors.PerkinElmerDetector.rst.txt -ophyd/_sources/generated/ophyd.areadetector.detectors.PilatusDetector.rst.txt -ophyd/_sources/generated/ophyd.areadetector.detectors.PixiradDetector.rst.txt -ophyd/_sources/generated/ophyd.areadetector.detectors.PointGreyDetector.rst.txt -ophyd/_sources/generated/ophyd.areadetector.detectors.ProsilicaDetector.rst.txt -ophyd/_sources/generated/ophyd.areadetector.detectors.PvcamDetector.rst.txt -ophyd/_sources/generated/ophyd.areadetector.detectors.RoperDetector.rst.txt -ophyd/_sources/generated/ophyd.areadetector.detectors.SimDetector.rst.txt -ophyd/_sources/generated/ophyd.areadetector.detectors.URLDetector.rst.txt -ophyd/_sources/generated/ophyd.areadetector.detectors.rst.txt -ophyd/_sources/generated/ophyd.areadetector.docs.rst.txt -ophyd/_sources/generated/ophyd.areadetector.filestore_mixins.FileStoreBase.fs_root.rst.txt -ophyd/_sources/generated/ophyd.areadetector.filestore_mixins.FileStoreBase.generate_datum.rst.txt -ophyd/_sources/generated/ophyd.areadetector.filestore_mixins.FileStoreBase.read_path_template.rst.txt -ophyd/_sources/generated/ophyd.areadetector.filestore_mixins.FileStoreBase.reg_root.rst.txt -ophyd/_sources/generated/ophyd.areadetector.filestore_mixins.FileStoreBase.rst.txt -ophyd/_sources/generated/ophyd.areadetector.filestore_mixins.FileStoreBase.write_path_template.rst.txt -ophyd/_sources/generated/ophyd.areadetector.filestore_mixins.FileStoreHDF5.rst.txt -ophyd/_sources/generated/ophyd.areadetector.filestore_mixins.FileStoreHDF5IterativeWrite.rst.txt -ophyd/_sources/generated/ophyd.areadetector.filestore_mixins.FileStoreIterativeWrite.rst.txt -ophyd/_sources/generated/ophyd.areadetector.filestore_mixins.FileStorePluginBase.make_filename.rst.txt -ophyd/_sources/generated/ophyd.areadetector.filestore_mixins.FileStorePluginBase.rst.txt -ophyd/_sources/generated/ophyd.areadetector.filestore_mixins.FileStoreTIFF.rst.txt -ophyd/_sources/generated/ophyd.areadetector.filestore_mixins.FileStoreTIFFIterativeWrite.rst.txt -ophyd/_sources/generated/ophyd.areadetector.filestore_mixins.FileStoreTIFFSquashing.rst.txt -ophyd/_sources/generated/ophyd.areadetector.filestore_mixins.rst.txt -ophyd/_sources/generated/ophyd.areadetector.plugins.ColorConvPlugin.rst.txt -ophyd/_sources/generated/ophyd.areadetector.plugins.FilePlugin.rst.txt -ophyd/_sources/generated/ophyd.areadetector.plugins.HDF5Plugin.rst.txt -ophyd/_sources/generated/ophyd.areadetector.plugins.ImagePlugin.rst.txt -ophyd/_sources/generated/ophyd.areadetector.plugins.JPEGPlugin.rst.txt -ophyd/_sources/generated/ophyd.areadetector.plugins.MagickPlugin.rst.txt -ophyd/_sources/generated/ophyd.areadetector.plugins.NetCDFPlugin.rst.txt -ophyd/_sources/generated/ophyd.areadetector.plugins.NexusPlugin.rst.txt -ophyd/_sources/generated/ophyd.areadetector.plugins.OverlayPlugin.rst.txt -ophyd/_sources/generated/ophyd.areadetector.plugins.PluginBase.rst.txt -ophyd/_sources/generated/ophyd.areadetector.plugins.ProcessPlugin.rst.txt -ophyd/_sources/generated/ophyd.areadetector.plugins.ROIPlugin.rst.txt -ophyd/_sources/generated/ophyd.areadetector.plugins.StatsPlugin.rst.txt -ophyd/_sources/generated/ophyd.areadetector.plugins.TIFFPlugin.rst.txt -ophyd/_sources/generated/ophyd.areadetector.plugins.TransformPlugin.rst.txt -ophyd/_sources/generated/ophyd.areadetector.plugins.rst.txt -ophyd/_sources/generated/ophyd.areadetector.rst.txt -ophyd/_sources/generated/ophyd.areadetector.trigger_mixins.MultiTrigger.rst.txt -ophyd/_sources/generated/ophyd.areadetector.trigger_mixins.SingleTrigger.rst.txt -ophyd/_sources/generated/ophyd.areadetector.trigger_mixins.TriggerBase.rst.txt -ophyd/_sources/generated/ophyd.areadetector.trigger_mixins.rst.txt -ophyd/_sources/generated/ophyd.areadetector.util.rst.txt -ophyd/_sources/generated/ophyd.callbacks.rst.txt -ophyd/_sources/generated/ophyd.device.BlueskyInterface.describe.rst.txt -ophyd/_sources/generated/ophyd.device.BlueskyInterface.pause.rst.txt -ophyd/_sources/generated/ophyd.device.BlueskyInterface.read.rst.txt -ophyd/_sources/generated/ophyd.device.BlueskyInterface.resume.rst.txt -ophyd/_sources/generated/ophyd.device.BlueskyInterface.stage.rst.txt -ophyd/_sources/generated/ophyd.device.BlueskyInterface.trigger.rst.txt -ophyd/_sources/generated/ophyd.device.BlueskyInterface.unstage.rst.txt -ophyd/_sources/generated/ophyd.device.Component.rst.txt -ophyd/_sources/generated/ophyd.device.Device.configure.rst.txt -ophyd/_sources/generated/ophyd.device.Device.connected.rst.txt -ophyd/_sources/generated/ophyd.device.Device.describe_configuration.rst.txt -ophyd/_sources/generated/ophyd.device.Device.get.rst.txt -ophyd/_sources/generated/ophyd.device.Device.get_device_tuple.rst.txt -ophyd/_sources/generated/ophyd.device.Device.get_instantiated_signals.rst.txt -ophyd/_sources/generated/ophyd.device.Device.put.rst.txt -ophyd/_sources/generated/ophyd.device.Device.read_configuration.rst.txt -ophyd/_sources/generated/ophyd.device.Device.rst.txt -ophyd/_sources/generated/ophyd.device.Device.wait_for_connection.rst.txt -ophyd/_sources/generated/ophyd.device.DynamicDeviceComponent.rst.txt -ophyd/_sources/generated/ophyd.device.FormattedComponent.rst.txt -ophyd/_sources/generated/ophyd.device.rst.txt -ophyd/_sources/generated/ophyd.epics_motor.rst.txt -ophyd/_sources/generated/ophyd.flyers.FlyerInterface.collect.rst.txt -ophyd/_sources/generated/ophyd.flyers.FlyerInterface.complete.rst.txt -ophyd/_sources/generated/ophyd.flyers.FlyerInterface.describe_collect.rst.txt -ophyd/_sources/generated/ophyd.flyers.FlyerInterface.kickoff.rst.txt -ophyd/_sources/generated/ophyd.flyers.rst.txt -ophyd/_sources/generated/ophyd.mca.rst.txt -ophyd/_sources/generated/ophyd.mixins.rst.txt -ophyd/_sources/generated/ophyd.ophydobj.OphydObject._reset_sub.rst.txt -ophyd/_sources/generated/ophyd.ophydobj.OphydObject._run_subs.rst.txt -ophyd/_sources/generated/ophyd.ophydobj.OphydObject.clear_sub.rst.txt -ophyd/_sources/generated/ophyd.ophydobj.OphydObject.event_types.rst.txt -ophyd/_sources/generated/ophyd.ophydobj.OphydObject.name.rst.txt -ophyd/_sources/generated/ophyd.ophydobj.OphydObject.parent.rst.txt -ophyd/_sources/generated/ophyd.ophydobj.OphydObject.root.rst.txt -ophyd/_sources/generated/ophyd.ophydobj.OphydObject.rst.txt -ophyd/_sources/generated/ophyd.ophydobj.OphydObject.subscribe.rst.txt -ophyd/_sources/generated/ophyd.ophydobj.OphydObject.unsubscribe.rst.txt -ophyd/_sources/generated/ophyd.ophydobj.rst.txt -ophyd/_sources/generated/ophyd.positioner.PositionerBase.set.rst.txt -ophyd/_sources/generated/ophyd.positioner.PositionerBase.stop.rst.txt -ophyd/_sources/generated/ophyd.positioner.rst.txt -ophyd/_sources/generated/ophyd.pseudopos.rst.txt -ophyd/_sources/generated/ophyd.pv_positioner.rst.txt -ophyd/_sources/generated/ophyd.quadem.rst.txt -ophyd/_sources/generated/ophyd.rst.txt -ophyd/_sources/generated/ophyd.scaler.rst.txt -ophyd/_sources/generated/ophyd.signal.rst.txt -ophyd/_sources/generated/ophyd.status.rst.txt -ophyd/_sources/generated/ophyd.utils.epics_pvs.rst.txt -ophyd/_sources/generated/ophyd.utils.errors.rst.txt -ophyd/_sources/generated/ophyd.utils.paths.rst.txt -ophyd/_sources/generated/ophyd.utils.rst.txt -ophyd/_sources/generated/ophyd.utils.startup.rst.txt -ophyd/_sources/index.rst.txt -ophyd/_sources/positioners.rst.txt -ophyd/_sources/release_notes.rst.txt -ophyd/_sources/signals.rst.txt -ophyd/_sources/status.rst.txt -ophyd/_static/ajax-loader.gif -ophyd/_static/basic.css -ophyd/_static/comment-bright.png -ophyd/_static/comment-close.png -ophyd/_static/comment.png -ophyd/_static/css/badge_only.css -ophyd/_static/css/fonts/Roboto-Slab-Bold.woff -ophyd/_static/css/fonts/Roboto-Slab-Bold.woff2 -ophyd/_static/css/fonts/Roboto-Slab-Regular.woff -ophyd/_static/css/fonts/Roboto-Slab-Regular.woff2 -ophyd/_static/css/fonts/fontawesome-webfont.eot -ophyd/_static/css/fonts/fontawesome-webfont.svg -ophyd/_static/css/fonts/fontawesome-webfont.ttf -ophyd/_static/css/fonts/fontawesome-webfont.woff -ophyd/_static/css/fonts/fontawesome-webfont.woff2 -ophyd/_static/css/fonts/lato-bold-italic.woff -ophyd/_static/css/fonts/lato-bold-italic.woff2 -ophyd/_static/css/fonts/lato-bold.woff -ophyd/_static/css/fonts/lato-bold.woff2 -ophyd/_static/css/fonts/lato-normal-italic.woff -ophyd/_static/css/fonts/lato-normal-italic.woff2 -ophyd/_static/css/fonts/lato-normal.woff -ophyd/_static/css/fonts/lato-normal.woff2 -ophyd/_static/css/theme.css -ophyd/_static/doctools.js -ophyd/_static/down-pressed.png -ophyd/_static/down.png -ophyd/_static/file.png -ophyd/_static/fonts/FontAwesome.otf -ophyd/_static/fonts/Lato/lato-bold.eot -ophyd/_static/fonts/Lato/lato-bold.ttf -ophyd/_static/fonts/Lato/lato-bold.woff -ophyd/_static/fonts/Lato/lato-bold.woff2 -ophyd/_static/fonts/Lato/lato-bolditalic.eot -ophyd/_static/fonts/Lato/lato-bolditalic.ttf -ophyd/_static/fonts/Lato/lato-bolditalic.woff -ophyd/_static/fonts/Lato/lato-bolditalic.woff2 -ophyd/_static/fonts/Lato/lato-italic.eot -ophyd/_static/fonts/Lato/lato-italic.ttf -ophyd/_static/fonts/Lato/lato-italic.woff -ophyd/_static/fonts/Lato/lato-italic.woff2 -ophyd/_static/fonts/Lato/lato-regular.eot -ophyd/_static/fonts/Lato/lato-regular.ttf -ophyd/_static/fonts/Lato/lato-regular.woff -ophyd/_static/fonts/Lato/lato-regular.woff2 -ophyd/_static/fonts/Roboto-Slab-Bold.woff -ophyd/_static/fonts/Roboto-Slab-Bold.woff2 -ophyd/_static/fonts/Roboto-Slab-Light.woff -ophyd/_static/fonts/Roboto-Slab-Light.woff2 -ophyd/_static/fonts/Roboto-Slab-Regular.woff -ophyd/_static/fonts/Roboto-Slab-Regular.woff2 -ophyd/_static/fonts/Roboto-Slab-Thin.woff -ophyd/_static/fonts/Roboto-Slab-Thin.woff2 -ophyd/_static/fonts/RobotoSlab/roboto-slab-v7-bold.eot -ophyd/_static/fonts/RobotoSlab/roboto-slab-v7-bold.ttf -ophyd/_static/fonts/RobotoSlab/roboto-slab-v7-bold.woff -ophyd/_static/fonts/RobotoSlab/roboto-slab-v7-bold.woff2 -ophyd/_static/fonts/RobotoSlab/roboto-slab-v7-regular.eot -ophyd/_static/fonts/RobotoSlab/roboto-slab-v7-regular.ttf -ophyd/_static/fonts/RobotoSlab/roboto-slab-v7-regular.woff -ophyd/_static/fonts/RobotoSlab/roboto-slab-v7-regular.woff2 -ophyd/_static/fonts/fontawesome-webfont.eot -ophyd/_static/fonts/fontawesome-webfont.svg -ophyd/_static/fonts/fontawesome-webfont.ttf -ophyd/_static/fonts/fontawesome-webfont.woff -ophyd/_static/fonts/fontawesome-webfont.woff2 -ophyd/_static/fonts/lato-bold-italic.woff -ophyd/_static/fonts/lato-bold-italic.woff2 -ophyd/_static/fonts/lato-bold.woff -ophyd/_static/fonts/lato-bold.woff2 -ophyd/_static/fonts/lato-normal-italic.woff -ophyd/_static/fonts/lato-normal-italic.woff2 -ophyd/_static/fonts/lato-normal.woff -ophyd/_static/fonts/lato-normal.woff2 -ophyd/_static/jquery-3.2.1.js -ophyd/_static/jquery.js -ophyd/_static/js/badge_only.js -ophyd/_static/js/html5shiv-printshiv.min.js -ophyd/_static/js/html5shiv.min.js -ophyd/_static/js/modernizr.min.js -ophyd/_static/js/theme.js -ophyd/_static/minus.png -ophyd/_static/plus.png -ophyd/_static/pygments.css -ophyd/_static/searchtools.js -ophyd/_static/underscore-1.3.1.js -ophyd/_static/underscore.js -ophyd/_static/up-pressed.png -ophyd/_static/up.png -ophyd/_static/websupport.js -ophyd/api.html -ophyd/architecture.html -ophyd/area-detector.html -ophyd/builtin-devices.html -ophyd/debugging.html -ophyd/device-overview.html -ophyd/docker.html -ophyd/generated/ophyd.areadetector.base.ADBase.get_asyn_digraph.html -ophyd/generated/ophyd.areadetector.base.ADBase.get_asyn_port_dictionary.html -ophyd/generated/ophyd.areadetector.base.ADBase.get_plugin_by_asyn_port.html -ophyd/generated/ophyd.areadetector.base.ADBase.html -ophyd/generated/ophyd.areadetector.base.ADBase.missing_plugins.html -ophyd/generated/ophyd.areadetector.base.ADBase.validate_asyn_ports.html -ophyd/generated/ophyd.areadetector.base.ADBase.visualize_asyn_digraph.html -ophyd/generated/ophyd.areadetector.base.ADComponent.html -ophyd/generated/ophyd.areadetector.base.EpicsSignalWithRBV.html -ophyd/generated/ophyd.areadetector.base.ad_group.html -ophyd/generated/ophyd.areadetector.base.html -ophyd/generated/ophyd.areadetector.cam.AdscDetectorCam.html -ophyd/generated/ophyd.areadetector.cam.Andor3DetectorCam.html -ophyd/generated/ophyd.areadetector.cam.AndorDetectorCam.html -ophyd/generated/ophyd.areadetector.cam.BrukerDetectorCam.html -ophyd/generated/ophyd.areadetector.cam.CamBase.html -ophyd/generated/ophyd.areadetector.cam.FirewireLinDetectorCam.html -ophyd/generated/ophyd.areadetector.cam.FirewireWinDetectorCam.html -ophyd/generated/ophyd.areadetector.cam.LightFieldDetectorCam.html -ophyd/generated/ophyd.areadetector.cam.Mar345DetectorCam.html -ophyd/generated/ophyd.areadetector.cam.MarCCDDetectorCam.html -ophyd/generated/ophyd.areadetector.cam.PSLDetectorCam.html -ophyd/generated/ophyd.areadetector.cam.PcoDetectorCam.html -ophyd/generated/ophyd.areadetector.cam.PcoDetectorIO.html -ophyd/generated/ophyd.areadetector.cam.PcoDetectorSimIO.html -ophyd/generated/ophyd.areadetector.cam.PerkinElmerDetectorCam.html -ophyd/generated/ophyd.areadetector.cam.PilatusDetectorCam.html -ophyd/generated/ophyd.areadetector.cam.PixiradDetectorCam.html -ophyd/generated/ophyd.areadetector.cam.PointGreyDetectorCam.html -ophyd/generated/ophyd.areadetector.cam.ProsilicaDetectorCam.html -ophyd/generated/ophyd.areadetector.cam.PvcamDetectorCam.html -ophyd/generated/ophyd.areadetector.cam.RoperDetectorCam.html -ophyd/generated/ophyd.areadetector.cam.SimDetectorCam.html -ophyd/generated/ophyd.areadetector.cam.URLDetectorCam.html -ophyd/generated/ophyd.areadetector.cam.html -ophyd/generated/ophyd.areadetector.detectors.AdscDetector.html -ophyd/generated/ophyd.areadetector.detectors.Andor3Detector.html -ophyd/generated/ophyd.areadetector.detectors.AndorDetector.html -ophyd/generated/ophyd.areadetector.detectors.AreaDetector.html -ophyd/generated/ophyd.areadetector.detectors.BrukerDetector.html -ophyd/generated/ophyd.areadetector.detectors.DetectorBase.dispatch.html -ophyd/generated/ophyd.areadetector.detectors.DetectorBase.html -ophyd/generated/ophyd.areadetector.detectors.DetectorBase.make_data_key.html -ophyd/generated/ophyd.areadetector.detectors.FirewireLinDetector.html -ophyd/generated/ophyd.areadetector.detectors.FirewireWinDetector.html -ophyd/generated/ophyd.areadetector.detectors.LightFieldDetector.html -ophyd/generated/ophyd.areadetector.detectors.Mar345Detector.html -ophyd/generated/ophyd.areadetector.detectors.MarCCDDetector.html -ophyd/generated/ophyd.areadetector.detectors.PSLDetector.html -ophyd/generated/ophyd.areadetector.detectors.PerkinElmerDetector.html -ophyd/generated/ophyd.areadetector.detectors.PilatusDetector.html -ophyd/generated/ophyd.areadetector.detectors.PixiradDetector.html -ophyd/generated/ophyd.areadetector.detectors.PointGreyDetector.html -ophyd/generated/ophyd.areadetector.detectors.ProsilicaDetector.html -ophyd/generated/ophyd.areadetector.detectors.PvcamDetector.html -ophyd/generated/ophyd.areadetector.detectors.RoperDetector.html -ophyd/generated/ophyd.areadetector.detectors.SimDetector.html -ophyd/generated/ophyd.areadetector.detectors.URLDetector.html -ophyd/generated/ophyd.areadetector.detectors.html -ophyd/generated/ophyd.areadetector.docs.html -ophyd/generated/ophyd.areadetector.filestore_mixins.FileStoreBase.fs_root.html -ophyd/generated/ophyd.areadetector.filestore_mixins.FileStoreBase.generate_datum.html -ophyd/generated/ophyd.areadetector.filestore_mixins.FileStoreBase.html -ophyd/generated/ophyd.areadetector.filestore_mixins.FileStoreBase.read_path_template.html -ophyd/generated/ophyd.areadetector.filestore_mixins.FileStoreBase.reg_root.html -ophyd/generated/ophyd.areadetector.filestore_mixins.FileStoreBase.write_path_template.html -ophyd/generated/ophyd.areadetector.filestore_mixins.FileStoreHDF5.html -ophyd/generated/ophyd.areadetector.filestore_mixins.FileStoreHDF5IterativeWrite.html -ophyd/generated/ophyd.areadetector.filestore_mixins.FileStoreIterativeWrite.html -ophyd/generated/ophyd.areadetector.filestore_mixins.FileStorePluginBase.html -ophyd/generated/ophyd.areadetector.filestore_mixins.FileStorePluginBase.make_filename.html -ophyd/generated/ophyd.areadetector.filestore_mixins.FileStoreTIFF.html -ophyd/generated/ophyd.areadetector.filestore_mixins.FileStoreTIFFIterativeWrite.html -ophyd/generated/ophyd.areadetector.filestore_mixins.FileStoreTIFFSquashing.html -ophyd/generated/ophyd.areadetector.filestore_mixins.html -ophyd/generated/ophyd.areadetector.html -ophyd/generated/ophyd.areadetector.plugins.ColorConvPlugin.html -ophyd/generated/ophyd.areadetector.plugins.FilePlugin.html -ophyd/generated/ophyd.areadetector.plugins.HDF5Plugin.html -ophyd/generated/ophyd.areadetector.plugins.ImagePlugin.html -ophyd/generated/ophyd.areadetector.plugins.JPEGPlugin.html -ophyd/generated/ophyd.areadetector.plugins.MagickPlugin.html -ophyd/generated/ophyd.areadetector.plugins.NetCDFPlugin.html -ophyd/generated/ophyd.areadetector.plugins.NexusPlugin.html -ophyd/generated/ophyd.areadetector.plugins.OverlayPlugin.html -ophyd/generated/ophyd.areadetector.plugins.PluginBase.html -ophyd/generated/ophyd.areadetector.plugins.ProcessPlugin.html -ophyd/generated/ophyd.areadetector.plugins.ROIPlugin.html -ophyd/generated/ophyd.areadetector.plugins.StatsPlugin.html -ophyd/generated/ophyd.areadetector.plugins.TIFFPlugin.html -ophyd/generated/ophyd.areadetector.plugins.TransformPlugin.html -ophyd/generated/ophyd.areadetector.plugins.html -ophyd/generated/ophyd.areadetector.trigger_mixins.MultiTrigger.html -ophyd/generated/ophyd.areadetector.trigger_mixins.SingleTrigger.html -ophyd/generated/ophyd.areadetector.trigger_mixins.TriggerBase.html -ophyd/generated/ophyd.areadetector.trigger_mixins.html -ophyd/generated/ophyd.areadetector.util.html -ophyd/generated/ophyd.callbacks.html -ophyd/generated/ophyd.device.BlueskyInterface.describe.html -ophyd/generated/ophyd.device.BlueskyInterface.pause.html -ophyd/generated/ophyd.device.BlueskyInterface.read.html -ophyd/generated/ophyd.device.BlueskyInterface.resume.html -ophyd/generated/ophyd.device.BlueskyInterface.stage.html -ophyd/generated/ophyd.device.BlueskyInterface.trigger.html -ophyd/generated/ophyd.device.BlueskyInterface.unstage.html -ophyd/generated/ophyd.device.Component.html -ophyd/generated/ophyd.device.Device.configure.html -ophyd/generated/ophyd.device.Device.connected.html -ophyd/generated/ophyd.device.Device.describe_configuration.html -ophyd/generated/ophyd.device.Device.get.html -ophyd/generated/ophyd.device.Device.get_device_tuple.html -ophyd/generated/ophyd.device.Device.get_instantiated_signals.html -ophyd/generated/ophyd.device.Device.html -ophyd/generated/ophyd.device.Device.put.html -ophyd/generated/ophyd.device.Device.read_configuration.html -ophyd/generated/ophyd.device.Device.wait_for_connection.html -ophyd/generated/ophyd.device.DynamicDeviceComponent.html -ophyd/generated/ophyd.device.FormattedComponent.html -ophyd/generated/ophyd.device.html -ophyd/generated/ophyd.epics_motor.html -ophyd/generated/ophyd.flyers.FlyerInterface.collect.html -ophyd/generated/ophyd.flyers.FlyerInterface.complete.html -ophyd/generated/ophyd.flyers.FlyerInterface.describe_collect.html -ophyd/generated/ophyd.flyers.FlyerInterface.kickoff.html -ophyd/generated/ophyd.flyers.html -ophyd/generated/ophyd.html -ophyd/generated/ophyd.mca.html -ophyd/generated/ophyd.mixins.html -ophyd/generated/ophyd.ophydobj.OphydObject._reset_sub.html -ophyd/generated/ophyd.ophydobj.OphydObject._run_subs.html -ophyd/generated/ophyd.ophydobj.OphydObject.clear_sub.html -ophyd/generated/ophyd.ophydobj.OphydObject.event_types.html -ophyd/generated/ophyd.ophydobj.OphydObject.html -ophyd/generated/ophyd.ophydobj.OphydObject.name.html -ophyd/generated/ophyd.ophydobj.OphydObject.parent.html -ophyd/generated/ophyd.ophydobj.OphydObject.root.html -ophyd/generated/ophyd.ophydobj.OphydObject.subscribe.html -ophyd/generated/ophyd.ophydobj.OphydObject.unsubscribe.html -ophyd/generated/ophyd.ophydobj.html -ophyd/generated/ophyd.positioner.PositionerBase.set.html -ophyd/generated/ophyd.positioner.PositionerBase.stop.html -ophyd/generated/ophyd.positioner.html -ophyd/generated/ophyd.pseudopos.html -ophyd/generated/ophyd.pv_positioner.html -ophyd/generated/ophyd.quadem.html -ophyd/generated/ophyd.scaler.html -ophyd/generated/ophyd.signal.html -ophyd/generated/ophyd.status.html -ophyd/generated/ophyd.utils.epics_pvs.html -ophyd/generated/ophyd.utils.errors.html -ophyd/generated/ophyd.utils.html -ophyd/generated/ophyd.utils.paths.html -ophyd/generated/ophyd.utils.startup.html -ophyd/genindex.html -ophyd/index.html -ophyd/objects.inv -ophyd/positioners.html -ophyd/py-modindex.html -ophyd/release_notes.html -ophyd/search.html -ophyd/searchindex.js -ophyd/signals.html -ophyd/status.html \ No newline at end of file diff --git a/ophyd/OEP/OEP_001.html b/ophyd/OEP/OEP_001.html deleted file mode 100644 index 0cd514c571..0000000000 --- a/ophyd/OEP/OEP_001.html +++ /dev/null @@ -1,322 +0,0 @@ - - - - - - - - - - OEP 1 : AD refactor/unification — ophyd documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - -
- - - - - -
- -
- - - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

OEP 1 : AD refactor/unification

- -
-

Status

-

Discussion

-
- -
-

Abstract

-

Merge the two AreaDetector implementations.

-
-
-

Detailed description

-
-

Requirements

-
-
    -
  • support full BlueSky API
  • -
  • interact with filestore (may be super-ceded by FS integration at c-level)
  • -
  • provide access to all PVs and plugins on the EPICS layer area -detector -- set up AD pipelines -- frame squashing
  • -
  • be able to change at run-time what is inserted into the result of -read (ex, just return ROI values without saving full data)
  • -
  • deal with dark-frames
  • -
  • ‘frequency’ attribute to set acquire time
  • -
-
-
-
- -
-

Backward compatibility

-

None, break all the things

-
-
-

Alternatives

-

Status quo

-
-
- - -
- -
- - -
-
- -
- -
- - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/OEP/index.html b/ophyd/OEP/index.html deleted file mode 100644 index 2166e7518b..0000000000 --- a/ophyd/OEP/index.html +++ /dev/null @@ -1,252 +0,0 @@ - - - - - - - - - - Ophyd Enhancement Proposals — ophyd documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - -
- - - - - -
- -
- - - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

Ophyd Enhancement Proposals

- -
- - -
- -
- - -
-
- -
- -
- - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_as_gen/ophyd.areadetector.base.ADBase.get_asyn_digraph.html b/ophyd/_as_gen/ophyd.areadetector.base.ADBase.get_asyn_digraph.html deleted file mode 100644 index cb831673e7..0000000000 --- a/ophyd/_as_gen/ophyd.areadetector.base.ADBase.get_asyn_digraph.html +++ /dev/null @@ -1,297 +0,0 @@ - - - - - - - - - - - ophyd.areadetector.base.ADBase.get_asyn_digraph — ophyd documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
-
- - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

ophyd.areadetector.base.ADBase.get_asyn_digraph

-
-
-ADBase.get_asyn_digraph()
-

Get the directed graph of the ASYN ports

- --- - - - -
Returns:

G : networkx.DiGraph

-
-

Directed graph of pipelines

-
-

port_map : dict

-
-

Mapping between port_name and ADBase objects

-
-
-
- -
- - -
-
- -
-
- - -
-
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_as_gen/ophyd.areadetector.base.ADBase.get_asyn_port_dictionary.html b/ophyd/_as_gen/ophyd.areadetector.base.ADBase.get_asyn_port_dictionary.html deleted file mode 100644 index 9bf048a36f..0000000000 --- a/ophyd/_as_gen/ophyd.areadetector.base.ADBase.get_asyn_port_dictionary.html +++ /dev/null @@ -1,293 +0,0 @@ - - - - - - - - - - - ophyd.areadetector.base.ADBase.get_asyn_port_dictionary — ophyd documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
-
- - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

ophyd.areadetector.base.ADBase.get_asyn_port_dictionary

-
-
-ADBase.get_asyn_port_dictionary()
-

Return port name : component map

- --- - - - -
Returns:

port_map : dict

-
-

Mapping between port_name and ADBase objects

-
-
-
- -
- - -
-
- -
-
- - -
-
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_as_gen/ophyd.areadetector.base.ADBase.get_plugin_by_asyn_port.html b/ophyd/_as_gen/ophyd.areadetector.base.ADBase.get_plugin_by_asyn_port.html deleted file mode 100644 index 0668021302..0000000000 --- a/ophyd/_as_gen/ophyd.areadetector.base.ADBase.get_plugin_by_asyn_port.html +++ /dev/null @@ -1,299 +0,0 @@ - - - - - - - - - - - ophyd.areadetector.base.ADBase.get_plugin_by_asyn_port — ophyd documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
-
- - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

ophyd.areadetector.base.ADBase.get_plugin_by_asyn_port

-
-
-ADBase.get_plugin_by_asyn_port(port_name)
-

Get the plugin which has the given asyn port name

- --- - - - - - -
Parameters:

port_name : str

-
-

The port name to search for

-
-
Returns:

ret : ADBase or None

-
-

Either the requested plugin or None if not found

-
-
-
- -
- - -
-
- -
-
- - -
-
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_as_gen/ophyd.areadetector.base.ADBase.html b/ophyd/_as_gen/ophyd.areadetector.base.ADBase.html deleted file mode 100644 index e117226200..0000000000 --- a/ophyd/_as_gen/ophyd.areadetector.base.ADBase.html +++ /dev/null @@ -1,380 +0,0 @@ - - - - - - - - - - - ophyd.areadetector.base.ADBase — ophyd documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
-
- - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

ophyd.areadetector.base.ADBase

-
-
-class ophyd.areadetector.base.ADBase(prefix='', *, name, read_attrs=None, configuration_attrs=None, parent=None, **kwargs)
-

The AreaDetector base class

-

This serves as the base for all detectors and plugins

-
-
-__init__(prefix='', *, name, read_attrs=None, configuration_attrs=None, parent=None, **kwargs)
-
- -

Methods

- ---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
__init__([prefix, read_attrs, …])
check_value(value, **kwargs)Check if the value is valid for this object
clear_sub(cb[, event_type])Remove a subscription, given the original callback function
configure((d: typing.Dict[str, …)Configure the device for something during a run
describe(…)Provide schema and meta-data for read()
describe_configuration(…)Provide schema & meta-data for read_configuration()
find_signal(text[, use_re, case_sensitive, …])Search through the signal docs on this detector for the string text
get(**kwargs)Get the value of all components in the device
get_asyn_digraph()Get the directed graph of the ASYN ports
get_asyn_port_dictionary()Return port name : component map
get_device_tuple()The device tuple type associated with an Device class
get_instantiated_signals(*[, attr_prefix])Yields all of the instantiated signals in a device hierarchy
get_plugin_by_asyn_port(port_name)Get the plugin which has the given asyn port name
missing_plugins()Find missing ports
pause(() -> None)Attempt to ‘pause’ the device.
put(dev_t, **kwargs)Put a value to all components of the device
read(() -> ophyd.device.OrderedDictType[str, …)Read data from the device
read_configuration(…)returns dictionary mapping names to (value, timestamp) pairs
resume(() -> None)Resume a device from a ‘paused’ state
stage(*args, **kwargs)
stop(*[, success])Stop the Device and all (instantiated) subdevices
subscribe(cb[, event_type, run])Subscribe to events this event_type generates.
summary()
trigger(() -> ophyd.status.StatusBase)Trigger the device and return status object
unstage(() -> typing.List[object])Unstage the device.
unsubscribe(cid)Remove a subscription
validate_asyn_ports()Validate that all components of pipeline are known
wait_for_connection([all_signals, timeout])Wait for signals to connect
-
- -
- - -
-
- -
-
- - -
-
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_as_gen/ophyd.areadetector.base.ADBase.missing_plugins.html b/ophyd/_as_gen/ophyd.areadetector.base.ADBase.missing_plugins.html deleted file mode 100644 index bfac7e5fc5..0000000000 --- a/ophyd/_as_gen/ophyd.areadetector.base.ADBase.missing_plugins.html +++ /dev/null @@ -1,281 +0,0 @@ - - - - - - - - - - - ophyd.areadetector.base.ADBase.missing_plugins — ophyd documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
-
- - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

ophyd.areadetector.base.ADBase.missing_plugins

-
-
-ADBase.missing_plugins()
-

Find missing ports

-
- -
- - -
-
- -
-
- - -
-
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_as_gen/ophyd.areadetector.base.ADBase.validate_asyn_ports.html b/ophyd/_as_gen/ophyd.areadetector.base.ADBase.validate_asyn_ports.html deleted file mode 100644 index f6b70433fb..0000000000 --- a/ophyd/_as_gen/ophyd.areadetector.base.ADBase.validate_asyn_ports.html +++ /dev/null @@ -1,294 +0,0 @@ - - - - - - - - - - - ophyd.areadetector.base.ADBase.validate_asyn_ports — ophyd documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
-
- - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

ophyd.areadetector.base.ADBase.validate_asyn_ports

-
-
-ADBase.validate_asyn_ports()
-

Validate that all components of pipeline are known

- --- - - - -
Raises:

RuntimeError

-
-

If there any input ports to known plugins where the source is -not known to ophyd

-
-
-
- -
- - -
-
- -
-
- - -
-
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_as_gen/ophyd.areadetector.base.ADComponent.html b/ophyd/_as_gen/ophyd.areadetector.base.ADComponent.html deleted file mode 100644 index b47d4fb285..0000000000 --- a/ophyd/_as_gen/ophyd.areadetector.base.ADComponent.html +++ /dev/null @@ -1,306 +0,0 @@ - - - - - - - - - - - ophyd.areadetector.base.ADComponent — ophyd documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
-
- - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

ophyd.areadetector.base.ADComponent

-
-
-class ophyd.areadetector.base.ADComponent(cls, suffix, **kwargs)
-
-
-__init__(cls, suffix, **kwargs)
-
- -

Methods

- ---- - - - - - - - - - - - - - - - - - -
__init__(cls, suffix, **kwargs)
create_component(instance)Create a component for the instance
find_docs(parent_class)Find all the documentation related to this class, all the way up the
make_docstring(parent_class)Create a docstring for the component, given the parent class
maybe_add_prefix(instance, kw, suffix)Add prefix to a suffix if kw is in self.add_prefix
-
- -
- - -
-
- -
-
- - -
-
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_as_gen/ophyd.areadetector.base.EpicsSignalWithRBV.html b/ophyd/_as_gen/ophyd.areadetector.base.EpicsSignalWithRBV.html deleted file mode 100644 index 92fc7dd85a..0000000000 --- a/ophyd/_as_gen/ophyd.areadetector.base.EpicsSignalWithRBV.html +++ /dev/null @@ -1,336 +0,0 @@ - - - - - - - - - - - ophyd.areadetector.base.EpicsSignalWithRBV — ophyd documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
-
- - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

ophyd.areadetector.base.EpicsSignalWithRBV

-
-
-class ophyd.areadetector.base.EpicsSignalWithRBV(prefix, **kwargs)
-
-
-__init__(prefix, **kwargs)
-
- -

Methods

- ---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
__init__(prefix, **kwargs)
check_value(value)Check if the value is within the setpoint PV’s control limits
clear_sub(cb[, event_type])Remove a subscription, given the original callback function
describe()Return the description as a dictionary
describe_configuration()Subclasses may customize this.
get(*[, as_string, connection_timeout])Get the readback value through an explicit call to EPICS
get_setpoint(**kwargs)Get the setpoint value (use only if the setpoint PV and the readback
put(value[, force, connection_timeout, …])Using channel access, set the write PV to value.
read()Read the signal and format for data collection
read_configuration()Subclasses may customize this.
set(value, *[, timeout, settle_time])Set is like EpicsSignal.put, but is here for bluesky compatibility
subscribe(callback[, event_type, run])
trigger()Call that is used by bluesky prior to read()
unsubscribe(cid)Remove a subscription
wait_for_connection([timeout])
-
- -
- - -
-
- -
-
- - -
-
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_as_gen/ophyd.areadetector.base.ad_group.html b/ophyd/_as_gen/ophyd.areadetector.base.ad_group.html deleted file mode 100644 index ae83bc0b79..0000000000 --- a/ophyd/_as_gen/ophyd.areadetector.base.ad_group.html +++ /dev/null @@ -1,278 +0,0 @@ - - - - - - - - - - - ophyd.areadetector.base.ad_group — ophyd documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
-
- - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

ophyd.areadetector.base.ad_group

-
-
-ophyd.areadetector.base.ad_group(cls, attr_suffix, **kwargs)
-

Definition creation for groups of signals in areadetectors

-
- -
- - -
-
- -
-
- - -
-
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_as_gen/ophyd.areadetector.base.html b/ophyd/_as_gen/ophyd.areadetector.base.html deleted file mode 100644 index b3e8539a78..0000000000 --- a/ophyd/_as_gen/ophyd.areadetector.base.html +++ /dev/null @@ -1,319 +0,0 @@ - - - - - - - - - - - ophyd.areadetector.base — ophyd documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
-
- - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

ophyd.areadetector.base

-

Functions

- ---- - - - - - -
ad_group(cls, attr_suffix, **kwargs)Definition creation for groups of signals in areadetectors
-

Classes

- ---- - - - - - - - - - - - -
ADBase([prefix, read_attrs, …])The AreaDetector base class
ADComponent(cls, suffix, **kwargs)
EpicsSignalWithRBV(prefix, **kwargs)
-
- - -
-
- -
-
- - -
-
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_as_gen/ophyd.areadetector.cam.AdscDetectorCam.html b/ophyd/_as_gen/ophyd.areadetector.cam.AdscDetectorCam.html deleted file mode 100644 index 01ad7fc25a..0000000000 --- a/ophyd/_as_gen/ophyd.areadetector.cam.AdscDetectorCam.html +++ /dev/null @@ -1,418 +0,0 @@ - - - - - - - - - - - ophyd.areadetector.cam.AdscDetectorCam — ophyd documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
-
- - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

ophyd.areadetector.cam.AdscDetectorCam

-
-
-class ophyd.areadetector.cam.AdscDetectorCam(prefix='', *, name, read_attrs=None, configuration_attrs=None, parent=None, **kwargs)
-
-
-__init__(prefix='', *, name, read_attrs=None, configuration_attrs=None, parent=None, **kwargs)
-
- -

Methods

- ---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
__init__([prefix, read_attrs, …])
check_value(value, **kwargs)Check if the value is valid for this object
clear_sub(cb[, event_type])Remove a subscription, given the original callback function
configure((d: typing.Dict[str, …)Configure the device for something during a run
describe(…)Provide schema and meta-data for read()
describe_configuration(…)Provide schema & meta-data for read_configuration()
find_signal(text[, use_re, case_sensitive, …])Search through the signal docs on this detector for the string text
get(**kwargs)Get the value of all components in the device
get_asyn_digraph()Get the directed graph of the ASYN ports
get_asyn_port_dictionary()Return port name : component map
get_device_tuple()The device tuple type associated with an Device class
get_instantiated_signals(*[, attr_prefix])Yields all of the instantiated signals in a device hierarchy
get_plugin_by_asyn_port(port_name)Get the plugin which has the given asyn port name
missing_plugins()Find missing ports
pause(() -> None)Attempt to ‘pause’ the device.
put(dev_t, **kwargs)Put a value to all components of the device
read(() -> ophyd.device.OrderedDictType[str, …)Read data from the device
read_configuration(…)returns dictionary mapping names to (value, timestamp) pairs
resume(() -> None)Resume a device from a ‘paused’ state
stage(*args, **kwargs)
stop(*[, success])Stop the Device and all (instantiated) subdevices
subscribe(cb[, event_type, run])Subscribe to events this event_type generates.
summary()
trigger(() -> ophyd.status.StatusBase)Trigger the device and return status object
unstage(() -> typing.List[object])Unstage the device.
unsubscribe(cid)Remove a subscription
validate_asyn_ports()Validate that all components of pipeline are known
wait_for_connection([all_signals, timeout])Wait for signals to connect
-
- -
- - -
-
- -
-
- - -
-
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_as_gen/ophyd.areadetector.cam.Andor3DetectorCam.html b/ophyd/_as_gen/ophyd.areadetector.cam.Andor3DetectorCam.html deleted file mode 100644 index 832c5466f3..0000000000 --- a/ophyd/_as_gen/ophyd.areadetector.cam.Andor3DetectorCam.html +++ /dev/null @@ -1,418 +0,0 @@ - - - - - - - - - - - ophyd.areadetector.cam.Andor3DetectorCam — ophyd documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
-
- - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

ophyd.areadetector.cam.Andor3DetectorCam

-
-
-class ophyd.areadetector.cam.Andor3DetectorCam(prefix='', *, name, read_attrs=None, configuration_attrs=None, parent=None, **kwargs)
-
-
-__init__(prefix='', *, name, read_attrs=None, configuration_attrs=None, parent=None, **kwargs)
-
- -

Methods

- ---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
__init__([prefix, read_attrs, …])
check_value(value, **kwargs)Check if the value is valid for this object
clear_sub(cb[, event_type])Remove a subscription, given the original callback function
configure((d: typing.Dict[str, …)Configure the device for something during a run
describe(…)Provide schema and meta-data for read()
describe_configuration(…)Provide schema & meta-data for read_configuration()
find_signal(text[, use_re, case_sensitive, …])Search through the signal docs on this detector for the string text
get(**kwargs)Get the value of all components in the device
get_asyn_digraph()Get the directed graph of the ASYN ports
get_asyn_port_dictionary()Return port name : component map
get_device_tuple()The device tuple type associated with an Device class
get_instantiated_signals(*[, attr_prefix])Yields all of the instantiated signals in a device hierarchy
get_plugin_by_asyn_port(port_name)Get the plugin which has the given asyn port name
missing_plugins()Find missing ports
pause(() -> None)Attempt to ‘pause’ the device.
put(dev_t, **kwargs)Put a value to all components of the device
read(() -> ophyd.device.OrderedDictType[str, …)Read data from the device
read_configuration(…)returns dictionary mapping names to (value, timestamp) pairs
resume(() -> None)Resume a device from a ‘paused’ state
stage(*args, **kwargs)
stop(*[, success])Stop the Device and all (instantiated) subdevices
subscribe(cb[, event_type, run])Subscribe to events this event_type generates.
summary()
trigger(() -> ophyd.status.StatusBase)Trigger the device and return status object
unstage(() -> typing.List[object])Unstage the device.
unsubscribe(cid)Remove a subscription
validate_asyn_ports()Validate that all components of pipeline are known
wait_for_connection([all_signals, timeout])Wait for signals to connect
-
- -
- - -
-
- -
-
- - -
-
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_as_gen/ophyd.areadetector.cam.AndorDetectorCam.html b/ophyd/_as_gen/ophyd.areadetector.cam.AndorDetectorCam.html deleted file mode 100644 index aa488443a0..0000000000 --- a/ophyd/_as_gen/ophyd.areadetector.cam.AndorDetectorCam.html +++ /dev/null @@ -1,418 +0,0 @@ - - - - - - - - - - - ophyd.areadetector.cam.AndorDetectorCam — ophyd documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
-
- - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

ophyd.areadetector.cam.AndorDetectorCam

-
-
-class ophyd.areadetector.cam.AndorDetectorCam(prefix='', *, name, read_attrs=None, configuration_attrs=None, parent=None, **kwargs)
-
-
-__init__(prefix='', *, name, read_attrs=None, configuration_attrs=None, parent=None, **kwargs)
-
- -

Methods

- ---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
__init__([prefix, read_attrs, …])
check_value(value, **kwargs)Check if the value is valid for this object
clear_sub(cb[, event_type])Remove a subscription, given the original callback function
configure((d: typing.Dict[str, …)Configure the device for something during a run
describe(…)Provide schema and meta-data for read()
describe_configuration(…)Provide schema & meta-data for read_configuration()
find_signal(text[, use_re, case_sensitive, …])Search through the signal docs on this detector for the string text
get(**kwargs)Get the value of all components in the device
get_asyn_digraph()Get the directed graph of the ASYN ports
get_asyn_port_dictionary()Return port name : component map
get_device_tuple()The device tuple type associated with an Device class
get_instantiated_signals(*[, attr_prefix])Yields all of the instantiated signals in a device hierarchy
get_plugin_by_asyn_port(port_name)Get the plugin which has the given asyn port name
missing_plugins()Find missing ports
pause(() -> None)Attempt to ‘pause’ the device.
put(dev_t, **kwargs)Put a value to all components of the device
read(() -> ophyd.device.OrderedDictType[str, …)Read data from the device
read_configuration(…)returns dictionary mapping names to (value, timestamp) pairs
resume(() -> None)Resume a device from a ‘paused’ state
stage(*args, **kwargs)
stop(*[, success])Stop the Device and all (instantiated) subdevices
subscribe(cb[, event_type, run])Subscribe to events this event_type generates.
summary()
trigger(() -> ophyd.status.StatusBase)Trigger the device and return status object
unstage(() -> typing.List[object])Unstage the device.
unsubscribe(cid)Remove a subscription
validate_asyn_ports()Validate that all components of pipeline are known
wait_for_connection([all_signals, timeout])Wait for signals to connect
-
- -
- - -
-
- -
-
- - -
-
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_as_gen/ophyd.areadetector.cam.BrukerDetectorCam.html b/ophyd/_as_gen/ophyd.areadetector.cam.BrukerDetectorCam.html deleted file mode 100644 index 2f0fd37382..0000000000 --- a/ophyd/_as_gen/ophyd.areadetector.cam.BrukerDetectorCam.html +++ /dev/null @@ -1,418 +0,0 @@ - - - - - - - - - - - ophyd.areadetector.cam.BrukerDetectorCam — ophyd documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
-
- - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

ophyd.areadetector.cam.BrukerDetectorCam

-
-
-class ophyd.areadetector.cam.BrukerDetectorCam(prefix='', *, name, read_attrs=None, configuration_attrs=None, parent=None, **kwargs)
-
-
-__init__(prefix='', *, name, read_attrs=None, configuration_attrs=None, parent=None, **kwargs)
-
- -

Methods

- ---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
__init__([prefix, read_attrs, …])
check_value(value, **kwargs)Check if the value is valid for this object
clear_sub(cb[, event_type])Remove a subscription, given the original callback function
configure((d: typing.Dict[str, …)Configure the device for something during a run
describe(…)Provide schema and meta-data for read()
describe_configuration(…)Provide schema & meta-data for read_configuration()
find_signal(text[, use_re, case_sensitive, …])Search through the signal docs on this detector for the string text
get(**kwargs)Get the value of all components in the device
get_asyn_digraph()Get the directed graph of the ASYN ports
get_asyn_port_dictionary()Return port name : component map
get_device_tuple()The device tuple type associated with an Device class
get_instantiated_signals(*[, attr_prefix])Yields all of the instantiated signals in a device hierarchy
get_plugin_by_asyn_port(port_name)Get the plugin which has the given asyn port name
missing_plugins()Find missing ports
pause(() -> None)Attempt to ‘pause’ the device.
put(dev_t, **kwargs)Put a value to all components of the device
read(() -> ophyd.device.OrderedDictType[str, …)Read data from the device
read_configuration(…)returns dictionary mapping names to (value, timestamp) pairs
resume(() -> None)Resume a device from a ‘paused’ state
stage(*args, **kwargs)
stop(*[, success])Stop the Device and all (instantiated) subdevices
subscribe(cb[, event_type, run])Subscribe to events this event_type generates.
summary()
trigger(() -> ophyd.status.StatusBase)Trigger the device and return status object
unstage(() -> typing.List[object])Unstage the device.
unsubscribe(cid)Remove a subscription
validate_asyn_ports()Validate that all components of pipeline are known
wait_for_connection([all_signals, timeout])Wait for signals to connect
-
- -
- - -
-
- -
-
- - -
-
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_as_gen/ophyd.areadetector.cam.CamBase.html b/ophyd/_as_gen/ophyd.areadetector.cam.CamBase.html deleted file mode 100644 index 546020ae6d..0000000000 --- a/ophyd/_as_gen/ophyd.areadetector.cam.CamBase.html +++ /dev/null @@ -1,418 +0,0 @@ - - - - - - - - - - - ophyd.areadetector.cam.CamBase — ophyd documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
-
- - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

ophyd.areadetector.cam.CamBase

-
-
-class ophyd.areadetector.cam.CamBase(prefix='', *, name, read_attrs=None, configuration_attrs=None, parent=None, **kwargs)
-
-
-__init__(prefix='', *, name, read_attrs=None, configuration_attrs=None, parent=None, **kwargs)
-
- -

Methods

- ---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
__init__([prefix, read_attrs, …])
check_value(value, **kwargs)Check if the value is valid for this object
clear_sub(cb[, event_type])Remove a subscription, given the original callback function
configure((d: typing.Dict[str, …)Configure the device for something during a run
describe(…)Provide schema and meta-data for read()
describe_configuration(…)Provide schema & meta-data for read_configuration()
find_signal(text[, use_re, case_sensitive, …])Search through the signal docs on this detector for the string text
get(**kwargs)Get the value of all components in the device
get_asyn_digraph()Get the directed graph of the ASYN ports
get_asyn_port_dictionary()Return port name : component map
get_device_tuple()The device tuple type associated with an Device class
get_instantiated_signals(*[, attr_prefix])Yields all of the instantiated signals in a device hierarchy
get_plugin_by_asyn_port(port_name)Get the plugin which has the given asyn port name
missing_plugins()Find missing ports
pause(() -> None)Attempt to ‘pause’ the device.
put(dev_t, **kwargs)Put a value to all components of the device
read(() -> ophyd.device.OrderedDictType[str, …)Read data from the device
read_configuration(…)returns dictionary mapping names to (value, timestamp) pairs
resume(() -> None)Resume a device from a ‘paused’ state
stage(*args, **kwargs)
stop(*[, success])Stop the Device and all (instantiated) subdevices
subscribe(cb[, event_type, run])Subscribe to events this event_type generates.
summary()
trigger(() -> ophyd.status.StatusBase)Trigger the device and return status object
unstage(() -> typing.List[object])Unstage the device.
unsubscribe(cid)Remove a subscription
validate_asyn_ports()Validate that all components of pipeline are known
wait_for_connection([all_signals, timeout])Wait for signals to connect
-
- -
- - -
-
- -
-
- - -
-
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_as_gen/ophyd.areadetector.cam.FirewireLinDetectorCam.html b/ophyd/_as_gen/ophyd.areadetector.cam.FirewireLinDetectorCam.html deleted file mode 100644 index 2237d382e3..0000000000 --- a/ophyd/_as_gen/ophyd.areadetector.cam.FirewireLinDetectorCam.html +++ /dev/null @@ -1,418 +0,0 @@ - - - - - - - - - - - ophyd.areadetector.cam.FirewireLinDetectorCam — ophyd documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
-
- - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

ophyd.areadetector.cam.FirewireLinDetectorCam

-
-
-class ophyd.areadetector.cam.FirewireLinDetectorCam(prefix='', *, name, read_attrs=None, configuration_attrs=None, parent=None, **kwargs)
-
-
-__init__(prefix='', *, name, read_attrs=None, configuration_attrs=None, parent=None, **kwargs)
-
- -

Methods

- ---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
__init__([prefix, read_attrs, …])
check_value(value, **kwargs)Check if the value is valid for this object
clear_sub(cb[, event_type])Remove a subscription, given the original callback function
configure((d: typing.Dict[str, …)Configure the device for something during a run
describe(…)Provide schema and meta-data for read()
describe_configuration(…)Provide schema & meta-data for read_configuration()
find_signal(text[, use_re, case_sensitive, …])Search through the signal docs on this detector for the string text
get(**kwargs)Get the value of all components in the device
get_asyn_digraph()Get the directed graph of the ASYN ports
get_asyn_port_dictionary()Return port name : component map
get_device_tuple()The device tuple type associated with an Device class
get_instantiated_signals(*[, attr_prefix])Yields all of the instantiated signals in a device hierarchy
get_plugin_by_asyn_port(port_name)Get the plugin which has the given asyn port name
missing_plugins()Find missing ports
pause(() -> None)Attempt to ‘pause’ the device.
put(dev_t, **kwargs)Put a value to all components of the device
read(() -> ophyd.device.OrderedDictType[str, …)Read data from the device
read_configuration(…)returns dictionary mapping names to (value, timestamp) pairs
resume(() -> None)Resume a device from a ‘paused’ state
stage(*args, **kwargs)
stop(*[, success])Stop the Device and all (instantiated) subdevices
subscribe(cb[, event_type, run])Subscribe to events this event_type generates.
summary()
trigger(() -> ophyd.status.StatusBase)Trigger the device and return status object
unstage(() -> typing.List[object])Unstage the device.
unsubscribe(cid)Remove a subscription
validate_asyn_ports()Validate that all components of pipeline are known
wait_for_connection([all_signals, timeout])Wait for signals to connect
-
- -
- - -
-
- -
-
- - -
-
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_as_gen/ophyd.areadetector.cam.FirewireWinDetectorCam.html b/ophyd/_as_gen/ophyd.areadetector.cam.FirewireWinDetectorCam.html deleted file mode 100644 index 50da14efa7..0000000000 --- a/ophyd/_as_gen/ophyd.areadetector.cam.FirewireWinDetectorCam.html +++ /dev/null @@ -1,418 +0,0 @@ - - - - - - - - - - - ophyd.areadetector.cam.FirewireWinDetectorCam — ophyd documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
-
- - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

ophyd.areadetector.cam.FirewireWinDetectorCam

-
-
-class ophyd.areadetector.cam.FirewireWinDetectorCam(prefix='', *, name, read_attrs=None, configuration_attrs=None, parent=None, **kwargs)
-
-
-__init__(prefix='', *, name, read_attrs=None, configuration_attrs=None, parent=None, **kwargs)
-
- -

Methods

- ---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
__init__([prefix, read_attrs, …])
check_value(value, **kwargs)Check if the value is valid for this object
clear_sub(cb[, event_type])Remove a subscription, given the original callback function
configure((d: typing.Dict[str, …)Configure the device for something during a run
describe(…)Provide schema and meta-data for read()
describe_configuration(…)Provide schema & meta-data for read_configuration()
find_signal(text[, use_re, case_sensitive, …])Search through the signal docs on this detector for the string text
get(**kwargs)Get the value of all components in the device
get_asyn_digraph()Get the directed graph of the ASYN ports
get_asyn_port_dictionary()Return port name : component map
get_device_tuple()The device tuple type associated with an Device class
get_instantiated_signals(*[, attr_prefix])Yields all of the instantiated signals in a device hierarchy
get_plugin_by_asyn_port(port_name)Get the plugin which has the given asyn port name
missing_plugins()Find missing ports
pause(() -> None)Attempt to ‘pause’ the device.
put(dev_t, **kwargs)Put a value to all components of the device
read(() -> ophyd.device.OrderedDictType[str, …)Read data from the device
read_configuration(…)returns dictionary mapping names to (value, timestamp) pairs
resume(() -> None)Resume a device from a ‘paused’ state
stage(*args, **kwargs)
stop(*[, success])Stop the Device and all (instantiated) subdevices
subscribe(cb[, event_type, run])Subscribe to events this event_type generates.
summary()
trigger(() -> ophyd.status.StatusBase)Trigger the device and return status object
unstage(() -> typing.List[object])Unstage the device.
unsubscribe(cid)Remove a subscription
validate_asyn_ports()Validate that all components of pipeline are known
wait_for_connection([all_signals, timeout])Wait for signals to connect
-
- -
- - -
-
- -
-
- - -
-
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_as_gen/ophyd.areadetector.cam.LightFieldDetectorCam.html b/ophyd/_as_gen/ophyd.areadetector.cam.LightFieldDetectorCam.html deleted file mode 100644 index 2333df9e08..0000000000 --- a/ophyd/_as_gen/ophyd.areadetector.cam.LightFieldDetectorCam.html +++ /dev/null @@ -1,418 +0,0 @@ - - - - - - - - - - - ophyd.areadetector.cam.LightFieldDetectorCam — ophyd documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
-
- - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

ophyd.areadetector.cam.LightFieldDetectorCam

-
-
-class ophyd.areadetector.cam.LightFieldDetectorCam(prefix='', *, name, read_attrs=None, configuration_attrs=None, parent=None, **kwargs)
-
-
-__init__(prefix='', *, name, read_attrs=None, configuration_attrs=None, parent=None, **kwargs)
-
- -

Methods

- ---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
__init__([prefix, read_attrs, …])
check_value(value, **kwargs)Check if the value is valid for this object
clear_sub(cb[, event_type])Remove a subscription, given the original callback function
configure((d: typing.Dict[str, …)Configure the device for something during a run
describe(…)Provide schema and meta-data for read()
describe_configuration(…)Provide schema & meta-data for read_configuration()
find_signal(text[, use_re, case_sensitive, …])Search through the signal docs on this detector for the string text
get(**kwargs)Get the value of all components in the device
get_asyn_digraph()Get the directed graph of the ASYN ports
get_asyn_port_dictionary()Return port name : component map
get_device_tuple()The device tuple type associated with an Device class
get_instantiated_signals(*[, attr_prefix])Yields all of the instantiated signals in a device hierarchy
get_plugin_by_asyn_port(port_name)Get the plugin which has the given asyn port name
missing_plugins()Find missing ports
pause(() -> None)Attempt to ‘pause’ the device.
put(dev_t, **kwargs)Put a value to all components of the device
read(() -> ophyd.device.OrderedDictType[str, …)Read data from the device
read_configuration(…)returns dictionary mapping names to (value, timestamp) pairs
resume(() -> None)Resume a device from a ‘paused’ state
stage(*args, **kwargs)
stop(*[, success])Stop the Device and all (instantiated) subdevices
subscribe(cb[, event_type, run])Subscribe to events this event_type generates.
summary()
trigger(() -> ophyd.status.StatusBase)Trigger the device and return status object
unstage(() -> typing.List[object])Unstage the device.
unsubscribe(cid)Remove a subscription
validate_asyn_ports()Validate that all components of pipeline are known
wait_for_connection([all_signals, timeout])Wait for signals to connect
-
- -
- - -
-
- -
-
- - -
-
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_as_gen/ophyd.areadetector.cam.Mar345DetectorCam.html b/ophyd/_as_gen/ophyd.areadetector.cam.Mar345DetectorCam.html deleted file mode 100644 index 86aa1efce8..0000000000 --- a/ophyd/_as_gen/ophyd.areadetector.cam.Mar345DetectorCam.html +++ /dev/null @@ -1,418 +0,0 @@ - - - - - - - - - - - ophyd.areadetector.cam.Mar345DetectorCam — ophyd documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
-
- - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

ophyd.areadetector.cam.Mar345DetectorCam

-
-
-class ophyd.areadetector.cam.Mar345DetectorCam(prefix='', *, name, read_attrs=None, configuration_attrs=None, parent=None, **kwargs)
-
-
-__init__(prefix='', *, name, read_attrs=None, configuration_attrs=None, parent=None, **kwargs)
-
- -

Methods

- ---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
__init__([prefix, read_attrs, …])
check_value(value, **kwargs)Check if the value is valid for this object
clear_sub(cb[, event_type])Remove a subscription, given the original callback function
configure((d: typing.Dict[str, …)Configure the device for something during a run
describe(…)Provide schema and meta-data for read()
describe_configuration(…)Provide schema & meta-data for read_configuration()
find_signal(text[, use_re, case_sensitive, …])Search through the signal docs on this detector for the string text
get(**kwargs)Get the value of all components in the device
get_asyn_digraph()Get the directed graph of the ASYN ports
get_asyn_port_dictionary()Return port name : component map
get_device_tuple()The device tuple type associated with an Device class
get_instantiated_signals(*[, attr_prefix])Yields all of the instantiated signals in a device hierarchy
get_plugin_by_asyn_port(port_name)Get the plugin which has the given asyn port name
missing_plugins()Find missing ports
pause(() -> None)Attempt to ‘pause’ the device.
put(dev_t, **kwargs)Put a value to all components of the device
read(() -> ophyd.device.OrderedDictType[str, …)Read data from the device
read_configuration(…)returns dictionary mapping names to (value, timestamp) pairs
resume(() -> None)Resume a device from a ‘paused’ state
stage(*args, **kwargs)
stop(*[, success])Stop the Device and all (instantiated) subdevices
subscribe(cb[, event_type, run])Subscribe to events this event_type generates.
summary()
trigger(() -> ophyd.status.StatusBase)Trigger the device and return status object
unstage(() -> typing.List[object])Unstage the device.
unsubscribe(cid)Remove a subscription
validate_asyn_ports()Validate that all components of pipeline are known
wait_for_connection([all_signals, timeout])Wait for signals to connect
-
- -
- - -
-
- -
-
- - -
-
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_as_gen/ophyd.areadetector.cam.MarCCDDetectorCam.html b/ophyd/_as_gen/ophyd.areadetector.cam.MarCCDDetectorCam.html deleted file mode 100644 index b0910993cd..0000000000 --- a/ophyd/_as_gen/ophyd.areadetector.cam.MarCCDDetectorCam.html +++ /dev/null @@ -1,418 +0,0 @@ - - - - - - - - - - - ophyd.areadetector.cam.MarCCDDetectorCam — ophyd documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
-
- - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

ophyd.areadetector.cam.MarCCDDetectorCam

-
-
-class ophyd.areadetector.cam.MarCCDDetectorCam(prefix='', *, name, read_attrs=None, configuration_attrs=None, parent=None, **kwargs)
-
-
-__init__(prefix='', *, name, read_attrs=None, configuration_attrs=None, parent=None, **kwargs)
-
- -

Methods

- ---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
__init__([prefix, read_attrs, …])
check_value(value, **kwargs)Check if the value is valid for this object
clear_sub(cb[, event_type])Remove a subscription, given the original callback function
configure((d: typing.Dict[str, …)Configure the device for something during a run
describe(…)Provide schema and meta-data for read()
describe_configuration(…)Provide schema & meta-data for read_configuration()
find_signal(text[, use_re, case_sensitive, …])Search through the signal docs on this detector for the string text
get(**kwargs)Get the value of all components in the device
get_asyn_digraph()Get the directed graph of the ASYN ports
get_asyn_port_dictionary()Return port name : component map
get_device_tuple()The device tuple type associated with an Device class
get_instantiated_signals(*[, attr_prefix])Yields all of the instantiated signals in a device hierarchy
get_plugin_by_asyn_port(port_name)Get the plugin which has the given asyn port name
missing_plugins()Find missing ports
pause(() -> None)Attempt to ‘pause’ the device.
put(dev_t, **kwargs)Put a value to all components of the device
read(() -> ophyd.device.OrderedDictType[str, …)Read data from the device
read_configuration(…)returns dictionary mapping names to (value, timestamp) pairs
resume(() -> None)Resume a device from a ‘paused’ state
stage(*args, **kwargs)
stop(*[, success])Stop the Device and all (instantiated) subdevices
subscribe(cb[, event_type, run])Subscribe to events this event_type generates.
summary()
trigger(() -> ophyd.status.StatusBase)Trigger the device and return status object
unstage(() -> typing.List[object])Unstage the device.
unsubscribe(cid)Remove a subscription
validate_asyn_ports()Validate that all components of pipeline are known
wait_for_connection([all_signals, timeout])Wait for signals to connect
-
- -
- - -
-
- -
-
- - -
-
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_as_gen/ophyd.areadetector.cam.PSLDetectorCam.html b/ophyd/_as_gen/ophyd.areadetector.cam.PSLDetectorCam.html deleted file mode 100644 index 1069bdf0e1..0000000000 --- a/ophyd/_as_gen/ophyd.areadetector.cam.PSLDetectorCam.html +++ /dev/null @@ -1,418 +0,0 @@ - - - - - - - - - - - ophyd.areadetector.cam.PSLDetectorCam — ophyd documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
-
- - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

ophyd.areadetector.cam.PSLDetectorCam

-
-
-class ophyd.areadetector.cam.PSLDetectorCam(prefix='', *, name, read_attrs=None, configuration_attrs=None, parent=None, **kwargs)
-
-
-__init__(prefix='', *, name, read_attrs=None, configuration_attrs=None, parent=None, **kwargs)
-
- -

Methods

- ---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
__init__([prefix, read_attrs, …])
check_value(value, **kwargs)Check if the value is valid for this object
clear_sub(cb[, event_type])Remove a subscription, given the original callback function
configure((d: typing.Dict[str, …)Configure the device for something during a run
describe(…)Provide schema and meta-data for read()
describe_configuration(…)Provide schema & meta-data for read_configuration()
find_signal(text[, use_re, case_sensitive, …])Search through the signal docs on this detector for the string text
get(**kwargs)Get the value of all components in the device
get_asyn_digraph()Get the directed graph of the ASYN ports
get_asyn_port_dictionary()Return port name : component map
get_device_tuple()The device tuple type associated with an Device class
get_instantiated_signals(*[, attr_prefix])Yields all of the instantiated signals in a device hierarchy
get_plugin_by_asyn_port(port_name)Get the plugin which has the given asyn port name
missing_plugins()Find missing ports
pause(() -> None)Attempt to ‘pause’ the device.
put(dev_t, **kwargs)Put a value to all components of the device
read(() -> ophyd.device.OrderedDictType[str, …)Read data from the device
read_configuration(…)returns dictionary mapping names to (value, timestamp) pairs
resume(() -> None)Resume a device from a ‘paused’ state
stage(*args, **kwargs)
stop(*[, success])Stop the Device and all (instantiated) subdevices
subscribe(cb[, event_type, run])Subscribe to events this event_type generates.
summary()
trigger(() -> ophyd.status.StatusBase)Trigger the device and return status object
unstage(() -> typing.List[object])Unstage the device.
unsubscribe(cid)Remove a subscription
validate_asyn_ports()Validate that all components of pipeline are known
wait_for_connection([all_signals, timeout])Wait for signals to connect
-
- -
- - -
-
- -
-
- - -
-
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_as_gen/ophyd.areadetector.cam.PcoDetectorCam.html b/ophyd/_as_gen/ophyd.areadetector.cam.PcoDetectorCam.html deleted file mode 100644 index 69cca31acf..0000000000 --- a/ophyd/_as_gen/ophyd.areadetector.cam.PcoDetectorCam.html +++ /dev/null @@ -1,418 +0,0 @@ - - - - - - - - - - - ophyd.areadetector.cam.PcoDetectorCam — ophyd documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
-
- - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

ophyd.areadetector.cam.PcoDetectorCam

-
-
-class ophyd.areadetector.cam.PcoDetectorCam(prefix='', *, name, read_attrs=None, configuration_attrs=None, parent=None, **kwargs)
-
-
-__init__(prefix='', *, name, read_attrs=None, configuration_attrs=None, parent=None, **kwargs)
-
- -

Methods

- ---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
__init__([prefix, read_attrs, …])
check_value(value, **kwargs)Check if the value is valid for this object
clear_sub(cb[, event_type])Remove a subscription, given the original callback function
configure((d: typing.Dict[str, …)Configure the device for something during a run
describe(…)Provide schema and meta-data for read()
describe_configuration(…)Provide schema & meta-data for read_configuration()
find_signal(text[, use_re, case_sensitive, …])Search through the signal docs on this detector for the string text
get(**kwargs)Get the value of all components in the device
get_asyn_digraph()Get the directed graph of the ASYN ports
get_asyn_port_dictionary()Return port name : component map
get_device_tuple()The device tuple type associated with an Device class
get_instantiated_signals(*[, attr_prefix])Yields all of the instantiated signals in a device hierarchy
get_plugin_by_asyn_port(port_name)Get the plugin which has the given asyn port name
missing_plugins()Find missing ports
pause(() -> None)Attempt to ‘pause’ the device.
put(dev_t, **kwargs)Put a value to all components of the device
read(() -> ophyd.device.OrderedDictType[str, …)Read data from the device
read_configuration(…)returns dictionary mapping names to (value, timestamp) pairs
resume(() -> None)Resume a device from a ‘paused’ state
stage(*args, **kwargs)
stop(*[, success])Stop the Device and all (instantiated) subdevices
subscribe(cb[, event_type, run])Subscribe to events this event_type generates.
summary()
trigger(() -> ophyd.status.StatusBase)Trigger the device and return status object
unstage(() -> typing.List[object])Unstage the device.
unsubscribe(cid)Remove a subscription
validate_asyn_ports()Validate that all components of pipeline are known
wait_for_connection([all_signals, timeout])Wait for signals to connect
-
- -
- - -
-
- -
-
- - -
-
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_as_gen/ophyd.areadetector.cam.PcoDetectorIO.html b/ophyd/_as_gen/ophyd.areadetector.cam.PcoDetectorIO.html deleted file mode 100644 index fcabdca3a7..0000000000 --- a/ophyd/_as_gen/ophyd.areadetector.cam.PcoDetectorIO.html +++ /dev/null @@ -1,418 +0,0 @@ - - - - - - - - - - - ophyd.areadetector.cam.PcoDetectorIO — ophyd documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
-
- - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

ophyd.areadetector.cam.PcoDetectorIO

-
-
-class ophyd.areadetector.cam.PcoDetectorIO(prefix='', *, name, read_attrs=None, configuration_attrs=None, parent=None, **kwargs)
-
-
-__init__(prefix='', *, name, read_attrs=None, configuration_attrs=None, parent=None, **kwargs)
-
- -

Methods

- ---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
__init__([prefix, read_attrs, …])
check_value(value, **kwargs)Check if the value is valid for this object
clear_sub(cb[, event_type])Remove a subscription, given the original callback function
configure((d: typing.Dict[str, …)Configure the device for something during a run
describe(…)Provide schema and meta-data for read()
describe_configuration(…)Provide schema & meta-data for read_configuration()
find_signal(text[, use_re, case_sensitive, …])Search through the signal docs on this detector for the string text
get(**kwargs)Get the value of all components in the device
get_asyn_digraph()Get the directed graph of the ASYN ports
get_asyn_port_dictionary()Return port name : component map
get_device_tuple()The device tuple type associated with an Device class
get_instantiated_signals(*[, attr_prefix])Yields all of the instantiated signals in a device hierarchy
get_plugin_by_asyn_port(port_name)Get the plugin which has the given asyn port name
missing_plugins()Find missing ports
pause(() -> None)Attempt to ‘pause’ the device.
put(dev_t, **kwargs)Put a value to all components of the device
read(() -> ophyd.device.OrderedDictType[str, …)Read data from the device
read_configuration(…)returns dictionary mapping names to (value, timestamp) pairs
resume(() -> None)Resume a device from a ‘paused’ state
stage(*args, **kwargs)
stop(*[, success])Stop the Device and all (instantiated) subdevices
subscribe(cb[, event_type, run])Subscribe to events this event_type generates.
summary()
trigger(() -> ophyd.status.StatusBase)Trigger the device and return status object
unstage(() -> typing.List[object])Unstage the device.
unsubscribe(cid)Remove a subscription
validate_asyn_ports()Validate that all components of pipeline are known
wait_for_connection([all_signals, timeout])Wait for signals to connect
-
- -
- - -
-
- -
-
- - -
-
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_as_gen/ophyd.areadetector.cam.PcoDetectorSimIO.html b/ophyd/_as_gen/ophyd.areadetector.cam.PcoDetectorSimIO.html deleted file mode 100644 index 5995a61773..0000000000 --- a/ophyd/_as_gen/ophyd.areadetector.cam.PcoDetectorSimIO.html +++ /dev/null @@ -1,418 +0,0 @@ - - - - - - - - - - - ophyd.areadetector.cam.PcoDetectorSimIO — ophyd documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
-
- - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

ophyd.areadetector.cam.PcoDetectorSimIO

-
-
-class ophyd.areadetector.cam.PcoDetectorSimIO(prefix='', *, name, read_attrs=None, configuration_attrs=None, parent=None, **kwargs)
-
-
-__init__(prefix='', *, name, read_attrs=None, configuration_attrs=None, parent=None, **kwargs)
-
- -

Methods

- ---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
__init__([prefix, read_attrs, …])
check_value(value, **kwargs)Check if the value is valid for this object
clear_sub(cb[, event_type])Remove a subscription, given the original callback function
configure((d: typing.Dict[str, …)Configure the device for something during a run
describe(…)Provide schema and meta-data for read()
describe_configuration(…)Provide schema & meta-data for read_configuration()
find_signal(text[, use_re, case_sensitive, …])Search through the signal docs on this detector for the string text
get(**kwargs)Get the value of all components in the device
get_asyn_digraph()Get the directed graph of the ASYN ports
get_asyn_port_dictionary()Return port name : component map
get_device_tuple()The device tuple type associated with an Device class
get_instantiated_signals(*[, attr_prefix])Yields all of the instantiated signals in a device hierarchy
get_plugin_by_asyn_port(port_name)Get the plugin which has the given asyn port name
missing_plugins()Find missing ports
pause(() -> None)Attempt to ‘pause’ the device.
put(dev_t, **kwargs)Put a value to all components of the device
read(() -> ophyd.device.OrderedDictType[str, …)Read data from the device
read_configuration(…)returns dictionary mapping names to (value, timestamp) pairs
resume(() -> None)Resume a device from a ‘paused’ state
stage(*args, **kwargs)
stop(*[, success])Stop the Device and all (instantiated) subdevices
subscribe(cb[, event_type, run])Subscribe to events this event_type generates.
summary()
trigger(() -> ophyd.status.StatusBase)Trigger the device and return status object
unstage(() -> typing.List[object])Unstage the device.
unsubscribe(cid)Remove a subscription
validate_asyn_ports()Validate that all components of pipeline are known
wait_for_connection([all_signals, timeout])Wait for signals to connect
-
- -
- - -
-
- -
-
- - -
-
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_as_gen/ophyd.areadetector.cam.PerkinElmerDetectorCam.html b/ophyd/_as_gen/ophyd.areadetector.cam.PerkinElmerDetectorCam.html deleted file mode 100644 index a3d3bd5f07..0000000000 --- a/ophyd/_as_gen/ophyd.areadetector.cam.PerkinElmerDetectorCam.html +++ /dev/null @@ -1,418 +0,0 @@ - - - - - - - - - - - ophyd.areadetector.cam.PerkinElmerDetectorCam — ophyd documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
-
- - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

ophyd.areadetector.cam.PerkinElmerDetectorCam

-
-
-class ophyd.areadetector.cam.PerkinElmerDetectorCam(prefix='', *, name, read_attrs=None, configuration_attrs=None, parent=None, **kwargs)
-
-
-__init__(prefix='', *, name, read_attrs=None, configuration_attrs=None, parent=None, **kwargs)
-
- -

Methods

- ---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
__init__([prefix, read_attrs, …])
check_value(value, **kwargs)Check if the value is valid for this object
clear_sub(cb[, event_type])Remove a subscription, given the original callback function
configure((d: typing.Dict[str, …)Configure the device for something during a run
describe(…)Provide schema and meta-data for read()
describe_configuration(…)Provide schema & meta-data for read_configuration()
find_signal(text[, use_re, case_sensitive, …])Search through the signal docs on this detector for the string text
get(**kwargs)Get the value of all components in the device
get_asyn_digraph()Get the directed graph of the ASYN ports
get_asyn_port_dictionary()Return port name : component map
get_device_tuple()The device tuple type associated with an Device class
get_instantiated_signals(*[, attr_prefix])Yields all of the instantiated signals in a device hierarchy
get_plugin_by_asyn_port(port_name)Get the plugin which has the given asyn port name
missing_plugins()Find missing ports
pause(() -> None)Attempt to ‘pause’ the device.
put(dev_t, **kwargs)Put a value to all components of the device
read(() -> ophyd.device.OrderedDictType[str, …)Read data from the device
read_configuration(…)returns dictionary mapping names to (value, timestamp) pairs
resume(() -> None)Resume a device from a ‘paused’ state
stage(*args, **kwargs)
stop(*[, success])Stop the Device and all (instantiated) subdevices
subscribe(cb[, event_type, run])Subscribe to events this event_type generates.
summary()
trigger(() -> ophyd.status.StatusBase)Trigger the device and return status object
unstage(() -> typing.List[object])Unstage the device.
unsubscribe(cid)Remove a subscription
validate_asyn_ports()Validate that all components of pipeline are known
wait_for_connection([all_signals, timeout])Wait for signals to connect
-
- -
- - -
-
- -
-
- - -
-
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_as_gen/ophyd.areadetector.cam.PilatusDetectorCam.html b/ophyd/_as_gen/ophyd.areadetector.cam.PilatusDetectorCam.html deleted file mode 100644 index c1fd4f1055..0000000000 --- a/ophyd/_as_gen/ophyd.areadetector.cam.PilatusDetectorCam.html +++ /dev/null @@ -1,418 +0,0 @@ - - - - - - - - - - - ophyd.areadetector.cam.PilatusDetectorCam — ophyd documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
-
- - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

ophyd.areadetector.cam.PilatusDetectorCam

-
-
-class ophyd.areadetector.cam.PilatusDetectorCam(prefix='', *, name, read_attrs=None, configuration_attrs=None, parent=None, **kwargs)
-
-
-__init__(prefix='', *, name, read_attrs=None, configuration_attrs=None, parent=None, **kwargs)
-
- -

Methods

- ---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
__init__([prefix, read_attrs, …])
check_value(value, **kwargs)Check if the value is valid for this object
clear_sub(cb[, event_type])Remove a subscription, given the original callback function
configure((d: typing.Dict[str, …)Configure the device for something during a run
describe(…)Provide schema and meta-data for read()
describe_configuration(…)Provide schema & meta-data for read_configuration()
find_signal(text[, use_re, case_sensitive, …])Search through the signal docs on this detector for the string text
get(**kwargs)Get the value of all components in the device
get_asyn_digraph()Get the directed graph of the ASYN ports
get_asyn_port_dictionary()Return port name : component map
get_device_tuple()The device tuple type associated with an Device class
get_instantiated_signals(*[, attr_prefix])Yields all of the instantiated signals in a device hierarchy
get_plugin_by_asyn_port(port_name)Get the plugin which has the given asyn port name
missing_plugins()Find missing ports
pause(() -> None)Attempt to ‘pause’ the device.
put(dev_t, **kwargs)Put a value to all components of the device
read(() -> ophyd.device.OrderedDictType[str, …)Read data from the device
read_configuration(…)returns dictionary mapping names to (value, timestamp) pairs
resume(() -> None)Resume a device from a ‘paused’ state
stage(*args, **kwargs)
stop(*[, success])Stop the Device and all (instantiated) subdevices
subscribe(cb[, event_type, run])Subscribe to events this event_type generates.
summary()
trigger(() -> ophyd.status.StatusBase)Trigger the device and return status object
unstage(() -> typing.List[object])Unstage the device.
unsubscribe(cid)Remove a subscription
validate_asyn_ports()Validate that all components of pipeline are known
wait_for_connection([all_signals, timeout])Wait for signals to connect
-
- -
- - -
-
- -
-
- - -
-
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_as_gen/ophyd.areadetector.cam.PixiradDetectorCam.html b/ophyd/_as_gen/ophyd.areadetector.cam.PixiradDetectorCam.html deleted file mode 100644 index 8e844a5e7c..0000000000 --- a/ophyd/_as_gen/ophyd.areadetector.cam.PixiradDetectorCam.html +++ /dev/null @@ -1,418 +0,0 @@ - - - - - - - - - - - ophyd.areadetector.cam.PixiradDetectorCam — ophyd documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
-
- - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

ophyd.areadetector.cam.PixiradDetectorCam

-
-
-class ophyd.areadetector.cam.PixiradDetectorCam(prefix='', *, name, read_attrs=None, configuration_attrs=None, parent=None, **kwargs)
-
-
-__init__(prefix='', *, name, read_attrs=None, configuration_attrs=None, parent=None, **kwargs)
-
- -

Methods

- ---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
__init__([prefix, read_attrs, …])
check_value(value, **kwargs)Check if the value is valid for this object
clear_sub(cb[, event_type])Remove a subscription, given the original callback function
configure((d: typing.Dict[str, …)Configure the device for something during a run
describe(…)Provide schema and meta-data for read()
describe_configuration(…)Provide schema & meta-data for read_configuration()
find_signal(text[, use_re, case_sensitive, …])Search through the signal docs on this detector for the string text
get(**kwargs)Get the value of all components in the device
get_asyn_digraph()Get the directed graph of the ASYN ports
get_asyn_port_dictionary()Return port name : component map
get_device_tuple()The device tuple type associated with an Device class
get_instantiated_signals(*[, attr_prefix])Yields all of the instantiated signals in a device hierarchy
get_plugin_by_asyn_port(port_name)Get the plugin which has the given asyn port name
missing_plugins()Find missing ports
pause(() -> None)Attempt to ‘pause’ the device.
put(dev_t, **kwargs)Put a value to all components of the device
read(() -> ophyd.device.OrderedDictType[str, …)Read data from the device
read_configuration(…)returns dictionary mapping names to (value, timestamp) pairs
resume(() -> None)Resume a device from a ‘paused’ state
stage(*args, **kwargs)
stop(*[, success])Stop the Device and all (instantiated) subdevices
subscribe(cb[, event_type, run])Subscribe to events this event_type generates.
summary()
trigger(() -> ophyd.status.StatusBase)Trigger the device and return status object
unstage(() -> typing.List[object])Unstage the device.
unsubscribe(cid)Remove a subscription
validate_asyn_ports()Validate that all components of pipeline are known
wait_for_connection([all_signals, timeout])Wait for signals to connect
-
- -
- - -
-
- -
-
- - -
-
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_as_gen/ophyd.areadetector.cam.PointGreyDetectorCam.html b/ophyd/_as_gen/ophyd.areadetector.cam.PointGreyDetectorCam.html deleted file mode 100644 index fc30d55740..0000000000 --- a/ophyd/_as_gen/ophyd.areadetector.cam.PointGreyDetectorCam.html +++ /dev/null @@ -1,418 +0,0 @@ - - - - - - - - - - - ophyd.areadetector.cam.PointGreyDetectorCam — ophyd documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
-
- - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

ophyd.areadetector.cam.PointGreyDetectorCam

-
-
-class ophyd.areadetector.cam.PointGreyDetectorCam(prefix='', *, name, read_attrs=None, configuration_attrs=None, parent=None, **kwargs)
-
-
-__init__(prefix='', *, name, read_attrs=None, configuration_attrs=None, parent=None, **kwargs)
-
- -

Methods

- ---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
__init__([prefix, read_attrs, …])
check_value(value, **kwargs)Check if the value is valid for this object
clear_sub(cb[, event_type])Remove a subscription, given the original callback function
configure((d: typing.Dict[str, …)Configure the device for something during a run
describe(…)Provide schema and meta-data for read()
describe_configuration(…)Provide schema & meta-data for read_configuration()
find_signal(text[, use_re, case_sensitive, …])Search through the signal docs on this detector for the string text
get(**kwargs)Get the value of all components in the device
get_asyn_digraph()Get the directed graph of the ASYN ports
get_asyn_port_dictionary()Return port name : component map
get_device_tuple()The device tuple type associated with an Device class
get_instantiated_signals(*[, attr_prefix])Yields all of the instantiated signals in a device hierarchy
get_plugin_by_asyn_port(port_name)Get the plugin which has the given asyn port name
missing_plugins()Find missing ports
pause(() -> None)Attempt to ‘pause’ the device.
put(dev_t, **kwargs)Put a value to all components of the device
read(() -> ophyd.device.OrderedDictType[str, …)Read data from the device
read_configuration(…)returns dictionary mapping names to (value, timestamp) pairs
resume(() -> None)Resume a device from a ‘paused’ state
stage(*args, **kwargs)
stop(*[, success])Stop the Device and all (instantiated) subdevices
subscribe(cb[, event_type, run])Subscribe to events this event_type generates.
summary()
trigger(() -> ophyd.status.StatusBase)Trigger the device and return status object
unstage(() -> typing.List[object])Unstage the device.
unsubscribe(cid)Remove a subscription
validate_asyn_ports()Validate that all components of pipeline are known
wait_for_connection([all_signals, timeout])Wait for signals to connect
-
- -
- - -
-
- -
-
- - -
-
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_as_gen/ophyd.areadetector.cam.ProsilicaDetectorCam.html b/ophyd/_as_gen/ophyd.areadetector.cam.ProsilicaDetectorCam.html deleted file mode 100644 index eba9bf2e29..0000000000 --- a/ophyd/_as_gen/ophyd.areadetector.cam.ProsilicaDetectorCam.html +++ /dev/null @@ -1,418 +0,0 @@ - - - - - - - - - - - ophyd.areadetector.cam.ProsilicaDetectorCam — ophyd documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
-
- - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

ophyd.areadetector.cam.ProsilicaDetectorCam

-
-
-class ophyd.areadetector.cam.ProsilicaDetectorCam(prefix='', *, name, read_attrs=None, configuration_attrs=None, parent=None, **kwargs)
-
-
-__init__(prefix='', *, name, read_attrs=None, configuration_attrs=None, parent=None, **kwargs)
-
- -

Methods

- ---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
__init__([prefix, read_attrs, …])
check_value(value, **kwargs)Check if the value is valid for this object
clear_sub(cb[, event_type])Remove a subscription, given the original callback function
configure((d: typing.Dict[str, …)Configure the device for something during a run
describe(…)Provide schema and meta-data for read()
describe_configuration(…)Provide schema & meta-data for read_configuration()
find_signal(text[, use_re, case_sensitive, …])Search through the signal docs on this detector for the string text
get(**kwargs)Get the value of all components in the device
get_asyn_digraph()Get the directed graph of the ASYN ports
get_asyn_port_dictionary()Return port name : component map
get_device_tuple()The device tuple type associated with an Device class
get_instantiated_signals(*[, attr_prefix])Yields all of the instantiated signals in a device hierarchy
get_plugin_by_asyn_port(port_name)Get the plugin which has the given asyn port name
missing_plugins()Find missing ports
pause(() -> None)Attempt to ‘pause’ the device.
put(dev_t, **kwargs)Put a value to all components of the device
read(() -> ophyd.device.OrderedDictType[str, …)Read data from the device
read_configuration(…)returns dictionary mapping names to (value, timestamp) pairs
resume(() -> None)Resume a device from a ‘paused’ state
stage(*args, **kwargs)
stop(*[, success])Stop the Device and all (instantiated) subdevices
subscribe(cb[, event_type, run])Subscribe to events this event_type generates.
summary()
trigger(() -> ophyd.status.StatusBase)Trigger the device and return status object
unstage(() -> typing.List[object])Unstage the device.
unsubscribe(cid)Remove a subscription
validate_asyn_ports()Validate that all components of pipeline are known
wait_for_connection([all_signals, timeout])Wait for signals to connect
-
- -
- - -
-
- -
-
- - -
-
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_as_gen/ophyd.areadetector.cam.PvcamDetectorCam.html b/ophyd/_as_gen/ophyd.areadetector.cam.PvcamDetectorCam.html deleted file mode 100644 index b42d135ac0..0000000000 --- a/ophyd/_as_gen/ophyd.areadetector.cam.PvcamDetectorCam.html +++ /dev/null @@ -1,418 +0,0 @@ - - - - - - - - - - - ophyd.areadetector.cam.PvcamDetectorCam — ophyd documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
-
- - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

ophyd.areadetector.cam.PvcamDetectorCam

-
-
-class ophyd.areadetector.cam.PvcamDetectorCam(prefix='', *, name, read_attrs=None, configuration_attrs=None, parent=None, **kwargs)
-
-
-__init__(prefix='', *, name, read_attrs=None, configuration_attrs=None, parent=None, **kwargs)
-
- -

Methods

- ---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
__init__([prefix, read_attrs, …])
check_value(value, **kwargs)Check if the value is valid for this object
clear_sub(cb[, event_type])Remove a subscription, given the original callback function
configure((d: typing.Dict[str, …)Configure the device for something during a run
describe(…)Provide schema and meta-data for read()
describe_configuration(…)Provide schema & meta-data for read_configuration()
find_signal(text[, use_re, case_sensitive, …])Search through the signal docs on this detector for the string text
get(**kwargs)Get the value of all components in the device
get_asyn_digraph()Get the directed graph of the ASYN ports
get_asyn_port_dictionary()Return port name : component map
get_device_tuple()The device tuple type associated with an Device class
get_instantiated_signals(*[, attr_prefix])Yields all of the instantiated signals in a device hierarchy
get_plugin_by_asyn_port(port_name)Get the plugin which has the given asyn port name
missing_plugins()Find missing ports
pause(() -> None)Attempt to ‘pause’ the device.
put(dev_t, **kwargs)Put a value to all components of the device
read(() -> ophyd.device.OrderedDictType[str, …)Read data from the device
read_configuration(…)returns dictionary mapping names to (value, timestamp) pairs
resume(() -> None)Resume a device from a ‘paused’ state
stage(*args, **kwargs)
stop(*[, success])Stop the Device and all (instantiated) subdevices
subscribe(cb[, event_type, run])Subscribe to events this event_type generates.
summary()
trigger(() -> ophyd.status.StatusBase)Trigger the device and return status object
unstage(() -> typing.List[object])Unstage the device.
unsubscribe(cid)Remove a subscription
validate_asyn_ports()Validate that all components of pipeline are known
wait_for_connection([all_signals, timeout])Wait for signals to connect
-
- -
- - -
-
- -
-
- - -
-
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_as_gen/ophyd.areadetector.cam.RoperDetectorCam.html b/ophyd/_as_gen/ophyd.areadetector.cam.RoperDetectorCam.html deleted file mode 100644 index bcc68f2258..0000000000 --- a/ophyd/_as_gen/ophyd.areadetector.cam.RoperDetectorCam.html +++ /dev/null @@ -1,418 +0,0 @@ - - - - - - - - - - - ophyd.areadetector.cam.RoperDetectorCam — ophyd documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
-
- - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

ophyd.areadetector.cam.RoperDetectorCam

-
-
-class ophyd.areadetector.cam.RoperDetectorCam(prefix='', *, name, read_attrs=None, configuration_attrs=None, parent=None, **kwargs)
-
-
-__init__(prefix='', *, name, read_attrs=None, configuration_attrs=None, parent=None, **kwargs)
-
- -

Methods

- ---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
__init__([prefix, read_attrs, …])
check_value(value, **kwargs)Check if the value is valid for this object
clear_sub(cb[, event_type])Remove a subscription, given the original callback function
configure((d: typing.Dict[str, …)Configure the device for something during a run
describe(…)Provide schema and meta-data for read()
describe_configuration(…)Provide schema & meta-data for read_configuration()
find_signal(text[, use_re, case_sensitive, …])Search through the signal docs on this detector for the string text
get(**kwargs)Get the value of all components in the device
get_asyn_digraph()Get the directed graph of the ASYN ports
get_asyn_port_dictionary()Return port name : component map
get_device_tuple()The device tuple type associated with an Device class
get_instantiated_signals(*[, attr_prefix])Yields all of the instantiated signals in a device hierarchy
get_plugin_by_asyn_port(port_name)Get the plugin which has the given asyn port name
missing_plugins()Find missing ports
pause(() -> None)Attempt to ‘pause’ the device.
put(dev_t, **kwargs)Put a value to all components of the device
read(() -> ophyd.device.OrderedDictType[str, …)Read data from the device
read_configuration(…)returns dictionary mapping names to (value, timestamp) pairs
resume(() -> None)Resume a device from a ‘paused’ state
stage(*args, **kwargs)
stop(*[, success])Stop the Device and all (instantiated) subdevices
subscribe(cb[, event_type, run])Subscribe to events this event_type generates.
summary()
trigger(() -> ophyd.status.StatusBase)Trigger the device and return status object
unstage(() -> typing.List[object])Unstage the device.
unsubscribe(cid)Remove a subscription
validate_asyn_ports()Validate that all components of pipeline are known
wait_for_connection([all_signals, timeout])Wait for signals to connect
-
- -
- - -
-
- -
-
- - -
-
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_as_gen/ophyd.areadetector.cam.SimDetectorCam.html b/ophyd/_as_gen/ophyd.areadetector.cam.SimDetectorCam.html deleted file mode 100644 index e2c5d901ac..0000000000 --- a/ophyd/_as_gen/ophyd.areadetector.cam.SimDetectorCam.html +++ /dev/null @@ -1,418 +0,0 @@ - - - - - - - - - - - ophyd.areadetector.cam.SimDetectorCam — ophyd documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
-
- - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

ophyd.areadetector.cam.SimDetectorCam

-
-
-class ophyd.areadetector.cam.SimDetectorCam(prefix='', *, name, read_attrs=None, configuration_attrs=None, parent=None, **kwargs)
-
-
-__init__(prefix='', *, name, read_attrs=None, configuration_attrs=None, parent=None, **kwargs)
-
- -

Methods

- ---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
__init__([prefix, read_attrs, …])
check_value(value, **kwargs)Check if the value is valid for this object
clear_sub(cb[, event_type])Remove a subscription, given the original callback function
configure((d: typing.Dict[str, …)Configure the device for something during a run
describe(…)Provide schema and meta-data for read()
describe_configuration(…)Provide schema & meta-data for read_configuration()
find_signal(text[, use_re, case_sensitive, …])Search through the signal docs on this detector for the string text
get(**kwargs)Get the value of all components in the device
get_asyn_digraph()Get the directed graph of the ASYN ports
get_asyn_port_dictionary()Return port name : component map
get_device_tuple()The device tuple type associated with an Device class
get_instantiated_signals(*[, attr_prefix])Yields all of the instantiated signals in a device hierarchy
get_plugin_by_asyn_port(port_name)Get the plugin which has the given asyn port name
missing_plugins()Find missing ports
pause(() -> None)Attempt to ‘pause’ the device.
put(dev_t, **kwargs)Put a value to all components of the device
read(() -> ophyd.device.OrderedDictType[str, …)Read data from the device
read_configuration(…)returns dictionary mapping names to (value, timestamp) pairs
resume(() -> None)Resume a device from a ‘paused’ state
stage(*args, **kwargs)
stop(*[, success])Stop the Device and all (instantiated) subdevices
subscribe(cb[, event_type, run])Subscribe to events this event_type generates.
summary()
trigger(() -> ophyd.status.StatusBase)Trigger the device and return status object
unstage(() -> typing.List[object])Unstage the device.
unsubscribe(cid)Remove a subscription
validate_asyn_ports()Validate that all components of pipeline are known
wait_for_connection([all_signals, timeout])Wait for signals to connect
-
- -
- - -
-
- -
-
- - -
-
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_as_gen/ophyd.areadetector.cam.URLDetectorCam.html b/ophyd/_as_gen/ophyd.areadetector.cam.URLDetectorCam.html deleted file mode 100644 index 017bc3a88c..0000000000 --- a/ophyd/_as_gen/ophyd.areadetector.cam.URLDetectorCam.html +++ /dev/null @@ -1,418 +0,0 @@ - - - - - - - - - - - ophyd.areadetector.cam.URLDetectorCam — ophyd documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
-
- - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

ophyd.areadetector.cam.URLDetectorCam

-
-
-class ophyd.areadetector.cam.URLDetectorCam(prefix='', *, name, read_attrs=None, configuration_attrs=None, parent=None, **kwargs)
-
-
-__init__(prefix='', *, name, read_attrs=None, configuration_attrs=None, parent=None, **kwargs)
-
- -

Methods

- ---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
__init__([prefix, read_attrs, …])
check_value(value, **kwargs)Check if the value is valid for this object
clear_sub(cb[, event_type])Remove a subscription, given the original callback function
configure((d: typing.Dict[str, …)Configure the device for something during a run
describe(…)Provide schema and meta-data for read()
describe_configuration(…)Provide schema & meta-data for read_configuration()
find_signal(text[, use_re, case_sensitive, …])Search through the signal docs on this detector for the string text
get(**kwargs)Get the value of all components in the device
get_asyn_digraph()Get the directed graph of the ASYN ports
get_asyn_port_dictionary()Return port name : component map
get_device_tuple()The device tuple type associated with an Device class
get_instantiated_signals(*[, attr_prefix])Yields all of the instantiated signals in a device hierarchy
get_plugin_by_asyn_port(port_name)Get the plugin which has the given asyn port name
missing_plugins()Find missing ports
pause(() -> None)Attempt to ‘pause’ the device.
put(dev_t, **kwargs)Put a value to all components of the device
read(() -> ophyd.device.OrderedDictType[str, …)Read data from the device
read_configuration(…)returns dictionary mapping names to (value, timestamp) pairs
resume(() -> None)Resume a device from a ‘paused’ state
stage(*args, **kwargs)
stop(*[, success])Stop the Device and all (instantiated) subdevices
subscribe(cb[, event_type, run])Subscribe to events this event_type generates.
summary()
trigger(() -> ophyd.status.StatusBase)Trigger the device and return status object
unstage(() -> typing.List[object])Unstage the device.
unsubscribe(cid)Remove a subscription
validate_asyn_ports()Validate that all components of pipeline are known
wait_for_connection([all_signals, timeout])Wait for signals to connect
-
- -
- - -
-
- -
-
- - -
-
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_as_gen/ophyd.areadetector.cam.html b/ophyd/_as_gen/ophyd.areadetector.cam.html deleted file mode 100644 index 79af48cf90..0000000000 --- a/ophyd/_as_gen/ophyd.areadetector.cam.html +++ /dev/null @@ -1,370 +0,0 @@ - - - - - - - - - - - ophyd.areadetector.cam — ophyd documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
-
- - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

ophyd.areadetector.cam

-

Classes

- ---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
AdscDetectorCam([prefix, read_attrs, …])
Andor3DetectorCam([prefix, read_attrs, …])
AndorDetectorCam([prefix, read_attrs, …])
AreaDetectorCam([prefix, read_attrs, …])
BrukerDetectorCam([prefix, read_attrs, …])
CamBase([prefix, read_attrs, …])
FirewireLinDetectorCam([prefix, read_attrs, …])
FirewireWinDetectorCam([prefix, read_attrs, …])
LightFieldDetectorCam([prefix, read_attrs, …])
Mar345DetectorCam([prefix, read_attrs, …])
MarCCDDetectorCam([prefix, read_attrs, …])
PSLDetectorCam([prefix, read_attrs, …])
PcoDetectorCam([prefix, read_attrs, …])
PcoDetectorIO([prefix, read_attrs, …])
PcoDetectorSimIO([prefix, read_attrs, …])
PerkinElmerDetectorCam([prefix, read_attrs, …])
PilatusDetectorCam([prefix, read_attrs, …])
PixiradDetectorCam([prefix, read_attrs, …])
PointGreyDetectorCam([prefix, read_attrs, …])
ProsilicaDetectorCam([prefix, read_attrs, …])
PvcamDetectorCam([prefix, read_attrs, …])
RoperDetectorCam([prefix, read_attrs, …])
SimDetectorCam([prefix, read_attrs, …])
URLDetectorCam([prefix, read_attrs, …])
-
- - -
-
- -
-
- - -
-
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_as_gen/ophyd.areadetector.detectors.AdscDetector.html b/ophyd/_as_gen/ophyd.areadetector.detectors.AdscDetector.html deleted file mode 100644 index 570256ddf6..0000000000 --- a/ophyd/_as_gen/ophyd.areadetector.detectors.AdscDetector.html +++ /dev/null @@ -1,399 +0,0 @@ - - - - - - - - - - - ophyd.areadetector.detectors.AdscDetector — ophyd documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
-
- - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

ophyd.areadetector.detectors.AdscDetector

-
-
-class ophyd.areadetector.detectors.AdscDetector(prefix='', *, name, read_attrs=None, configuration_attrs=None, parent=None, **kwargs)
-
-
-__init__(prefix='', *, name, read_attrs=None, configuration_attrs=None, parent=None, **kwargs)
-
- -

Methods

- ---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
__init__([prefix, read_attrs, …])
check_value(value, **kwargs)Check if the value is valid for this object
clear_sub(cb[, event_type])Remove a subscription, given the original callback function
configure((d: typing.Dict[str, …)Configure the device for something during a run
describe(…)Provide schema and meta-data for read()
describe_configuration(…)Provide schema & meta-data for read_configuration()
dispatch(key, timestamp)Notify plugins of acquisition being complete.
find_signal(text[, use_re, case_sensitive, …])Search through the signal docs on this detector for the string text
get(**kwargs)Get the value of all components in the device
get_asyn_digraph()Get the directed graph of the ASYN ports
get_asyn_port_dictionary()Return port name : component map
get_device_tuple()The device tuple type associated with an Device class
get_instantiated_signals(*[, attr_prefix])Yields all of the instantiated signals in a device hierarchy
get_plugin_by_asyn_port(port_name)Get the plugin which has the given asyn port name
make_data_key()
missing_plugins()Find missing ports
pause(() -> None)Attempt to ‘pause’ the device.
put(dev_t, **kwargs)Put a value to all components of the device
read(() -> ophyd.device.OrderedDictType[str, …)Read data from the device
read_configuration(…)returns dictionary mapping names to (value, timestamp) pairs
resume(() -> None)Resume a device from a ‘paused’ state
stage(*args, **kwargs)
stop(*[, success])Stop the Device and all (instantiated) subdevices
subscribe(cb[, event_type, run])Subscribe to events this event_type generates.
summary()
trigger(() -> ophyd.status.StatusBase)Trigger the device and return status object
unstage(() -> typing.List[object])Unstage the device.
unsubscribe(cid)Remove a subscription
validate_asyn_ports()Validate that all components of pipeline are known
wait_for_connection([all_signals, timeout])Wait for signals to connect
-
- -
- - -
-
- -
-
- - -
-
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_as_gen/ophyd.areadetector.detectors.Andor3Detector.html b/ophyd/_as_gen/ophyd.areadetector.detectors.Andor3Detector.html deleted file mode 100644 index fc4f61ddfc..0000000000 --- a/ophyd/_as_gen/ophyd.areadetector.detectors.Andor3Detector.html +++ /dev/null @@ -1,399 +0,0 @@ - - - - - - - - - - - ophyd.areadetector.detectors.Andor3Detector — ophyd documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
-
- - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

ophyd.areadetector.detectors.Andor3Detector

-
-
-class ophyd.areadetector.detectors.Andor3Detector(prefix='', *, name, read_attrs=None, configuration_attrs=None, parent=None, **kwargs)
-
-
-__init__(prefix='', *, name, read_attrs=None, configuration_attrs=None, parent=None, **kwargs)
-
- -

Methods

- ---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
__init__([prefix, read_attrs, …])
check_value(value, **kwargs)Check if the value is valid for this object
clear_sub(cb[, event_type])Remove a subscription, given the original callback function
configure((d: typing.Dict[str, …)Configure the device for something during a run
describe(…)Provide schema and meta-data for read()
describe_configuration(…)Provide schema & meta-data for read_configuration()
dispatch(key, timestamp)Notify plugins of acquisition being complete.
find_signal(text[, use_re, case_sensitive, …])Search through the signal docs on this detector for the string text
get(**kwargs)Get the value of all components in the device
get_asyn_digraph()Get the directed graph of the ASYN ports
get_asyn_port_dictionary()Return port name : component map
get_device_tuple()The device tuple type associated with an Device class
get_instantiated_signals(*[, attr_prefix])Yields all of the instantiated signals in a device hierarchy
get_plugin_by_asyn_port(port_name)Get the plugin which has the given asyn port name
make_data_key()
missing_plugins()Find missing ports
pause(() -> None)Attempt to ‘pause’ the device.
put(dev_t, **kwargs)Put a value to all components of the device
read(() -> ophyd.device.OrderedDictType[str, …)Read data from the device
read_configuration(…)returns dictionary mapping names to (value, timestamp) pairs
resume(() -> None)Resume a device from a ‘paused’ state
stage(*args, **kwargs)
stop(*[, success])Stop the Device and all (instantiated) subdevices
subscribe(cb[, event_type, run])Subscribe to events this event_type generates.
summary()
trigger(() -> ophyd.status.StatusBase)Trigger the device and return status object
unstage(() -> typing.List[object])Unstage the device.
unsubscribe(cid)Remove a subscription
validate_asyn_ports()Validate that all components of pipeline are known
wait_for_connection([all_signals, timeout])Wait for signals to connect
-
- -
- - -
-
- -
-
- - -
-
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_as_gen/ophyd.areadetector.detectors.AndorDetector.html b/ophyd/_as_gen/ophyd.areadetector.detectors.AndorDetector.html deleted file mode 100644 index 7eda9bf05d..0000000000 --- a/ophyd/_as_gen/ophyd.areadetector.detectors.AndorDetector.html +++ /dev/null @@ -1,399 +0,0 @@ - - - - - - - - - - - ophyd.areadetector.detectors.AndorDetector — ophyd documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
-
- - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

ophyd.areadetector.detectors.AndorDetector

-
-
-class ophyd.areadetector.detectors.AndorDetector(prefix='', *, name, read_attrs=None, configuration_attrs=None, parent=None, **kwargs)
-
-
-__init__(prefix='', *, name, read_attrs=None, configuration_attrs=None, parent=None, **kwargs)
-
- -

Methods

- ---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
__init__([prefix, read_attrs, …])
check_value(value, **kwargs)Check if the value is valid for this object
clear_sub(cb[, event_type])Remove a subscription, given the original callback function
configure((d: typing.Dict[str, …)Configure the device for something during a run
describe(…)Provide schema and meta-data for read()
describe_configuration(…)Provide schema & meta-data for read_configuration()
dispatch(key, timestamp)Notify plugins of acquisition being complete.
find_signal(text[, use_re, case_sensitive, …])Search through the signal docs on this detector for the string text
get(**kwargs)Get the value of all components in the device
get_asyn_digraph()Get the directed graph of the ASYN ports
get_asyn_port_dictionary()Return port name : component map
get_device_tuple()The device tuple type associated with an Device class
get_instantiated_signals(*[, attr_prefix])Yields all of the instantiated signals in a device hierarchy
get_plugin_by_asyn_port(port_name)Get the plugin which has the given asyn port name
make_data_key()
missing_plugins()Find missing ports
pause(() -> None)Attempt to ‘pause’ the device.
put(dev_t, **kwargs)Put a value to all components of the device
read(() -> ophyd.device.OrderedDictType[str, …)Read data from the device
read_configuration(…)returns dictionary mapping names to (value, timestamp) pairs
resume(() -> None)Resume a device from a ‘paused’ state
stage(*args, **kwargs)
stop(*[, success])Stop the Device and all (instantiated) subdevices
subscribe(cb[, event_type, run])Subscribe to events this event_type generates.
summary()
trigger(() -> ophyd.status.StatusBase)Trigger the device and return status object
unstage(() -> typing.List[object])Unstage the device.
unsubscribe(cid)Remove a subscription
validate_asyn_ports()Validate that all components of pipeline are known
wait_for_connection([all_signals, timeout])Wait for signals to connect
-
- -
- - -
-
- -
-
- - -
-
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_as_gen/ophyd.areadetector.detectors.AreaDetector.html b/ophyd/_as_gen/ophyd.areadetector.detectors.AreaDetector.html deleted file mode 100644 index 8bd219fea0..0000000000 --- a/ophyd/_as_gen/ophyd.areadetector.detectors.AreaDetector.html +++ /dev/null @@ -1,399 +0,0 @@ - - - - - - - - - - - ophyd.areadetector.detectors.AreaDetector — ophyd documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
-
- - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

ophyd.areadetector.detectors.AreaDetector

-
-
-class ophyd.areadetector.detectors.AreaDetector(prefix='', *, name, read_attrs=None, configuration_attrs=None, parent=None, **kwargs)
-
-
-__init__(prefix='', *, name, read_attrs=None, configuration_attrs=None, parent=None, **kwargs)
-
- -

Methods

- ---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
__init__([prefix, read_attrs, …])
check_value(value, **kwargs)Check if the value is valid for this object
clear_sub(cb[, event_type])Remove a subscription, given the original callback function
configure((d: typing.Dict[str, …)Configure the device for something during a run
describe(…)Provide schema and meta-data for read()
describe_configuration(…)Provide schema & meta-data for read_configuration()
dispatch(key, timestamp)Notify plugins of acquisition being complete.
find_signal(text[, use_re, case_sensitive, …])Search through the signal docs on this detector for the string text
get(**kwargs)Get the value of all components in the device
get_asyn_digraph()Get the directed graph of the ASYN ports
get_asyn_port_dictionary()Return port name : component map
get_device_tuple()The device tuple type associated with an Device class
get_instantiated_signals(*[, attr_prefix])Yields all of the instantiated signals in a device hierarchy
get_plugin_by_asyn_port(port_name)Get the plugin which has the given asyn port name
make_data_key()
missing_plugins()Find missing ports
pause(() -> None)Attempt to ‘pause’ the device.
put(dev_t, **kwargs)Put a value to all components of the device
read(() -> ophyd.device.OrderedDictType[str, …)Read data from the device
read_configuration(…)returns dictionary mapping names to (value, timestamp) pairs
resume(() -> None)Resume a device from a ‘paused’ state
stage(*args, **kwargs)
stop(*[, success])Stop the Device and all (instantiated) subdevices
subscribe(cb[, event_type, run])Subscribe to events this event_type generates.
summary()
trigger(() -> ophyd.status.StatusBase)Trigger the device and return status object
unstage(() -> typing.List[object])Unstage the device.
unsubscribe(cid)Remove a subscription
validate_asyn_ports()Validate that all components of pipeline are known
wait_for_connection([all_signals, timeout])Wait for signals to connect
-
- -
- - -
-
- -
-
- - -
-
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_as_gen/ophyd.areadetector.detectors.BrukerDetector.html b/ophyd/_as_gen/ophyd.areadetector.detectors.BrukerDetector.html deleted file mode 100644 index ddce738bda..0000000000 --- a/ophyd/_as_gen/ophyd.areadetector.detectors.BrukerDetector.html +++ /dev/null @@ -1,399 +0,0 @@ - - - - - - - - - - - ophyd.areadetector.detectors.BrukerDetector — ophyd documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
-
- - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

ophyd.areadetector.detectors.BrukerDetector

-
-
-class ophyd.areadetector.detectors.BrukerDetector(prefix='', *, name, read_attrs=None, configuration_attrs=None, parent=None, **kwargs)
-
-
-__init__(prefix='', *, name, read_attrs=None, configuration_attrs=None, parent=None, **kwargs)
-
- -

Methods

- ---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
__init__([prefix, read_attrs, …])
check_value(value, **kwargs)Check if the value is valid for this object
clear_sub(cb[, event_type])Remove a subscription, given the original callback function
configure((d: typing.Dict[str, …)Configure the device for something during a run
describe(…)Provide schema and meta-data for read()
describe_configuration(…)Provide schema & meta-data for read_configuration()
dispatch(key, timestamp)Notify plugins of acquisition being complete.
find_signal(text[, use_re, case_sensitive, …])Search through the signal docs on this detector for the string text
get(**kwargs)Get the value of all components in the device
get_asyn_digraph()Get the directed graph of the ASYN ports
get_asyn_port_dictionary()Return port name : component map
get_device_tuple()The device tuple type associated with an Device class
get_instantiated_signals(*[, attr_prefix])Yields all of the instantiated signals in a device hierarchy
get_plugin_by_asyn_port(port_name)Get the plugin which has the given asyn port name
make_data_key()
missing_plugins()Find missing ports
pause(() -> None)Attempt to ‘pause’ the device.
put(dev_t, **kwargs)Put a value to all components of the device
read(() -> ophyd.device.OrderedDictType[str, …)Read data from the device
read_configuration(…)returns dictionary mapping names to (value, timestamp) pairs
resume(() -> None)Resume a device from a ‘paused’ state
stage(*args, **kwargs)
stop(*[, success])Stop the Device and all (instantiated) subdevices
subscribe(cb[, event_type, run])Subscribe to events this event_type generates.
summary()
trigger(() -> ophyd.status.StatusBase)Trigger the device and return status object
unstage(() -> typing.List[object])Unstage the device.
unsubscribe(cid)Remove a subscription
validate_asyn_ports()Validate that all components of pipeline are known
wait_for_connection([all_signals, timeout])Wait for signals to connect
-
- -
- - -
-
- -
-
- - -
-
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_as_gen/ophyd.areadetector.detectors.DetectorBase.dispatch.html b/ophyd/_as_gen/ophyd.areadetector.detectors.DetectorBase.dispatch.html deleted file mode 100644 index 53d3e53210..0000000000 --- a/ophyd/_as_gen/ophyd.areadetector.detectors.DetectorBase.dispatch.html +++ /dev/null @@ -1,292 +0,0 @@ - - - - - - - - - - - ophyd.areadetector.detectors.DetectorBase.dispatch — ophyd documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
-
- - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

ophyd.areadetector.detectors.DetectorBase.dispatch

-
-
-DetectorBase.dispatch(key, timestamp)
-

Notify plugins of acquisition being complete.

-

When a new acquisition is finished, this method is called with a -key which is a label like ‘light’, ‘dark’, or ‘gain8’.

-

It in turn calls all of the file plugins and makes them insert a -datum into FileStore.

-

File plugins are identified by searching for a -generate_datum() -method that must have the siganture

-
def generate_datum(key: str, timestamp: float):
-   ...
-
-
-
- -
- - -
-
- -
-
- - -
-
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_as_gen/ophyd.areadetector.detectors.DetectorBase.html b/ophyd/_as_gen/ophyd.areadetector.detectors.DetectorBase.html deleted file mode 100644 index 2493ae6e07..0000000000 --- a/ophyd/_as_gen/ophyd.areadetector.detectors.DetectorBase.html +++ /dev/null @@ -1,387 +0,0 @@ - - - - - - - - - - - ophyd.areadetector.detectors.DetectorBase — ophyd documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
-
- - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

ophyd.areadetector.detectors.DetectorBase

-
-
-class ophyd.areadetector.detectors.DetectorBase(prefix='', *, name, read_attrs=None, configuration_attrs=None, parent=None, **kwargs)
-

The base class for the hardware-specific classes that follow.

-

Note that Plugin also inherits from ADBase. -This adds some AD-specific methods that are not shared by the plugins.

-
-
-__init__(prefix='', *, name, read_attrs=None, configuration_attrs=None, parent=None, **kwargs)
-
- -

Methods

- ---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
__init__([prefix, read_attrs, …])
check_value(value, **kwargs)Check if the value is valid for this object
clear_sub(cb[, event_type])Remove a subscription, given the original callback function
configure((d: typing.Dict[str, …)Configure the device for something during a run
describe(…)Provide schema and meta-data for read()
describe_configuration(…)Provide schema & meta-data for read_configuration()
dispatch(key, timestamp)Notify plugins of acquisition being complete.
find_signal(text[, use_re, case_sensitive, …])Search through the signal docs on this detector for the string text
get(**kwargs)Get the value of all components in the device
get_asyn_digraph()Get the directed graph of the ASYN ports
get_asyn_port_dictionary()Return port name : component map
get_device_tuple()The device tuple type associated with an Device class
get_instantiated_signals(*[, attr_prefix])Yields all of the instantiated signals in a device hierarchy
get_plugin_by_asyn_port(port_name)Get the plugin which has the given asyn port name
make_data_key()
missing_plugins()Find missing ports
pause(() -> None)Attempt to ‘pause’ the device.
put(dev_t, **kwargs)Put a value to all components of the device
read(() -> ophyd.device.OrderedDictType[str, …)Read data from the device
read_configuration(…)returns dictionary mapping names to (value, timestamp) pairs
resume(() -> None)Resume a device from a ‘paused’ state
stage(*args, **kwargs)
stop(*[, success])Stop the Device and all (instantiated) subdevices
subscribe(cb[, event_type, run])Subscribe to events this event_type generates.
summary()
trigger(() -> ophyd.status.StatusBase)Trigger the device and return status object
unstage(() -> typing.List[object])Unstage the device.
unsubscribe(cid)Remove a subscription
validate_asyn_ports()Validate that all components of pipeline are known
wait_for_connection([all_signals, timeout])Wait for signals to connect
-
- -
- - -
-
- -
-
- - -
-
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_as_gen/ophyd.areadetector.detectors.DetectorBase.make_data_key.html b/ophyd/_as_gen/ophyd.areadetector.detectors.DetectorBase.make_data_key.html deleted file mode 100644 index fbe07e1b7f..0000000000 --- a/ophyd/_as_gen/ophyd.areadetector.detectors.DetectorBase.make_data_key.html +++ /dev/null @@ -1,280 +0,0 @@ - - - - - - - - - - - ophyd.areadetector.detectors.DetectorBase.make_data_key — ophyd documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
-
- - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

ophyd.areadetector.detectors.DetectorBase.make_data_key

-
-
-DetectorBase.make_data_key()
-
- -
- - -
-
- -
-
- - -
-
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_as_gen/ophyd.areadetector.detectors.FirewireLinDetector.html b/ophyd/_as_gen/ophyd.areadetector.detectors.FirewireLinDetector.html deleted file mode 100644 index 31f928ade7..0000000000 --- a/ophyd/_as_gen/ophyd.areadetector.detectors.FirewireLinDetector.html +++ /dev/null @@ -1,399 +0,0 @@ - - - - - - - - - - - ophyd.areadetector.detectors.FirewireLinDetector — ophyd documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
-
- - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

ophyd.areadetector.detectors.FirewireLinDetector

-
-
-class ophyd.areadetector.detectors.FirewireLinDetector(prefix='', *, name, read_attrs=None, configuration_attrs=None, parent=None, **kwargs)
-
-
-__init__(prefix='', *, name, read_attrs=None, configuration_attrs=None, parent=None, **kwargs)
-
- -

Methods

- ---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
__init__([prefix, read_attrs, …])
check_value(value, **kwargs)Check if the value is valid for this object
clear_sub(cb[, event_type])Remove a subscription, given the original callback function
configure((d: typing.Dict[str, …)Configure the device for something during a run
describe(…)Provide schema and meta-data for read()
describe_configuration(…)Provide schema & meta-data for read_configuration()
dispatch(key, timestamp)Notify plugins of acquisition being complete.
find_signal(text[, use_re, case_sensitive, …])Search through the signal docs on this detector for the string text
get(**kwargs)Get the value of all components in the device
get_asyn_digraph()Get the directed graph of the ASYN ports
get_asyn_port_dictionary()Return port name : component map
get_device_tuple()The device tuple type associated with an Device class
get_instantiated_signals(*[, attr_prefix])Yields all of the instantiated signals in a device hierarchy
get_plugin_by_asyn_port(port_name)Get the plugin which has the given asyn port name
make_data_key()
missing_plugins()Find missing ports
pause(() -> None)Attempt to ‘pause’ the device.
put(dev_t, **kwargs)Put a value to all components of the device
read(() -> ophyd.device.OrderedDictType[str, …)Read data from the device
read_configuration(…)returns dictionary mapping names to (value, timestamp) pairs
resume(() -> None)Resume a device from a ‘paused’ state
stage(*args, **kwargs)
stop(*[, success])Stop the Device and all (instantiated) subdevices
subscribe(cb[, event_type, run])Subscribe to events this event_type generates.
summary()
trigger(() -> ophyd.status.StatusBase)Trigger the device and return status object
unstage(() -> typing.List[object])Unstage the device.
unsubscribe(cid)Remove a subscription
validate_asyn_ports()Validate that all components of pipeline are known
wait_for_connection([all_signals, timeout])Wait for signals to connect
-
- -
- - -
-
- -
-
- - -
-
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_as_gen/ophyd.areadetector.detectors.FirewireWinDetector.html b/ophyd/_as_gen/ophyd.areadetector.detectors.FirewireWinDetector.html deleted file mode 100644 index 64494e2971..0000000000 --- a/ophyd/_as_gen/ophyd.areadetector.detectors.FirewireWinDetector.html +++ /dev/null @@ -1,399 +0,0 @@ - - - - - - - - - - - ophyd.areadetector.detectors.FirewireWinDetector — ophyd documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
-
- - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

ophyd.areadetector.detectors.FirewireWinDetector

-
-
-class ophyd.areadetector.detectors.FirewireWinDetector(prefix='', *, name, read_attrs=None, configuration_attrs=None, parent=None, **kwargs)
-
-
-__init__(prefix='', *, name, read_attrs=None, configuration_attrs=None, parent=None, **kwargs)
-
- -

Methods

- ---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
__init__([prefix, read_attrs, …])
check_value(value, **kwargs)Check if the value is valid for this object
clear_sub(cb[, event_type])Remove a subscription, given the original callback function
configure((d: typing.Dict[str, …)Configure the device for something during a run
describe(…)Provide schema and meta-data for read()
describe_configuration(…)Provide schema & meta-data for read_configuration()
dispatch(key, timestamp)Notify plugins of acquisition being complete.
find_signal(text[, use_re, case_sensitive, …])Search through the signal docs on this detector for the string text
get(**kwargs)Get the value of all components in the device
get_asyn_digraph()Get the directed graph of the ASYN ports
get_asyn_port_dictionary()Return port name : component map
get_device_tuple()The device tuple type associated with an Device class
get_instantiated_signals(*[, attr_prefix])Yields all of the instantiated signals in a device hierarchy
get_plugin_by_asyn_port(port_name)Get the plugin which has the given asyn port name
make_data_key()
missing_plugins()Find missing ports
pause(() -> None)Attempt to ‘pause’ the device.
put(dev_t, **kwargs)Put a value to all components of the device
read(() -> ophyd.device.OrderedDictType[str, …)Read data from the device
read_configuration(…)returns dictionary mapping names to (value, timestamp) pairs
resume(() -> None)Resume a device from a ‘paused’ state
stage(*args, **kwargs)
stop(*[, success])Stop the Device and all (instantiated) subdevices
subscribe(cb[, event_type, run])Subscribe to events this event_type generates.
summary()
trigger(() -> ophyd.status.StatusBase)Trigger the device and return status object
unstage(() -> typing.List[object])Unstage the device.
unsubscribe(cid)Remove a subscription
validate_asyn_ports()Validate that all components of pipeline are known
wait_for_connection([all_signals, timeout])Wait for signals to connect
-
- -
- - -
-
- -
-
- - -
-
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_as_gen/ophyd.areadetector.detectors.LightFieldDetector.html b/ophyd/_as_gen/ophyd.areadetector.detectors.LightFieldDetector.html deleted file mode 100644 index 821bf698e7..0000000000 --- a/ophyd/_as_gen/ophyd.areadetector.detectors.LightFieldDetector.html +++ /dev/null @@ -1,399 +0,0 @@ - - - - - - - - - - - ophyd.areadetector.detectors.LightFieldDetector — ophyd documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
-
- - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

ophyd.areadetector.detectors.LightFieldDetector

-
-
-class ophyd.areadetector.detectors.LightFieldDetector(prefix='', *, name, read_attrs=None, configuration_attrs=None, parent=None, **kwargs)
-
-
-__init__(prefix='', *, name, read_attrs=None, configuration_attrs=None, parent=None, **kwargs)
-
- -

Methods

- ---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
__init__([prefix, read_attrs, …])
check_value(value, **kwargs)Check if the value is valid for this object
clear_sub(cb[, event_type])Remove a subscription, given the original callback function
configure((d: typing.Dict[str, …)Configure the device for something during a run
describe(…)Provide schema and meta-data for read()
describe_configuration(…)Provide schema & meta-data for read_configuration()
dispatch(key, timestamp)Notify plugins of acquisition being complete.
find_signal(text[, use_re, case_sensitive, …])Search through the signal docs on this detector for the string text
get(**kwargs)Get the value of all components in the device
get_asyn_digraph()Get the directed graph of the ASYN ports
get_asyn_port_dictionary()Return port name : component map
get_device_tuple()The device tuple type associated with an Device class
get_instantiated_signals(*[, attr_prefix])Yields all of the instantiated signals in a device hierarchy
get_plugin_by_asyn_port(port_name)Get the plugin which has the given asyn port name
make_data_key()
missing_plugins()Find missing ports
pause(() -> None)Attempt to ‘pause’ the device.
put(dev_t, **kwargs)Put a value to all components of the device
read(() -> ophyd.device.OrderedDictType[str, …)Read data from the device
read_configuration(…)returns dictionary mapping names to (value, timestamp) pairs
resume(() -> None)Resume a device from a ‘paused’ state
stage(*args, **kwargs)
stop(*[, success])Stop the Device and all (instantiated) subdevices
subscribe(cb[, event_type, run])Subscribe to events this event_type generates.
summary()
trigger(() -> ophyd.status.StatusBase)Trigger the device and return status object
unstage(() -> typing.List[object])Unstage the device.
unsubscribe(cid)Remove a subscription
validate_asyn_ports()Validate that all components of pipeline are known
wait_for_connection([all_signals, timeout])Wait for signals to connect
-
- -
- - -
-
- -
-
- - -
-
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_as_gen/ophyd.areadetector.detectors.Mar345Detector.html b/ophyd/_as_gen/ophyd.areadetector.detectors.Mar345Detector.html deleted file mode 100644 index b0ef60f066..0000000000 --- a/ophyd/_as_gen/ophyd.areadetector.detectors.Mar345Detector.html +++ /dev/null @@ -1,399 +0,0 @@ - - - - - - - - - - - ophyd.areadetector.detectors.Mar345Detector — ophyd documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
-
- - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

ophyd.areadetector.detectors.Mar345Detector

-
-
-class ophyd.areadetector.detectors.Mar345Detector(prefix='', *, name, read_attrs=None, configuration_attrs=None, parent=None, **kwargs)
-
-
-__init__(prefix='', *, name, read_attrs=None, configuration_attrs=None, parent=None, **kwargs)
-
- -

Methods

- ---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
__init__([prefix, read_attrs, …])
check_value(value, **kwargs)Check if the value is valid for this object
clear_sub(cb[, event_type])Remove a subscription, given the original callback function
configure((d: typing.Dict[str, …)Configure the device for something during a run
describe(…)Provide schema and meta-data for read()
describe_configuration(…)Provide schema & meta-data for read_configuration()
dispatch(key, timestamp)Notify plugins of acquisition being complete.
find_signal(text[, use_re, case_sensitive, …])Search through the signal docs on this detector for the string text
get(**kwargs)Get the value of all components in the device
get_asyn_digraph()Get the directed graph of the ASYN ports
get_asyn_port_dictionary()Return port name : component map
get_device_tuple()The device tuple type associated with an Device class
get_instantiated_signals(*[, attr_prefix])Yields all of the instantiated signals in a device hierarchy
get_plugin_by_asyn_port(port_name)Get the plugin which has the given asyn port name
make_data_key()
missing_plugins()Find missing ports
pause(() -> None)Attempt to ‘pause’ the device.
put(dev_t, **kwargs)Put a value to all components of the device
read(() -> ophyd.device.OrderedDictType[str, …)Read data from the device
read_configuration(…)returns dictionary mapping names to (value, timestamp) pairs
resume(() -> None)Resume a device from a ‘paused’ state
stage(*args, **kwargs)
stop(*[, success])Stop the Device and all (instantiated) subdevices
subscribe(cb[, event_type, run])Subscribe to events this event_type generates.
summary()
trigger(() -> ophyd.status.StatusBase)Trigger the device and return status object
unstage(() -> typing.List[object])Unstage the device.
unsubscribe(cid)Remove a subscription
validate_asyn_ports()Validate that all components of pipeline are known
wait_for_connection([all_signals, timeout])Wait for signals to connect
-
- -
- - -
-
- -
-
- - -
-
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_as_gen/ophyd.areadetector.detectors.MarCCDDetector.html b/ophyd/_as_gen/ophyd.areadetector.detectors.MarCCDDetector.html deleted file mode 100644 index c38766177a..0000000000 --- a/ophyd/_as_gen/ophyd.areadetector.detectors.MarCCDDetector.html +++ /dev/null @@ -1,399 +0,0 @@ - - - - - - - - - - - ophyd.areadetector.detectors.MarCCDDetector — ophyd documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
-
- - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

ophyd.areadetector.detectors.MarCCDDetector

-
-
-class ophyd.areadetector.detectors.MarCCDDetector(prefix='', *, name, read_attrs=None, configuration_attrs=None, parent=None, **kwargs)
-
-
-__init__(prefix='', *, name, read_attrs=None, configuration_attrs=None, parent=None, **kwargs)
-
- -

Methods

- ---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
__init__([prefix, read_attrs, …])
check_value(value, **kwargs)Check if the value is valid for this object
clear_sub(cb[, event_type])Remove a subscription, given the original callback function
configure((d: typing.Dict[str, …)Configure the device for something during a run
describe(…)Provide schema and meta-data for read()
describe_configuration(…)Provide schema & meta-data for read_configuration()
dispatch(key, timestamp)Notify plugins of acquisition being complete.
find_signal(text[, use_re, case_sensitive, …])Search through the signal docs on this detector for the string text
get(**kwargs)Get the value of all components in the device
get_asyn_digraph()Get the directed graph of the ASYN ports
get_asyn_port_dictionary()Return port name : component map
get_device_tuple()The device tuple type associated with an Device class
get_instantiated_signals(*[, attr_prefix])Yields all of the instantiated signals in a device hierarchy
get_plugin_by_asyn_port(port_name)Get the plugin which has the given asyn port name
make_data_key()
missing_plugins()Find missing ports
pause(() -> None)Attempt to ‘pause’ the device.
put(dev_t, **kwargs)Put a value to all components of the device
read(() -> ophyd.device.OrderedDictType[str, …)Read data from the device
read_configuration(…)returns dictionary mapping names to (value, timestamp) pairs
resume(() -> None)Resume a device from a ‘paused’ state
stage(*args, **kwargs)
stop(*[, success])Stop the Device and all (instantiated) subdevices
subscribe(cb[, event_type, run])Subscribe to events this event_type generates.
summary()
trigger(() -> ophyd.status.StatusBase)Trigger the device and return status object
unstage(() -> typing.List[object])Unstage the device.
unsubscribe(cid)Remove a subscription
validate_asyn_ports()Validate that all components of pipeline are known
wait_for_connection([all_signals, timeout])Wait for signals to connect
-
- -
- - -
-
- -
-
- - -
-
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_as_gen/ophyd.areadetector.detectors.PSLDetector.html b/ophyd/_as_gen/ophyd.areadetector.detectors.PSLDetector.html deleted file mode 100644 index c599695ae1..0000000000 --- a/ophyd/_as_gen/ophyd.areadetector.detectors.PSLDetector.html +++ /dev/null @@ -1,399 +0,0 @@ - - - - - - - - - - - ophyd.areadetector.detectors.PSLDetector — ophyd documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
-
- - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

ophyd.areadetector.detectors.PSLDetector

-
-
-class ophyd.areadetector.detectors.PSLDetector(prefix='', *, name, read_attrs=None, configuration_attrs=None, parent=None, **kwargs)
-
-
-__init__(prefix='', *, name, read_attrs=None, configuration_attrs=None, parent=None, **kwargs)
-
- -

Methods

- ---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
__init__([prefix, read_attrs, …])
check_value(value, **kwargs)Check if the value is valid for this object
clear_sub(cb[, event_type])Remove a subscription, given the original callback function
configure((d: typing.Dict[str, …)Configure the device for something during a run
describe(…)Provide schema and meta-data for read()
describe_configuration(…)Provide schema & meta-data for read_configuration()
dispatch(key, timestamp)Notify plugins of acquisition being complete.
find_signal(text[, use_re, case_sensitive, …])Search through the signal docs on this detector for the string text
get(**kwargs)Get the value of all components in the device
get_asyn_digraph()Get the directed graph of the ASYN ports
get_asyn_port_dictionary()Return port name : component map
get_device_tuple()The device tuple type associated with an Device class
get_instantiated_signals(*[, attr_prefix])Yields all of the instantiated signals in a device hierarchy
get_plugin_by_asyn_port(port_name)Get the plugin which has the given asyn port name
make_data_key()
missing_plugins()Find missing ports
pause(() -> None)Attempt to ‘pause’ the device.
put(dev_t, **kwargs)Put a value to all components of the device
read(() -> ophyd.device.OrderedDictType[str, …)Read data from the device
read_configuration(…)returns dictionary mapping names to (value, timestamp) pairs
resume(() -> None)Resume a device from a ‘paused’ state
stage(*args, **kwargs)
stop(*[, success])Stop the Device and all (instantiated) subdevices
subscribe(cb[, event_type, run])Subscribe to events this event_type generates.
summary()
trigger(() -> ophyd.status.StatusBase)Trigger the device and return status object
unstage(() -> typing.List[object])Unstage the device.
unsubscribe(cid)Remove a subscription
validate_asyn_ports()Validate that all components of pipeline are known
wait_for_connection([all_signals, timeout])Wait for signals to connect
-
- -
- - -
-
- -
-
- - -
-
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_as_gen/ophyd.areadetector.detectors.PerkinElmerDetector.html b/ophyd/_as_gen/ophyd.areadetector.detectors.PerkinElmerDetector.html deleted file mode 100644 index f2434c4c4a..0000000000 --- a/ophyd/_as_gen/ophyd.areadetector.detectors.PerkinElmerDetector.html +++ /dev/null @@ -1,399 +0,0 @@ - - - - - - - - - - - ophyd.areadetector.detectors.PerkinElmerDetector — ophyd documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
-
- - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

ophyd.areadetector.detectors.PerkinElmerDetector

-
-
-class ophyd.areadetector.detectors.PerkinElmerDetector(prefix='', *, name, read_attrs=None, configuration_attrs=None, parent=None, **kwargs)
-
-
-__init__(prefix='', *, name, read_attrs=None, configuration_attrs=None, parent=None, **kwargs)
-
- -

Methods

- ---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
__init__([prefix, read_attrs, …])
check_value(value, **kwargs)Check if the value is valid for this object
clear_sub(cb[, event_type])Remove a subscription, given the original callback function
configure((d: typing.Dict[str, …)Configure the device for something during a run
describe(…)Provide schema and meta-data for read()
describe_configuration(…)Provide schema & meta-data for read_configuration()
dispatch(key, timestamp)Notify plugins of acquisition being complete.
find_signal(text[, use_re, case_sensitive, …])Search through the signal docs on this detector for the string text
get(**kwargs)Get the value of all components in the device
get_asyn_digraph()Get the directed graph of the ASYN ports
get_asyn_port_dictionary()Return port name : component map
get_device_tuple()The device tuple type associated with an Device class
get_instantiated_signals(*[, attr_prefix])Yields all of the instantiated signals in a device hierarchy
get_plugin_by_asyn_port(port_name)Get the plugin which has the given asyn port name
make_data_key()
missing_plugins()Find missing ports
pause(() -> None)Attempt to ‘pause’ the device.
put(dev_t, **kwargs)Put a value to all components of the device
read(() -> ophyd.device.OrderedDictType[str, …)Read data from the device
read_configuration(…)returns dictionary mapping names to (value, timestamp) pairs
resume(() -> None)Resume a device from a ‘paused’ state
stage(*args, **kwargs)
stop(*[, success])Stop the Device and all (instantiated) subdevices
subscribe(cb[, event_type, run])Subscribe to events this event_type generates.
summary()
trigger(() -> ophyd.status.StatusBase)Trigger the device and return status object
unstage(() -> typing.List[object])Unstage the device.
unsubscribe(cid)Remove a subscription
validate_asyn_ports()Validate that all components of pipeline are known
wait_for_connection([all_signals, timeout])Wait for signals to connect
-
- -
- - -
-
- -
-
- - -
-
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_as_gen/ophyd.areadetector.detectors.PilatusDetector.html b/ophyd/_as_gen/ophyd.areadetector.detectors.PilatusDetector.html deleted file mode 100644 index 29a32f9788..0000000000 --- a/ophyd/_as_gen/ophyd.areadetector.detectors.PilatusDetector.html +++ /dev/null @@ -1,399 +0,0 @@ - - - - - - - - - - - ophyd.areadetector.detectors.PilatusDetector — ophyd documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
-
- - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

ophyd.areadetector.detectors.PilatusDetector

-
-
-class ophyd.areadetector.detectors.PilatusDetector(prefix='', *, name, read_attrs=None, configuration_attrs=None, parent=None, **kwargs)
-
-
-__init__(prefix='', *, name, read_attrs=None, configuration_attrs=None, parent=None, **kwargs)
-
- -

Methods

- ---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
__init__([prefix, read_attrs, …])
check_value(value, **kwargs)Check if the value is valid for this object
clear_sub(cb[, event_type])Remove a subscription, given the original callback function
configure((d: typing.Dict[str, …)Configure the device for something during a run
describe(…)Provide schema and meta-data for read()
describe_configuration(…)Provide schema & meta-data for read_configuration()
dispatch(key, timestamp)Notify plugins of acquisition being complete.
find_signal(text[, use_re, case_sensitive, …])Search through the signal docs on this detector for the string text
get(**kwargs)Get the value of all components in the device
get_asyn_digraph()Get the directed graph of the ASYN ports
get_asyn_port_dictionary()Return port name : component map
get_device_tuple()The device tuple type associated with an Device class
get_instantiated_signals(*[, attr_prefix])Yields all of the instantiated signals in a device hierarchy
get_plugin_by_asyn_port(port_name)Get the plugin which has the given asyn port name
make_data_key()
missing_plugins()Find missing ports
pause(() -> None)Attempt to ‘pause’ the device.
put(dev_t, **kwargs)Put a value to all components of the device
read(() -> ophyd.device.OrderedDictType[str, …)Read data from the device
read_configuration(…)returns dictionary mapping names to (value, timestamp) pairs
resume(() -> None)Resume a device from a ‘paused’ state
stage(*args, **kwargs)
stop(*[, success])Stop the Device and all (instantiated) subdevices
subscribe(cb[, event_type, run])Subscribe to events this event_type generates.
summary()
trigger(() -> ophyd.status.StatusBase)Trigger the device and return status object
unstage(() -> typing.List[object])Unstage the device.
unsubscribe(cid)Remove a subscription
validate_asyn_ports()Validate that all components of pipeline are known
wait_for_connection([all_signals, timeout])Wait for signals to connect
-
- -
- - -
-
- -
-
- - -
-
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_as_gen/ophyd.areadetector.detectors.PixiradDetector.html b/ophyd/_as_gen/ophyd.areadetector.detectors.PixiradDetector.html deleted file mode 100644 index 1cc2406cf6..0000000000 --- a/ophyd/_as_gen/ophyd.areadetector.detectors.PixiradDetector.html +++ /dev/null @@ -1,399 +0,0 @@ - - - - - - - - - - - ophyd.areadetector.detectors.PixiradDetector — ophyd documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
-
- - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

ophyd.areadetector.detectors.PixiradDetector

-
-
-class ophyd.areadetector.detectors.PixiradDetector(prefix='', *, name, read_attrs=None, configuration_attrs=None, parent=None, **kwargs)
-
-
-__init__(prefix='', *, name, read_attrs=None, configuration_attrs=None, parent=None, **kwargs)
-
- -

Methods

- ---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
__init__([prefix, read_attrs, …])
check_value(value, **kwargs)Check if the value is valid for this object
clear_sub(cb[, event_type])Remove a subscription, given the original callback function
configure((d: typing.Dict[str, …)Configure the device for something during a run
describe(…)Provide schema and meta-data for read()
describe_configuration(…)Provide schema & meta-data for read_configuration()
dispatch(key, timestamp)Notify plugins of acquisition being complete.
find_signal(text[, use_re, case_sensitive, …])Search through the signal docs on this detector for the string text
get(**kwargs)Get the value of all components in the device
get_asyn_digraph()Get the directed graph of the ASYN ports
get_asyn_port_dictionary()Return port name : component map
get_device_tuple()The device tuple type associated with an Device class
get_instantiated_signals(*[, attr_prefix])Yields all of the instantiated signals in a device hierarchy
get_plugin_by_asyn_port(port_name)Get the plugin which has the given asyn port name
make_data_key()
missing_plugins()Find missing ports
pause(() -> None)Attempt to ‘pause’ the device.
put(dev_t, **kwargs)Put a value to all components of the device
read(() -> ophyd.device.OrderedDictType[str, …)Read data from the device
read_configuration(…)returns dictionary mapping names to (value, timestamp) pairs
resume(() -> None)Resume a device from a ‘paused’ state
stage(*args, **kwargs)
stop(*[, success])Stop the Device and all (instantiated) subdevices
subscribe(cb[, event_type, run])Subscribe to events this event_type generates.
summary()
trigger(() -> ophyd.status.StatusBase)Trigger the device and return status object
unstage(() -> typing.List[object])Unstage the device.
unsubscribe(cid)Remove a subscription
validate_asyn_ports()Validate that all components of pipeline are known
wait_for_connection([all_signals, timeout])Wait for signals to connect
-
- -
- - -
-
- -
-
- - -
-
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_as_gen/ophyd.areadetector.detectors.PointGreyDetector.html b/ophyd/_as_gen/ophyd.areadetector.detectors.PointGreyDetector.html deleted file mode 100644 index 2a01d5f7a8..0000000000 --- a/ophyd/_as_gen/ophyd.areadetector.detectors.PointGreyDetector.html +++ /dev/null @@ -1,399 +0,0 @@ - - - - - - - - - - - ophyd.areadetector.detectors.PointGreyDetector — ophyd documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
-
- - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

ophyd.areadetector.detectors.PointGreyDetector

-
-
-class ophyd.areadetector.detectors.PointGreyDetector(prefix='', *, name, read_attrs=None, configuration_attrs=None, parent=None, **kwargs)
-
-
-__init__(prefix='', *, name, read_attrs=None, configuration_attrs=None, parent=None, **kwargs)
-
- -

Methods

- ---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
__init__([prefix, read_attrs, …])
check_value(value, **kwargs)Check if the value is valid for this object
clear_sub(cb[, event_type])Remove a subscription, given the original callback function
configure((d: typing.Dict[str, …)Configure the device for something during a run
describe(…)Provide schema and meta-data for read()
describe_configuration(…)Provide schema & meta-data for read_configuration()
dispatch(key, timestamp)Notify plugins of acquisition being complete.
find_signal(text[, use_re, case_sensitive, …])Search through the signal docs on this detector for the string text
get(**kwargs)Get the value of all components in the device
get_asyn_digraph()Get the directed graph of the ASYN ports
get_asyn_port_dictionary()Return port name : component map
get_device_tuple()The device tuple type associated with an Device class
get_instantiated_signals(*[, attr_prefix])Yields all of the instantiated signals in a device hierarchy
get_plugin_by_asyn_port(port_name)Get the plugin which has the given asyn port name
make_data_key()
missing_plugins()Find missing ports
pause(() -> None)Attempt to ‘pause’ the device.
put(dev_t, **kwargs)Put a value to all components of the device
read(() -> ophyd.device.OrderedDictType[str, …)Read data from the device
read_configuration(…)returns dictionary mapping names to (value, timestamp) pairs
resume(() -> None)Resume a device from a ‘paused’ state
stage(*args, **kwargs)
stop(*[, success])Stop the Device and all (instantiated) subdevices
subscribe(cb[, event_type, run])Subscribe to events this event_type generates.
summary()
trigger(() -> ophyd.status.StatusBase)Trigger the device and return status object
unstage(() -> typing.List[object])Unstage the device.
unsubscribe(cid)Remove a subscription
validate_asyn_ports()Validate that all components of pipeline are known
wait_for_connection([all_signals, timeout])Wait for signals to connect
-
- -
- - -
-
- -
-
- - -
-
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_as_gen/ophyd.areadetector.detectors.ProsilicaDetector.html b/ophyd/_as_gen/ophyd.areadetector.detectors.ProsilicaDetector.html deleted file mode 100644 index f08338033e..0000000000 --- a/ophyd/_as_gen/ophyd.areadetector.detectors.ProsilicaDetector.html +++ /dev/null @@ -1,399 +0,0 @@ - - - - - - - - - - - ophyd.areadetector.detectors.ProsilicaDetector — ophyd documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
-
- - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

ophyd.areadetector.detectors.ProsilicaDetector

-
-
-class ophyd.areadetector.detectors.ProsilicaDetector(prefix='', *, name, read_attrs=None, configuration_attrs=None, parent=None, **kwargs)
-
-
-__init__(prefix='', *, name, read_attrs=None, configuration_attrs=None, parent=None, **kwargs)
-
- -

Methods

- ---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
__init__([prefix, read_attrs, …])
check_value(value, **kwargs)Check if the value is valid for this object
clear_sub(cb[, event_type])Remove a subscription, given the original callback function
configure((d: typing.Dict[str, …)Configure the device for something during a run
describe(…)Provide schema and meta-data for read()
describe_configuration(…)Provide schema & meta-data for read_configuration()
dispatch(key, timestamp)Notify plugins of acquisition being complete.
find_signal(text[, use_re, case_sensitive, …])Search through the signal docs on this detector for the string text
get(**kwargs)Get the value of all components in the device
get_asyn_digraph()Get the directed graph of the ASYN ports
get_asyn_port_dictionary()Return port name : component map
get_device_tuple()The device tuple type associated with an Device class
get_instantiated_signals(*[, attr_prefix])Yields all of the instantiated signals in a device hierarchy
get_plugin_by_asyn_port(port_name)Get the plugin which has the given asyn port name
make_data_key()
missing_plugins()Find missing ports
pause(() -> None)Attempt to ‘pause’ the device.
put(dev_t, **kwargs)Put a value to all components of the device
read(() -> ophyd.device.OrderedDictType[str, …)Read data from the device
read_configuration(…)returns dictionary mapping names to (value, timestamp) pairs
resume(() -> None)Resume a device from a ‘paused’ state
stage(*args, **kwargs)
stop(*[, success])Stop the Device and all (instantiated) subdevices
subscribe(cb[, event_type, run])Subscribe to events this event_type generates.
summary()
trigger(() -> ophyd.status.StatusBase)Trigger the device and return status object
unstage(() -> typing.List[object])Unstage the device.
unsubscribe(cid)Remove a subscription
validate_asyn_ports()Validate that all components of pipeline are known
wait_for_connection([all_signals, timeout])Wait for signals to connect
-
- -
- - -
-
- -
-
- - -
-
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_as_gen/ophyd.areadetector.detectors.PvcamDetector.html b/ophyd/_as_gen/ophyd.areadetector.detectors.PvcamDetector.html deleted file mode 100644 index a56638aa2b..0000000000 --- a/ophyd/_as_gen/ophyd.areadetector.detectors.PvcamDetector.html +++ /dev/null @@ -1,399 +0,0 @@ - - - - - - - - - - - ophyd.areadetector.detectors.PvcamDetector — ophyd documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
-
- - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

ophyd.areadetector.detectors.PvcamDetector

-
-
-class ophyd.areadetector.detectors.PvcamDetector(prefix='', *, name, read_attrs=None, configuration_attrs=None, parent=None, **kwargs)
-
-
-__init__(prefix='', *, name, read_attrs=None, configuration_attrs=None, parent=None, **kwargs)
-
- -

Methods

- ---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
__init__([prefix, read_attrs, …])
check_value(value, **kwargs)Check if the value is valid for this object
clear_sub(cb[, event_type])Remove a subscription, given the original callback function
configure((d: typing.Dict[str, …)Configure the device for something during a run
describe(…)Provide schema and meta-data for read()
describe_configuration(…)Provide schema & meta-data for read_configuration()
dispatch(key, timestamp)Notify plugins of acquisition being complete.
find_signal(text[, use_re, case_sensitive, …])Search through the signal docs on this detector for the string text
get(**kwargs)Get the value of all components in the device
get_asyn_digraph()Get the directed graph of the ASYN ports
get_asyn_port_dictionary()Return port name : component map
get_device_tuple()The device tuple type associated with an Device class
get_instantiated_signals(*[, attr_prefix])Yields all of the instantiated signals in a device hierarchy
get_plugin_by_asyn_port(port_name)Get the plugin which has the given asyn port name
make_data_key()
missing_plugins()Find missing ports
pause(() -> None)Attempt to ‘pause’ the device.
put(dev_t, **kwargs)Put a value to all components of the device
read(() -> ophyd.device.OrderedDictType[str, …)Read data from the device
read_configuration(…)returns dictionary mapping names to (value, timestamp) pairs
resume(() -> None)Resume a device from a ‘paused’ state
stage(*args, **kwargs)
stop(*[, success])Stop the Device and all (instantiated) subdevices
subscribe(cb[, event_type, run])Subscribe to events this event_type generates.
summary()
trigger(() -> ophyd.status.StatusBase)Trigger the device and return status object
unstage(() -> typing.List[object])Unstage the device.
unsubscribe(cid)Remove a subscription
validate_asyn_ports()Validate that all components of pipeline are known
wait_for_connection([all_signals, timeout])Wait for signals to connect
-
- -
- - -
-
- -
-
- - -
-
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_as_gen/ophyd.areadetector.detectors.RoperDetector.html b/ophyd/_as_gen/ophyd.areadetector.detectors.RoperDetector.html deleted file mode 100644 index baaf514aaa..0000000000 --- a/ophyd/_as_gen/ophyd.areadetector.detectors.RoperDetector.html +++ /dev/null @@ -1,399 +0,0 @@ - - - - - - - - - - - ophyd.areadetector.detectors.RoperDetector — ophyd documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
-
- - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

ophyd.areadetector.detectors.RoperDetector

-
-
-class ophyd.areadetector.detectors.RoperDetector(prefix='', *, name, read_attrs=None, configuration_attrs=None, parent=None, **kwargs)
-
-
-__init__(prefix='', *, name, read_attrs=None, configuration_attrs=None, parent=None, **kwargs)
-
- -

Methods

- ---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
__init__([prefix, read_attrs, …])
check_value(value, **kwargs)Check if the value is valid for this object
clear_sub(cb[, event_type])Remove a subscription, given the original callback function
configure((d: typing.Dict[str, …)Configure the device for something during a run
describe(…)Provide schema and meta-data for read()
describe_configuration(…)Provide schema & meta-data for read_configuration()
dispatch(key, timestamp)Notify plugins of acquisition being complete.
find_signal(text[, use_re, case_sensitive, …])Search through the signal docs on this detector for the string text
get(**kwargs)Get the value of all components in the device
get_asyn_digraph()Get the directed graph of the ASYN ports
get_asyn_port_dictionary()Return port name : component map
get_device_tuple()The device tuple type associated with an Device class
get_instantiated_signals(*[, attr_prefix])Yields all of the instantiated signals in a device hierarchy
get_plugin_by_asyn_port(port_name)Get the plugin which has the given asyn port name
make_data_key()
missing_plugins()Find missing ports
pause(() -> None)Attempt to ‘pause’ the device.
put(dev_t, **kwargs)Put a value to all components of the device
read(() -> ophyd.device.OrderedDictType[str, …)Read data from the device
read_configuration(…)returns dictionary mapping names to (value, timestamp) pairs
resume(() -> None)Resume a device from a ‘paused’ state
stage(*args, **kwargs)
stop(*[, success])Stop the Device and all (instantiated) subdevices
subscribe(cb[, event_type, run])Subscribe to events this event_type generates.
summary()
trigger(() -> ophyd.status.StatusBase)Trigger the device and return status object
unstage(() -> typing.List[object])Unstage the device.
unsubscribe(cid)Remove a subscription
validate_asyn_ports()Validate that all components of pipeline are known
wait_for_connection([all_signals, timeout])Wait for signals to connect
-
- -
- - -
-
- -
-
- - -
-
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_as_gen/ophyd.areadetector.detectors.SimDetector.html b/ophyd/_as_gen/ophyd.areadetector.detectors.SimDetector.html deleted file mode 100644 index bbbc08be36..0000000000 --- a/ophyd/_as_gen/ophyd.areadetector.detectors.SimDetector.html +++ /dev/null @@ -1,399 +0,0 @@ - - - - - - - - - - - ophyd.areadetector.detectors.SimDetector — ophyd documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
-
- - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

ophyd.areadetector.detectors.SimDetector

-
-
-class ophyd.areadetector.detectors.SimDetector(prefix='', *, name, read_attrs=None, configuration_attrs=None, parent=None, **kwargs)
-
-
-__init__(prefix='', *, name, read_attrs=None, configuration_attrs=None, parent=None, **kwargs)
-
- -

Methods

- ---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
__init__([prefix, read_attrs, …])
check_value(value, **kwargs)Check if the value is valid for this object
clear_sub(cb[, event_type])Remove a subscription, given the original callback function
configure((d: typing.Dict[str, …)Configure the device for something during a run
describe(…)Provide schema and meta-data for read()
describe_configuration(…)Provide schema & meta-data for read_configuration()
dispatch(key, timestamp)Notify plugins of acquisition being complete.
find_signal(text[, use_re, case_sensitive, …])Search through the signal docs on this detector for the string text
get(**kwargs)Get the value of all components in the device
get_asyn_digraph()Get the directed graph of the ASYN ports
get_asyn_port_dictionary()Return port name : component map
get_device_tuple()The device tuple type associated with an Device class
get_instantiated_signals(*[, attr_prefix])Yields all of the instantiated signals in a device hierarchy
get_plugin_by_asyn_port(port_name)Get the plugin which has the given asyn port name
make_data_key()
missing_plugins()Find missing ports
pause(() -> None)Attempt to ‘pause’ the device.
put(dev_t, **kwargs)Put a value to all components of the device
read(() -> ophyd.device.OrderedDictType[str, …)Read data from the device
read_configuration(…)returns dictionary mapping names to (value, timestamp) pairs
resume(() -> None)Resume a device from a ‘paused’ state
stage(*args, **kwargs)
stop(*[, success])Stop the Device and all (instantiated) subdevices
subscribe(cb[, event_type, run])Subscribe to events this event_type generates.
summary()
trigger(() -> ophyd.status.StatusBase)Trigger the device and return status object
unstage(() -> typing.List[object])Unstage the device.
unsubscribe(cid)Remove a subscription
validate_asyn_ports()Validate that all components of pipeline are known
wait_for_connection([all_signals, timeout])Wait for signals to connect
-
- -
- - -
-
- -
-
- - -
-
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_as_gen/ophyd.areadetector.detectors.URLDetector.html b/ophyd/_as_gen/ophyd.areadetector.detectors.URLDetector.html deleted file mode 100644 index 6d5e72bef4..0000000000 --- a/ophyd/_as_gen/ophyd.areadetector.detectors.URLDetector.html +++ /dev/null @@ -1,399 +0,0 @@ - - - - - - - - - - - ophyd.areadetector.detectors.URLDetector — ophyd documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
-
- - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

ophyd.areadetector.detectors.URLDetector

-
-
-class ophyd.areadetector.detectors.URLDetector(prefix='', *, name, read_attrs=None, configuration_attrs=None, parent=None, **kwargs)
-
-
-__init__(prefix='', *, name, read_attrs=None, configuration_attrs=None, parent=None, **kwargs)
-
- -

Methods

- ---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
__init__([prefix, read_attrs, …])
check_value(value, **kwargs)Check if the value is valid for this object
clear_sub(cb[, event_type])Remove a subscription, given the original callback function
configure((d: typing.Dict[str, …)Configure the device for something during a run
describe(…)Provide schema and meta-data for read()
describe_configuration(…)Provide schema & meta-data for read_configuration()
dispatch(key, timestamp)Notify plugins of acquisition being complete.
find_signal(text[, use_re, case_sensitive, …])Search through the signal docs on this detector for the string text
get(**kwargs)Get the value of all components in the device
get_asyn_digraph()Get the directed graph of the ASYN ports
get_asyn_port_dictionary()Return port name : component map
get_device_tuple()The device tuple type associated with an Device class
get_instantiated_signals(*[, attr_prefix])Yields all of the instantiated signals in a device hierarchy
get_plugin_by_asyn_port(port_name)Get the plugin which has the given asyn port name
make_data_key()
missing_plugins()Find missing ports
pause(() -> None)Attempt to ‘pause’ the device.
put(dev_t, **kwargs)Put a value to all components of the device
read(() -> ophyd.device.OrderedDictType[str, …)Read data from the device
read_configuration(…)returns dictionary mapping names to (value, timestamp) pairs
resume(() -> None)Resume a device from a ‘paused’ state
stage(*args, **kwargs)
stop(*[, success])Stop the Device and all (instantiated) subdevices
subscribe(cb[, event_type, run])Subscribe to events this event_type generates.
summary()
trigger(() -> ophyd.status.StatusBase)Trigger the device and return status object
unstage(() -> typing.List[object])Unstage the device.
unsubscribe(cid)Remove a subscription
validate_asyn_ports()Validate that all components of pipeline are known
wait_for_connection([all_signals, timeout])Wait for signals to connect
-
- -
- - -
-
- -
-
- - -
-
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_as_gen/ophyd.areadetector.detectors.html b/ophyd/_as_gen/ophyd.areadetector.detectors.html deleted file mode 100644 index baf8e826b5..0000000000 --- a/ophyd/_as_gen/ophyd.areadetector.detectors.html +++ /dev/null @@ -1,363 +0,0 @@ - - - - - - - - - - - ophyd.areadetector.detectors — ophyd documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
-
- - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

ophyd.areadetector.detectors

-

AreaDetector Devices

-

areaDetector detector abstractions

-

Classes

- ---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
AdscDetector([prefix, read_attrs, …])
Andor3Detector([prefix, read_attrs, …])
AndorDetector([prefix, read_attrs, …])
AreaDetector([prefix, read_attrs, …])
BrukerDetector([prefix, read_attrs, …])
DetectorBase([prefix, read_attrs, …])The base class for the hardware-specific classes that follow.
FirewireLinDetector([prefix, read_attrs, …])
FirewireWinDetector([prefix, read_attrs, …])
LightFieldDetector([prefix, read_attrs, …])
Mar345Detector([prefix, read_attrs, …])
MarCCDDetector([prefix, read_attrs, …])
PSLDetector([prefix, read_attrs, …])
PerkinElmerDetector([prefix, read_attrs, …])
PilatusDetector([prefix, read_attrs, …])
PixiradDetector([prefix, read_attrs, …])
PointGreyDetector([prefix, read_attrs, …])
ProsilicaDetector([prefix, read_attrs, …])
PvcamDetector([prefix, read_attrs, …])
RoperDetector([prefix, read_attrs, …])
SimDetector([prefix, read_attrs, …])
URLDetector([prefix, read_attrs, …])
-
- - -
-
- -
-
- - -
-
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_as_gen/ophyd.areadetector.docs.html b/ophyd/_as_gen/ophyd.areadetector.docs.html deleted file mode 100644 index eb57c53f99..0000000000 --- a/ophyd/_as_gen/ophyd.areadetector.docs.html +++ /dev/null @@ -1,289 +0,0 @@ - - - - - - - - - - - ophyd.areadetector.docs — ophyd documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
-
- - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

ophyd.areadetector.docs

-
- - -
-
- -
-
- - -
-
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_as_gen/ophyd.areadetector.filestore_mixins.FileStoreBase.fs_root.html b/ophyd/_as_gen/ophyd.areadetector.filestore_mixins.FileStoreBase.fs_root.html deleted file mode 100644 index 4c79bb0689..0000000000 --- a/ophyd/_as_gen/ophyd.areadetector.filestore_mixins.FileStoreBase.fs_root.html +++ /dev/null @@ -1,289 +0,0 @@ - - - - - - - - - - - ophyd.areadetector.filestore_mixins.FileStoreBase.fs_root — ophyd documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
-
- - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

ophyd.areadetector.filestore_mixins.FileStoreBase.fs_root

-
-
-FileStoreBase.fs_root
-

DEPRECATED: The ‘root’ put into the Asset registry, use reg_root

-
- -
- - -
-
- -
-
- - -
-
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_as_gen/ophyd.areadetector.filestore_mixins.FileStoreBase.generate_datum.html b/ophyd/_as_gen/ophyd.areadetector.filestore_mixins.FileStoreBase.generate_datum.html deleted file mode 100644 index 10350400e1..0000000000 --- a/ophyd/_as_gen/ophyd.areadetector.filestore_mixins.FileStoreBase.generate_datum.html +++ /dev/null @@ -1,289 +0,0 @@ - - - - - - - - - - - ophyd.areadetector.filestore_mixins.FileStoreBase.generate_datum — ophyd documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
-
- - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

ophyd.areadetector.filestore_mixins.FileStoreBase.generate_datum

-
-
-FileStoreBase.generate_datum(key, timestamp, datum_kwargs)
-

Generate a uid and cache it with its key for later insertion.

-
- -
- - -
-
- -
-
- - -
-
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_as_gen/ophyd.areadetector.filestore_mixins.FileStoreBase.html b/ophyd/_as_gen/ophyd.areadetector.filestore_mixins.FileStoreBase.html deleted file mode 100644 index 60b5ccee2a..0000000000 --- a/ophyd/_as_gen/ophyd.areadetector.filestore_mixins.FileStoreBase.html +++ /dev/null @@ -1,418 +0,0 @@ - - - - - - - - - - - ophyd.areadetector.filestore_mixins.FileStoreBase — ophyd documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
-
- - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

ophyd.areadetector.filestore_mixins.FileStoreBase

-
-
-class ophyd.areadetector.filestore_mixins.FileStoreBase(*args, write_path_template, root='/', read_path_template=None, reg=None, **kwargs)
-

Base class for FileStore mixin classes

-

This class provides

-
-
    -
  • python side path management (root, seperate write / read paths)
  • -
  • provides generate_datum() to work with -dispatch()
  • -
  • cooperative stage / unstage methods
  • -
  • cooperative read / describe methods that inject datums
  • -
-
-

Separate read and write paths are supported because the IOC that -writes the files may not have the data storage mounted at the same -place as the computers that are expected to access it later (for -example, if the IOC is running on a windows machine and mounting a -NFS share via samba).

-

write_path_template must always be provided, only provide -read_path_template if the writer and reader will not have the -same mount point.

-

The properties read_path_template and -write_path_template do the following check against -root

-
-
    -
  • if the only write_path_template is provided
      -
    • Used to generate read and write paths (which are identical)
    • -
    • verify that the path starts with root or the path is -a relative, prepend root
    • -
    -
  • -
  • if read_path_template is also provided then the above -checks are applied to it, but write_path_template is -returned without any validation.
  • -
-
-

This mixin assumes that it’s peers provide an enable signal

- --- - - - -
Parameters:

write_path_template : str

-
-

Template feed to strftime() to generate the -path to set the IOC to write saved files to.

-

See above for interactions with root and read_path_template

-
-

root : str, optional

-
-

The ‘root’ of the file path. This is inserted into filestore and -enables files to be renamed or re-mounted with only some pain.

-

This represents the part of the full path that is not -‘semantic’. For example in the path -‘/data/XF42ID/2248/05/01/’, the first two parts, -‘/data/XF42ID/’, would be part of the ‘root’, where as the -final 3 parts, ‘2248/05/01’ is the date the data was taken. -If the files were to be renamed, it is likely that only the -‘root’ will be changed (for example of the whole file tree is -copied to / mounted on another system or external hard drive).

-
-

read_path_template : str, optional

-
-

The read path template, if different from the write path. See the -docstings for write_path_template and root.

-
-

reg : Registry

-
-

If None provided, try to import the top-level api from -filestore.api This will be deprecated 17Q3.

-

This object must provide:

-
def register_resource(spec: str,
-                      root: str, rpath: str,
-                      rkwargs: dict,
-                      path_semantics: Optional[str]): -> str
-    ...
-
-def register_datum(resource: str, datum_kwargs: dict): -> str
-    ...
-
-
-
-
-

Notes

-

This class in cooperative and expected to particpate in multiple -inheritance, all *args and extra **kwargs are passed up the -MRO chain.

-

This class may be collapsed with FileStorePluginBase

-
-
-__init__(*args, write_path_template, root='/', read_path_template=None, reg=None, **kwargs)
-
- -

Methods

- ---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
__init__(*args, write_path_template[, root, …])
describe()
generate_datum(key, timestamp, datum_kwargs)Generate a uid and cache it with its key for later insertion.
pause(() -> None)Attempt to ‘pause’ the device.
read()
resume(() -> None)Resume a device from a ‘paused’ state
stage()
trigger(() -> ophyd.status.StatusBase)Trigger the device and return status object
unstage()
-
- -
- - -
-
- -
-
- - -
-
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_as_gen/ophyd.areadetector.filestore_mixins.FileStoreBase.read_path_template.html b/ophyd/_as_gen/ophyd.areadetector.filestore_mixins.FileStoreBase.read_path_template.html deleted file mode 100644 index 2103d45e75..0000000000 --- a/ophyd/_as_gen/ophyd.areadetector.filestore_mixins.FileStoreBase.read_path_template.html +++ /dev/null @@ -1,289 +0,0 @@ - - - - - - - - - - - ophyd.areadetector.filestore_mixins.FileStoreBase.read_path_template — ophyd documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
-
- - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

ophyd.areadetector.filestore_mixins.FileStoreBase.read_path_template

-
-
-FileStoreBase.read_path_template
-

Returns write_path_template if read_path_template is not set

-
- -
- - -
-
- -
-
- - -
-
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_as_gen/ophyd.areadetector.filestore_mixins.FileStoreBase.reg_root.html b/ophyd/_as_gen/ophyd.areadetector.filestore_mixins.FileStoreBase.reg_root.html deleted file mode 100644 index 8bf09d7bcb..0000000000 --- a/ophyd/_as_gen/ophyd.areadetector.filestore_mixins.FileStoreBase.reg_root.html +++ /dev/null @@ -1,289 +0,0 @@ - - - - - - - - - - - ophyd.areadetector.filestore_mixins.FileStoreBase.reg_root — ophyd documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
-
- - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

ophyd.areadetector.filestore_mixins.FileStoreBase.reg_root

-
-
-FileStoreBase.reg_root
-

The ‘root’ put into the Asset Registry

-
- -
- - -
-
- -
-
- - -
-
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_as_gen/ophyd.areadetector.filestore_mixins.FileStoreBase.root.html b/ophyd/_as_gen/ophyd.areadetector.filestore_mixins.FileStoreBase.root.html deleted file mode 100644 index 0442950a57..0000000000 --- a/ophyd/_as_gen/ophyd.areadetector.filestore_mixins.FileStoreBase.root.html +++ /dev/null @@ -1,294 +0,0 @@ - - - - - - - - - - - ophyd.areadetector.filestore_mixins.FileStoreBase.root — ophyd documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
-
- - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

ophyd.areadetector.filestore_mixins.FileStoreBase.root

-
-
-FileStoreBase.root
-
- -
- - -
-
- -
-
- - -
-
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_as_gen/ophyd.areadetector.filestore_mixins.FileStoreBase.write_path_template.html b/ophyd/_as_gen/ophyd.areadetector.filestore_mixins.FileStoreBase.write_path_template.html deleted file mode 100644 index 5b5ece8f76..0000000000 --- a/ophyd/_as_gen/ophyd.areadetector.filestore_mixins.FileStoreBase.write_path_template.html +++ /dev/null @@ -1,288 +0,0 @@ - - - - - - - - - - - ophyd.areadetector.filestore_mixins.FileStoreBase.write_path_template — ophyd documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
-
- - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

ophyd.areadetector.filestore_mixins.FileStoreBase.write_path_template

-
-
-FileStoreBase.write_path_template
-
- -
- - -
-
- -
-
- - -
-
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_as_gen/ophyd.areadetector.filestore_mixins.FileStoreBulkWrite.html b/ophyd/_as_gen/ophyd.areadetector.filestore_mixins.FileStoreBulkWrite.html deleted file mode 100644 index e051ad4992..0000000000 --- a/ophyd/_as_gen/ophyd.areadetector.filestore_mixins.FileStoreBulkWrite.html +++ /dev/null @@ -1,296 +0,0 @@ - - - - - - - - - - - ophyd.areadetector.filestore_mixins.FileStoreBulkWrite — ophyd documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
-
- - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

ophyd.areadetector.filestore_mixins.FileStoreBulkWrite

-
-
-class ophyd.areadetector.filestore_mixins.FileStoreBulkWrite(*args, **kwargs)
-

Cache records as they are created and save them all at the end.

-
-
-__init__(*args, **kwargs)
-
- -
- -
- - -
-
- -
-
- - -
-
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_as_gen/ophyd.areadetector.filestore_mixins.FileStoreHDF5.html b/ophyd/_as_gen/ophyd.areadetector.filestore_mixins.FileStoreHDF5.html deleted file mode 100644 index f6ab9351cc..0000000000 --- a/ophyd/_as_gen/ophyd.areadetector.filestore_mixins.FileStoreHDF5.html +++ /dev/null @@ -1,335 +0,0 @@ - - - - - - - - - - - ophyd.areadetector.filestore_mixins.FileStoreHDF5 — ophyd documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
-
- - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

ophyd.areadetector.filestore_mixins.FileStoreHDF5

-
-
-class ophyd.areadetector.filestore_mixins.FileStoreHDF5(*args, **kwargs)
-
-
-__init__(*args, **kwargs)
-
- -

Methods

- ---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
__init__(*args, **kwargs)
describe()
generate_datum(key, timestamp, datum_kwargs)Generate a uid and cache it with its key for later insertion.
get_frames_per_point()
make_filename()Make a filename.
pause(() -> None)Attempt to ‘pause’ the device.
read()
resume(() -> None)Resume a device from a ‘paused’ state
stage()
trigger(() -> ophyd.status.StatusBase)Trigger the device and return status object
unstage()
-
- -
- - -
-
- -
-
- - -
-
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_as_gen/ophyd.areadetector.filestore_mixins.FileStoreHDF5BulkWrite.html b/ophyd/_as_gen/ophyd.areadetector.filestore_mixins.FileStoreHDF5BulkWrite.html deleted file mode 100644 index ddaba4799d..0000000000 --- a/ophyd/_as_gen/ophyd.areadetector.filestore_mixins.FileStoreHDF5BulkWrite.html +++ /dev/null @@ -1,295 +0,0 @@ - - - - - - - - - - - ophyd.areadetector.filestore_mixins.FileStoreHDF5BulkWrite — ophyd documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
-
- - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

ophyd.areadetector.filestore_mixins.FileStoreHDF5BulkWrite

-
-
-class ophyd.areadetector.filestore_mixins.FileStoreHDF5BulkWrite(*args, **kwargs)
-
-
-__init__(*args, **kwargs)
-
- -
- -
- - -
-
- -
-
- - -
-
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_as_gen/ophyd.areadetector.filestore_mixins.FileStoreHDF5IterativeWrite.html b/ophyd/_as_gen/ophyd.areadetector.filestore_mixins.FileStoreHDF5IterativeWrite.html deleted file mode 100644 index bb77b04574..0000000000 --- a/ophyd/_as_gen/ophyd.areadetector.filestore_mixins.FileStoreHDF5IterativeWrite.html +++ /dev/null @@ -1,335 +0,0 @@ - - - - - - - - - - - ophyd.areadetector.filestore_mixins.FileStoreHDF5IterativeWrite — ophyd documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
-
- - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

ophyd.areadetector.filestore_mixins.FileStoreHDF5IterativeWrite

-
-
-class ophyd.areadetector.filestore_mixins.FileStoreHDF5IterativeWrite(*args, **kwargs)
-
-
-__init__(*args, **kwargs)
-
- -

Methods

- ---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
__init__(*args, **kwargs)
describe()
generate_datum(key, timestamp, datum_kwargs)Generate the datum and insert
get_frames_per_point()
make_filename()Make a filename.
pause(() -> None)Attempt to ‘pause’ the device.
read()
resume(() -> None)Resume a device from a ‘paused’ state
stage()
trigger(() -> ophyd.status.StatusBase)Trigger the device and return status object
unstage()
-
- -
- - -
-
- -
-
- - -
-
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_as_gen/ophyd.areadetector.filestore_mixins.FileStoreIterativeWrite.html b/ophyd/_as_gen/ophyd.areadetector.filestore_mixins.FileStoreIterativeWrite.html deleted file mode 100644 index 0b6d96b92b..0000000000 --- a/ophyd/_as_gen/ophyd.areadetector.filestore_mixins.FileStoreIterativeWrite.html +++ /dev/null @@ -1,330 +0,0 @@ - - - - - - - - - - - ophyd.areadetector.filestore_mixins.FileStoreIterativeWrite — ophyd documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
-
- - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

ophyd.areadetector.filestore_mixins.FileStoreIterativeWrite

-
-
-class ophyd.areadetector.filestore_mixins.FileStoreIterativeWrite(*args, write_path_template, root='/', read_path_template=None, reg=None, **kwargs)
-

Save records to filestore as they are generated.

-
-
-__init__(*args, write_path_template, root='/', read_path_template=None, reg=None, **kwargs)
-
- -

Methods

- ---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
__init__(*args, write_path_template[, root, …])
describe()
generate_datum(key, timestamp, datum_kwargs)Generate the datum and insert
pause(() -> None)Attempt to ‘pause’ the device.
read()
resume(() -> None)Resume a device from a ‘paused’ state
stage()
trigger(() -> ophyd.status.StatusBase)Trigger the device and return status object
unstage()
-
- -
- - -
-
- -
-
- - -
-
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_as_gen/ophyd.areadetector.filestore_mixins.FileStorePluginBase.html b/ophyd/_as_gen/ophyd.areadetector.filestore_mixins.FileStorePluginBase.html deleted file mode 100644 index ffc0933e8d..0000000000 --- a/ophyd/_as_gen/ophyd.areadetector.filestore_mixins.FileStorePluginBase.html +++ /dev/null @@ -1,332 +0,0 @@ - - - - - - - - - - - ophyd.areadetector.filestore_mixins.FileStorePluginBase — ophyd documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
-
- - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

ophyd.areadetector.filestore_mixins.FileStorePluginBase

-
-
-class ophyd.areadetector.filestore_mixins.FileStorePluginBase(*args, **kwargs)
-
-
-__init__(*args, **kwargs)
-
- -

Methods

- ---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
__init__(*args, **kwargs)
describe()
generate_datum(key, timestamp, datum_kwargs)Generate a uid and cache it with its key for later insertion.
make_filename()Make a filename.
pause(() -> None)Attempt to ‘pause’ the device.
read()
resume(() -> None)Resume a device from a ‘paused’ state
stage()
trigger(() -> ophyd.status.StatusBase)Trigger the device and return status object
unstage()
-
- -
- - -
-
- -
-
- - -
-
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_as_gen/ophyd.areadetector.filestore_mixins.FileStorePluginBase.make_filename.html b/ophyd/_as_gen/ophyd.areadetector.filestore_mixins.FileStorePluginBase.make_filename.html deleted file mode 100644 index 21af684ce0..0000000000 --- a/ophyd/_as_gen/ophyd.areadetector.filestore_mixins.FileStorePluginBase.make_filename.html +++ /dev/null @@ -1,311 +0,0 @@ - - - - - - - - - - - ophyd.areadetector.filestore_mixins.FileStorePluginBase.make_filename — ophyd documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
-
- - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

ophyd.areadetector.filestore_mixins.FileStorePluginBase.make_filename

-
-
-FileStorePluginBase.make_filename()
-

Make a filename.

-

This is a hook so that the read and write paths can either be modified -or created on disk prior to configuring the areaDetector plugin.

- --- - - - -
Returns:

filename : str

-
-

The start of the filename

-
-

read_path : str

-
-

Path that ophyd can read from

-
-

write_path : str

-
-

Path that the IOC can write to

-
-
-
- -
- - -
-
- -
-
- - -
-
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_as_gen/ophyd.areadetector.filestore_mixins.FileStoreTIFF.html b/ophyd/_as_gen/ophyd.areadetector.filestore_mixins.FileStoreTIFF.html deleted file mode 100644 index 0b8b6a90bc..0000000000 --- a/ophyd/_as_gen/ophyd.areadetector.filestore_mixins.FileStoreTIFF.html +++ /dev/null @@ -1,335 +0,0 @@ - - - - - - - - - - - ophyd.areadetector.filestore_mixins.FileStoreTIFF — ophyd documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
-
- - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

ophyd.areadetector.filestore_mixins.FileStoreTIFF

-
-
-class ophyd.areadetector.filestore_mixins.FileStoreTIFF(*args, **kwargs)
-
-
-__init__(*args, **kwargs)
-
- -

Methods

- ---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
__init__(*args, **kwargs)
describe()
generate_datum(key, timestamp, datum_kwargs)Generate a uid and cache it with its key for later insertion.
get_frames_per_point()
make_filename()Make a filename.
pause(() -> None)Attempt to ‘pause’ the device.
read()
resume(() -> None)Resume a device from a ‘paused’ state
stage()
trigger(() -> ophyd.status.StatusBase)Trigger the device and return status object
unstage()
-
- -
- - -
-
- -
-
- - -
-
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_as_gen/ophyd.areadetector.filestore_mixins.FileStoreTIFFBulkWrite.html b/ophyd/_as_gen/ophyd.areadetector.filestore_mixins.FileStoreTIFFBulkWrite.html deleted file mode 100644 index c291393316..0000000000 --- a/ophyd/_as_gen/ophyd.areadetector.filestore_mixins.FileStoreTIFFBulkWrite.html +++ /dev/null @@ -1,295 +0,0 @@ - - - - - - - - - - - ophyd.areadetector.filestore_mixins.FileStoreTIFFBulkWrite — ophyd documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
-
- - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

ophyd.areadetector.filestore_mixins.FileStoreTIFFBulkWrite

-
-
-class ophyd.areadetector.filestore_mixins.FileStoreTIFFBulkWrite(*args, **kwargs)
-
-
-__init__(*args, **kwargs)
-
- -
- -
- - -
-
- -
-
- - -
-
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_as_gen/ophyd.areadetector.filestore_mixins.FileStoreTIFFIterativeWrite.html b/ophyd/_as_gen/ophyd.areadetector.filestore_mixins.FileStoreTIFFIterativeWrite.html deleted file mode 100644 index d029039f5d..0000000000 --- a/ophyd/_as_gen/ophyd.areadetector.filestore_mixins.FileStoreTIFFIterativeWrite.html +++ /dev/null @@ -1,335 +0,0 @@ - - - - - - - - - - - ophyd.areadetector.filestore_mixins.FileStoreTIFFIterativeWrite — ophyd documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
-
- - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

ophyd.areadetector.filestore_mixins.FileStoreTIFFIterativeWrite

-
-
-class ophyd.areadetector.filestore_mixins.FileStoreTIFFIterativeWrite(*args, **kwargs)
-
-
-__init__(*args, **kwargs)
-
- -

Methods

- ---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
__init__(*args, **kwargs)
describe()
generate_datum(key, timestamp, datum_kwargs)Generate the datum and insert
get_frames_per_point()
make_filename()Make a filename.
pause(() -> None)Attempt to ‘pause’ the device.
read()
resume(() -> None)Resume a device from a ‘paused’ state
stage()
trigger(() -> ophyd.status.StatusBase)Trigger the device and return status object
unstage()
-
- -
- - -
-
- -
-
- - -
-
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_as_gen/ophyd.areadetector.filestore_mixins.FileStoreTIFFSquashing.html b/ophyd/_as_gen/ophyd.areadetector.filestore_mixins.FileStoreTIFFSquashing.html deleted file mode 100644 index 2001763787..0000000000 --- a/ophyd/_as_gen/ophyd.areadetector.filestore_mixins.FileStoreTIFFSquashing.html +++ /dev/null @@ -1,380 +0,0 @@ - - - - - - - - - - - ophyd.areadetector.filestore_mixins.FileStoreTIFFSquashing — ophyd documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
-
- - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

ophyd.areadetector.filestore_mixins.FileStoreTIFFSquashing

-
-
-class ophyd.areadetector.filestore_mixins.FileStoreTIFFSquashing(*args, images_per_set_name='images_per_set', number_of_sets_name='number_of_sets', cam_name='cam', proc_name='proc1', **kwargs)
-

Write out ‘squashed’ tiffs

-
-

Note

-

See FileStoreBase for the rest of the required parametrs

-
-

This mixin will also configure the cam and proc plugins -on the parent.

-

This is useful to work around the dynamic range of detectors -and minimizing disk spaced used by synthetically increasing -the exposure time of the saved images.

- --- - - - -
Parameters:

images_per_set_name, number_of_sets_name : str, optional

-
-

The names of the signals on the parent to get the -images_pre_set and number_of_sets from.

-

The total number of frames extracted from the camera will be -\(number\_of\_sets * images\_per\_set\) and result in -number_of_sets tiff files each of which is the average of -images_per_set frames from the detector.

-

Defaults to 'images_per_set' and 'number_of_sets'

-
-

cam_name : str, optional

-
-

The name of the CamBase -instance on the parent.

-

Defaults to 'cam'

-
-

proc_name : str, optional

-
-

The name of the -ProcessPlugin instance on -the parent.

-

Defaults to 'proc1'

-
-
-

Notes

-

This class in cooperative and expected to particpate in multiple -inheritance, all *args and extra **kwargs are passed up the -MRO chain.

-
-
-__init__(*args, images_per_set_name='images_per_set', number_of_sets_name='number_of_sets', cam_name='cam', proc_name='proc1', **kwargs)
-
- -

Methods

- ---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
__init__(*args[, images_per_set_name, …])
describe()
generate_datum(key, timestamp, datum_kwargs)Generate a uid and cache it with its key for later insertion.
get_frames_per_point()
make_filename()Make a filename.
pause(() -> None)Attempt to ‘pause’ the device.
read()
resume(() -> None)Resume a device from a ‘paused’ state
stage()
trigger(() -> ophyd.status.StatusBase)Trigger the device and return status object
unstage()
-
- -
- - -
-
- -
-
- - -
-
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_as_gen/ophyd.areadetector.filestore_mixins.html b/ophyd/_as_gen/ophyd.areadetector.filestore_mixins.html deleted file mode 100644 index 672098c5ef..0000000000 --- a/ophyd/_as_gen/ophyd.areadetector.filestore_mixins.html +++ /dev/null @@ -1,357 +0,0 @@ - - - - - - - - - - - ophyd.areadetector.filestore_mixins — ophyd documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
-
- - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

ophyd.areadetector.filestore_mixins

-

Mixin classes that customize the filestore integration of AreaDetector -FilePlugins.

-

To be used like so

-
from ophyd.areadetector.detectors import PerkinElmerDetector
-from ophyd.areadetector.plugins import HDF5Plugin
-from ophyd.areadetector.trigger_mixins import SingleTrigger
-from ophyd.areadetector.filestore_mixins import (
-    FileStoreIterativeWrite)
-
-class MyPlugin(HDF5Plugin, FileStoreIterativeWrite):
-    pass
-
-dest = '/tmp'  # in production, use a directory on your system -- not /tmp
-
-class MyDetector(PerkinElmerDetector, SingleTrigger):  # for example
-    file_plugin = MyPlugin(suffix='HDF1:', write_path_template=dest)
-
-det = MyDetector(...)
-
-
-

Functions

- ---- - - - - - - - - -
new_short_uid()uuid4, skipping the last stanza because of AD length restrictions.
new_uid()uuid4 as a string
-

Classes

- ---- - - - - - - - - - - - - - - - - - - - - - - - - - - -
FileStoreBase(*args, write_path_template[, …])Base class for FileStore mixin classes
FileStoreHDF5(*args, **kwargs)
FileStoreHDF5IterativeWrite(*args, **kwargs)
FileStoreIterativeWrite(*args, …[, root, …])Save records to filestore as they are generated.
FileStorePluginBase(*args, **kwargs)
FileStoreTIFF(*args, **kwargs)
FileStoreTIFFIterativeWrite(*args, **kwargs)
FileStoreTIFFSquashing(*args[, …])Write out ‘squashed’ tiffs
-
- - -
-
- -
-
- - -
-
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_as_gen/ophyd.areadetector.html b/ophyd/_as_gen/ophyd.areadetector.html deleted file mode 100644 index 7e7783248e..0000000000 --- a/ophyd/_as_gen/ophyd.areadetector.html +++ /dev/null @@ -1,289 +0,0 @@ - - - - - - - - - - - ophyd.areadetector — ophyd documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
-
- - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

ophyd.areadetector

-
- - -
-
- -
-
- - -
-
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_as_gen/ophyd.areadetector.plugins.ColorConvPlugin.html b/ophyd/_as_gen/ophyd.areadetector.plugins.ColorConvPlugin.html deleted file mode 100644 index 529f7a1181..0000000000 --- a/ophyd/_as_gen/ophyd.areadetector.plugins.ColorConvPlugin.html +++ /dev/null @@ -1,392 +0,0 @@ - - - - - - - - - - - ophyd.areadetector.plugins.ColorConvPlugin — ophyd documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
-
- - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

ophyd.areadetector.plugins.ColorConvPlugin

-
-
-class ophyd.areadetector.plugins.ColorConvPlugin(*args, **kwargs)
-
-
-__init__(*args, **kwargs)
-
- -

Methods

- ---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
__init__(*args, **kwargs)
check_value(value, **kwargs)Check if the value is valid for this object
clear_sub(cb[, event_type])Remove a subscription, given the original callback function
configure((d: typing.Dict[str, …)Configure the device for something during a run
describe(…)Provide schema and meta-data for read()
describe_configuration()
disable_on_stage()when the plugin is staged, ensure that it is disabled.
enable_on_stage()when the plugin is staged, ensure that it is enabled.
ensure_blocking()Ensure that if plugin is enabled after staging, callbacks block.
ensure_nonblocking()Ensure that if plugin is enabled after staging, callbacks don’t block.
find_signal(text[, use_re, case_sensitive, …])Search through the signal docs on this detector for the string text
get(**kwargs)Get the value of all components in the device
get_asyn_digraph()Get the directed graph of the ASYN ports
get_asyn_port_dictionary()Return port name : component map
get_device_tuple()The device tuple type associated with an Device class
get_instantiated_signals(*[, attr_prefix])Yields all of the instantiated signals in a device hierarchy
get_plugin_by_asyn_port(port_name)Get the plugin which has the given asyn port name
missing_plugins()Find missing ports
pause(() -> None)Attempt to ‘pause’ the device.
put(dev_t, **kwargs)Put a value to all components of the device
read(() -> ophyd.device.OrderedDictType[str, …)Read data from the device
read_configuration()
resume(() -> None)Resume a device from a ‘paused’ state
stage()
stop(*[, success])Stop the Device and all (instantiated) subdevices
subscribe(cb[, event_type, run])Subscribe to events this event_type generates.
summary()
trigger(() -> ophyd.status.StatusBase)Trigger the device and return status object
unstage(() -> typing.List[object])Unstage the device.
unsubscribe(cid)Remove a subscription
validate_asyn_ports()Validate that all components of pipeline are known
wait_for_connection([all_signals, timeout])Wait for signals to connect
-
- -
- - -
-
- -
-
- - -
-
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_as_gen/ophyd.areadetector.plugins.FilePlugin.html b/ophyd/_as_gen/ophyd.areadetector.plugins.FilePlugin.html deleted file mode 100644 index e7fcecc299..0000000000 --- a/ophyd/_as_gen/ophyd.areadetector.plugins.FilePlugin.html +++ /dev/null @@ -1,394 +0,0 @@ - - - - - - - - - - - ophyd.areadetector.plugins.FilePlugin — ophyd documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
-
- - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

ophyd.areadetector.plugins.FilePlugin

-
-
-class ophyd.areadetector.plugins.FilePlugin(*args, **kwargs)
-
-
-__init__(*args, **kwargs)
-
- -

Methods

- ---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
__init__(*args, **kwargs)
check_value(value, **kwargs)Check if the value is valid for this object
clear_sub(cb[, event_type])Remove a subscription, given the original callback function
configure((d: typing.Dict[str, …)Configure the device for something during a run
describe(…)Provide schema and meta-data for read()
describe_configuration()
disable_on_stage()when the plugin is staged, ensure that it is disabled.
enable_on_stage()when the plugin is staged, ensure that it is enabled.
ensure_blocking()Ensure that if plugin is enabled after staging, callbacks block.
ensure_nonblocking()Ensure that if plugin is enabled after staging, callbacks don’t block.
find_signal(text[, use_re, case_sensitive, …])Search through the signal docs on this detector for the string text
generate_datum(key, timestamp, datum_kwargs)
get(**kwargs)Get the value of all components in the device
get_asyn_digraph()Get the directed graph of the ASYN ports
get_asyn_port_dictionary()Return port name : component map
get_device_tuple()The device tuple type associated with an Device class
get_instantiated_signals(*[, attr_prefix])Yields all of the instantiated signals in a device hierarchy
get_plugin_by_asyn_port(port_name)Get the plugin which has the given asyn port name
missing_plugins()Find missing ports
pause(() -> None)Attempt to ‘pause’ the device.
put(dev_t, **kwargs)Put a value to all components of the device
read(() -> ophyd.device.OrderedDictType[str, …)Read data from the device
read_configuration()
resume(() -> None)Resume a device from a ‘paused’ state
stage()
stop(*[, success])Stop the Device and all (instantiated) subdevices
subscribe(cb[, event_type, run])Subscribe to events this event_type generates.
summary()
trigger(() -> ophyd.status.StatusBase)Trigger the device and return status object
unstage(() -> typing.List[object])Unstage the device.
unsubscribe(cid)Remove a subscription
validate_asyn_ports()Validate that all components of pipeline are known
wait_for_connection([all_signals, timeout])Wait for signals to connect
-
- -
- - -
-
- -
-
- - -
-
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_as_gen/ophyd.areadetector.plugins.HDF5Plugin.html b/ophyd/_as_gen/ophyd.areadetector.plugins.HDF5Plugin.html deleted file mode 100644 index 76be3bcbe2..0000000000 --- a/ophyd/_as_gen/ophyd.areadetector.plugins.HDF5Plugin.html +++ /dev/null @@ -1,397 +0,0 @@ - - - - - - - - - - - ophyd.areadetector.plugins.HDF5Plugin — ophyd documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
-
- - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

ophyd.areadetector.plugins.HDF5Plugin

-
-
-class ophyd.areadetector.plugins.HDF5Plugin(*args, **kwargs)
-
-
-__init__(*args, **kwargs)
-
- -

Methods

- ---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
__init__(*args, **kwargs)
check_value(value, **kwargs)Check if the value is valid for this object
clear_sub(cb[, event_type])Remove a subscription, given the original callback function
configure((d: typing.Dict[str, …)Configure the device for something during a run
describe(…)Provide schema and meta-data for read()
describe_configuration()
disable_on_stage()when the plugin is staged, ensure that it is disabled.
enable_on_stage()when the plugin is staged, ensure that it is enabled.
ensure_blocking()Ensure that if plugin is enabled after staging, callbacks block.
ensure_nonblocking()Ensure that if plugin is enabled after staging, callbacks don’t block.
find_signal(text[, use_re, case_sensitive, …])Search through the signal docs on this detector for the string text
generate_datum(key, timestamp, datum_kwargs)
get(**kwargs)Get the value of all components in the device
get_asyn_digraph()Get the directed graph of the ASYN ports
get_asyn_port_dictionary()Return port name : component map
get_device_tuple()The device tuple type associated with an Device class
get_instantiated_signals(*[, attr_prefix])Yields all of the instantiated signals in a device hierarchy
get_plugin_by_asyn_port(port_name)Get the plugin which has the given asyn port name
missing_plugins()Find missing ports
pause(() -> None)Attempt to ‘pause’ the device.
put(dev_t, **kwargs)Put a value to all components of the device
read(() -> ophyd.device.OrderedDictType[str, …)Read data from the device
read_configuration()
resume(() -> None)Resume a device from a ‘paused’ state
stage()
stop(*[, success])Stop the Device and all (instantiated) subdevices
subscribe(cb[, event_type, run])Subscribe to events this event_type generates.
summary()
trigger(() -> ophyd.status.StatusBase)Trigger the device and return status object
unstage(() -> typing.List[object])Unstage the device.
unsubscribe(cid)Remove a subscription
validate_asyn_ports()Validate that all components of pipeline are known
wait_for_connection([all_signals, timeout])Wait for signals to connect
warmup()A convenience method for ‘priming’ the plugin.
-
- -
- - -
-
- -
-
- - -
-
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_as_gen/ophyd.areadetector.plugins.ImagePlugin.html b/ophyd/_as_gen/ophyd.areadetector.plugins.ImagePlugin.html deleted file mode 100644 index a8e6d3854b..0000000000 --- a/ophyd/_as_gen/ophyd.areadetector.plugins.ImagePlugin.html +++ /dev/null @@ -1,392 +0,0 @@ - - - - - - - - - - - ophyd.areadetector.plugins.ImagePlugin — ophyd documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
-
- - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

ophyd.areadetector.plugins.ImagePlugin

-
-
-class ophyd.areadetector.plugins.ImagePlugin(*args, **kwargs)
-
-
-__init__(*args, **kwargs)
-
- -

Methods

- ---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
__init__(*args, **kwargs)
check_value(value, **kwargs)Check if the value is valid for this object
clear_sub(cb[, event_type])Remove a subscription, given the original callback function
configure((d: typing.Dict[str, …)Configure the device for something during a run
describe(…)Provide schema and meta-data for read()
describe_configuration()
disable_on_stage()when the plugin is staged, ensure that it is disabled.
enable_on_stage()when the plugin is staged, ensure that it is enabled.
ensure_blocking()Ensure that if plugin is enabled after staging, callbacks block.
ensure_nonblocking()Ensure that if plugin is enabled after staging, callbacks don’t block.
find_signal(text[, use_re, case_sensitive, …])Search through the signal docs on this detector for the string text
get(**kwargs)Get the value of all components in the device
get_asyn_digraph()Get the directed graph of the ASYN ports
get_asyn_port_dictionary()Return port name : component map
get_device_tuple()The device tuple type associated with an Device class
get_instantiated_signals(*[, attr_prefix])Yields all of the instantiated signals in a device hierarchy
get_plugin_by_asyn_port(port_name)Get the plugin which has the given asyn port name
missing_plugins()Find missing ports
pause(() -> None)Attempt to ‘pause’ the device.
put(dev_t, **kwargs)Put a value to all components of the device
read(() -> ophyd.device.OrderedDictType[str, …)Read data from the device
read_configuration()
resume(() -> None)Resume a device from a ‘paused’ state
stage()
stop(*[, success])Stop the Device and all (instantiated) subdevices
subscribe(cb[, event_type, run])Subscribe to events this event_type generates.
summary()
trigger(() -> ophyd.status.StatusBase)Trigger the device and return status object
unstage(() -> typing.List[object])Unstage the device.
unsubscribe(cid)Remove a subscription
validate_asyn_ports()Validate that all components of pipeline are known
wait_for_connection([all_signals, timeout])Wait for signals to connect
-
- -
- - -
-
- -
-
- - -
-
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_as_gen/ophyd.areadetector.plugins.JPEGPlugin.html b/ophyd/_as_gen/ophyd.areadetector.plugins.JPEGPlugin.html deleted file mode 100644 index 8a8bb4fc95..0000000000 --- a/ophyd/_as_gen/ophyd.areadetector.plugins.JPEGPlugin.html +++ /dev/null @@ -1,394 +0,0 @@ - - - - - - - - - - - ophyd.areadetector.plugins.JPEGPlugin — ophyd documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
-
- - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

ophyd.areadetector.plugins.JPEGPlugin

-
-
-class ophyd.areadetector.plugins.JPEGPlugin(*args, **kwargs)
-
-
-__init__(*args, **kwargs)
-
- -

Methods

- ---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
__init__(*args, **kwargs)
check_value(value, **kwargs)Check if the value is valid for this object
clear_sub(cb[, event_type])Remove a subscription, given the original callback function
configure((d: typing.Dict[str, …)Configure the device for something during a run
describe(…)Provide schema and meta-data for read()
describe_configuration()
disable_on_stage()when the plugin is staged, ensure that it is disabled.
enable_on_stage()when the plugin is staged, ensure that it is enabled.
ensure_blocking()Ensure that if plugin is enabled after staging, callbacks block.
ensure_nonblocking()Ensure that if plugin is enabled after staging, callbacks don’t block.
find_signal(text[, use_re, case_sensitive, …])Search through the signal docs on this detector for the string text
generate_datum(key, timestamp, datum_kwargs)
get(**kwargs)Get the value of all components in the device
get_asyn_digraph()Get the directed graph of the ASYN ports
get_asyn_port_dictionary()Return port name : component map
get_device_tuple()The device tuple type associated with an Device class
get_instantiated_signals(*[, attr_prefix])Yields all of the instantiated signals in a device hierarchy
get_plugin_by_asyn_port(port_name)Get the plugin which has the given asyn port name
missing_plugins()Find missing ports
pause(() -> None)Attempt to ‘pause’ the device.
put(dev_t, **kwargs)Put a value to all components of the device
read(() -> ophyd.device.OrderedDictType[str, …)Read data from the device
read_configuration()
resume(() -> None)Resume a device from a ‘paused’ state
stage()
stop(*[, success])Stop the Device and all (instantiated) subdevices
subscribe(cb[, event_type, run])Subscribe to events this event_type generates.
summary()
trigger(() -> ophyd.status.StatusBase)Trigger the device and return status object
unstage(() -> typing.List[object])Unstage the device.
unsubscribe(cid)Remove a subscription
validate_asyn_ports()Validate that all components of pipeline are known
wait_for_connection([all_signals, timeout])Wait for signals to connect
-
- -
- - -
-
- -
-
- - -
-
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_as_gen/ophyd.areadetector.plugins.MagickPlugin.html b/ophyd/_as_gen/ophyd.areadetector.plugins.MagickPlugin.html deleted file mode 100644 index 0004017fc3..0000000000 --- a/ophyd/_as_gen/ophyd.areadetector.plugins.MagickPlugin.html +++ /dev/null @@ -1,394 +0,0 @@ - - - - - - - - - - - ophyd.areadetector.plugins.MagickPlugin — ophyd documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
-
- - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

ophyd.areadetector.plugins.MagickPlugin

-
-
-class ophyd.areadetector.plugins.MagickPlugin(*args, **kwargs)
-
-
-__init__(*args, **kwargs)
-
- -

Methods

- ---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
__init__(*args, **kwargs)
check_value(value, **kwargs)Check if the value is valid for this object
clear_sub(cb[, event_type])Remove a subscription, given the original callback function
configure((d: typing.Dict[str, …)Configure the device for something during a run
describe(…)Provide schema and meta-data for read()
describe_configuration()
disable_on_stage()when the plugin is staged, ensure that it is disabled.
enable_on_stage()when the plugin is staged, ensure that it is enabled.
ensure_blocking()Ensure that if plugin is enabled after staging, callbacks block.
ensure_nonblocking()Ensure that if plugin is enabled after staging, callbacks don’t block.
find_signal(text[, use_re, case_sensitive, …])Search through the signal docs on this detector for the string text
generate_datum(key, timestamp, datum_kwargs)
get(**kwargs)Get the value of all components in the device
get_asyn_digraph()Get the directed graph of the ASYN ports
get_asyn_port_dictionary()Return port name : component map
get_device_tuple()The device tuple type associated with an Device class
get_instantiated_signals(*[, attr_prefix])Yields all of the instantiated signals in a device hierarchy
get_plugin_by_asyn_port(port_name)Get the plugin which has the given asyn port name
missing_plugins()Find missing ports
pause(() -> None)Attempt to ‘pause’ the device.
put(dev_t, **kwargs)Put a value to all components of the device
read(() -> ophyd.device.OrderedDictType[str, …)Read data from the device
read_configuration()
resume(() -> None)Resume a device from a ‘paused’ state
stage()
stop(*[, success])Stop the Device and all (instantiated) subdevices
subscribe(cb[, event_type, run])Subscribe to events this event_type generates.
summary()
trigger(() -> ophyd.status.StatusBase)Trigger the device and return status object
unstage(() -> typing.List[object])Unstage the device.
unsubscribe(cid)Remove a subscription
validate_asyn_ports()Validate that all components of pipeline are known
wait_for_connection([all_signals, timeout])Wait for signals to connect
-
- -
- - -
-
- -
-
- - -
-
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_as_gen/ophyd.areadetector.plugins.NetCDFPlugin.html b/ophyd/_as_gen/ophyd.areadetector.plugins.NetCDFPlugin.html deleted file mode 100644 index 3c6e6d1049..0000000000 --- a/ophyd/_as_gen/ophyd.areadetector.plugins.NetCDFPlugin.html +++ /dev/null @@ -1,394 +0,0 @@ - - - - - - - - - - - ophyd.areadetector.plugins.NetCDFPlugin — ophyd documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
-
- - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

ophyd.areadetector.plugins.NetCDFPlugin

-
-
-class ophyd.areadetector.plugins.NetCDFPlugin(*args, **kwargs)
-
-
-__init__(*args, **kwargs)
-
- -

Methods

- ---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
__init__(*args, **kwargs)
check_value(value, **kwargs)Check if the value is valid for this object
clear_sub(cb[, event_type])Remove a subscription, given the original callback function
configure((d: typing.Dict[str, …)Configure the device for something during a run
describe(…)Provide schema and meta-data for read()
describe_configuration()
disable_on_stage()when the plugin is staged, ensure that it is disabled.
enable_on_stage()when the plugin is staged, ensure that it is enabled.
ensure_blocking()Ensure that if plugin is enabled after staging, callbacks block.
ensure_nonblocking()Ensure that if plugin is enabled after staging, callbacks don’t block.
find_signal(text[, use_re, case_sensitive, …])Search through the signal docs on this detector for the string text
generate_datum(key, timestamp, datum_kwargs)
get(**kwargs)Get the value of all components in the device
get_asyn_digraph()Get the directed graph of the ASYN ports
get_asyn_port_dictionary()Return port name : component map
get_device_tuple()The device tuple type associated with an Device class
get_instantiated_signals(*[, attr_prefix])Yields all of the instantiated signals in a device hierarchy
get_plugin_by_asyn_port(port_name)Get the plugin which has the given asyn port name
missing_plugins()Find missing ports
pause(() -> None)Attempt to ‘pause’ the device.
put(dev_t, **kwargs)Put a value to all components of the device
read(() -> ophyd.device.OrderedDictType[str, …)Read data from the device
read_configuration()
resume(() -> None)Resume a device from a ‘paused’ state
stage()
stop(*[, success])Stop the Device and all (instantiated) subdevices
subscribe(cb[, event_type, run])Subscribe to events this event_type generates.
summary()
trigger(() -> ophyd.status.StatusBase)Trigger the device and return status object
unstage(() -> typing.List[object])Unstage the device.
unsubscribe(cid)Remove a subscription
validate_asyn_ports()Validate that all components of pipeline are known
wait_for_connection([all_signals, timeout])Wait for signals to connect
-
- -
- - -
-
- -
-
- - -
-
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_as_gen/ophyd.areadetector.plugins.NexusPlugin.html b/ophyd/_as_gen/ophyd.areadetector.plugins.NexusPlugin.html deleted file mode 100644 index e16505fb36..0000000000 --- a/ophyd/_as_gen/ophyd.areadetector.plugins.NexusPlugin.html +++ /dev/null @@ -1,394 +0,0 @@ - - - - - - - - - - - ophyd.areadetector.plugins.NexusPlugin — ophyd documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
-
- - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

ophyd.areadetector.plugins.NexusPlugin

-
-
-class ophyd.areadetector.plugins.NexusPlugin(*args, **kwargs)
-
-
-__init__(*args, **kwargs)
-
- -

Methods

- ---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
__init__(*args, **kwargs)
check_value(value, **kwargs)Check if the value is valid for this object
clear_sub(cb[, event_type])Remove a subscription, given the original callback function
configure((d: typing.Dict[str, …)Configure the device for something during a run
describe(…)Provide schema and meta-data for read()
describe_configuration()
disable_on_stage()when the plugin is staged, ensure that it is disabled.
enable_on_stage()when the plugin is staged, ensure that it is enabled.
ensure_blocking()Ensure that if plugin is enabled after staging, callbacks block.
ensure_nonblocking()Ensure that if plugin is enabled after staging, callbacks don’t block.
find_signal(text[, use_re, case_sensitive, …])Search through the signal docs on this detector for the string text
generate_datum(key, timestamp, datum_kwargs)
get(**kwargs)Get the value of all components in the device
get_asyn_digraph()Get the directed graph of the ASYN ports
get_asyn_port_dictionary()Return port name : component map
get_device_tuple()The device tuple type associated with an Device class
get_instantiated_signals(*[, attr_prefix])Yields all of the instantiated signals in a device hierarchy
get_plugin_by_asyn_port(port_name)Get the plugin which has the given asyn port name
missing_plugins()Find missing ports
pause(() -> None)Attempt to ‘pause’ the device.
put(dev_t, **kwargs)Put a value to all components of the device
read(() -> ophyd.device.OrderedDictType[str, …)Read data from the device
read_configuration()
resume(() -> None)Resume a device from a ‘paused’ state
stage()
stop(*[, success])Stop the Device and all (instantiated) subdevices
subscribe(cb[, event_type, run])Subscribe to events this event_type generates.
summary()
trigger(() -> ophyd.status.StatusBase)Trigger the device and return status object
unstage(() -> typing.List[object])Unstage the device.
unsubscribe(cid)Remove a subscription
validate_asyn_ports()Validate that all components of pipeline are known
wait_for_connection([all_signals, timeout])Wait for signals to connect
-
- -
- - -
-
- -
-
- - -
-
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_as_gen/ophyd.areadetector.plugins.OverlayPlugin.html b/ophyd/_as_gen/ophyd.areadetector.plugins.OverlayPlugin.html deleted file mode 100644 index 8b490c84ec..0000000000 --- a/ophyd/_as_gen/ophyd.areadetector.plugins.OverlayPlugin.html +++ /dev/null @@ -1,406 +0,0 @@ - - - - - - - - - - - ophyd.areadetector.plugins.OverlayPlugin — ophyd documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
-
- - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

ophyd.areadetector.plugins.OverlayPlugin

-
-
-class ophyd.areadetector.plugins.OverlayPlugin(*args, **kwargs)
-

Plugin which adds graphics overlays to an NDArray image

-

Keyword arguments are passed to the base class, PluginBase

- --- - - - -
Parameters:

prefix : str

-
-

The areaDetector plugin prefix

-
-
-
-
-__init__(*args, **kwargs)
-
- -

Methods

- ---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
__init__(*args, **kwargs)
check_value(value, **kwargs)Check if the value is valid for this object
clear_sub(cb[, event_type])Remove a subscription, given the original callback function
configure((d: typing.Dict[str, …)Configure the device for something during a run
describe(…)Provide schema and meta-data for read()
describe_configuration()
disable_on_stage()when the plugin is staged, ensure that it is disabled.
enable_on_stage()when the plugin is staged, ensure that it is enabled.
ensure_blocking()Ensure that if plugin is enabled after staging, callbacks block.
ensure_nonblocking()Ensure that if plugin is enabled after staging, callbacks don’t block.
find_signal(text[, use_re, case_sensitive, …])Search through the signal docs on this detector for the string text
get(**kwargs)Get the value of all components in the device
get_asyn_digraph()Get the directed graph of the ASYN ports
get_asyn_port_dictionary()Return port name : component map
get_device_tuple()The device tuple type associated with an Device class
get_instantiated_signals(*[, attr_prefix])Yields all of the instantiated signals in a device hierarchy
get_plugin_by_asyn_port(port_name)Get the plugin which has the given asyn port name
missing_plugins()Find missing ports
pause(() -> None)Attempt to ‘pause’ the device.
put(dev_t, **kwargs)Put a value to all components of the device
read(() -> ophyd.device.OrderedDictType[str, …)Read data from the device
read_configuration()
resume(() -> None)Resume a device from a ‘paused’ state
stage()
stop(*[, success])Stop the Device and all (instantiated) subdevices
subscribe(cb[, event_type, run])Subscribe to events this event_type generates.
summary()
trigger(() -> ophyd.status.StatusBase)Trigger the device and return status object
unstage(() -> typing.List[object])Unstage the device.
unsubscribe(cid)Remove a subscription
validate_asyn_ports()Validate that all components of pipeline are known
wait_for_connection([all_signals, timeout])Wait for signals to connect
-
- -
- - -
-
- -
-
- - -
-
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_as_gen/ophyd.areadetector.plugins.PluginBase.html b/ophyd/_as_gen/ophyd.areadetector.plugins.PluginBase.html deleted file mode 100644 index fc27133659..0000000000 --- a/ophyd/_as_gen/ophyd.areadetector.plugins.PluginBase.html +++ /dev/null @@ -1,393 +0,0 @@ - - - - - - - - - - - ophyd.areadetector.plugins.PluginBase — ophyd documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
-
- - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

ophyd.areadetector.plugins.PluginBase

-
-
-class ophyd.areadetector.plugins.PluginBase(*args, **kwargs)
-

AreaDetector plugin base class

-
-
-__init__(*args, **kwargs)
-
- -

Methods

- ---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
__init__(*args, **kwargs)
check_value(value, **kwargs)Check if the value is valid for this object
clear_sub(cb[, event_type])Remove a subscription, given the original callback function
configure((d: typing.Dict[str, …)Configure the device for something during a run
describe(…)Provide schema and meta-data for read()
describe_configuration()
disable_on_stage()when the plugin is staged, ensure that it is disabled.
enable_on_stage()when the plugin is staged, ensure that it is enabled.
ensure_blocking()Ensure that if plugin is enabled after staging, callbacks block.
ensure_nonblocking()Ensure that if plugin is enabled after staging, callbacks don’t block.
find_signal(text[, use_re, case_sensitive, …])Search through the signal docs on this detector for the string text
get(**kwargs)Get the value of all components in the device
get_asyn_digraph()Get the directed graph of the ASYN ports
get_asyn_port_dictionary()Return port name : component map
get_device_tuple()The device tuple type associated with an Device class
get_instantiated_signals(*[, attr_prefix])Yields all of the instantiated signals in a device hierarchy
get_plugin_by_asyn_port(port_name)Get the plugin which has the given asyn port name
missing_plugins()Find missing ports
pause(() -> None)Attempt to ‘pause’ the device.
put(dev_t, **kwargs)Put a value to all components of the device
read(() -> ophyd.device.OrderedDictType[str, …)Read data from the device
read_configuration()
resume(() -> None)Resume a device from a ‘paused’ state
stage()
stop(*[, success])Stop the Device and all (instantiated) subdevices
subscribe(cb[, event_type, run])Subscribe to events this event_type generates.
summary()
trigger(() -> ophyd.status.StatusBase)Trigger the device and return status object
unstage(() -> typing.List[object])Unstage the device.
unsubscribe(cid)Remove a subscription
validate_asyn_ports()Validate that all components of pipeline are known
wait_for_connection([all_signals, timeout])Wait for signals to connect
-
- -
- - -
-
- -
-
- - -
-
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_as_gen/ophyd.areadetector.plugins.ProcessPlugin.html b/ophyd/_as_gen/ophyd.areadetector.plugins.ProcessPlugin.html deleted file mode 100644 index 4568613c43..0000000000 --- a/ophyd/_as_gen/ophyd.areadetector.plugins.ProcessPlugin.html +++ /dev/null @@ -1,392 +0,0 @@ - - - - - - - - - - - ophyd.areadetector.plugins.ProcessPlugin — ophyd documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
-
- - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

ophyd.areadetector.plugins.ProcessPlugin

-
-
-class ophyd.areadetector.plugins.ProcessPlugin(*args, **kwargs)
-
-
-__init__(*args, **kwargs)
-
- -

Methods

- ---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
__init__(*args, **kwargs)
check_value(value, **kwargs)Check if the value is valid for this object
clear_sub(cb[, event_type])Remove a subscription, given the original callback function
configure((d: typing.Dict[str, …)Configure the device for something during a run
describe(…)Provide schema and meta-data for read()
describe_configuration()
disable_on_stage()when the plugin is staged, ensure that it is disabled.
enable_on_stage()when the plugin is staged, ensure that it is enabled.
ensure_blocking()Ensure that if plugin is enabled after staging, callbacks block.
ensure_nonblocking()Ensure that if plugin is enabled after staging, callbacks don’t block.
find_signal(text[, use_re, case_sensitive, …])Search through the signal docs on this detector for the string text
get(**kwargs)Get the value of all components in the device
get_asyn_digraph()Get the directed graph of the ASYN ports
get_asyn_port_dictionary()Return port name : component map
get_device_tuple()The device tuple type associated with an Device class
get_instantiated_signals(*[, attr_prefix])Yields all of the instantiated signals in a device hierarchy
get_plugin_by_asyn_port(port_name)Get the plugin which has the given asyn port name
missing_plugins()Find missing ports
pause(() -> None)Attempt to ‘pause’ the device.
put(dev_t, **kwargs)Put a value to all components of the device
read(() -> ophyd.device.OrderedDictType[str, …)Read data from the device
read_configuration()
resume(() -> None)Resume a device from a ‘paused’ state
stage()
stop(*[, success])Stop the Device and all (instantiated) subdevices
subscribe(cb[, event_type, run])Subscribe to events this event_type generates.
summary()
trigger(() -> ophyd.status.StatusBase)Trigger the device and return status object
unstage(() -> typing.List[object])Unstage the device.
unsubscribe(cid)Remove a subscription
validate_asyn_ports()Validate that all components of pipeline are known
wait_for_connection([all_signals, timeout])Wait for signals to connect
-
- -
- - -
-
- -
-
- - -
-
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_as_gen/ophyd.areadetector.plugins.ROIPlugin.html b/ophyd/_as_gen/ophyd.areadetector.plugins.ROIPlugin.html deleted file mode 100644 index d32df2bb0b..0000000000 --- a/ophyd/_as_gen/ophyd.areadetector.plugins.ROIPlugin.html +++ /dev/null @@ -1,392 +0,0 @@ - - - - - - - - - - - ophyd.areadetector.plugins.ROIPlugin — ophyd documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
-
- - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

ophyd.areadetector.plugins.ROIPlugin

-
-
-class ophyd.areadetector.plugins.ROIPlugin(*args, **kwargs)
-
-
-__init__(*args, **kwargs)
-
- -

Methods

- ---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
__init__(*args, **kwargs)
check_value(value, **kwargs)Check if the value is valid for this object
clear_sub(cb[, event_type])Remove a subscription, given the original callback function
configure((d: typing.Dict[str, …)Configure the device for something during a run
describe(…)Provide schema and meta-data for read()
describe_configuration()
disable_on_stage()when the plugin is staged, ensure that it is disabled.
enable_on_stage()when the plugin is staged, ensure that it is enabled.
ensure_blocking()Ensure that if plugin is enabled after staging, callbacks block.
ensure_nonblocking()Ensure that if plugin is enabled after staging, callbacks don’t block.
find_signal(text[, use_re, case_sensitive, …])Search through the signal docs on this detector for the string text
get(**kwargs)Get the value of all components in the device
get_asyn_digraph()Get the directed graph of the ASYN ports
get_asyn_port_dictionary()Return port name : component map
get_device_tuple()The device tuple type associated with an Device class
get_instantiated_signals(*[, attr_prefix])Yields all of the instantiated signals in a device hierarchy
get_plugin_by_asyn_port(port_name)Get the plugin which has the given asyn port name
missing_plugins()Find missing ports
pause(() -> None)Attempt to ‘pause’ the device.
put(dev_t, **kwargs)Put a value to all components of the device
read(() -> ophyd.device.OrderedDictType[str, …)Read data from the device
read_configuration()
resume(() -> None)Resume a device from a ‘paused’ state
stage()
stop(*[, success])Stop the Device and all (instantiated) subdevices
subscribe(cb[, event_type, run])Subscribe to events this event_type generates.
summary()
trigger(() -> ophyd.status.StatusBase)Trigger the device and return status object
unstage(() -> typing.List[object])Unstage the device.
unsubscribe(cid)Remove a subscription
validate_asyn_ports()Validate that all components of pipeline are known
wait_for_connection([all_signals, timeout])Wait for signals to connect
-
- -
- - -
-
- -
-
- - -
-
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_as_gen/ophyd.areadetector.plugins.StatsPlugin.html b/ophyd/_as_gen/ophyd.areadetector.plugins.StatsPlugin.html deleted file mode 100644 index 35027373a5..0000000000 --- a/ophyd/_as_gen/ophyd.areadetector.plugins.StatsPlugin.html +++ /dev/null @@ -1,392 +0,0 @@ - - - - - - - - - - - ophyd.areadetector.plugins.StatsPlugin — ophyd documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
-
- - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

ophyd.areadetector.plugins.StatsPlugin

-
-
-class ophyd.areadetector.plugins.StatsPlugin(*args, **kwargs)
-
-
-__init__(*args, **kwargs)
-
- -

Methods

- ---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
__init__(*args, **kwargs)
check_value(value, **kwargs)Check if the value is valid for this object
clear_sub(cb[, event_type])Remove a subscription, given the original callback function
configure((d: typing.Dict[str, …)Configure the device for something during a run
describe(…)Provide schema and meta-data for read()
describe_configuration()
disable_on_stage()when the plugin is staged, ensure that it is disabled.
enable_on_stage()when the plugin is staged, ensure that it is enabled.
ensure_blocking()Ensure that if plugin is enabled after staging, callbacks block.
ensure_nonblocking()Ensure that if plugin is enabled after staging, callbacks don’t block.
find_signal(text[, use_re, case_sensitive, …])Search through the signal docs on this detector for the string text
get(**kwargs)Get the value of all components in the device
get_asyn_digraph()Get the directed graph of the ASYN ports
get_asyn_port_dictionary()Return port name : component map
get_device_tuple()The device tuple type associated with an Device class
get_instantiated_signals(*[, attr_prefix])Yields all of the instantiated signals in a device hierarchy
get_plugin_by_asyn_port(port_name)Get the plugin which has the given asyn port name
missing_plugins()Find missing ports
pause(() -> None)Attempt to ‘pause’ the device.
put(dev_t, **kwargs)Put a value to all components of the device
read(() -> ophyd.device.OrderedDictType[str, …)Read data from the device
read_configuration()
resume(() -> None)Resume a device from a ‘paused’ state
stage()
stop(*[, success])Stop the Device and all (instantiated) subdevices
subscribe(cb[, event_type, run])Subscribe to events this event_type generates.
summary()
trigger(() -> ophyd.status.StatusBase)Trigger the device and return status object
unstage(() -> typing.List[object])Unstage the device.
unsubscribe(cid)Remove a subscription
validate_asyn_ports()Validate that all components of pipeline are known
wait_for_connection([all_signals, timeout])Wait for signals to connect
-
- -
- - -
-
- -
-
- - -
-
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_as_gen/ophyd.areadetector.plugins.TIFFPlugin.html b/ophyd/_as_gen/ophyd.areadetector.plugins.TIFFPlugin.html deleted file mode 100644 index 6abd54e0bc..0000000000 --- a/ophyd/_as_gen/ophyd.areadetector.plugins.TIFFPlugin.html +++ /dev/null @@ -1,394 +0,0 @@ - - - - - - - - - - - ophyd.areadetector.plugins.TIFFPlugin — ophyd documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
-
- - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

ophyd.areadetector.plugins.TIFFPlugin

-
-
-class ophyd.areadetector.plugins.TIFFPlugin(*args, **kwargs)
-
-
-__init__(*args, **kwargs)
-
- -

Methods

- ---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
__init__(*args, **kwargs)
check_value(value, **kwargs)Check if the value is valid for this object
clear_sub(cb[, event_type])Remove a subscription, given the original callback function
configure((d: typing.Dict[str, …)Configure the device for something during a run
describe(…)Provide schema and meta-data for read()
describe_configuration()
disable_on_stage()when the plugin is staged, ensure that it is disabled.
enable_on_stage()when the plugin is staged, ensure that it is enabled.
ensure_blocking()Ensure that if plugin is enabled after staging, callbacks block.
ensure_nonblocking()Ensure that if plugin is enabled after staging, callbacks don’t block.
find_signal(text[, use_re, case_sensitive, …])Search through the signal docs on this detector for the string text
generate_datum(key, timestamp, datum_kwargs)
get(**kwargs)Get the value of all components in the device
get_asyn_digraph()Get the directed graph of the ASYN ports
get_asyn_port_dictionary()Return port name : component map
get_device_tuple()The device tuple type associated with an Device class
get_instantiated_signals(*[, attr_prefix])Yields all of the instantiated signals in a device hierarchy
get_plugin_by_asyn_port(port_name)Get the plugin which has the given asyn port name
missing_plugins()Find missing ports
pause(() -> None)Attempt to ‘pause’ the device.
put(dev_t, **kwargs)Put a value to all components of the device
read(() -> ophyd.device.OrderedDictType[str, …)Read data from the device
read_configuration()
resume(() -> None)Resume a device from a ‘paused’ state
stage()
stop(*[, success])Stop the Device and all (instantiated) subdevices
subscribe(cb[, event_type, run])Subscribe to events this event_type generates.
summary()
trigger(() -> ophyd.status.StatusBase)Trigger the device and return status object
unstage(() -> typing.List[object])Unstage the device.
unsubscribe(cid)Remove a subscription
validate_asyn_ports()Validate that all components of pipeline are known
wait_for_connection([all_signals, timeout])Wait for signals to connect
-
- -
- - -
-
- -
-
- - -
-
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_as_gen/ophyd.areadetector.plugins.TransformPlugin.html b/ophyd/_as_gen/ophyd.areadetector.plugins.TransformPlugin.html deleted file mode 100644 index 2f3086d38f..0000000000 --- a/ophyd/_as_gen/ophyd.areadetector.plugins.TransformPlugin.html +++ /dev/null @@ -1,392 +0,0 @@ - - - - - - - - - - - ophyd.areadetector.plugins.TransformPlugin — ophyd documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
-
- - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

ophyd.areadetector.plugins.TransformPlugin

-
-
-class ophyd.areadetector.plugins.TransformPlugin(*args, **kwargs)
-
-
-__init__(*args, **kwargs)
-
- -

Methods

- ---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
__init__(*args, **kwargs)
check_value(value, **kwargs)Check if the value is valid for this object
clear_sub(cb[, event_type])Remove a subscription, given the original callback function
configure((d: typing.Dict[str, …)Configure the device for something during a run
describe(…)Provide schema and meta-data for read()
describe_configuration()
disable_on_stage()when the plugin is staged, ensure that it is disabled.
enable_on_stage()when the plugin is staged, ensure that it is enabled.
ensure_blocking()Ensure that if plugin is enabled after staging, callbacks block.
ensure_nonblocking()Ensure that if plugin is enabled after staging, callbacks don’t block.
find_signal(text[, use_re, case_sensitive, …])Search through the signal docs on this detector for the string text
get(**kwargs)Get the value of all components in the device
get_asyn_digraph()Get the directed graph of the ASYN ports
get_asyn_port_dictionary()Return port name : component map
get_device_tuple()The device tuple type associated with an Device class
get_instantiated_signals(*[, attr_prefix])Yields all of the instantiated signals in a device hierarchy
get_plugin_by_asyn_port(port_name)Get the plugin which has the given asyn port name
missing_plugins()Find missing ports
pause(() -> None)Attempt to ‘pause’ the device.
put(dev_t, **kwargs)Put a value to all components of the device
read(() -> ophyd.device.OrderedDictType[str, …)Read data from the device
read_configuration()
resume(() -> None)Resume a device from a ‘paused’ state
stage()
stop(*[, success])Stop the Device and all (instantiated) subdevices
subscribe(cb[, event_type, run])Subscribe to events this event_type generates.
summary()
trigger(() -> ophyd.status.StatusBase)Trigger the device and return status object
unstage(() -> typing.List[object])Unstage the device.
unsubscribe(cid)Remove a subscription
validate_asyn_ports()Validate that all components of pipeline are known
wait_for_connection([all_signals, timeout])Wait for signals to connect
-
- -
- - -
-
- -
-
- - -
-
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_as_gen/ophyd.areadetector.plugins.html b/ophyd/_as_gen/ophyd.areadetector.plugins.html deleted file mode 100644 index dd4b15be7b..0000000000 --- a/ophyd/_as_gen/ophyd.areadetector.plugins.html +++ /dev/null @@ -1,370 +0,0 @@ - - - - - - - - - - - ophyd.areadetector.plugins — ophyd documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
-
- - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

ophyd.areadetector.plugins

-

AreaDetector plugins

-
-
areaDetector plugin abstractions
-

Functions

- ---- - - - - - - - - - - - - - - -
get_areadetector_plugin(prefix, **kwargs)Get an instance of an areadetector plugin by supplying its PV prefix and any kwargs for the constructor.
get_areadetector_plugin_class(prefix[, timeout])Get an areadetector plugin class by supplying its PV prefix
plugin_from_pvname(pv)Get the plugin class from a pvname, using regular expressions defined in the classes (_suffix_re).
register_plugin(cls)Register a plugin
-

Classes

- ---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ColorConvPlugin(*args, **kwargs)
FilePlugin(*args, **kwargs)
HDF5Plugin(*args, **kwargs)
ImagePlugin(*args, **kwargs)
JPEGPlugin(*args, **kwargs)
MagickPlugin(*args, **kwargs)
NetCDFPlugin(*args, **kwargs)
NexusPlugin(*args, **kwargs)
Overlay([prefix, read_attrs, …])
OverlayPlugin(*args, **kwargs)Plugin which adds graphics overlays to an NDArray image
PluginBase(*args, **kwargs)AreaDetector plugin base class
ProcessPlugin(*args, **kwargs)
ROIPlugin(*args, **kwargs)
StatsPlugin(*args, **kwargs)
TIFFPlugin(*args, **kwargs)
TransformPlugin(*args, **kwargs)
-
- - -
-
- -
-
- - -
-
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_as_gen/ophyd.areadetector.trigger_mixins.MultiTrigger.html b/ophyd/_as_gen/ophyd.areadetector.trigger_mixins.MultiTrigger.html deleted file mode 100644 index 2369754a03..0000000000 --- a/ophyd/_as_gen/ophyd.areadetector.trigger_mixins.MultiTrigger.html +++ /dev/null @@ -1,361 +0,0 @@ - - - - - - - - - - - ophyd.areadetector.trigger_mixins.MultiTrigger — ophyd documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
-
- - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

ophyd.areadetector.trigger_mixins.MultiTrigger

-
-
-class ophyd.areadetector.trigger_mixins.MultiTrigger(*args, trigger_cycle=None, **kwargs)
-

This trigger mixin class can take multiple acquisitions per trigger.

-

This can be used to give more control to the detector. One call to -‘trigger’ can be interpreted by the detector as a call to take several -acquisitions with, for example, different gain settings or shutter -positions.

-

The are two levels of nesting here:

-
-
    -
  • cycling through different actions on successive calls to trigger
  • -
  • within each trigger, executing a list of acquisitions with different -settings
  • -
-
-

See the example below, which takes and 3 and 1 acquisitions in -alternation.

-

Examples

-
>>> class MyDetector(SimDetector, MultiTrigger):
-...     pass
-# EXAMPLE:
-# 1. On the first trigger, close the shutter and acquire three images
-# with different gain settings on the detector. Then open the shutter
-# and take a light frame.
-# 2. On the next trigger, just take a light frame.
-# Repeat.
-#
-# Each element of this list specifies one acquisition. It gives a
-# a label for each kind of image that will be taken and a dictionary
-# mapping signals to values that must be set for that acquisition.
->>> dark_and_light = [('gain1', {'shutter': 'close', 'image_gain': 1}),
-...                   ('gain2', {'image_gain': 2}),
-...                   ('gain8', {'image_gain': 8}),
-...                   ('light', {'shutter': 'open'})],
-# This list only has one element; it will only take one acquisition.
->>> light_only = [('light', {'shutter': 'open'}]]
-# Finally, put the lists together. The detector will cycle through
-# this list as it is triggered.
->>> trigger_cycle = [dark_and_light, light_only]
->>> det = MyDetector(trigger_cycle=trigger_cycle)
-# Note: for simplicity, the settings were specified as dictionaries. If
-# you need to control the order that they are processed, use
-# OrderedDict instead.
-
-
-
-
-__init__(*args, trigger_cycle=None, **kwargs)
-
- -

Methods

- ---- - - - - - - - - - - - - - - - - - - - - - - - - - - -
__init__(*args[, trigger_cycle])
describe(…)Provide schema and meta-data for read()
pause(() -> None)Attempt to ‘pause’ the device.
read(() -> ophyd.device.OrderedDictType[str, …)Read data from the device
resume(() -> None)Resume a device from a ‘paused’ state
stage()
trigger()Trigger one or more acquisitions.
unstage()
-
- -
- - -
-
- -
-
- - -
-
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_as_gen/ophyd.areadetector.trigger_mixins.SingleTrigger.html b/ophyd/_as_gen/ophyd.areadetector.trigger_mixins.SingleTrigger.html deleted file mode 100644 index 0854de2fdf..0000000000 --- a/ophyd/_as_gen/ophyd.areadetector.trigger_mixins.SingleTrigger.html +++ /dev/null @@ -1,327 +0,0 @@ - - - - - - - - - - - ophyd.areadetector.trigger_mixins.SingleTrigger — ophyd documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
-
- - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

ophyd.areadetector.trigger_mixins.SingleTrigger

-
-
-class ophyd.areadetector.trigger_mixins.SingleTrigger(*args, image_name=None, **kwargs)
-

This trigger mixin class takes one acquisition per trigger.

-

Examples

-
>>> class SimDetector(SingleTrigger):
-...     pass
->>> det = SimDetector('..pv..')
-# optionally, customize name of image
->>> det = SimDetector('..pv..', image_name='fast_detector_image')
-
-
-
-
-__init__(*args, image_name=None, **kwargs)
-
- -

Methods

- ---- - - - - - - - - - - - - - - - - - - - - - - - - - - -
__init__(*args[, image_name])
describe(…)Provide schema and meta-data for read()
pause(() -> None)Attempt to ‘pause’ the device.
read(() -> ophyd.device.OrderedDictType[str, …)Read data from the device
resume(() -> None)Resume a device from a ‘paused’ state
stage()
trigger()Trigger one acquisition.
unstage()
-
- -
- - -
-
- -
-
- - -
-
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_as_gen/ophyd.areadetector.trigger_mixins.TriggerBase.html b/ophyd/_as_gen/ophyd.areadetector.trigger_mixins.TriggerBase.html deleted file mode 100644 index 2ce4571076..0000000000 --- a/ophyd/_as_gen/ophyd.areadetector.trigger_mixins.TriggerBase.html +++ /dev/null @@ -1,321 +0,0 @@ - - - - - - - - - - - ophyd.areadetector.trigger_mixins.TriggerBase — ophyd documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
-
- - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

ophyd.areadetector.trigger_mixins.TriggerBase

-
-
-class ophyd.areadetector.trigger_mixins.TriggerBase(*args, **kwargs)
-

Base class for trigger mixin classes

-

Subclasses must define a method with this signature:

-

acquire_changed(self, value=None, old_value=None, **kwargs)

-
-
-__init__(*args, **kwargs)
-
- -

Methods

- ---- - - - - - - - - - - - - - - - - - - - - - - - - - - -
__init__(*args, **kwargs)
describe(…)Provide schema and meta-data for read()
pause(() -> None)Attempt to ‘pause’ the device.
read(() -> ophyd.device.OrderedDictType[str, …)Read data from the device
resume(() -> None)Resume a device from a ‘paused’ state
stage(() -> typing.List[object])Stage the device for data collection.
trigger(() -> ophyd.status.StatusBase)Trigger the device and return status object
unstage(() -> typing.List[object])Unstage the device.
-
- -
- - -
-
- -
-
- - -
-
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_as_gen/ophyd.areadetector.trigger_mixins.html b/ophyd/_as_gen/ophyd.areadetector.trigger_mixins.html deleted file mode 100644 index d68e867bed..0000000000 --- a/ophyd/_as_gen/ophyd.areadetector.trigger_mixins.html +++ /dev/null @@ -1,319 +0,0 @@ - - - - - - - - - - - ophyd.areadetector.trigger_mixins — ophyd documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
-
- - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

ophyd.areadetector.trigger_mixins

-

Mixin classes that customize the triggering behavior of AreaDetector

-

To be used like so

-
from ophyd.areadetector.detectors import PerkinElmerDetector
-from ophyd.areadetector.trigger_mixins import SingleTrigger
-
-class MyDetector(PerkinElmerDetector, SingleTrigger):
-    pass
-
-
-

Classes

- ---- - - - - - - - - - - - - - - -
ADTriggerStatus(*args, **kwargs)A special status object that notifies watches (progress bars) based on comparing device.cam.array_counter to device.cam.num_images.
MultiTrigger(*args[, trigger_cycle])This trigger mixin class can take multiple acquisitions per trigger.
SingleTrigger(*args[, image_name])This trigger mixin class takes one acquisition per trigger.
TriggerBase(*args, **kwargs)Base class for trigger mixin classes
-
- - -
-
- -
-
- - -
-
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_as_gen/ophyd.areadetector.util.html b/ophyd/_as_gen/ophyd.areadetector.util.html deleted file mode 100644 index a762e4ee78..0000000000 --- a/ophyd/_as_gen/ophyd.areadetector.util.html +++ /dev/null @@ -1,322 +0,0 @@ - - - - - - - - - - - ophyd.areadetector.util — ophyd documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
-
- - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

ophyd.areadetector.util

-

Functions

- ---- - - - - - - - - - - - - - - -
create_detector_stub(db_file[, macros, …])Stub out a new AreaDetector camera directly from a database file
get_prop_name(pv)Get a property name from the camel-case AreaDetector PV name
get_stub_info(db_file[, macros, base_class])Stub out a new AreaDetector directly from a database file
stub_templates(path, **kwargs)Stub out a new AreaDetector directly from all database files in a path
-

Classes

- ---- - - - - - -
StubInfo(signal_type, record)Create new instance of StubInfo(signal_type, record)
-
- - -
-
- -
-
- - -
-
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_as_gen/ophyd.callbacks.html b/ophyd/_as_gen/ophyd.callbacks.html deleted file mode 100644 index 633613f9a2..0000000000 --- a/ophyd/_as_gen/ophyd.callbacks.html +++ /dev/null @@ -1,304 +0,0 @@ - - - - - - - - - - - ophyd.callbacks — ophyd documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
-
- - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

ophyd.callbacks

-

Classes

- ---- - - - - - - - - -
LastUidPublish(signal[, raise_if_disconnected])Publishes run start UID of most recently completed run to a given signal
UidPublish(signal[, raise_if_disconnected])Publishes run start UID of most recently begun run to a given signal
-
- - -
-
- -
-
- - -
-
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_as_gen/ophyd.commands.get_all_positioners.html b/ophyd/_as_gen/ophyd.commands.get_all_positioners.html deleted file mode 100644 index dd7d38896f..0000000000 --- a/ophyd/_as_gen/ophyd.commands.get_all_positioners.html +++ /dev/null @@ -1,274 +0,0 @@ - - - - - - - - - - - ophyd.commands.get_all_positioners — ophyd documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
-
- - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

ophyd.commands.get_all_positioners

-
-
-ophyd.commands.get_all_positioners()
-

Get all positioners defined in the IPython namespace

-
- -
- - -
-
- -
-
- - -
-
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_as_gen/ophyd.commands.html b/ophyd/_as_gen/ophyd.commands.html deleted file mode 100644 index 7b4f80ab41..0000000000 --- a/ophyd/_as_gen/ophyd.commands.html +++ /dev/null @@ -1,370 +0,0 @@ - - - - - - - - - - - ophyd.commands — ophyd documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
-
- - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

ophyd.commands

-

Command Line Interface to opyd objects

-

Functions

- ---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
blink([on, file])
catch_keyboard_interrupt(positioners)Context manager to capture Keyboard Interrupt and stop motors
ducks_from_namespace(attr)Get all instances that have a given attribute.
ensure(*ensure_args)
get_all_positioners()Get all positioners defined in the IPython namespace
get_logbook()Get the logbook instance from the user namespace
instances_from_namespace(classes)Get all instances of classes from the user namespace
log_pos([positioners, extra_msg])Get the current position of Positioners and make a logbook entry.
log_pos_diff([id, positioners])Move to positions located in logboook
log_pos_mov([id, dry_run, positioners])Move to positions located in logboook
logbook_add_objects(objects[, extra_pvs])Add to the logbook aditional information on ophyd objects.
logbook_to_objects([id])Search the logbook and return positioners
mov(positioner, position)Move positioners to given positions
movr(positioner, position)Move positioners relative to their current positon.
print_header([title, char, len, file])
print_string(val[, size, pre, post, file])
print_value(val[, prec, egu])
scrape_namespace()Get all public objects from the user namespace, sorted by name.
set_lm(positioner, limits)Set the limits of the positioner
set_pos(positioner, position)Set the position of a positioner
var_from_namespace(var)
wh_pos([positioners])Get the current position of Positioners and print to screen.
-
- - -
-
- -
-
- - -
-
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_as_gen/ophyd.commands.log_pos.html b/ophyd/_as_gen/ophyd.commands.log_pos.html deleted file mode 100644 index 9803b845d1..0000000000 --- a/ophyd/_as_gen/ophyd.commands.log_pos.html +++ /dev/null @@ -1,292 +0,0 @@ - - - - - - - - - - - ophyd.commands.log_pos — ophyd documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
-
- - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

ophyd.commands.log_pos

-
-
-ophyd.commands.log_pos(positioners=None, extra_msg=None)
-

Get the current position of Positioners and make a logbook entry.

-

Print to the screen the position of the positioners and make a logbook text -entry. This routine also creates session information in the logbook so -positions can be recovered.

- --- - - - - - -
Parameters:

positioners : Positioner, list of Positioners or None

-
Returns:

int

-
-

The ID of the logbook entry returned by the logbook.log method.

-
-
-
- -
- - -
-
- -
-
- - -
-
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_as_gen/ophyd.commands.log_pos_diff.html b/ophyd/_as_gen/ophyd.commands.log_pos_diff.html deleted file mode 100644 index edbb6a7e8e..0000000000 --- a/ophyd/_as_gen/ophyd.commands.log_pos_diff.html +++ /dev/null @@ -1,293 +0,0 @@ - - - - - - - - - - - ophyd.commands.log_pos_diff — ophyd documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
-
- - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

ophyd.commands.log_pos_diff

-
-
-ophyd.commands.log_pos_diff(id=None, positioners=None, **kwargs)
-

Move to positions located in logboook

-

This function compares positions recorded in the experimental logbook -using the log_pos() function.

- --- - - - -
Parameters:

id : integer

-
-

ID of logbook entry to search for and move positions to.

-
-

positioners : list

-
-

List of string names of positioners to compare. Other positioners -in the log entry will be ignored.

-
-
-
- -
- - -
-
- -
-
- - -
-
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_as_gen/ophyd.commands.log_pos_mov.html b/ophyd/_as_gen/ophyd.commands.log_pos_mov.html deleted file mode 100644 index 039b494182..0000000000 --- a/ophyd/_as_gen/ophyd.commands.log_pos_mov.html +++ /dev/null @@ -1,297 +0,0 @@ - - - - - - - - - - - ophyd.commands.log_pos_mov — ophyd documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
-
- - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

ophyd.commands.log_pos_mov

-
-
-ophyd.commands.log_pos_mov(id=None, dry_run=False, positioners=None, **kwargs)
-

Move to positions located in logboook

-

This function moves to positions recorded in the experimental logbook using -the log_pos() function.

- --- - - - -
Parameters:

id : integer, optional

-
-

ID of logbook entry to search for and move positions to.

-
-

dry_run : bool, optional

-
-

If True, do not move motors, but execute a dry_run

-
-

positioners : list, optional

-
-

List of string names of positioners to compare and move. Other -positioners in the log entry will be ignored.

-
-
-
- -
- - -
-
- -
-
- - -
-
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_as_gen/ophyd.commands.wh_pos.html b/ophyd/_as_gen/ophyd.commands.wh_pos.html deleted file mode 100644 index 7c7a9065b6..0000000000 --- a/ophyd/_as_gen/ophyd.commands.wh_pos.html +++ /dev/null @@ -1,299 +0,0 @@ - - - - - - - - - - - ophyd.commands.wh_pos — ophyd documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
-
- - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

ophyd.commands.wh_pos

-
-
-ophyd.commands.wh_pos(positioners=None)
-

Get the current position of Positioners and print to screen.

-

Print to the screen the position of the positioners in a formated table.

- --- - - - -
Parameters:positioners : Positioner, list of Positioners or None
-
-

See also

-
-
log_pos
-
Log positioner values to logbook
-
-
-

Examples

-

List all positioners:

-
>>>wh_pos()
-
-
-

List positioners m1, m2 and m3:

-
>>>wh_pos([m1, m2, m3])
-
-
-
- -
- - -
-
- -
-
- - -
-
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_as_gen/ophyd.device.BlueskyInterface.describe.html b/ophyd/_as_gen/ophyd.device.BlueskyInterface.describe.html deleted file mode 100644 index a653a1c6ea..0000000000 --- a/ophyd/_as_gen/ophyd.device.BlueskyInterface.describe.html +++ /dev/null @@ -1,304 +0,0 @@ - - - - - - - - - - - ophyd.device.BlueskyInterface.describe — ophyd documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
-
- - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

ophyd.device.BlueskyInterface.describe

-
-
-BlueskyInterface.describe() → ophyd.device.OrderedDictType[str, typing.Dict[str, typing.Any]]
-

Provide schema and meta-data for read()

-

This keys in the OrderedDict this method returns must match the -keys in the OrderedDict return by read().

-

This provides schema related information, (ex shape, dtype), the -source (ex PV name), and if available, units, limits, precision etc.

- --- - - - -
Returns:

data_keys : OrderedDict

-
-

The keys must be strings and the values must be dict-like -with the event_model.event_descriptor.data_key schema.

-
-
-
- -
- - -
-
- -
-
- - -
-
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_as_gen/ophyd.device.BlueskyInterface.pause.html b/ophyd/_as_gen/ophyd.device.BlueskyInterface.pause.html deleted file mode 100644 index e3b5f2415f..0000000000 --- a/ophyd/_as_gen/ophyd.device.BlueskyInterface.pause.html +++ /dev/null @@ -1,302 +0,0 @@ - - - - - - - - - - - ophyd.device.BlueskyInterface.pause — ophyd documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
-
- - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

ophyd.device.BlueskyInterface.pause

-
-
-BlueskyInterface.pause() → None
-

Attempt to ‘pause’ the device.

-

This is called when ever the -RunEngine is interrupted.

-

A device may have internal state that means plans can not -safely be re-wound. This method may: put the device in a -‘paused’ state and/or raise -NoReplayAllowed to indicate that -the plan can not be rewound.

- --- - - - -
Raises:bluesky.run_engine.NoReplayAllowed
-
- -
- - -
-
- -
-
- - -
-
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_as_gen/ophyd.device.BlueskyInterface.read.html b/ophyd/_as_gen/ophyd.device.BlueskyInterface.read.html deleted file mode 100644 index efe33aad65..0000000000 --- a/ophyd/_as_gen/ophyd.device.BlueskyInterface.read.html +++ /dev/null @@ -1,311 +0,0 @@ - - - - - - - - - - - ophyd.device.BlueskyInterface.read — ophyd documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
-
- - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

ophyd.device.BlueskyInterface.read

-
-
-BlueskyInterface.read() → ophyd.device.OrderedDictType[str, typing.Dict[str, typing.Any]]
-

Read data from the device

-

This method is expected to be as instantaneous as possible, -with any substantial acquisition time taken care of in -trigger().

-

The OrderedDict returned by this method must have identical -keys (in the same order) as the OrderedDict returned by -describe().

-

By convention, the first key in the return is the ‘primary’ key -and maybe used by heuristics in bluesky.

-

The values in the ordered dictionary must be dict (-likes) with the -keys {'value', 'timestamp'}. The 'value' may have any type, -the timestamp must be a float UNIX epoch timestamp in UTC.

- --- - - - -
Returns:

data : OrderedDict

-
-

The keys must be strings and the values must be dict-like -with the keys {'value', 'timestamp'}

-
-
-
- -
- - -
-
- -
-
- - -
-
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_as_gen/ophyd.device.BlueskyInterface.resume.html b/ophyd/_as_gen/ophyd.device.BlueskyInterface.resume.html deleted file mode 100644 index 68f4d6ca8a..0000000000 --- a/ophyd/_as_gen/ophyd.device.BlueskyInterface.resume.html +++ /dev/null @@ -1,290 +0,0 @@ - - - - - - - - - - - ophyd.device.BlueskyInterface.resume — ophyd documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
-
- - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

ophyd.device.BlueskyInterface.resume

-
-
-BlueskyInterface.resume() → None
-

Resume a device from a ‘paused’ state

-

This is called by the bluesky.run_engine.RunEngine -when it resumes from an interruption and is responsible for -ensuring that the device is ready to take data again.

-
- -
- - -
-
- -
-
- - -
-
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_as_gen/ophyd.device.BlueskyInterface.stage.html b/ophyd/_as_gen/ophyd.device.BlueskyInterface.stage.html deleted file mode 100644 index 07517b7c37..0000000000 --- a/ophyd/_as_gen/ophyd.device.BlueskyInterface.stage.html +++ /dev/null @@ -1,313 +0,0 @@ - - - - - - - - - - - ophyd.device.BlueskyInterface.stage — ophyd documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
-
- - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

ophyd.device.BlueskyInterface.stage

-
-
-BlueskyInterface.stage() → typing.List[object]
-

Stage the device for data collection.

-

This method is expected to put the device into a state where -repeated calls to trigger() and -read() will ‘do the right thing’.

-

Staging not idempotent and should raise -RedundantStaging if staged twice without an -intermediate unstage().

-

This method should be as fast as is feasible as it does not return -a status object.

-

The return value of this is a list of all of the (sub) devices -stage, including it’s self. This is used to ensure devices -are not staged twice by the RunEngine.

-

This is an optional method, if the device does not need -staging behavior it should not implement stage (or -unstage).

- --- - - - -
Returns:

devices : list

-
-

list including self and all child devices staged

-
-
-
- -
- - -
-
- -
-
- - -
-
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_as_gen/ophyd.device.BlueskyInterface.trigger.html b/ophyd/_as_gen/ophyd.device.BlueskyInterface.trigger.html deleted file mode 100644 index 7d3969a4e9..0000000000 --- a/ophyd/_as_gen/ophyd.device.BlueskyInterface.trigger.html +++ /dev/null @@ -1,311 +0,0 @@ - - - - - - - - - - - ophyd.device.BlueskyInterface.trigger — ophyd documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
-
- - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

ophyd.device.BlueskyInterface.trigger

-
-
-BlueskyInterface.trigger() → ophyd.status.StatusBase
-

Trigger the device and return status object

-

This method is responsible for implementing ‘trigger’ or -‘acquire’ functionality of this device.

-

If there is an appreciable time between triggering the device -and it being able to be read (via the -read() method) then this method is -also responsible for arranging that the -StatusBase object returned my this method -is notified when the device is ready to be read.

-

If there is no delay between triggering and being readable, -then this method must return a SatusBase -object which is already completed.

- --- - - - -
Returns:

status : StatusBase

-
-

StatusBase object which will be marked -as complete when the device is ready to be read.

-
-
-
- -
- - -
-
- -
-
- - -
-
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_as_gen/ophyd.device.BlueskyInterface.unstage.html b/ophyd/_as_gen/ophyd.device.BlueskyInterface.unstage.html deleted file mode 100644 index 26886717b0..0000000000 --- a/ophyd/_as_gen/ophyd.device.BlueskyInterface.unstage.html +++ /dev/null @@ -1,305 +0,0 @@ - - - - - - - - - - - ophyd.device.BlueskyInterface.unstage — ophyd documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
-
- - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

ophyd.device.BlueskyInterface.unstage

-
-
-BlueskyInterface.unstage() → typing.List[object]
-

Unstage the device.

-

This method returns the device to the state it was prior to the -last stage call.

-

This method should be as fast as feasible as it does not -return a status object.

-

This method must be idempotent, multiple calls (without a new -call to ‘stage’) have no effect.

- --- - - - -
Returns:

devices : list

-
-

list including self and all child devices unstaged

-
-
-
- -
- - -
-
- -
-
- - -
-
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_as_gen/ophyd.device.Component.html b/ophyd/_as_gen/ophyd.device.Component.html deleted file mode 100644 index 30ad764522..0000000000 --- a/ophyd/_as_gen/ophyd.device.Component.html +++ /dev/null @@ -1,358 +0,0 @@ - - - - - - - - - - - ophyd.device.Component — ophyd documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
-
- - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

ophyd.device.Component

-
-
-class ophyd.device.Component(cls, suffix=None, *, lazy=False, trigger_value=None, add_prefix=None, doc=None, **kwargs)
-

A descriptor representing a device component (or signal)

-

Unrecognized keyword arguments will be passed directly to the component -class initializer.

- --- - - - -
Parameters:

cls : class

-
-

Class of signal to create. The required signature of -cls.__init__ is (if suffix is given):

-
def __init__(self, pv_name, parent=None, **kwargs):
-
-
-

or (if suffix is None)

-
def __init__(self, parent=None, **kwargs):
-
-
-

The class may have a wait_for_connection() which is called -during the component instance creation.

-
-

suffix : str, optional

-
-

The PV suffix, which gets appended onto parent.prefix to -generate the final PV that the instance component will bind to. -Also see add_prefix

-
-

lazy : bool, optional

-
-

Lazily instantiate the signal. If False, the signal will be -instantiated upon component instantiation

-
-

trigger_value : any, optional

-
-

Mark as a signal to be set on trigger. The value is sent to the signal -at trigger time.

-
-

add_prefix : sequence, optional

-
-

Keys in the kwargs to prefix with the Device PV prefix during -creation of the component instance. -Defaults to ('suffix', 'write_pv', )

-
-

doc : str, optional

-
-

string to attach to component DvcClass.component.__doc__

-
-
-
-
-__init__(cls, suffix=None, *, lazy=False, trigger_value=None, add_prefix=None, doc=None, **kwargs)
-
- -

Methods

- ---- - - - - - - - - - - - - - - -
__init__(cls[, suffix, lazy, trigger_value, …])
create_component(instance)Create a component for the instance
make_docstring(parent_class)
maybe_add_prefix(instance, kw, suffix)Add prefix to a suffix if kw is in self.add_prefix
-
- -
- - -
-
- -
-
- - -
-
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_as_gen/ophyd.device.ComponentMeta.__new__.html b/ophyd/_as_gen/ophyd.device.ComponentMeta.__new__.html deleted file mode 100644 index 4017283c73..0000000000 --- a/ophyd/_as_gen/ophyd.device.ComponentMeta.__new__.html +++ /dev/null @@ -1,281 +0,0 @@ - - - - - - - - - - - ophyd.device.ComponentMeta.__new__ — ophyd documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
-
- - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

ophyd.device.ComponentMeta.__new__

-
-
-static ComponentMeta.__new__(name, bases, clsdict)
-
- -
- - -
-
- -
-
- - -
-
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_as_gen/ophyd.device.ComponentMeta.__prepare__.html b/ophyd/_as_gen/ophyd.device.ComponentMeta.__prepare__.html deleted file mode 100644 index 50c4ca639f..0000000000 --- a/ophyd/_as_gen/ophyd.device.ComponentMeta.__prepare__.html +++ /dev/null @@ -1,283 +0,0 @@ - - - - - - - - - - - ophyd.device.ComponentMeta.__prepare__ — ophyd documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
-
- - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

ophyd.device.ComponentMeta.__prepare__

-
-
-classmethod ComponentMeta.__prepare__(name, bases)
-

Prepare allows the class attribute dictionary to be ordered as -defined by the user

-
- -
- - -
-
- -
-
- - -
-
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_as_gen/ophyd.device.ComponentMeta.html b/ophyd/_as_gen/ophyd.device.ComponentMeta.html deleted file mode 100644 index 7144991cd1..0000000000 --- a/ophyd/_as_gen/ophyd.device.ComponentMeta.html +++ /dev/null @@ -1,300 +0,0 @@ - - - - - - - - - - - ophyd.device.ComponentMeta — ophyd documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
-
- - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

ophyd.device.ComponentMeta

-
-
-class ophyd.device.ComponentMeta
-

Creates attributes for Components by inspecting class definition

-
-
-__init__($self, /, *args, **kwargs)
-

Initialize self. See help(type(self)) for accurate signature.

-
- -

Methods

- ---- - - - - - -
mro(() -> list)return a type’s method resolution order
-
- -
- - -
-
- -
-
- - -
-
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_as_gen/ophyd.device.Device.configure.html b/ophyd/_as_gen/ophyd.device.Device.configure.html deleted file mode 100644 index 0efce47ee6..0000000000 --- a/ophyd/_as_gen/ophyd.device.Device.configure.html +++ /dev/null @@ -1,300 +0,0 @@ - - - - - - - - - - - ophyd.device.Device.configure — ophyd documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
-
- - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

ophyd.device.Device.configure

-
-
-Device.configure(d: typing.Dict[str, typing.Any]) → typing.Tuple[typing.Dict[str, typing.Any], typing.Dict[str, typing.Any]]
-

Configure the device for something during a run

-

This default implementation allows the user to change any of the -configuration_attrs. Subclasses might override this to perform -additional input validation, cleanup, etc.

- --- - - - - - -
Parameters:

d : dict

-
-

The configuration dictionary. To specify the order that -the changes should be made, use an OrderedDict.

-
-
Returns:

(old, new) tuple of dictionaries

-

Where old and new are pre- and post-configure configuration states.

-
-
- -
- - -
-
- -
-
- - -
-
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_as_gen/ophyd.device.Device.connected.html b/ophyd/_as_gen/ophyd.device.Device.connected.html deleted file mode 100644 index c8d2a26ef4..0000000000 --- a/ophyd/_as_gen/ophyd.device.Device.connected.html +++ /dev/null @@ -1,275 +0,0 @@ - - - - - - - - - - - ophyd.device.Device.connected — ophyd documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
-
- - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

ophyd.device.Device.connected

-
-
-Device.connected
-
- -
- - -
-
- -
-
- - -
-
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_as_gen/ophyd.device.Device.describe_configuration.html b/ophyd/_as_gen/ophyd.device.Device.describe_configuration.html deleted file mode 100644 index c8bfa8041f..0000000000 --- a/ophyd/_as_gen/ophyd.device.Device.describe_configuration.html +++ /dev/null @@ -1,297 +0,0 @@ - - - - - - - - - - - ophyd.device.Device.describe_configuration — ophyd documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
-
- - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

ophyd.device.Device.describe_configuration

-
-
-Device.describe_configuration() → ophyd.device.OrderedDictType[str, typing.Dict[str, typing.Any]]
-

Provide schema & meta-data for read_configuration()

-

This keys in the OrderedDict this method returns must match the -keys in the OrderedDict return by read().

-

This provides schema related information, (ex shape, dtype), the -source (ex PV name), and if available, units, limits, precision etc.

- --- - - - -
Returns:

data_keys : OrderedDict

-
-

The keys must be strings and the values must be dict-like -with the event_model.event_descriptor.data_key schema.

-
-
-
- -
- - -
-
- -
-
- - -
-
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_as_gen/ophyd.device.Device.get.html b/ophyd/_as_gen/ophyd.device.Device.get.html deleted file mode 100644 index cb3fe9753a..0000000000 --- a/ophyd/_as_gen/ophyd.device.Device.get.html +++ /dev/null @@ -1,277 +0,0 @@ - - - - - - - - - - - ophyd.device.Device.get — ophyd documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
-
- - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

ophyd.device.Device.get

-
-
-Device.get(**kwargs)
-

Get the value of all components in the device

-

Keyword arguments are passed onto each signal.get()

-
- -
- - -
-
- -
-
- - -
-
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_as_gen/ophyd.device.Device.get_device_tuple.html b/ophyd/_as_gen/ophyd.device.Device.get_device_tuple.html deleted file mode 100644 index 26af1cbde7..0000000000 --- a/ophyd/_as_gen/ophyd.device.Device.get_device_tuple.html +++ /dev/null @@ -1,278 +0,0 @@ - - - - - - - - - - - ophyd.device.Device.get_device_tuple — ophyd documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
-
- - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

ophyd.device.Device.get_device_tuple

-
-
-classmethod Device.get_device_tuple()
-

The device tuple type associated with an Device class

-

This is a tuple representing the full state of all components and -dynamic device sub-components.

-
- -
- - -
-
- -
-
- - -
-
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_as_gen/ophyd.device.Device.get_instantiated_signals.html b/ophyd/_as_gen/ophyd.device.Device.get_instantiated_signals.html deleted file mode 100644 index 944a3eef94..0000000000 --- a/ophyd/_as_gen/ophyd.device.Device.get_instantiated_signals.html +++ /dev/null @@ -1,291 +0,0 @@ - - - - - - - - - - - ophyd.device.Device.get_instantiated_signals — ophyd documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
-
- - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

ophyd.device.Device.get_instantiated_signals

-
-
-Device.get_instantiated_signals(*, attr_prefix=None)
-

Yields all of the instantiated signals in a device hierarchy

- --- - - - - - -
Parameters:

attr_prefix : string, optional

-
-

The attribute prefix. If None, defaults to self.name

-
-
Yields:

(fully_qualified_attribute_name, signal_instance)

-
-
- -
- - -
-
- -
-
- - -
-
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_as_gen/ophyd.device.Device.html b/ophyd/_as_gen/ophyd.device.Device.html deleted file mode 100644 index 287c8ff5fb..0000000000 --- a/ophyd/_as_gen/ophyd.device.Device.html +++ /dev/null @@ -1,383 +0,0 @@ - - - - - - - - - - - ophyd.device.Device — ophyd documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
-
- - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

ophyd.device.Device

-
-
-class ophyd.device.Device(prefix='', *, name, read_attrs=None, configuration_attrs=None, parent=None, **kwargs)
-

Base class for device objects

-

This class provides attribute access to one or more Signals, which can be -a mixture of read-only and writable. All must share the same base_name.

- --- - - - -
Parameters:

prefix : str, optional

-
-

The PV prefix for all components of the device

-
-

name : str, keyword only

-
-

The name of the device

-
-

read_attrs : sequence of attribute names

-
-

the components to include in a normal reading (i.e., in read())

-
-

configuration_attrs : sequence of attribute names

-
-

the components to be read less often (i.e., in -read_configuration()) and to adjust via configure()

-
-

parent : instance or None

-
-

The instance of the parent device, if applicable

-
-
-
-
-__init__(prefix='', *, name, read_attrs=None, configuration_attrs=None, parent=None, **kwargs)
-
- -

Methods

- ---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
__init__([prefix, read_attrs, …])
check_value(value, **kwargs)Check if the value is valid for this object
clear_sub(cb[, event_type])Remove a subscription, given the original callback function
configure((d: typing.Dict[str, …)Configure the device for something during a run
describe(…)Provide schema and meta-data for read()
describe_configuration(…)Provide schema & meta-data for read_configuration()
get(**kwargs)Get the value of all components in the device
get_device_tuple()The device tuple type associated with an Device class
get_instantiated_signals(*[, attr_prefix])Yields all of the instantiated signals in a device hierarchy
pause(() -> None)Attempt to ‘pause’ the device.
put(dev_t, **kwargs)Put a value to all components of the device
read(() -> ophyd.device.OrderedDictType[str, …)Read data from the device
read_configuration(…)returns dictionary mapping names to (value, timestamp) pairs
resume(() -> None)Resume a device from a ‘paused’ state
stage(() -> typing.List[object])Stage the device for data collection.
stop(*[, success])Stop the Device and all (instantiated) subdevices
subscribe(cb[, event_type, run])Subscribe to events this event_type generates.
summary()
trigger(() -> ophyd.status.StatusBase)Trigger the device and return status object
unstage(() -> typing.List[object])Unstage the device.
unsubscribe(cid)Remove a subscription
wait_for_connection([all_signals, timeout])Wait for signals to connect
-
- -
- - -
-
- -
-
- - -
-
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_as_gen/ophyd.device.Device.put.html b/ophyd/_as_gen/ophyd.device.Device.put.html deleted file mode 100644 index d1dae7d9df..0000000000 --- a/ophyd/_as_gen/ophyd.device.Device.put.html +++ /dev/null @@ -1,289 +0,0 @@ - - - - - - - - - - - ophyd.device.Device.put — ophyd documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
-
- - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

ophyd.device.Device.put

-
-
-Device.put(dev_t, **kwargs)
-

Put a value to all components of the device

-

Keyword arguments are passed onto each signal.put()

- --- - - - -
Parameters:

dev_t : DeviceTuple or tuple

-
-

The device tuple with the value(s) to put (see get_device_tuple)

-
-
-
- -
- - -
-
- -
-
- - -
-
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_as_gen/ophyd.device.Device.read_configuration.html b/ophyd/_as_gen/ophyd.device.Device.read_configuration.html deleted file mode 100644 index 467303a9c8..0000000000 --- a/ophyd/_as_gen/ophyd.device.Device.read_configuration.html +++ /dev/null @@ -1,282 +0,0 @@ - - - - - - - - - - - ophyd.device.Device.read_configuration — ophyd documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
-
- - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

ophyd.device.Device.read_configuration

-
-
-Device.read_configuration() → ophyd.device.OrderedDictType[str, typing.Dict[str, typing.Any]]
-

returns dictionary mapping names to (value, timestamp) pairs

-

To control which fields are included, adjust the -configuration_attrs list.

-
- -
- - -
-
- -
-
- - -
-
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_as_gen/ophyd.device.Device.wait_for_connection.html b/ophyd/_as_gen/ophyd.device.Device.wait_for_connection.html deleted file mode 100644 index e949fd3e36..0000000000 --- a/ophyd/_as_gen/ophyd.device.Device.wait_for_connection.html +++ /dev/null @@ -1,292 +0,0 @@ - - - - - - - - - - - ophyd.device.Device.wait_for_connection — ophyd documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
-
- - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

ophyd.device.Device.wait_for_connection

-
-
-Device.wait_for_connection(all_signals=False, timeout=2.0)
-

Wait for signals to connect

- --- - - - -
Parameters:

all_signals : bool, optional

-
-

Wait for all signals to connect (including lazy ones)

-
-

timeout : float or None

-
-

Overall timeout

-
-
-
- -
- - -
-
- -
-
- - -
-
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_as_gen/ophyd.device.DynamicDeviceComponent.html b/ophyd/_as_gen/ophyd.device.DynamicDeviceComponent.html deleted file mode 100644 index 19b321df94..0000000000 --- a/ophyd/_as_gen/ophyd.device.DynamicDeviceComponent.html +++ /dev/null @@ -1,339 +0,0 @@ - - - - - - - - - - - ophyd.device.DynamicDeviceComponent — ophyd documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
-
- - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

ophyd.device.DynamicDeviceComponent

-
-
-class ophyd.device.DynamicDeviceComponent(defn, *, clsname=None, doc=None)
-

An Device component that dynamically creates a OphyDevice

- --- - - - -
Parameters:

defn : OrderedDict

-
-

The definition of all attributes to be created, in the form of:

-
defn['attribute_name'] = (SignalClass, pv_suffix, keyword_arg_dict)
-
-
-

This will create an attribute on the sub-device of type SignalClass, -with a suffix of pv_suffix, which looks something like this:

-
parent.attribute_name = SignalClass(pv_suffix, **keyword_arg_dict)
-
-
-

Keep in mind that this is actually done in the metaclass creation, and -not exactly as written above.

-
-

clsname : str, optional

-
-

The name of the class to be generated -This defaults to {parent_name}{this_attribute_name.capitalize()}

-
-

doc : str, optional

-
-

The docstring to put on the dynamically generated class

-
-
-
-
-__init__(defn, *, clsname=None, doc=None)
-
- -

Methods

- ---- - - - - - - - - - - - - - - -
__init__(defn, *[, clsname, doc])
create_attr(attr_name)
create_component(instance)Create a component for the instance
make_docstring(parent_class)
-
- -
- - -
-
- -
-
- - -
-
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_as_gen/ophyd.device.FormattedComponent.html b/ophyd/_as_gen/ophyd.device.FormattedComponent.html deleted file mode 100644 index cc14098e95..0000000000 --- a/ophyd/_as_gen/ophyd.device.FormattedComponent.html +++ /dev/null @@ -1,331 +0,0 @@ - - - - - - - - - - - ophyd.device.FormattedComponent — ophyd documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
-
- - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

ophyd.device.FormattedComponent

-
-
-class ophyd.device.FormattedComponent(cls, suffix=None, *, lazy=False, trigger_value=None, add_prefix=None, doc=None, **kwargs)
-

A Component which takes a dynamic format string

-

This differs from Component in that the parent prefix is not automatically -added onto the Component suffix. Additionally, str.format() style strings -are accepted, allowing access to Device instance attributes:

-
>>> from ophyd import (Component as C, FormattedComponent as FC)
->>> class MyDevice(Device):
-...     # A normal component, where 'suffix' is added to prefix verbatim
-...     cpt = C(EpicsSignal, 'suffix')
-...     # A formatted component, where 'self' refers to the Device instance
-...     ch = FC(EpicsSignal, '{self.prefix}{self._ch_name}')
-...
-...     def __init__(self, prefix, ch_name=None, **kwargs):
-...         self._ch_name = ch_name
-...         super().__init__(prefix, **kwargs)
-
-
-
>>> dev = MyDevice('prefix:', ch_name='some_channel', name='dev')
->>> print(dev.cpt.pvname)
-prefix:suffix
->>> print(dev.ch.pvname)
-prefix:some_channel
-
-
-

For additional documentation, refer to Component.

-
-
-__init__(cls, suffix=None, *, lazy=False, trigger_value=None, add_prefix=None, doc=None, **kwargs)
-
- -

Methods

- ---- - - - - - - - - - - - - - - -
__init__(cls[, suffix, lazy, trigger_value, …])
create_component(instance)Create a component for the instance
make_docstring(parent_class)
maybe_add_prefix(instance, kw, suffix)
-
- -
- - -
-
- -
-
- - -
-
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_as_gen/ophyd.device.html b/ophyd/_as_gen/ophyd.device.html deleted file mode 100644 index 21a8a74473..0000000000 --- a/ophyd/_as_gen/ophyd.device.html +++ /dev/null @@ -1,325 +0,0 @@ - - - - - - - - - - - ophyd.device — ophyd documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
-
- - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

ophyd.device

-

Classes

- ---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
BlueskyInterface(*args, **kwargs)Classes that inherit from this can safely customize the these methods without breaking mro.
Component(cls[, suffix, lazy, …])A descriptor representing a device component (or signal)
ComponentMetaCreates attributes for Components by inspecting class definition
Device([prefix, read_attrs, …])Base class for device objects
DynamicDeviceComponent(defn, *[, clsname, doc])An Device component that dynamically creates a OphyDevice
FormattedComponent(cls[, suffix, lazy, …])A Component which takes a dynamic format string
GenerateDatumInterfaceClasses that inherit from this can safely customize the generate_datum method without breaking mro.
OrderedDictType(…[, two])
StagedThree-state switch
-
- - -
-
- -
-
- - -
-
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_as_gen/ophyd.epics_motor.html b/ophyd/_as_gen/ophyd.epics_motor.html deleted file mode 100644 index a8df764dd3..0000000000 --- a/ophyd/_as_gen/ophyd.epics_motor.html +++ /dev/null @@ -1,307 +0,0 @@ - - - - - - - - - - - ophyd.epics_motor — ophyd documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
-
- - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

ophyd.epics_motor

-

Classes

- ---- - - - - - - - - - - - -
EpicsMotor(*args, **kwargs)An EPICS motor record, wrapped in a Positioner
HomeEnumAn enumeration.
MotorBundle(*args[, configuration_attrs])Sub-class this to device a bundle of motors
-
- - -
-
- -
-
- - -
-
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_as_gen/ophyd.flyers.FlyerInterface.collect.html b/ophyd/_as_gen/ophyd.flyers.FlyerInterface.collect.html deleted file mode 100644 index 2ae4a3624e..0000000000 --- a/ophyd/_as_gen/ophyd.flyers.FlyerInterface.collect.html +++ /dev/null @@ -1,296 +0,0 @@ - - - - - - - - - - - ophyd.flyers.FlyerInterface.collect — ophyd documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
-
- - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

ophyd.flyers.FlyerInterface.collect

-
-
-FlyerInterface.collect() → typing.Generator[[typing.Dict, NoneType], NoneType]
-

Retrieve data from the flyer as proto-events

-

The events can be from a mixture of event streams, it is -the responsibility of the consumer (ei the RunEngine) to sort -them out.

- --- - - - -
Yields:

event_data : dict

-
-

Must have the keys {‘time’, ‘timestamps’, ‘data’}.

-
-
-
- -
- - -
-
- -
-
- - -
-
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_as_gen/ophyd.flyers.FlyerInterface.complete.html b/ophyd/_as_gen/ophyd.flyers.FlyerInterface.complete.html deleted file mode 100644 index a05d265bc6..0000000000 --- a/ophyd/_as_gen/ophyd.flyers.FlyerInterface.complete.html +++ /dev/null @@ -1,299 +0,0 @@ - - - - - - - - - - - ophyd.flyers.FlyerInterface.complete — ophyd documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
-
- - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

ophyd.flyers.FlyerInterface.complete

-
-
-FlyerInterface.complete() → ophyd.status.StatusBase
-

Wait for flying to be complete.

-

This can either be a question (“are you done yet”) or a -command (“please wrap up”) to accommodate flyers that have a -fixed trajectory (ex. high-speed raster scans) or that are -passive collectors (ex MAIA or a hardware buffer).

-

In either case, the returned status object should indicate when -the device is actually finished flying.

- --- - - - -
Returns:

complete_status : StatusBase

-
-

Indicate when flying has completed

-
-
-
- -
- - -
-
- -
-
- - -
-
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_as_gen/ophyd.flyers.FlyerInterface.describe_collect.html b/ophyd/_as_gen/ophyd.flyers.FlyerInterface.describe_collect.html deleted file mode 100644 index de79bdd7a4..0000000000 --- a/ophyd/_as_gen/ophyd.flyers.FlyerInterface.describe_collect.html +++ /dev/null @@ -1,300 +0,0 @@ - - - - - - - - - - - ophyd.flyers.FlyerInterface.describe_collect — ophyd documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
-
- - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

ophyd.flyers.FlyerInterface.describe_collect

-
-
-FlyerInterface.describe_collect() → typing.Dict[str, typing.Dict]
-

Provide schema & meta-data from collect()

-

This is analogous to describe(), but nested by stream name.

-

This provides schema related information, (ex shape, dtype), the -source (ex PV name), and if available, units, limits, precision etc.

-

The data_keys are mapped to events from collect by matching the -keys.

- --- - - - -
Returns:

data_keys_by_stream : dict

-
-

The keys must be strings and the values must be dict-like -with keys that are str and the inner values are dict-like -with the event_model.event_descriptor.data_key schema.

-
-
-
- -
- - -
-
- -
-
- - -
-
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_as_gen/ophyd.flyers.FlyerInterface.kickoff.html b/ophyd/_as_gen/ophyd.flyers.FlyerInterface.kickoff.html deleted file mode 100644 index 62a2c54d5b..0000000000 --- a/ophyd/_as_gen/ophyd.flyers.FlyerInterface.kickoff.html +++ /dev/null @@ -1,295 +0,0 @@ - - - - - - - - - - - ophyd.flyers.FlyerInterface.kickoff — ophyd documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
-
- - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

ophyd.flyers.FlyerInterface.kickoff

-
-
-FlyerInterface.kickoff() → ophyd.status.StatusBase
-

Start a flyer

-

The status object return is marked as done once flying -has started.

- --- - - - -
Returns:

kickoff_status : StatusBase

-
-

Indicate when flying has started.

-
-
-
- -
- - -
-
- -
-
- - -
-
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_as_gen/ophyd.flyers.html b/ophyd/_as_gen/ophyd.flyers.html deleted file mode 100644 index a60e5cd6c6..0000000000 --- a/ophyd/_as_gen/ophyd.flyers.html +++ /dev/null @@ -1,310 +0,0 @@ - - - - - - - - - - - ophyd.flyers — ophyd documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
-
- - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

ophyd.flyers

-

Classes

- ---- - - - - - - - - - - - - - - -
AreaDetectorTimeseriesCollector(*args[, …])
FlyerInterface(*args, **kwargs)
MonitorFlyerMixin(*args[, monitor_attrs, …])A bluesky-compatible flyer mixin, using monitor_attrs
WaveformCollector(*args[, data_is_time, …])Waveform collector
-
- - -
-
- -
-
- - -
-
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_as_gen/ophyd.html b/ophyd/_as_gen/ophyd.html deleted file mode 100644 index 0af5eee6e2..0000000000 --- a/ophyd/_as_gen/ophyd.html +++ /dev/null @@ -1,289 +0,0 @@ - - - - - - - - - - - ophyd — ophyd documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
-
- - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

ophyd

-
- - -
-
- -
-
- - -
-
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_as_gen/ophyd.mca.html b/ophyd/_as_gen/ophyd.mca.html deleted file mode 100644 index a7a45ee46d..0000000000 --- a/ophyd/_as_gen/ophyd.mca.html +++ /dev/null @@ -1,361 +0,0 @@ - - - - - - - - - - - ophyd.mca — ophyd documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
-
- - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

ophyd.mca

-

Functions

- ---- - - - - - -
add_rois(range_, **kwargs)Add one or more ROIs to an MCA instance
-

Classes

- ---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
EpicsDXP([prefix, read_attrs, …])All high-level DXP parameters for each channel
EpicsDXPBaseSystem([prefix, read_attrs, …])
EpicsDXPLowLevel(*args, **kwargs)
EpicsDXPLowLevelParameter([prefix, …])
EpicsDXPMapping([prefix, read_attrs, …])
EpicsDXPMultiElementSystem([prefix, …])
EpicsMCA(*args, **kwargs)mca records with extras from mca.db
EpicsMCACallback([prefix, read_attrs, …])Callback-related signals for MCA devices
EpicsMCAReadNotify(*args, **kwargs)mca record with extras from mcaReadNotify.db
EpicsMCARecord(*args, **kwargs)SynApps MCA Record interface
Mercury1([prefix, read_attrs, …])DXP Mercury with 1 channel example
MercuryDXP(*args, **kwargs)
ROI(prefix, *[, read_attrs, …])
Saturn([prefix, read_attrs, …])DXP Saturn with 1 channel example
SaturnDXP(*args, **kwargs)
SaturnMCA(*args, **kwargs)
SoftDXPTrigger(*args[, count_signal, …])Simple soft trigger for DXP devices
-
- - -
-
- -
-
- - -
-
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_as_gen/ophyd.mixins.html b/ophyd/_as_gen/ophyd.mixins.html deleted file mode 100644 index 3ee14ae827..0000000000 --- a/ophyd/_as_gen/ophyd.mixins.html +++ /dev/null @@ -1,304 +0,0 @@ - - - - - - - - - - - ophyd.mixins — ophyd documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
-
- - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

ophyd.mixins

-

Classes

- ---- - - - - - - - - -
EpicsSignalPositioner(read_pv, **kwargs)
SignalPositionerMixin(*args, set_func[, …])Mixin to make a Signal a Positioner
-
- - -
-
- -
-
- - -
-
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_as_gen/ophyd.ophydobj.OphydObject._reset_sub.html b/ophyd/_as_gen/ophyd.ophydobj.OphydObject._reset_sub.html deleted file mode 100644 index e2143605dd..0000000000 --- a/ophyd/_as_gen/ophyd.ophydobj.OphydObject._reset_sub.html +++ /dev/null @@ -1,278 +0,0 @@ - - - - - - - - - - - ophyd.ophydobj.OphydObject._reset_sub — ophyd documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
-
- - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

ophyd.ophydobj.OphydObject._reset_sub

-
-
-OphydObject._reset_sub(event_type)
-

Remove all subscriptions in an event type

-
- -
- - -
-
- -
-
- - -
-
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_as_gen/ophyd.ophydobj.OphydObject._run_subs.html b/ophyd/_as_gen/ophyd.ophydobj.OphydObject._run_subs.html deleted file mode 100644 index e6cb1d8825..0000000000 --- a/ophyd/_as_gen/ophyd.ophydobj.OphydObject._run_subs.html +++ /dev/null @@ -1,286 +0,0 @@ - - - - - - - - - - - ophyd.ophydobj.OphydObject._run_subs — ophyd documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
-
- - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

ophyd.ophydobj.OphydObject._run_subs

-
-
-OphydObject._run_subs(*args, sub_type, **kwargs)
-

Run a set of subscription callbacks

-

Only the kwarg sub_type is required, indicating -the type of callback to perform. All other positional arguments -and kwargs are passed directly to the callback function.

-

The host object will be injected into kwargs as ‘obj’ unless that key -already exists.

-

If the timestamp is None, then it will be replaced by the current -time.

-

No exceptions are raised if the callback functions fail.

-
- -
- - -
-
- -
-
- - -
-
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_as_gen/ophyd.ophydobj.OphydObject.clear_sub.html b/ophyd/_as_gen/ophyd.ophydobj.OphydObject.clear_sub.html deleted file mode 100644 index e532499d4a..0000000000 --- a/ophyd/_as_gen/ophyd.ophydobj.OphydObject.clear_sub.html +++ /dev/null @@ -1,296 +0,0 @@ - - - - - - - - - - - ophyd.ophydobj.OphydObject.clear_sub — ophyd documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
-
- - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

ophyd.ophydobj.OphydObject.clear_sub

-
-
-OphydObject.clear_sub(cb, event_type=None)
-

Remove a subscription, given the original callback function

-

See also subscribe(), unsubscribe()

- --- - - - -
Parameters:

cb : callable

-
-

The callback

-
-

event_type : str, optional

-
-

The event to unsubscribe from (if None, removes it from all event -types)

-
-
-
- -
- - -
-
- -
-
- - -
-
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_as_gen/ophyd.ophydobj.OphydObject.connected.html b/ophyd/_as_gen/ophyd.ophydobj.OphydObject.connected.html deleted file mode 100644 index 856f8cf298..0000000000 --- a/ophyd/_as_gen/ophyd.ophydobj.OphydObject.connected.html +++ /dev/null @@ -1,284 +0,0 @@ - - - - - - - - - - - ophyd.ophydobj.OphydObject.connected — ophyd documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
-
- - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

ophyd.ophydobj.OphydObject.connected

-
-
-OphydObject.connected
-

If the device is connected.

-

Subclasses should override this

-
- -
- - -
-
- -
-
- - -
-
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_as_gen/ophyd.ophydobj.OphydObject.event_types.html b/ophyd/_as_gen/ophyd.ophydobj.OphydObject.event_types.html deleted file mode 100644 index 478918c60d..0000000000 --- a/ophyd/_as_gen/ophyd.ophydobj.OphydObject.event_types.html +++ /dev/null @@ -1,278 +0,0 @@ - - - - - - - - - - - ophyd.ophydobj.OphydObject.event_types — ophyd documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
-
- - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

ophyd.ophydobj.OphydObject.event_types

-
-
-OphydObject.event_types
-

Events that can be subscribed to via obj.subscribe

-
- -
- - -
-
- -
-
- - -
-
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_as_gen/ophyd.ophydobj.OphydObject.html b/ophyd/_as_gen/ophyd.ophydobj.OphydObject.html deleted file mode 100644 index b950f19bc6..0000000000 --- a/ophyd/_as_gen/ophyd.ophydobj.OphydObject.html +++ /dev/null @@ -1,344 +0,0 @@ - - - - - - - - - - - ophyd.ophydobj.OphydObject — ophyd documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
-
- - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

ophyd.ophydobj.OphydObject

-
-
-class ophyd.ophydobj.OphydObject(*, name=None, parent=None)
-

The base class for all objects in Ophyd

-

Handles:

-
-
    -
  • Subscription/callback mechanism
  • -
-
- --- - - - -
Parameters:

name : str, optional

-
-

The name of the object.

-
-

parent : parent, optional

-
-

The object’s parent, if it exists in a hierarchy

-
-
-

Attributes

- ---- - - - - - -
namename of the device
-
-
-__init__(*, name=None, parent=None)
-
- -

Methods

- ---- - - - - - - - - - - - - - - - - - -
__init__(*[, name, parent])
check_value(value, **kwargs)Check if the value is valid for this object
clear_sub(cb[, event_type])Remove a subscription, given the original callback function
subscribe(cb[, event_type, run])Subscribe to events this event_type generates.
unsubscribe(cid)Remove a subscription
-
- -
- - -
-
- -
-
- - -
-
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_as_gen/ophyd.ophydobj.OphydObject.name.html b/ophyd/_as_gen/ophyd.ophydobj.OphydObject.name.html deleted file mode 100644 index 7becf59b42..0000000000 --- a/ophyd/_as_gen/ophyd.ophydobj.OphydObject.name.html +++ /dev/null @@ -1,287 +0,0 @@ - - - - - - - - - - - ophyd.ophydobj.OphydObject.name — ophyd documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
-
- - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

ophyd.ophydobj.OphydObject.name

-
-
-OphydObject.name
-

name of the device

-
- -
- - -
-
- -
-
- - -
-
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_as_gen/ophyd.ophydobj.OphydObject.parent.html b/ophyd/_as_gen/ophyd.ophydobj.OphydObject.parent.html deleted file mode 100644 index 00b4521a10..0000000000 --- a/ophyd/_as_gen/ophyd.ophydobj.OphydObject.parent.html +++ /dev/null @@ -1,288 +0,0 @@ - - - - - - - - - - - ophyd.ophydobj.OphydObject.parent — ophyd documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
-
- - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

ophyd.ophydobj.OphydObject.parent

-
-
-OphydObject.parent
-

The parent of the ophyd object.

-

If at the top of its hierarchy, parent will be None

-
- -
- - -
-
- -
-
- - -
-
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_as_gen/ophyd.ophydobj.OphydObject.root.html b/ophyd/_as_gen/ophyd.ophydobj.OphydObject.root.html deleted file mode 100644 index f58aef4bad..0000000000 --- a/ophyd/_as_gen/ophyd.ophydobj.OphydObject.root.html +++ /dev/null @@ -1,287 +0,0 @@ - - - - - - - - - - - ophyd.ophydobj.OphydObject.root — ophyd documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
-
- - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

ophyd.ophydobj.OphydObject.root

-
-
-OphydObject.root
-

Walk parents to find ultimate ancestor (parent’s parent…).

-
- -
- - -
-
- -
-
- - -
-
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_as_gen/ophyd.ophydobj.OphydObject.subscribe.html b/ophyd/_as_gen/ophyd.ophydobj.OphydObject.subscribe.html deleted file mode 100644 index 83e79ce4e4..0000000000 --- a/ophyd/_as_gen/ophyd.ophydobj.OphydObject.subscribe.html +++ /dev/null @@ -1,331 +0,0 @@ - - - - - - - - - - - ophyd.ophydobj.OphydObject.subscribe — ophyd documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
-
- - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

ophyd.ophydobj.OphydObject.subscribe

-
-
-OphydObject.subscribe(cb, event_type=None, run=True)
-

Subscribe to events this event_type generates.

-

The callback will be called as cb(*args, **kwargs) with -the values passed to _run_subs with the following additional keys:

-
-
sub_type : the string value of the event_type -obj : the host object, added if ‘obj’ not already in kwargs
-

if the key ‘timestamp’ is in kwargs _and_ is None, then it will -be replaced with the current time before running the callback.

-

The *args, **kwargs passed to _run_subs will be cached as -shallow copies, be aware of passing in mutable data.

-
-

Warning

-

If the callback raises any exceptions when run they will be -silently ignored.

-
- --- - - - - - -
Parameters:

cb : callable

-
-

A callable function (that takes kwargs) to be run when the event is -generated. The expected signature is

-
def cb(*args, obj: OphydObject, sub_type: str, **kwargs) -> None:
-
-
-

The exact args/kwargs passed are whatever are passed to -_run_subs

-
-

event_type : str, optional

-
-

The name of the event to subscribe to (if None, defaults to -the default sub for the instance - obj._default_sub)

-

This maps to the sub_type kwargs in _run_subs

-
-

run : bool, optional

-
-

Run the callback now

-
-
Returns:

cid : int

-
-

id of callback, can be passed to unsubscribe to remove the -callback

-
-
-
-

See also

-

clear_sub, _run_subs

-
-
- -
- - -
-
- -
-
- - -
-
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_as_gen/ophyd.ophydobj.OphydObject.unsubscribe.html b/ophyd/_as_gen/ophyd.ophydobj.OphydObject.unsubscribe.html deleted file mode 100644 index e51637b21b..0000000000 --- a/ophyd/_as_gen/ophyd.ophydobj.OphydObject.unsubscribe.html +++ /dev/null @@ -1,291 +0,0 @@ - - - - - - - - - - - ophyd.ophydobj.OphydObject.unsubscribe — ophyd documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
-
- - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

ophyd.ophydobj.OphydObject.unsubscribe

-
-
-OphydObject.unsubscribe(cid)
-

Remove a subscription

-

See also subscribe(), clear_sub()

- --- - - - -
Parameters:

cid : int

-
-

token return by subscribe()

-
-
-
- -
- - -
-
- -
-
- - -
-
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_as_gen/ophyd.ophydobj.html b/ophyd/_as_gen/ophyd.ophydobj.html deleted file mode 100644 index ad7aacf58d..0000000000 --- a/ophyd/_as_gen/ophyd.ophydobj.html +++ /dev/null @@ -1,313 +0,0 @@ - - - - - - - - - - - ophyd.ophydobj — ophyd documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
-
- - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

ophyd.ophydobj

-

Classes

- ---- - - - - - -
OphydObject(*[, name, parent])The base class for all objects in Ophyd
-

Exceptions

- ---- - - - - - -
UnknownSubscriptionSubclass of KeyError.
-
- - -
-
- -
-
- - -
-
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_as_gen/ophyd.positioner.PositionerBase.set.html b/ophyd/_as_gen/ophyd.positioner.PositionerBase.set.html deleted file mode 100644 index e3d828b62e..0000000000 --- a/ophyd/_as_gen/ophyd.positioner.PositionerBase.set.html +++ /dev/null @@ -1,319 +0,0 @@ - - - - - - - - - - - ophyd.positioner.PositionerBase.set — ophyd documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
-
- - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

ophyd.positioner.PositionerBase.set

-
-
-PositionerBase.set(new_position: typing.Any, *, timeout: float = None, moved_cb: typing.Callable = None, wait: bool = False) → ophyd.status.StatusBase
-

Set a value and return a Status object

- --- - - - - - -
Parameters:

new_position : object

-
-

The input here is whatever the device requires (this -should be over-ridden by the implementation. For example -a motor would take a float, a shutter the strings {‘Open’, -‘Close’}, and a goineometer (h, k, l) tuples

-
-

timeout : float, optional

-
-

Maximum time to wait for the motion. If None, the default timeout -for this positioner is used.

-
-

moved_cb : callable, optional

-
-

Deprecated

-

Call this callback when movement has finished. This callback -must accept one keyword argument: ‘obj’ which will be set to -this positioner instance.

-
-

wait : bool, optional

-
-

Deprecated

-

If the method should block until the Status object reports -it is done.

-

Defaults to False

-
-
Returns:

status : StatusBase

-
-

Status object to indicate when the motion / set is done.

-
-
-
- -
- - -
-
- -
-
- - -
-
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_as_gen/ophyd.positioner.PositionerBase.stop.html b/ophyd/_as_gen/ophyd.positioner.PositionerBase.stop.html deleted file mode 100644 index d96bc51fb9..0000000000 --- a/ophyd/_as_gen/ophyd.positioner.PositionerBase.stop.html +++ /dev/null @@ -1,293 +0,0 @@ - - - - - - - - - - - ophyd.positioner.PositionerBase.stop — ophyd documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
-
- - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

ophyd.positioner.PositionerBase.stop

-
-
-PositionerBase.stop(*, success: bool = False)
-

Stops motion.

-

Sub-classes must extend this method to _actually_ stop the device.

- --- - - - -
Parameters:

success : bool, optional

-
-

If the move should be considered a success despite the stop.

-

Defaults to False

-
-
-
- -
- - -
-
- -
-
- - -
-
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_as_gen/ophyd.positioner.html b/ophyd/_as_gen/ophyd.positioner.html deleted file mode 100644 index 7affaee3b2..0000000000 --- a/ophyd/_as_gen/ophyd.positioner.html +++ /dev/null @@ -1,304 +0,0 @@ - - - - - - - - - - - ophyd.positioner — ophyd documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
-
- - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

ophyd.positioner

-

Classes

- ---- - - - - - - - - -
PositionerBase(*[, name, parent, …])The positioner base class
SoftPositioner(*[, egu, limits, source, …])A positioner which does not communicate with any hardware
-
- - -
-
- -
-
- - -
-
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_as_gen/ophyd.pseudopos.html b/ophyd/_as_gen/ophyd.pseudopos.html deleted file mode 100644 index 1fd96d3d48..0000000000 --- a/ophyd/_as_gen/ophyd.pseudopos.html +++ /dev/null @@ -1,319 +0,0 @@ - - - - - - - - - - - ophyd.pseudopos — ophyd documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
-
- - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

ophyd.pseudopos

-

Functions

- ---- - - - - - - - - -
pseudo_position_argument(method)
real_position_argument(method)
-

Classes

- ---- - - - - - - - - -
PseudoPositioner([prefix, concurrent, …])A pseudo positioner which can be comprised of multiple positioners
PseudoSingle([prefix, limits, egu, parent, …])A single axis of a PseudoPositioner
-
- - -
-
- -
-
- - -
-
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_as_gen/ophyd.pv_positioner.html b/ophyd/_as_gen/ophyd.pv_positioner.html deleted file mode 100644 index caf94bca3f..0000000000 --- a/ophyd/_as_gen/ophyd.pv_positioner.html +++ /dev/null @@ -1,304 +0,0 @@ - - - - - - - - - - - ophyd.pv_positioner — ophyd documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
-
- - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

ophyd.pv_positioner

-

Classes

- ---- - - - - - - - - -
PVPositioner([prefix, limits, name, …])A Positioner which is controlled using multiple user-defined signals
PVPositionerPC(*args, **kwargs)
-
- - -
-
- -
-
- - -
-
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_as_gen/ophyd.quadem.html b/ophyd/_as_gen/ophyd.quadem.html deleted file mode 100644 index 08ccab26fc..0000000000 --- a/ophyd/_as_gen/ophyd.quadem.html +++ /dev/null @@ -1,310 +0,0 @@ - - - - - - - - - - - ophyd.quadem — ophyd documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
-
- - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

ophyd.quadem

-

Classes

- ---- - - - - - - - - - - - - - - -
APS_EM(*args, **kwargs)
NSLS_EM(*args, **kwargs)
QuadEM(*args, **kwargs)
TetrAMM(*args, **kwargs)
-
- - -
-
- -
-
- - -
-
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_as_gen/ophyd.scaler.html b/ophyd/_as_gen/ophyd.scaler.html deleted file mode 100644 index 8cfa87d0aa..0000000000 --- a/ophyd/_as_gen/ophyd.scaler.html +++ /dev/null @@ -1,307 +0,0 @@ - - - - - - - - - - - ophyd.scaler — ophyd documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
-
- - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

ophyd.scaler

-

Classes

- ---- - - - - - - - - - - - -
EpicsScaler(*args, **kwargs)SynApps Scaler Record interface
ScalerCH(*args, **kwargs)
ScalerChannel(prefix, ch_num, **kwargs)
-
- - -
-
- -
-
- - -
-
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_as_gen/ophyd.signal.html b/ophyd/_as_gen/ophyd.signal.html deleted file mode 100644 index fdf3a447d4..0000000000 --- a/ophyd/_as_gen/ophyd.signal.html +++ /dev/null @@ -1,319 +0,0 @@ - - - - - - - - - - - ophyd.signal — ophyd documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
-
- - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

ophyd.signal

-

Classes

- ---- - - - - - - - - - - - - - - - - - - - - - - - -
ArrayAttributeSignal(attr, *[, name, parent])An AttributeSignal which is cast to an ndarray on get
AttributeSignal(attr, *[, name, parent])Signal derived from a Python object instance’s attribute
DerivedSignal(derived_from, *[, name, parent])A signal which is derived from another one
EpicsSignal(read_pv[, write_pv, pv_kw, …])An EPICS signal, comprised of either one or two EPICS PVs
EpicsSignalBase(read_pv, *[, pv_kw, string, …])A read-only EpicsSignal – that is, one with no write_pv
EpicsSignalRO(read_pv, *[, pv_kw, string, …])A read-only EpicsSignal – that is, one with no write_pv
Signal(*, name[, value, timestamp, parent, …])A signal, which can have a read-write or read-only value.
-
- - -
-
- -
-
- - -
-
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_as_gen/ophyd.status.DeviceStatus.html b/ophyd/_as_gen/ophyd.status.DeviceStatus.html deleted file mode 100644 index 08eba98538..0000000000 --- a/ophyd/_as_gen/ophyd.status.DeviceStatus.html +++ /dev/null @@ -1,321 +0,0 @@ - - - - - - - - - - - ophyd.status.DeviceStatus — ophyd documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
-
- - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

ophyd.status.DeviceStatus

-
-
-class ophyd.status.DeviceStatus(device, **kwargs)
-

Device status

- --- - - - -
Parameters:

device : obj

-

done : bool, optional

-
-

Whether or not the motion has already completed

-
-

success : bool, optional

-
-

If motion has already completed, the status of that motion

-
-

timeout : float, optional

-
-

The default timeout to use for a blocking wait, and the amount of time -to wait to mark the motion as failed

-
-

settle_time : float, optional

-
-

The amount of time to wait between motion completion and running -callbacks

-
-
-
-
-__init__(device, **kwargs)
-
- -

Methods

- ---- - - - - - - - - - - - -
__init__(device, **kwargs)
add_callback(cb)
watch(func)
-
- -
- - -
-
- -
-
- - -
-
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_as_gen/ophyd.status.MoveStatus.html b/ophyd/_as_gen/ophyd.status.MoveStatus.html deleted file mode 100644 index 6125e87ce1..0000000000 --- a/ophyd/_as_gen/ophyd.status.MoveStatus.html +++ /dev/null @@ -1,359 +0,0 @@ - - - - - - - - - - - ophyd.status.MoveStatus — ophyd documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
-
- - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

ophyd.status.MoveStatus

-
-
-class ophyd.status.MoveStatus(positioner, target, *, start_ts=None, **kwargs)
-

Asynchronous movement status

- --- - - - -
Parameters:

positioner : Positioner

-

target : float or array-like

-
-

Target position

-
-

done : bool, optional

-
-

Whether or not the motion has already completed

-
-

success : bool, optional

-
-

If motion has already completed, the status of that motion

-
-

start_ts : float, optional

-
-

The motion start timestamp

-
-

timeout : float, optional

-
-

The default timeout to use for a blocking wait, and the amount of time -to wait to mark the motion as failed

-
-

settle_time : float, optional

-
-

The amount of time to wait between motion completion and running -callbacks

-
-
-

Attributes

- ---- - - - - - - - - - - - - - - - - - - - - - - - -
pos(Positioner)
target(float or array-like) Target position
done(bool) Whether or not the motion has already completed
start_ts(float) The motion start timestamp
finish_ts(float) The motion completd timestamp
finish_pos(float or ndarray) The final position
success(bool) Motion successfully completed
-
-
-__init__(positioner, target, *, start_ts=None, **kwargs)
-
- -

Methods

- ---- - - - - - - - - - - - -
__init__(positioner, target, *[, start_ts])
add_callback(cb)
watch(func)Subscribe to notifications about progress.
-
- -
- - -
-
- -
-
- - -
-
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_as_gen/ophyd.status.Status.html b/ophyd/_as_gen/ophyd.status.Status.html deleted file mode 100644 index cba6e13501..0000000000 --- a/ophyd/_as_gen/ophyd.status.Status.html +++ /dev/null @@ -1,304 +0,0 @@ - - - - - - - - - - - ophyd.status.Status — ophyd documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
-
- - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

ophyd.status.Status

-
-
-class ophyd.status.Status(obj=None, **kwargs)
-

A basic status object

-

Has an optional associated object instance

-

Attributes

- ---- - - - - - -
obj(any or None) The object
-
-
-__init__(obj=None, **kwargs)
-
- -

Methods

- ---- - - - - - - - - -
__init__([obj])
add_callback(cb)
-
- -
- - -
-
- -
-
- - -
-
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_as_gen/ophyd.status.StatusBase._finished.html b/ophyd/_as_gen/ophyd.status.StatusBase._finished.html deleted file mode 100644 index daf6149932..0000000000 --- a/ophyd/_as_gen/ophyd.status.StatusBase._finished.html +++ /dev/null @@ -1,291 +0,0 @@ - - - - - - - - - - - ophyd.status.StatusBase._finished — ophyd documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
-
- - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

ophyd.status.StatusBase._finished

-
-
-StatusBase._finished(success=True, **kwargs)
-

Inform the status object that it is done and if it succeeded

-
-

Warning

-

kwargs are not used, but are accepted because pyepics gives -in a bunch of kwargs that we don’t care about. This allows -the status object to be handed directly to pyepics (but -this is probably a bad idea for other reason.

-

This may be deprecated in the future.

-
- --- - - - -
Parameters:

success : bool, optional

-
-

if the action succeeded.

-
-
-
- -
- - -
-
- -
-
- - -
-
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_as_gen/ophyd.status.StatusBase.finished_cb.html b/ophyd/_as_gen/ophyd.status.StatusBase.finished_cb.html deleted file mode 100644 index 0ecf8b06c8..0000000000 --- a/ophyd/_as_gen/ophyd.status.StatusBase.finished_cb.html +++ /dev/null @@ -1,270 +0,0 @@ - - - - - - - - - - - ophyd.status.StatusBase.finished_cb — ophyd documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
-
- - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

ophyd.status.StatusBase.finished_cb

-
-
-StatusBase.finished_cb
-
- -
- - -
-
- -
-
- - -
-
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_as_gen/ophyd.status.StatusBase.html b/ophyd/_as_gen/ophyd.status.StatusBase.html deleted file mode 100644 index e8d3cc0c53..0000000000 --- a/ophyd/_as_gen/ophyd.status.StatusBase.html +++ /dev/null @@ -1,310 +0,0 @@ - - - - - - - - - - - ophyd.status.StatusBase — ophyd documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
-
- - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

ophyd.status.StatusBase

-
-
-class ophyd.status.StatusBase(*, timeout=None, settle_time=None, done=False, success=False)
-

This is a base class that provides a single-slot callback for when the -specific operation has finished.

- --- - - - -
Parameters:

timeout : float, optional

-
-

The default timeout to use for a blocking wait, and the amount of time -to wait to mark the operation as failed

-
-

settle_time : float, optional

-
-

The amount of time to wait between the caller specifying that the -status has completed to running callbacks

-
-
-
-
-__init__(*, timeout=None, settle_time=None, done=False, success=False)
-
- -

Methods

- ---- - - - - - - - - -
__init__(*[, timeout, settle_time, done, …])
add_callback(cb)
-
- -
- - -
-
- -
-
- - -
-
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_as_gen/ophyd.status.html b/ophyd/_as_gen/ophyd.status.html deleted file mode 100644 index ec2578c19a..0000000000 --- a/ophyd/_as_gen/ophyd.status.html +++ /dev/null @@ -1,340 +0,0 @@ - - - - - - - - - - - ophyd.status — ophyd documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
-
- - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

ophyd.status

-

Functions

- ---- - - - - - -
wait(status[, timeout, poll_rate])(Blocking) wait for the status object to complete
-

Classes

- ---- - - - - - - - - - - - - - - - - - - - - -
AndStatus(left, right, **kwargs)a Status that has composes two other Status objects using logical and
DeviceStatus(device, **kwargs)Device status
MoveStatus(positioner, target, *[, start_ts])Asynchronous movement status
Status([obj])A basic status object
StatusBase(*[, timeout, settle_time, done, …])This is a base class that provides a single-slot callback for when the specific operation has finished.
SubscriptionStatus(device, callback[, …])Status updated via ophyd events
-

Exceptions

- ---- - - - - - -
UseNewProperty
-
- - -
-
- -
-
- - -
-
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_as_gen/ophyd.utils.epics_pvs.html b/ophyd/_as_gen/ophyd.utils.epics_pvs.html deleted file mode 100644 index 86337d2307..0000000000 --- a/ophyd/_as_gen/ophyd.utils.epics_pvs.html +++ /dev/null @@ -1,358 +0,0 @@ - - - - - - - - - - - ophyd.utils.epics_pvs — ophyd documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
-
- - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

ophyd.utils.epics_pvs

-

Functions

- ---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
data_shape(val)Determine data-shape (dimensions)
data_type(val)Determine data-type of val.
fmt_time([tstamp])simple formatter for time values
raise_if_disconnected(fcn)Decorator to catch attempted access to disconnected EPICS channels.
record_field(record, field)Given a record and a field, combine them into
records_from_db(fn)Naively parse db/template files looking for record names
set_and_wait(signal, val[, poll_time, …])Set a signal to a value and wait until it reads correctly.
split_record_field(pv)Splits a pv into (record, field)
strip_field(pv)Strip off the field from a record
validate_pv_name(pv)Validates that there is not more than 1 ‘.’ in pv
waveform_to_string(value[, type_, delim])Convert a waveform that represents a string into an actual Python string
-

Classes

- ---- - - - - - - - - -
AlarmSeverityAn enumeration.
AlarmStatusAn enumeration.
-

Exceptions

- ---- - - - - - -
BadPVName
-
- - -
-
- -
-
- - -
-
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_as_gen/ophyd.utils.errors.html b/ophyd/_as_gen/ophyd.utils.errors.html deleted file mode 100644 index 3e6a451a65..0000000000 --- a/ophyd/_as_gen/ophyd.utils.errors.html +++ /dev/null @@ -1,316 +0,0 @@ - - - - - - - - - - - ophyd.utils.errors — ophyd documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
-
- - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

ophyd.utils.errors

-

Exceptions

- ---- - - - - - - - - - - - - - - - - - - - - -
DisconnectedErrorSignal or SignalGroup is not connected to EPICS
ExceptionBundle(msg, exceptions)One or more exceptions was raised during a loop of try/except blocks
LimitErrorValue is outside of defined limits
OpExceptionOphyd base exception class
ReadOnlyErrorSignal is read-only
RedundantStaging
-
- - -
-
- -
-
- - -
-
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_as_gen/ophyd.utils.html b/ophyd/_as_gen/ophyd.utils.html deleted file mode 100644 index 0acb0ddf68..0000000000 --- a/ophyd/_as_gen/ophyd.utils.html +++ /dev/null @@ -1,316 +0,0 @@ - - - - - - - - - - - ophyd.utils — ophyd documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
-
- - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

ophyd.utils

-

Functions

- ---- - - - - - - - - -
doc_annotation_forwarder(base_klass)
enum(**enums)Create an enum from the keyword arguments
-

Classes

- ---- - - - - - -
OrderedDefaultDict([default_factory])a combination of defaultdict and OrderedDict
-
- - -
-
- -
-
- - -
-
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_as_gen/ophyd.utils.paths.html b/ophyd/_as_gen/ophyd.utils.paths.html deleted file mode 100644 index 77742424f9..0000000000 --- a/ophyd/_as_gen/ophyd.utils.paths.html +++ /dev/null @@ -1,304 +0,0 @@ - - - - - - - - - - - ophyd.utils.paths — ophyd documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
-
- - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

ophyd.utils.paths

-

Functions

- ---- - - - - - - - - -
make_dir_tree(year, *[, base_path, mode])Make full directory tree for the year
makedirs(path, *[, mode, mode_base])Recursively make directories and set permissions
-
- - -
-
- -
-
- - -
-
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_as_gen/ophyd.utils.startup.html b/ophyd/_as_gen/ophyd.utils.startup.html deleted file mode 100644 index a9d9b61fab..0000000000 --- a/ophyd/_as_gen/ophyd.utils.startup.html +++ /dev/null @@ -1,298 +0,0 @@ - - - - - - - - - - - ophyd.utils.startup — ophyd documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
-
- - - - - - - - - - - - - - - - -
- - - - -
-
-
-
- -
-

ophyd.utils.startup

-

Functions

- ---- - - - - - -
setup()
-
- - -
-
- -
-
- - -
-
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_images/inheritance-125299db027430716e817e0d5c4c9da91b99fca3.png b/ophyd/_images/inheritance-125299db027430716e817e0d5c4c9da91b99fca3.png deleted file mode 100644 index b606ce7e7e..0000000000 Binary files a/ophyd/_images/inheritance-125299db027430716e817e0d5c4c9da91b99fca3.png and /dev/null differ diff --git a/ophyd/_images/inheritance-125299db027430716e817e0d5c4c9da91b99fca3.png.map b/ophyd/_images/inheritance-125299db027430716e817e0d5c4c9da91b99fca3.png.map deleted file mode 100644 index 6b02880fc0..0000000000 --- a/ophyd/_images/inheritance-125299db027430716e817e0d5c4c9da91b99fca3.png.map +++ /dev/null @@ -1,12 +0,0 @@ - - - - - - - - - - - - diff --git a/ophyd/_images/inheritance-15bc9368c2f46f77d1599b9d515a6682240bfc8b.png b/ophyd/_images/inheritance-15bc9368c2f46f77d1599b9d515a6682240bfc8b.png deleted file mode 100644 index 3be776eb70..0000000000 Binary files a/ophyd/_images/inheritance-15bc9368c2f46f77d1599b9d515a6682240bfc8b.png and /dev/null differ diff --git a/ophyd/_images/inheritance-15bc9368c2f46f77d1599b9d515a6682240bfc8b.png.map b/ophyd/_images/inheritance-15bc9368c2f46f77d1599b9d515a6682240bfc8b.png.map deleted file mode 100644 index 4dbf38e68c..0000000000 --- a/ophyd/_images/inheritance-15bc9368c2f46f77d1599b9d515a6682240bfc8b.png.map +++ /dev/null @@ -1,7 +0,0 @@ - - - - - - - diff --git a/ophyd/_images/inheritance-3976a6e7436ad02c49d005e595a1a6cf07b83c70.png b/ophyd/_images/inheritance-3976a6e7436ad02c49d005e595a1a6cf07b83c70.png deleted file mode 100644 index c36642ca1b..0000000000 Binary files a/ophyd/_images/inheritance-3976a6e7436ad02c49d005e595a1a6cf07b83c70.png and /dev/null differ diff --git a/ophyd/_images/inheritance-3976a6e7436ad02c49d005e595a1a6cf07b83c70.png.map b/ophyd/_images/inheritance-3976a6e7436ad02c49d005e595a1a6cf07b83c70.png.map deleted file mode 100644 index 35e3f5cc77..0000000000 --- a/ophyd/_images/inheritance-3976a6e7436ad02c49d005e595a1a6cf07b83c70.png.map +++ /dev/null @@ -1,6 +0,0 @@ - - - - - - diff --git a/ophyd/_images/inheritance-3ead649a59595e814a12c6fc7d6708f6b9d28ff2.png b/ophyd/_images/inheritance-3ead649a59595e814a12c6fc7d6708f6b9d28ff2.png deleted file mode 100644 index 577bc2472c..0000000000 Binary files a/ophyd/_images/inheritance-3ead649a59595e814a12c6fc7d6708f6b9d28ff2.png and /dev/null differ diff --git a/ophyd/_images/inheritance-3ead649a59595e814a12c6fc7d6708f6b9d28ff2.png.map b/ophyd/_images/inheritance-3ead649a59595e814a12c6fc7d6708f6b9d28ff2.png.map deleted file mode 100644 index da4d3a85de..0000000000 --- a/ophyd/_images/inheritance-3ead649a59595e814a12c6fc7d6708f6b9d28ff2.png.map +++ /dev/null @@ -1,27 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/ophyd/_images/inheritance-400599b6065a4805b6977a7d8f4e7a8d1803134e.png b/ophyd/_images/inheritance-400599b6065a4805b6977a7d8f4e7a8d1803134e.png deleted file mode 100644 index 10c28e5b5a..0000000000 Binary files a/ophyd/_images/inheritance-400599b6065a4805b6977a7d8f4e7a8d1803134e.png and /dev/null differ diff --git a/ophyd/_images/inheritance-400599b6065a4805b6977a7d8f4e7a8d1803134e.png.map b/ophyd/_images/inheritance-400599b6065a4805b6977a7d8f4e7a8d1803134e.png.map deleted file mode 100644 index fede425825..0000000000 --- a/ophyd/_images/inheritance-400599b6065a4805b6977a7d8f4e7a8d1803134e.png.map +++ /dev/null @@ -1,25 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/ophyd/_images/inheritance-56ba088399d2c0103e2f5f0b87e1a5c50075c3fd.png b/ophyd/_images/inheritance-56ba088399d2c0103e2f5f0b87e1a5c50075c3fd.png deleted file mode 100644 index 10af27701f..0000000000 Binary files a/ophyd/_images/inheritance-56ba088399d2c0103e2f5f0b87e1a5c50075c3fd.png and /dev/null differ diff --git a/ophyd/_images/inheritance-56ba088399d2c0103e2f5f0b87e1a5c50075c3fd.png.map b/ophyd/_images/inheritance-56ba088399d2c0103e2f5f0b87e1a5c50075c3fd.png.map deleted file mode 100644 index a9ca0a0383..0000000000 --- a/ophyd/_images/inheritance-56ba088399d2c0103e2f5f0b87e1a5c50075c3fd.png.map +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/ophyd/_images/inheritance-5970b9d36cbddbb5c755c5f0bae788be51abe4f9.png b/ophyd/_images/inheritance-5970b9d36cbddbb5c755c5f0bae788be51abe4f9.png deleted file mode 100644 index 20e4bff80f..0000000000 Binary files a/ophyd/_images/inheritance-5970b9d36cbddbb5c755c5f0bae788be51abe4f9.png and /dev/null differ diff --git a/ophyd/_images/inheritance-5970b9d36cbddbb5c755c5f0bae788be51abe4f9.png.map b/ophyd/_images/inheritance-5970b9d36cbddbb5c755c5f0bae788be51abe4f9.png.map deleted file mode 100644 index 50823136b8..0000000000 --- a/ophyd/_images/inheritance-5970b9d36cbddbb5c755c5f0bae788be51abe4f9.png.map +++ /dev/null @@ -1,12 +0,0 @@ - - - - - - - - - - - - diff --git a/ophyd/_images/inheritance-5a622bdec20ce63c25d8c373388d172ce9d499e5.png b/ophyd/_images/inheritance-5a622bdec20ce63c25d8c373388d172ce9d499e5.png deleted file mode 100644 index d050509133..0000000000 Binary files a/ophyd/_images/inheritance-5a622bdec20ce63c25d8c373388d172ce9d499e5.png and /dev/null differ diff --git a/ophyd/_images/inheritance-5a622bdec20ce63c25d8c373388d172ce9d499e5.png.map b/ophyd/_images/inheritance-5a622bdec20ce63c25d8c373388d172ce9d499e5.png.map deleted file mode 100644 index 46bceadbc6..0000000000 --- a/ophyd/_images/inheritance-5a622bdec20ce63c25d8c373388d172ce9d499e5.png.map +++ /dev/null @@ -1,15 +0,0 @@ - - - - - - - - - - - - - - - diff --git a/ophyd/_images/inheritance-6ca39687e659a6c23dacd535938e324e17fe3201.png b/ophyd/_images/inheritance-6ca39687e659a6c23dacd535938e324e17fe3201.png deleted file mode 100644 index d77242913c..0000000000 Binary files a/ophyd/_images/inheritance-6ca39687e659a6c23dacd535938e324e17fe3201.png and /dev/null differ diff --git a/ophyd/_images/inheritance-6ca39687e659a6c23dacd535938e324e17fe3201.png.map b/ophyd/_images/inheritance-6ca39687e659a6c23dacd535938e324e17fe3201.png.map deleted file mode 100644 index 5fc27412dc..0000000000 --- a/ophyd/_images/inheritance-6ca39687e659a6c23dacd535938e324e17fe3201.png.map +++ /dev/null @@ -1,27 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/ophyd/_images/inheritance-702fe028f75ebee8c51545abba1e7b9ce9898e97.png b/ophyd/_images/inheritance-702fe028f75ebee8c51545abba1e7b9ce9898e97.png deleted file mode 100644 index 2aad2756db..0000000000 Binary files a/ophyd/_images/inheritance-702fe028f75ebee8c51545abba1e7b9ce9898e97.png and /dev/null differ diff --git a/ophyd/_images/inheritance-702fe028f75ebee8c51545abba1e7b9ce9898e97.png.map b/ophyd/_images/inheritance-702fe028f75ebee8c51545abba1e7b9ce9898e97.png.map deleted file mode 100644 index e4cfc6e3f7..0000000000 --- a/ophyd/_images/inheritance-702fe028f75ebee8c51545abba1e7b9ce9898e97.png.map +++ /dev/null @@ -1,15 +0,0 @@ - - - - - - - - - - - - - - - diff --git a/ophyd/_images/inheritance-77ecbb618f5cdbc91401d379f808279e6fa77e9a.png b/ophyd/_images/inheritance-77ecbb618f5cdbc91401d379f808279e6fa77e9a.png deleted file mode 100644 index 1833d73493..0000000000 Binary files a/ophyd/_images/inheritance-77ecbb618f5cdbc91401d379f808279e6fa77e9a.png and /dev/null differ diff --git a/ophyd/_images/inheritance-77ecbb618f5cdbc91401d379f808279e6fa77e9a.png.map b/ophyd/_images/inheritance-77ecbb618f5cdbc91401d379f808279e6fa77e9a.png.map deleted file mode 100644 index a188120389..0000000000 --- a/ophyd/_images/inheritance-77ecbb618f5cdbc91401d379f808279e6fa77e9a.png.map +++ /dev/null @@ -1,6 +0,0 @@ - - - - - - diff --git a/ophyd/_images/inheritance-80ef9c26c9bc2afeb9bc1c8baac10eda7e123a0b.png b/ophyd/_images/inheritance-80ef9c26c9bc2afeb9bc1c8baac10eda7e123a0b.png deleted file mode 100644 index bbc03ce747..0000000000 Binary files a/ophyd/_images/inheritance-80ef9c26c9bc2afeb9bc1c8baac10eda7e123a0b.png and /dev/null differ diff --git a/ophyd/_images/inheritance-80ef9c26c9bc2afeb9bc1c8baac10eda7e123a0b.png.map b/ophyd/_images/inheritance-80ef9c26c9bc2afeb9bc1c8baac10eda7e123a0b.png.map deleted file mode 100644 index f06550c541..0000000000 --- a/ophyd/_images/inheritance-80ef9c26c9bc2afeb9bc1c8baac10eda7e123a0b.png.map +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/ophyd/_images/inheritance-88121c6d044eeae967fb3b6509ae40ac1ec963cb.png b/ophyd/_images/inheritance-88121c6d044eeae967fb3b6509ae40ac1ec963cb.png deleted file mode 100644 index ad598c1eb4..0000000000 Binary files a/ophyd/_images/inheritance-88121c6d044eeae967fb3b6509ae40ac1ec963cb.png and /dev/null differ diff --git a/ophyd/_images/inheritance-88121c6d044eeae967fb3b6509ae40ac1ec963cb.png.map b/ophyd/_images/inheritance-88121c6d044eeae967fb3b6509ae40ac1ec963cb.png.map deleted file mode 100644 index 1bd766af68..0000000000 --- a/ophyd/_images/inheritance-88121c6d044eeae967fb3b6509ae40ac1ec963cb.png.map +++ /dev/null @@ -1,6 +0,0 @@ - - - - - - diff --git a/ophyd/_images/inheritance-93ab69f3c211deb5155033d05233120f5a03b15c.png b/ophyd/_images/inheritance-93ab69f3c211deb5155033d05233120f5a03b15c.png deleted file mode 100644 index 8fb4e01523..0000000000 Binary files a/ophyd/_images/inheritance-93ab69f3c211deb5155033d05233120f5a03b15c.png and /dev/null differ diff --git a/ophyd/_images/inheritance-93ab69f3c211deb5155033d05233120f5a03b15c.png.map b/ophyd/_images/inheritance-93ab69f3c211deb5155033d05233120f5a03b15c.png.map deleted file mode 100644 index f1cbe3fb4c..0000000000 --- a/ophyd/_images/inheritance-93ab69f3c211deb5155033d05233120f5a03b15c.png.map +++ /dev/null @@ -1,14 +0,0 @@ - - - - - - - - - - - - - - diff --git a/ophyd/_images/inheritance-9b988caf02abedc54423afddfe2feb0f3b822846.png b/ophyd/_images/inheritance-9b988caf02abedc54423afddfe2feb0f3b822846.png deleted file mode 100644 index 74b8e29fd8..0000000000 Binary files a/ophyd/_images/inheritance-9b988caf02abedc54423afddfe2feb0f3b822846.png and /dev/null differ diff --git a/ophyd/_images/inheritance-9b988caf02abedc54423afddfe2feb0f3b822846.png.map b/ophyd/_images/inheritance-9b988caf02abedc54423afddfe2feb0f3b822846.png.map deleted file mode 100644 index 9328553d92..0000000000 --- a/ophyd/_images/inheritance-9b988caf02abedc54423afddfe2feb0f3b822846.png.map +++ /dev/null @@ -1,29 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/ophyd/_images/inheritance-a80cbab97fb867a5f24b830d763319ad33b63840.png b/ophyd/_images/inheritance-a80cbab97fb867a5f24b830d763319ad33b63840.png deleted file mode 100644 index 4d04cadf6a..0000000000 Binary files a/ophyd/_images/inheritance-a80cbab97fb867a5f24b830d763319ad33b63840.png and /dev/null differ diff --git a/ophyd/_images/inheritance-a80cbab97fb867a5f24b830d763319ad33b63840.png.map b/ophyd/_images/inheritance-a80cbab97fb867a5f24b830d763319ad33b63840.png.map deleted file mode 100644 index 9aac51a7ab..0000000000 --- a/ophyd/_images/inheritance-a80cbab97fb867a5f24b830d763319ad33b63840.png.map +++ /dev/null @@ -1,86 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/ophyd/_images/inheritance-aa46490e2afb6cd7454a429a1a96057e59742cee.png b/ophyd/_images/inheritance-aa46490e2afb6cd7454a429a1a96057e59742cee.png deleted file mode 100644 index ba568315bc..0000000000 Binary files a/ophyd/_images/inheritance-aa46490e2afb6cd7454a429a1a96057e59742cee.png and /dev/null differ diff --git a/ophyd/_images/inheritance-aa46490e2afb6cd7454a429a1a96057e59742cee.png.map b/ophyd/_images/inheritance-aa46490e2afb6cd7454a429a1a96057e59742cee.png.map deleted file mode 100644 index f35a236d2b..0000000000 --- a/ophyd/_images/inheritance-aa46490e2afb6cd7454a429a1a96057e59742cee.png.map +++ /dev/null @@ -1,14 +0,0 @@ - - - - - - - - - - - - - - diff --git a/ophyd/_images/inheritance-bbcaac3b6a2ffeaba54a908d74c83ab374057a3a.png b/ophyd/_images/inheritance-bbcaac3b6a2ffeaba54a908d74c83ab374057a3a.png deleted file mode 100644 index e96a8a91a6..0000000000 Binary files a/ophyd/_images/inheritance-bbcaac3b6a2ffeaba54a908d74c83ab374057a3a.png and /dev/null differ diff --git a/ophyd/_images/inheritance-bbcaac3b6a2ffeaba54a908d74c83ab374057a3a.png.map b/ophyd/_images/inheritance-bbcaac3b6a2ffeaba54a908d74c83ab374057a3a.png.map deleted file mode 100644 index eec6dc951b..0000000000 --- a/ophyd/_images/inheritance-bbcaac3b6a2ffeaba54a908d74c83ab374057a3a.png.map +++ /dev/null @@ -1,15 +0,0 @@ - - - - - - - - - - - - - - - diff --git a/ophyd/_images/inheritance-dfc70fb3ebeec9e78455292b41bf6e388acf5744.png b/ophyd/_images/inheritance-dfc70fb3ebeec9e78455292b41bf6e388acf5744.png deleted file mode 100644 index bf0e664795..0000000000 Binary files a/ophyd/_images/inheritance-dfc70fb3ebeec9e78455292b41bf6e388acf5744.png and /dev/null differ diff --git a/ophyd/_images/inheritance-dfc70fb3ebeec9e78455292b41bf6e388acf5744.png.map b/ophyd/_images/inheritance-dfc70fb3ebeec9e78455292b41bf6e388acf5744.png.map deleted file mode 100644 index 58df49103a..0000000000 --- a/ophyd/_images/inheritance-dfc70fb3ebeec9e78455292b41bf6e388acf5744.png.map +++ /dev/null @@ -1,29 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/ophyd/_images/inheritance-e074d941bae841f54e92991832d2f65c1d96eaa0.png b/ophyd/_images/inheritance-e074d941bae841f54e92991832d2f65c1d96eaa0.png deleted file mode 100644 index 04516c9266..0000000000 Binary files a/ophyd/_images/inheritance-e074d941bae841f54e92991832d2f65c1d96eaa0.png and /dev/null differ diff --git a/ophyd/_images/inheritance-e074d941bae841f54e92991832d2f65c1d96eaa0.png.map b/ophyd/_images/inheritance-e074d941bae841f54e92991832d2f65c1d96eaa0.png.map deleted file mode 100644 index 1352472e81..0000000000 --- a/ophyd/_images/inheritance-e074d941bae841f54e92991832d2f65c1d96eaa0.png.map +++ /dev/null @@ -1,6 +0,0 @@ - - - - - - diff --git a/ophyd/_modules/index.html b/ophyd/_modules/index.html deleted file mode 100644 index 194e9973b9..0000000000 --- a/ophyd/_modules/index.html +++ /dev/null @@ -1,211 +0,0 @@ - - - - - - - - - - - Overview: module code — ophyd documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
-
- - - - - - -
-
    -
  • Docs »
  • - -
  • Overview: module code
  • -
  • - - - -
  • -
-
-
- - - -
-
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_modules/ophyd/areadetector/base.html b/ophyd/_modules/ophyd/areadetector/base.html deleted file mode 100644 index 2574e69ca2..0000000000 --- a/ophyd/_modules/ophyd/areadetector/base.html +++ /dev/null @@ -1,351 +0,0 @@ - - - - - - - - - - - ophyd.areadetector.base — ophyd documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
-
- - - - - - -
- -
-
-
-
- -

Source code for ophyd.areadetector.base

-import textwrap
-import inspect
-import re
-import sys
-from collections import OrderedDict
-
-from ..signal import EpicsSignal
-from . import docs
-from ..device import (Device, Component)
-
-
-class EpicsSignalWithRBV(EpicsSignal):
-    # An EPICS signal that simply uses the areaDetector convention of
-    # 'pvname' being the setpoint and 'pvname_RBV' being the read-back
-
-    def __init__(self, prefix, **kwargs):
-        super().__init__(prefix + '_RBV', write_pv=prefix, **kwargs)
-
-
-class ADComponent(Component):
-    def __init__(self, cls, suffix, **kwargs):
-        super().__init__(cls, suffix, lazy=True, **kwargs)
-
-    def find_docs(self, parent_class):
-        '''Find all the documentation related to this class, all the way up the
-        MRO'''
-
-        classes = inspect.getmro(parent_class)
-        for class_ in classes:
-            try:
-                html_file = class_._html_docs
-            except AttributeError:
-                continue
-
-            for fn in html_file:
-                if fn in docs.docs:
-                    yield docs.docs[fn]
-
-    def make_docstring(self, parent_class):
-        '''Create a docstring for the component, given the parent class'''
-        def make_codeblock(s):
-            '''Make a codeblock that will render nicely in sphinx'''
-            block = ['AreaDetector Component',
-                     '::',
-                     '',
-                     ]
-
-            lines = s.split('\n', 1)
-            header, lines = lines[0], lines[1:]
-
-            block.append(textwrap.indent(textwrap.dedent(header),
-                                         prefix=' ' * 4))
-
-            lines = '\n'.join(lines)
-            block.append(textwrap.indent(textwrap.dedent(lines),
-                                         prefix=' ' * 4))
-            block.append('')
-            return '\n'.join(block)
-
-        suffixes = [self.suffix]
-
-        if self.suffix.endswith('_RBV'):
-            suffixes.append(self.suffix[:-4])
-
-        for doc in self.find_docs(parent_class):
-            for suffix in suffixes:
-                try:
-                    return make_codeblock(doc[suffix])
-                except KeyError:
-                    pass
-
-        return super().make_docstring(parent_class)
-
-
-def ad_group(cls, attr_suffix, **kwargs):
-    '''Definition creation for groups of signals in areadetectors'''
-    defn = OrderedDict()
-    for attr, suffix in attr_suffix:
-        defn[attr] = (cls, suffix, kwargs)
-    return defn
-
-
-class ADBase(Device):
-    '''The AreaDetector base class
-
-    This serves as the base for all detectors and plugins
-    '''
-
-    _html_docs = ['areaDetectorDoc.html']
-
-    def find_signal(self, text, use_re=False, case_sensitive=False,
-                    match_fcn=None, f=sys.stdout):
-        '''Search through the signal docs on this detector for the string text
-
-        Parameters
-        ----------
-        text : str
-            Text to find
-        use_re : bool, optional
-            Use regular expressions
-        case_sensitive : bool, optional
-            Case sensitive search
-        match_fcn : callable, optional
-            Function to call when matches are found Defaults to a function that
-            prints matches to f
-        f : file-like, optional
-            File-like object that the default match function prints to
-            (Defaults to sys.stdout)
-        '''
-        # TODO: Some docstrings change based on the detector type,
-        #       showing different options than are available in
-        #       the base area detector class (for example). As such,
-        #       instead of using the current docstrings, this grabs
-        #       them again.
-
-        def default_match(attr, signal, doc):
-            print('Property: {}'.format(attr), file=f)
-            print('  Signal: {!r}'.format(signal), file=f)
-            print('     Doc: {}'.format(doc), file=f)
-            print(file=f)
-
-        if match_fcn is None:
-            match_fcn = default_match
-
-        if use_re:
-            flags = re.MULTILINE
-            if not case_sensitive:
-                flags |= re.IGNORECASE
-
-            regex = re.compile(text, flags=flags)
-
-        elif not case_sensitive:
-            text = text.lower()
-
-        for attr, cpt in self._sig_attrs.items():
-            doc = cpt.make_docstring(self.__class__)
-
-            match = False
-            if use_re:
-                if regex.search(doc):
-                    match = True
-            else:
-                if not case_sensitive:
-                    if text in doc.lower():
-                        match = True
-                elif text in doc:
-                    match = True
-
-            if match:
-                match_fcn(attr=attr, signal=getattr(self, attr), doc=doc)
-
- -
-
- - -
-
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_modules/ophyd/areadetector/cam.html b/ophyd/_modules/ophyd/areadetector/cam.html deleted file mode 100644 index a3a71b41ac..0000000000 --- a/ophyd/_modules/ophyd/areadetector/cam.html +++ /dev/null @@ -1,843 +0,0 @@ - - - - - - - - - - - ophyd.areadetector.cam — ophyd documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
-
- - - - - - -
- -
-
-
-
- -

Source code for ophyd.areadetector.cam

-import logging
-
-from ..utils import enum
-from .base import (ADBase, ADComponent as C, ad_group,
-                   EpicsSignalWithRBV as SignalWithRBV)
-from ..signal import (EpicsSignalRO, EpicsSignal)
-from ..device import DynamicDeviceComponent as DDC
-
-logger = logging.getLogger(__name__)
-
-
-__all__ = ['CamBase',
-           'AdscDetectorCam',
-           'Andor3DetectorCam',
-           'AndorDetectorCam',
-           'BrukerDetectorCam',
-           'FirewireLinDetectorCam',
-           'FirewireWinDetectorCam',
-           'LightFieldDetectorCam',
-           'Mar345DetectorCam',
-           'MarCCDDetectorCam',
-           'PerkinElmerDetectorCam',
-           'PilatusDetectorCam',
-           'PixiradDetectorCam',
-           'PointGreyDetectorCam',
-           'ProsilicaDetectorCam',
-           'PSLDetectorCam',
-           'PvcamDetectorCam',
-           'RoperDetectorCam',
-           'SimDetectorCam',
-           'URLDetectorCam',
-           ]
-
-
-
[docs]class CamBase(ADBase): - ImageMode = enum(SINGLE=0, MULTIPLE=1, CONTINUOUS=2) - - # Shared among all cams and plugins - array_counter = C(SignalWithRBV, 'ArrayCounter') - array_rate = C(EpicsSignalRO, 'ArrayRate_RBV') - asyn_io = C(EpicsSignal, 'AsynIO') - - nd_attributes_file = C(EpicsSignal, 'NDAttributesFile', string=True) - pool_alloc_buffers = C(EpicsSignalRO, 'PoolAllocBuffers') - pool_free_buffers = C(EpicsSignalRO, 'PoolFreeBuffers') - pool_max_buffers = C(EpicsSignalRO, 'PoolMaxBuffers') - pool_max_mem = C(EpicsSignalRO, 'PoolMaxMem') - pool_used_buffers = C(EpicsSignalRO, 'PoolUsedBuffers') - pool_used_mem = C(EpicsSignalRO, 'PoolUsedMem') - port_name = C(EpicsSignalRO, 'PortName_RBV', string=True) - - # Cam-specific - acquire = C(SignalWithRBV, 'Acquire') - acquire_period = C(SignalWithRBV, 'AcquirePeriod') - acquire_time = C(SignalWithRBV, 'AcquireTime') - - array_callbacks = C(SignalWithRBV, 'ArrayCallbacks') - array_size = DDC(ad_group(EpicsSignalRO, - (('array_size_x', 'ArraySizeX_RBV'), - ('array_size_y', 'ArraySizeY_RBV'), - ('array_size_z', 'ArraySizeZ_RBV'))), - doc='Size of the array in the XYZ dimensions') - - array_size_bytes = C(EpicsSignalRO, 'ArraySize_RBV') - bin_x = C(SignalWithRBV, 'BinX') - bin_y = C(SignalWithRBV, 'BinY') - color_mode = C(SignalWithRBV, 'ColorMode') - data_type = C(SignalWithRBV, 'DataType') - detector_state = C(EpicsSignalRO, 'DetectorState_RBV') - frame_type = C(SignalWithRBV, 'FrameType') - gain = C(SignalWithRBV, 'Gain') - - image_mode = C(SignalWithRBV, 'ImageMode') - manufacturer = C(EpicsSignalRO, 'Manufacturer_RBV') - - max_size = DDC(ad_group(EpicsSignalRO, - (('max_size_x', 'MaxSizeX_RBV'), - ('max_size_y', 'MaxSizeY_RBV'))), - doc='Maximum sensor size in the XY directions') - - min_x = C(SignalWithRBV, 'MinX') - min_y = C(SignalWithRBV, 'MinY') - model = C(EpicsSignalRO, 'Model_RBV') - - num_exposures = C(SignalWithRBV, 'NumExposures') - num_exposures_counter = C(EpicsSignalRO, 'NumExposuresCounter_RBV') - num_images = C(SignalWithRBV, 'NumImages') - num_images_counter = C(EpicsSignalRO, 'NumImagesCounter_RBV') - - read_status = C(EpicsSignal, 'ReadStatus') - reverse = DDC(ad_group(SignalWithRBV, - (('reverse_x', 'ReverseX'), - ('reverse_y', 'ReverseY')) - )) - - shutter_close_delay = C(SignalWithRBV, 'ShutterCloseDelay') - shutter_close_epics = C(EpicsSignal, 'ShutterCloseEPICS') - shutter_control = C(SignalWithRBV, 'ShutterControl') - shutter_control_epics = C(EpicsSignal, 'ShutterControlEPICS') - shutter_fanout = C(EpicsSignal, 'ShutterFanout') - shutter_mode = C(SignalWithRBV, 'ShutterMode') - shutter_open_delay = C(SignalWithRBV, 'ShutterOpenDelay') - shutter_open_epics = C(EpicsSignal, 'ShutterOpenEPICS') - shutter_status_epics = C(EpicsSignalRO, 'ShutterStatusEPICS_RBV') - shutter_status = C(EpicsSignalRO, 'ShutterStatus_RBV') - - size = DDC(ad_group(SignalWithRBV, - (('size_x', 'SizeX'), - ('size_y', 'SizeY')) - )) - - status_message = C(EpicsSignalRO, 'StatusMessage_RBV', string=True) - string_from_server = C(EpicsSignalRO, 'StringFromServer_RBV', string=True) - string_to_server = C(EpicsSignalRO, 'StringToServer_RBV', string=True) - temperature = C(SignalWithRBV, 'Temperature') - temperature_actual = C(EpicsSignal, 'TemperatureActual') - time_remaining = C(EpicsSignalRO, 'TimeRemaining_RBV') - trigger_mode = C(SignalWithRBV, 'TriggerMode')
- - -class AreaDetectorCam(CamBase): - pass - - -
[docs]class SimDetectorCam(CamBase): - _html_docs = ['simDetectorDoc.html'] - gain_rgb = DDC(ad_group(SignalWithRBV, - (('gain_red', 'GainRed'), - ('gain_green', 'GainGreen'), - ('gain_blue', 'GainBlue'))), - doc='Gain rgb components') - gain_xy = DDC(ad_group(SignalWithRBV, - (('gain_x', 'GainX'), - ('gain_y', 'GainY'))), - doc='Gain in XY') - - noise = C(SignalWithRBV, 'Noise') - peak_num = DDC(ad_group(SignalWithRBV, - (('peak_num_x', 'PeakNumX'), - ('peak_num_y', 'PeakNumY'))), - doc='Peak number in XY') - - peak_start = DDC(ad_group(SignalWithRBV, - (('peak_start_x', 'PeakStartX'), - ('peak_start_y', 'PeakStartY'))), - doc='Peak start in XY') - - peak_step = DDC(ad_group(SignalWithRBV, - (('peak_step_x', 'PeakStepX'), - ('peak_step_y', 'PeakStepY'))), - doc='Peak step in XY') - - peak_variation = C(SignalWithRBV, 'PeakVariation') - peak_width = DDC(ad_group(SignalWithRBV, - (('peak_width_x', 'PeakWidthX'), - ('peak_width_y', 'PeakWidthY'))), - doc='Peak width in XY') - - reset = C(SignalWithRBV, 'Reset') - sim_mode = C(SignalWithRBV, 'SimMode')
- - -
[docs]class AdscDetectorCam(CamBase): - _html_docs = ['adscDoc.html'] - adsc_2theta = C(SignalWithRBV, 'ADSC2Theta') - adsc_adc = C(SignalWithRBV, 'ADSCAdc') - adsc_axis = C(SignalWithRBV, 'ADSCAxis') - adsc_beam_x = C(SignalWithRBV, 'ADSCBeamX') - adsc_beam_y = C(SignalWithRBV, 'ADSCBeamY') - adsc_dezingr = C(SignalWithRBV, 'ADSCDezingr') - adsc_distance = C(SignalWithRBV, 'ADSCDistnce') - adsc_im_width = C(SignalWithRBV, 'ADSCImWidth') - adsc_im_xform = C(SignalWithRBV, 'ADSCImXform') - adsc_kappa = C(SignalWithRBV, 'ADSCKappa') - adsc_last_error = C(EpicsSignal, 'ADSCLastError') - adsc_last_image = C(EpicsSignal, 'ADSCLastImage') - adsc_omega = C(SignalWithRBV, 'ADSCOmega') - adsc_phi = C(SignalWithRBV, 'ADSCPhi') - adsc_raw = C(SignalWithRBV, 'ADSCRaw') - adsc_read_conditn = C(EpicsSignal, 'ADSCReadConditn') - adsc_reus_drk = C(SignalWithRBV, 'ADSCReusDrk') - adsc_soft_reset = C(EpicsSignal, 'ADSCSoftReset') - adsc_state = C(EpicsSignal, 'ADSCState') - adsc_status = C(EpicsSignal, 'ADSCStatus') - adsc_stp_ex_retry_count = C(EpicsSignal, 'ADSCStpExRtryCt') - adsc_str_drks = C(SignalWithRBV, 'ADSCStrDrks') - adsc_wavelen = C(SignalWithRBV, 'ADSCWavelen') - - bin_x_changed = C(EpicsSignal, 'BinXChanged') - bin_y_changed = C(EpicsSignal, 'BinYChanged') - ext_trig_ctl = C(EpicsSignal, 'ExSwTrCtl') - ext_trig_ctl_rsp = C(EpicsSignal, 'ExSwTrCtlRsp') - ext_trig_ok_to_exp = C(EpicsSignal, 'ExSwTrOkToExp')
- - -
[docs]class AndorDetectorCam(CamBase): - _html_docs = ['andorDoc.html'] - andor_adc_speed = C(SignalWithRBV, 'AndorADCSpeed') - andor_accumulate_period = C(SignalWithRBV, 'AndorAccumulatePeriod') - andor_cooler = C(SignalWithRBV, 'AndorCooler') - andor_message = C(EpicsSignalRO, 'AndorMessage_RBV') - andor_pre_amp_gain = C(SignalWithRBV, 'AndorPreAmpGain') - andor_shutter_ex_ttl = C(EpicsSignal, 'AndorShutterExTTL') - andor_shutter_mode = C(EpicsSignal, 'AndorShutterMode') - andor_temp_status = C(EpicsSignalRO, 'AndorTempStatus_RBV') - file_format = C(SignalWithRBV, 'FileFormat') - pal_file_path = C(SignalWithRBV, 'PALFilePath')
- - -
[docs]class Andor3DetectorCam(CamBase): - _html_docs = ['andor3Doc.html'] - a3_binning = C(SignalWithRBV, 'A3Binning') - a3_shutter_mode = C(SignalWithRBV, 'A3ShutterMode') - controller_id = C(EpicsSignal, 'ControllerID') - fan_speed = C(SignalWithRBV, 'FanSpeed') - firmware_version = C(EpicsSignal, 'FirmwareVersion') - frame_rate = C(SignalWithRBV, 'FrameRate') - full_aoic_ontrol = C(EpicsSignal, 'FullAOIControl') - noise_filter = C(SignalWithRBV, 'NoiseFilter') - overlap = C(SignalWithRBV, 'Overlap') - pixel_encoding = C(SignalWithRBV, 'PixelEncoding') - pre_amp_gain = C(SignalWithRBV, 'PreAmpGain') - readout_rate = C(SignalWithRBV, 'ReadoutRate') - readout_time = C(EpicsSignal, 'ReadoutTime') - sensor_cooling = C(SignalWithRBV, 'SensorCooling') - serial_number = C(EpicsSignal, 'SerialNumber') - software_trigger = C(EpicsSignal, 'SoftwareTrigger') - software_version = C(EpicsSignal, 'SoftwareVersion') - temp_control = C(SignalWithRBV, 'TempControl') - temp_status = C(EpicsSignalRO, 'TempStatus_RBV') - transfer_rate = C(EpicsSignal, 'TransferRate')
- - -
[docs]class BrukerDetectorCam(CamBase): - _html_docs = ['BrukerDoc.html'] - bis_asyn = C(EpicsSignal, 'BISAsyn') - bis_status = C(EpicsSignal, 'BISStatus') - file_format = C(SignalWithRBV, 'FileFormat') - num_darks = C(SignalWithRBV, 'NumDarks') - read_sfrm_timeout = C(EpicsSignal, 'ReadSFRMTimeout')
- - -
[docs]class FirewireLinDetectorCam(CamBase): - _html_docs = [] - - bandwidth = C(EpicsSignal, 'BANDWIDTH') - fanout_disable = C(EpicsSignal, 'FanoutDis') - framerate_max = C(SignalWithRBV, 'FR') - is_fixed_mode = C(EpicsSignal, 'IsFixedMode') - video_mode = C(EpicsSignal, 'VIDEOMODE')
- - -
[docs]class FirewireWinDetectorCam(CamBase): - _html_docs = ['FirewireWinDoc.html'] - colorcode = C(SignalWithRBV, 'COLORCODE') - current_colorcode = C(EpicsSignal, 'CURRENT_COLORCODE') - current_format = C(EpicsSignal, 'CURRENT_FORMAT') - current_mode = C(EpicsSignal, 'CURRENT_MODE') - current_rate = C(EpicsSignal, 'CURRENT_RATE') - dropped_frames = C(SignalWithRBV, 'DROPPED_FRAMES') - format_ = C(SignalWithRBV, 'FORMAT') - frame_rate = C(SignalWithRBV, 'FR') - mode = C(SignalWithRBV, 'MODE') - readout_time = C(SignalWithRBV, 'READOUT_TIME')
- - -
[docs]class LightFieldDetectorCam(CamBase): - _html_docs = ['LightFieldDoc.html'] - - aux_delay = C(SignalWithRBV, 'LFAuxDelay') - aux_width = C(SignalWithRBV, 'LFAuxWidth') - background_enable = C(SignalWithRBV, 'LFBackgroundEnable') - background_file = C(SignalWithRBV, 'LFBackgroundFile') - background_full_file = C(EpicsSignalRO, 'LFBackgroundFullFile_RBV') - background_path = C(SignalWithRBV, 'LFBackgroundPath') - entrance_width = C(SignalWithRBV, 'LFEntranceWidth') - exit_port = C(SignalWithRBV, 'LFExitPort') - experiment_name = C(SignalWithRBV, 'LFExperimentName') - file_name = C(EpicsSignalRO, 'LFFileName_RBV') - file_path = C(EpicsSignalRO, 'LFFilePath_RBV') - lf_gain = C(SignalWithRBV, 'LFGain') - gating_mode = C(SignalWithRBV, 'LFGatingMode') - grating = C(SignalWithRBV, 'LFGrating') - grating_wavelength = C(SignalWithRBV, 'LFGratingWavelength') - image_mode = C(SignalWithRBV, 'ImageMode') - intensifier_enable = C(SignalWithRBV, 'LFIntensifierEnable') - intensifier_gain = C(SignalWithRBV, 'LFIntensifierGain') - num_accumulations = C(SignalWithRBV, 'NumAccumulations') - ready_to_run = C(EpicsSignal, 'LFReadyToRun') - rep_gate_delay = C(SignalWithRBV, 'LFRepGateDelay') - rep_gate_width = C(SignalWithRBV, 'LFRepGateWidth') - seq_end_gate_delay = C(SignalWithRBV, 'LFSeqEndGateDelay') - seq_end_gate_width = C(SignalWithRBV, 'LFSeqEndGateWidth') - seq_start_gate_delay = C(SignalWithRBV, 'LFSeqStartGateDelay') - seq_start_gate_width = C(SignalWithRBV, 'LFSeqStartGateWidth') - lf_shutter_mode = C(SignalWithRBV, 'LFShutterMode') - sync_master2_delay = C(SignalWithRBV, 'LFSyncMaster2Delay') - sync_master_enable = C(SignalWithRBV, 'LFSyncMasterEnable') - trigger_frequency = C(SignalWithRBV, 'LFTriggerFrequency') - update_experiments = C(EpicsSignal, 'LFUpdateExperiments')
- - -
[docs]class Mar345DetectorCam(CamBase): - _html_docs = ['Mar345Doc.html'] - abort = C(SignalWithRBV, 'Abort') - change_mode = C(SignalWithRBV, 'ChangeMode') - erase = C(SignalWithRBV, 'Erase') - erase_mode = C(SignalWithRBV, 'EraseMode') - file_format = C(SignalWithRBV, 'FileFormat') - num_erase = C(SignalWithRBV, 'NumErase') - num_erased = C(EpicsSignalRO, 'NumErased_RBV') - scan_resolution = C(SignalWithRBV, 'ScanResolution') - scan_size = C(SignalWithRBV, 'ScanSize') - mar_server_asyn = C(EpicsSignal, 'marServerAsyn')
- - -
[docs]class MarCCDDetectorCam(CamBase): - _html_docs = ['MarCCDDoc.html'] - beam_x = C(EpicsSignal, 'BeamX') - beam_y = C(EpicsSignal, 'BeamY') - dataset_comments = C(EpicsSignal, 'DatasetComments') - detector_distance = C(EpicsSignal, 'DetectorDistance') - file_comments = C(EpicsSignal, 'FileComments') - file_format = C(SignalWithRBV, 'FileFormat') - frame_shift = C(SignalWithRBV, 'FrameShift') - mar_acquire_status = C(EpicsSignalRO, 'MarAcquireStatus_RBV') - mar_correct_status = C(EpicsSignalRO, 'MarCorrectStatus_RBV') - mar_dezinger_status = C(EpicsSignalRO, 'MarDezingerStatus_RBV') - mar_readout_status = C(EpicsSignalRO, 'MarReadoutStatus_RBV') - mar_state = C(EpicsSignalRO, 'MarState_RBV') - mar_status = C(EpicsSignalRO, 'MarStatus_RBV') - mar_writing_status = C(EpicsSignalRO, 'MarWritingStatus_RBV') - overlap_mode = C(SignalWithRBV, 'OverlapMode') - read_tiff_timeout = C(EpicsSignal, 'ReadTiffTimeout') - rotation_axis = C(EpicsSignal, 'RotationAxis') - rotation_range = C(EpicsSignal, 'RotationRange') - stability = C(SignalWithRBV, 'Stability') - start_phi = C(EpicsSignal, 'StartPhi') - two_theta = C(EpicsSignal, 'TwoTheta') - wavelength = C(EpicsSignal, 'Wavelength') - mar_server_asyn = C(EpicsSignal, 'marServerAsyn')
- - -
[docs]class PerkinElmerDetectorCam(CamBase): - _html_docs = ['PerkinElmerDoc.html'] - pe_acquire_gain = C(EpicsSignal, 'PEAcquireGain') - pe_acquire_offset = C(EpicsSignal, 'PEAcquireOffset') - pe_corrections_dir = C(EpicsSignal, 'PECorrectionsDir') - pe_current_gain_frame = C(EpicsSignal, 'PECurrentGainFrame') - pe_current_offset_frame = C(EpicsSignal, 'PECurrentOffsetFrame') - pe_dwell_time = C(SignalWithRBV, 'PEDwellTime') - pe_frame_buff_index = C(EpicsSignal, 'PEFrameBuffIndex') - pe_gain = C(SignalWithRBV, 'PEGain') - pe_gain_available = C(EpicsSignal, 'PEGainAvailable') - pe_gain_file = C(EpicsSignal, 'PEGainFile') - pe_image_number = C(EpicsSignal, 'PEImageNumber') - pe_initialize = C(EpicsSignal, 'PEInitialize') - pe_load_gain_file = C(EpicsSignal, 'PELoadGainFile') - pe_load_pixel_correction = C(EpicsSignal, 'PELoadPixelCorrection') - pe_num_frame_buffers = C(SignalWithRBV, 'PENumFrameBuffers') - pe_num_frames_to_skip = C(SignalWithRBV, 'PENumFramesToSkip') - pe_num_gain_frames = C(EpicsSignal, 'PENumGainFrames') - pe_num_offset_frames = C(EpicsSignal, 'PENumOffsetFrames') - pe_offset_available = C(EpicsSignal, 'PEOffsetAvailable') - pe_pixel_correction_available = C(EpicsSignal, - 'PEPixelCorrectionAvailable') - pe_pixel_correction_file = C(EpicsSignal, 'PEPixelCorrectionFile') - pe_save_gain_file = C(EpicsSignal, 'PESaveGainFile') - pe_skip_frames = C(SignalWithRBV, 'PESkipFrames') - pe_sync_time = C(SignalWithRBV, 'PESyncTime') - pe_system_id = C(EpicsSignal, 'PESystemID') - pe_trigger = C(EpicsSignal, 'PETrigger') - pe_use_gain = C(EpicsSignal, 'PEUseGain') - pe_use_offset = C(EpicsSignal, 'PEUseOffset') - pe_use_pixel_correction = C(EpicsSignal, 'PEUsePixelCorrection')
- - -
[docs]class PSLDetectorCam(CamBase): - _html_docs = ['PSLDoc.html'] - file_format = C(SignalWithRBV, 'FileFormat') - tiff_comment = C(SignalWithRBV, 'TIFFComment')
- - -
[docs]class PilatusDetectorCam(CamBase): - _html_docs = ['pilatusDoc.html'] - alpha = C(EpicsSignal, 'Alpha') - angle_incr = C(EpicsSignal, 'AngleIncr') - armed = C(EpicsSignal, 'Armed') - bad_pixel_file = C(EpicsSignal, 'BadPixelFile') - beam_x = C(EpicsSignal, 'BeamX') - beam_y = C(EpicsSignal, 'BeamY') - camserver_asyn = C(EpicsSignal, 'CamserverAsyn') - cbf_template_file = C(EpicsSignal, 'CbfTemplateFile') - chi = C(EpicsSignal, 'Chi') - delay_time = C(SignalWithRBV, 'DelayTime') - det_2theta = C(EpicsSignal, 'Det2theta') - det_dist = C(EpicsSignal, 'DetDist') - det_v_offset = C(EpicsSignal, 'DetVOffset') - energy_high = C(EpicsSignal, 'EnergyHigh') - energy_low = C(EpicsSignal, 'EnergyLow') - file_format = C(SignalWithRBV, 'FileFormat') - filter_transm = C(EpicsSignal, 'FilterTransm') - flat_field_file = C(EpicsSignal, 'FlatFieldFile') - flat_field_valid = C(EpicsSignal, 'FlatFieldValid') - flux = C(EpicsSignal, 'Flux') - gain_menu = C(EpicsSignal, 'GainMenu') - gap_fill = C(SignalWithRBV, 'GapFill') - header_string = C(EpicsSignal, 'HeaderString') - humid0 = C(EpicsSignalRO, 'Humid0_RBV') - humid1 = C(EpicsSignalRO, 'Humid1_RBV') - humid2 = C(EpicsSignalRO, 'Humid2_RBV') - image_file_tmot = C(EpicsSignal, 'ImageFileTmot') - kappa = C(EpicsSignal, 'Kappa') - min_flat_field = C(SignalWithRBV, 'MinFlatField') - num_bad_pixels = C(EpicsSignal, 'NumBadPixels') - num_oscill = C(EpicsSignal, 'NumOscill') - oscill_axis = C(EpicsSignal, 'OscillAxis') - phi = C(EpicsSignal, 'Phi') - pixel_cut_off = C(EpicsSignalRO, 'PixelCutOff_RBV') - polarization = C(EpicsSignal, 'Polarization') - start_angle = C(EpicsSignal, 'StartAngle') - tvx_version = C(EpicsSignalRO, 'TVXVersion_RBV') - temp0 = C(EpicsSignalRO, 'Temp0_RBV') - temp1 = C(EpicsSignalRO, 'Temp1_RBV') - temp2 = C(EpicsSignalRO, 'Temp2_RBV') - threshold_apply = C(EpicsSignal, 'ThresholdApply') - threshold_auto_apply = C(SignalWithRBV, 'ThresholdAutoApply') - threshold_energy = C(SignalWithRBV, 'ThresholdEnergy') - wavelength = C(EpicsSignal, 'Wavelength')
- - -
[docs]class PixiradDetectorCam(CamBase): - _html_docs = ['PixiradDoc.html'] - - auto_calibrate = C(EpicsSignal, 'AutoCalibrate') - humidity_box = C(EpicsSignalRO, 'BoxHumidity_RBV') - colors_collected = C(EpicsSignalRO, 'ColorsCollected_RBV') - cooling_state = C(SignalWithRBV, 'CoolingState') - cooling_status = C(EpicsSignalRO, 'CoolingStatus_RBV') - dew_point = C(EpicsSignalRO, 'DewPoint_RBV') - frame_type = C(SignalWithRBV, 'FrameType') - hv_actual = C(EpicsSignalRO, 'HVActual_RBV') - hv_current = C(EpicsSignalRO, 'HVCurrent_RBV') - hv_mode = C(SignalWithRBV, 'HVMode') - hv_state = C(SignalWithRBV, 'HVState') - hv_value = C(SignalWithRBV, 'HVValue') - peltier_power = C(EpicsSignalRO, 'PeltierPower_RBV') - sync_in_polarity = C(SignalWithRBV, 'SyncInPolarity') - sync_out_function = C(SignalWithRBV, 'SyncOutFunction') - sync_out_polarity = C(SignalWithRBV, 'SyncOutPolarity') - system_reset = C(EpicsSignal, 'SystemReset') - - temperature = C(SignalWithRBV, 'Temperature') - temperature_actual = C(EpicsSignal, 'TemperatureActual') - temperature_box = C(EpicsSignalRO, 'BoxTemperature_RBV') - temperature_hot = C(EpicsSignalRO, 'HotTemperature_RBV') - - threshold_1_actual = C(EpicsSignalRO, 'ThresholdActual1_RBV') - threshold_2_actual = C(EpicsSignalRO, 'ThresholdActual2_RBV') - threshold_3_actual = C(EpicsSignalRO, 'ThresholdActual3_RBV') - threshold_4_actual = C(EpicsSignalRO, 'ThresholdActual4_RBV') - thresholds_actual = DDC(ad_group(EpicsSignalRO, - (('threshold_1', 'ThresholdActual1_RBV'), - ('threshold_2', 'ThresholdActual2_RBV'), - ('threshold_3', 'ThresholdActual3_RBV'), - ('threshold_4', 'ThresholdActual4_RBV'), - )), - doc='Actual thresholds') - - threshold_1 = C(SignalWithRBV, 'Threshold1') - threshold_2 = C(SignalWithRBV, 'Threshold2') - threshold_3 = C(SignalWithRBV, 'Threshold3') - threshold_4 = C(SignalWithRBV, 'Threshold4') - thresholds = DDC(ad_group(SignalWithRBV, - (('threshold_1', 'Threshold1'), - ('threshold_2', 'Threshold2'), - ('threshold_3', 'Threshold3'), - ('threshold_4', 'Threshold4'), - )), - doc='Thresholds') - - udp_buffers_free = C(EpicsSignalRO, 'UDPBuffersFree_RBV') - udp_buffers_max = C(EpicsSignalRO, 'UDPBuffersMax_RBV') - udp_buffers_read = C(EpicsSignalRO, 'UDPBuffersRead_RBV') - udp_speed = C(EpicsSignalRO, 'UDPSpeed_RBV')
- - -
[docs]class PointGreyDetectorCam(CamBase): - _html_docs = ['PointGreyDoc.html'] - - bandwidth = C(EpicsSignal, 'Bandwidth') - binning_mode = C(SignalWithRBV, 'BinningMode') - convert_pixel_format = C(SignalWithRBV, 'ConvertPixelFormat') - corrupt_frames = C(EpicsSignalRO, 'CorruptFrames_RBV') - driver_dropped = C(EpicsSignalRO, 'DriverDropped_RBV') - dropped_frames = C(EpicsSignalRO, 'DroppedFrames_RBV') - firmware_version = C(EpicsSignal, 'FirmwareVersion') - format7_mode = C(SignalWithRBV, 'Format7Mode') - frame_rate = C(SignalWithRBV, 'FrameRate') - max_packet_size = C(EpicsSignal, 'MaxPacketSize') - packet_delay_actual = C(EpicsSignal, 'PacketDelayActual') - packet_delay = C(SignalWithRBV, 'PacketDelay') - packet_size_actual = C(EpicsSignal, 'PacketSizeActual') - packet_size = C(SignalWithRBV, 'PacketSize') - pixel_format = C(SignalWithRBV, 'PixelFormat') - read_status = C(EpicsSignal, 'ReadStatus') - serial_number = C(EpicsSignal, 'SerialNumber') - skip_frames = C(SignalWithRBV, 'SkipFrames') - software_trigger = C(EpicsSignal, 'SoftwareTrigger') - software_version = C(EpicsSignal, 'SoftwareVersion') - strobe_delay = C(SignalWithRBV, 'StrobeDelay') - strobe_duration = C(SignalWithRBV, 'StrobeDuration') - strobe_enable = C(SignalWithRBV, 'StrobeEnable') - strobe_polarity = C(SignalWithRBV, 'StrobePolarity') - strobe_source = C(SignalWithRBV, 'StrobeSource') - time_stamp_mode = C(SignalWithRBV, 'TimeStampMode') - transmit_failed = C(EpicsSignalRO, 'TransmitFailed_RBV') - trigger_polarity = C(SignalWithRBV, 'TriggerPolarity') - trigger_source = C(SignalWithRBV, 'TriggerSource') - video_mode = C(SignalWithRBV, 'VideoMode')
- - -
[docs]class ProsilicaDetectorCam(CamBase): - _html_docs = ['prosilicaDoc.html'] - ps_bad_frame_counter = C(EpicsSignalRO, 'PSBadFrameCounter_RBV') - ps_byte_rate = C(SignalWithRBV, 'PSByteRate') - ps_driver_type = C(EpicsSignalRO, 'PSDriverType_RBV') - ps_filter_version = C(EpicsSignalRO, 'PSFilterVersion_RBV') - ps_frame_rate = C(EpicsSignalRO, 'PSFrameRate_RBV') - ps_frames_completed = C(EpicsSignalRO, 'PSFramesCompleted_RBV') - ps_frames_dropped = C(EpicsSignalRO, 'PSFramesDropped_RBV') - ps_packet_size = C(EpicsSignalRO, 'PSPacketSize_RBV') - ps_packets_erroneous = C(EpicsSignalRO, 'PSPacketsErroneous_RBV') - ps_packets_missed = C(EpicsSignalRO, 'PSPacketsMissed_RBV') - ps_packets_received = C(EpicsSignalRO, 'PSPacketsReceived_RBV') - ps_packets_requested = C(EpicsSignalRO, 'PSPacketsRequested_RBV') - ps_packets_resent = C(EpicsSignalRO, 'PSPacketsResent_RBV') - ps_read_statistics = C(EpicsSignal, 'PSReadStatistics') - ps_reset_timer = C(EpicsSignal, 'PSResetTimer') - ps_timestamp_type = C(SignalWithRBV, 'PSTimestampType') - strobe1_ctl_duration = C(SignalWithRBV, 'Strobe1CtlDuration') - strobe1_delay = C(SignalWithRBV, 'Strobe1Delay') - strobe1_duration = C(SignalWithRBV, 'Strobe1Duration') - strobe1_mode = C(SignalWithRBV, 'Strobe1Mode') - sync_in1_level = C(EpicsSignalRO, 'SyncIn1Level_RBV') - sync_in2_level = C(EpicsSignalRO, 'SyncIn2Level_RBV') - sync_out1_invert = C(SignalWithRBV, 'SyncOut1Invert') - sync_out1_level = C(SignalWithRBV, 'SyncOut1Level') - sync_out1_mode = C(SignalWithRBV, 'SyncOut1Mode') - sync_out2_invert = C(SignalWithRBV, 'SyncOut2Invert') - sync_out2_level = C(SignalWithRBV, 'SyncOut2Level') - sync_out2_mode = C(SignalWithRBV, 'SyncOut2Mode') - sync_out3_invert = C(SignalWithRBV, 'SyncOut3Invert') - sync_out3_level = C(SignalWithRBV, 'SyncOut3Level') - sync_out3_mode = C(SignalWithRBV, 'SyncOut3Mode') - trigger_delay = C(SignalWithRBV, 'TriggerDelay') - trigger_event = C(SignalWithRBV, 'TriggerEvent') - trigger_overlap = C(SignalWithRBV, 'TriggerOverlap') - trigger_software = C(EpicsSignal, 'TriggerSoftware')
- - -
[docs]class PvcamDetectorCam(CamBase): - _html_docs = ['pvcamDoc.html'] - bit_depth = C(EpicsSignalRO, 'BitDepth_RBV') - camera_firmware_vers = C(EpicsSignalRO, 'CameraFirmwareVers_RBV') - chip_height = C(EpicsSignalRO, 'ChipHeight_RBV') - chip_name = C(EpicsSignalRO, 'ChipName_RBV') - chip_width = C(EpicsSignalRO, 'ChipWidth_RBV') - close_delay = C(SignalWithRBV, 'CloseDelay') - detector_mode = C(SignalWithRBV, 'DetectorMode') - detector_selected = C(SignalWithRBV, 'DetectorSelected') - dev_drv_vers = C(EpicsSignalRO, 'DevDrvVers_RBV') - frame_transfer_capable = C(EpicsSignalRO, 'FrameTransferCapable_RBV') - full_well_capacity = C(EpicsSignalRO, 'FullWellCapacity_RBV') - gain_index = C(SignalWithRBV, 'GainIndex') - head_ser_num = C(EpicsSignalRO, 'HeadSerNum_RBV') - initialize = C(SignalWithRBV, 'Initialize') - max_gain_index = C(EpicsSignalRO, 'MaxGainIndex_RBV') - max_set_temperature = C(EpicsSignal, 'MaxSetTemperature') - max_shutter_close_delay = C(EpicsSignalRO, 'MaxShutterCloseDelay_RBV') - max_shutter_open_delay = C(EpicsSignalRO, 'MaxShutterOpenDelay_RBV') - measured_temperature = C(EpicsSignalRO, 'MeasuredTemperature_RBV') - min_set_temperature = C(EpicsSignal, 'MinSetTemperature') - min_shutter_close_delay = C(EpicsSignalRO, 'MinShutterCloseDelay_RBV') - min_shutter_open_delay = C(EpicsSignalRO, 'MinShutterOpenDelay_RBV') - num_parallel_pixels = C(EpicsSignalRO, 'NumParallelPixels_RBV') - num_ports = C(EpicsSignalRO, 'NumPorts_RBV') - num_serial_pixels = C(EpicsSignalRO, 'NumSerialPixels_RBV') - num_speed_table_entries = C(EpicsSignalRO, 'NumSpeedTableEntries_RBV') - open_delay = C(SignalWithRBV, 'OpenDelay') - pcifw_vers = C(EpicsSignalRO, 'PCIFWVers_RBV') - pv_cam_vers = C(EpicsSignalRO, 'PVCamVers_RBV') - pixel_parallel_dist = C(EpicsSignalRO, 'PixelParallelDist_RBV') - pixel_parallel_size = C(EpicsSignalRO, 'PixelParallelSize_RBV') - pixel_serial_dist = C(EpicsSignalRO, 'PixelSerialDist_RBV') - pixel_serial_size = C(EpicsSignalRO, 'PixelSerialSize_RBV') - pixel_time = C(EpicsSignalRO, 'PixelTime_RBV') - post_mask = C(EpicsSignalRO, 'PostMask_RBV') - post_scan = C(EpicsSignalRO, 'PostScan_RBV') - pre_mask = C(EpicsSignalRO, 'PreMask_RBV') - pre_scan = C(EpicsSignalRO, 'PreScan_RBV') - serial_num = C(EpicsSignalRO, 'SerialNum_RBV') - set_temperature = C(SignalWithRBV, 'SetTemperature') - slot1_cam = C(EpicsSignalRO, 'Slot1Cam_RBV') - slot2_cam = C(EpicsSignalRO, 'Slot2Cam_RBV') - slot3_cam = C(EpicsSignalRO, 'Slot3Cam_RBV') - speed_table_index = C(SignalWithRBV, 'SpeedTableIndex') - trigger_edge = C(SignalWithRBV, 'TriggerEdge')
- - -
[docs]class RoperDetectorCam(CamBase): - _html_docs = ['RoperDoc.html'] - auto_data_type = C(SignalWithRBV, 'AutoDataType') - comment1 = C(SignalWithRBV, 'Comment1') - comment2 = C(SignalWithRBV, 'Comment2') - comment3 = C(SignalWithRBV, 'Comment3') - comment4 = C(SignalWithRBV, 'Comment4') - comment5 = C(SignalWithRBV, 'Comment5') - file_format = C(SignalWithRBV, 'FileFormat') - num_acquisitions = C(SignalWithRBV, 'NumAcquisitions') - num_acquisitions_counter = C(EpicsSignalRO, 'NumAcquisitionsCounter_RBV') - roper_shutter_mode = C(SignalWithRBV, 'RoperShutterMode')
- - -
[docs]class URLDetectorCam(CamBase): - _html_docs = ['URLDoc.html'] - urls = DDC(ad_group(EpicsSignal, - (('url_1', 'URL1'), - ('url_2', 'URL2'), - ('url_3', 'URL3'), - ('url_4', 'URL4'), - ('url_5', 'URL5'), - ('url_6', 'URL6'), - ('url_7', 'URL7'), - ('url_8', 'URL8'), - ('url_9', 'URL9'), - ('url_10', 'URL10'))), - doc='URLs') - - url_select = C(EpicsSignal, 'URLSelect') - url_seq = C(EpicsSignal, 'URLSeq') - url = C(EpicsSignalRO, 'URL_RBV')
-
- -
-
- - -
-
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_modules/ophyd/areadetector/detectors.html b/ophyd/_modules/ophyd/areadetector/detectors.html deleted file mode 100644 index f83fea6a9c..0000000000 --- a/ophyd/_modules/ophyd/areadetector/detectors.html +++ /dev/null @@ -1,363 +0,0 @@ - - - - - - - - - - - ophyd.areadetector.detectors — ophyd documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
-
- - - - - - -
-
    -
  • Docs »
  • - -
  • Module code »
  • - -
  • ophyd.areadetector.detectors
  • -
  • - - - -
  • -
-
-
-
-
- -

Source code for ophyd.areadetector.detectors

-# vi: ts=4 sw=4
-'''
-:mod:`ophyd.control.areadetector` - areaDetector
-================================================
-
-.. module:: ophyd.areadetector.detectors
- :synopsis:  `areaDetector`_ detector abstractions
-
-.. _areaDetector: http://cars.uchicago.edu/software/epics/areaDetector.html
-'''
-
-from .base import (ADBase, ADComponent as C)
-from . import cam
-
-
-__all__ = ['DetectorBase',
-           'AreaDetector',
-           'AdscDetector',
-           'Andor3Detector',
-           'AndorDetector',
-           'BrukerDetector',
-           'FirewireLinDetector',
-           'FirewireWinDetector',
-           'LightFieldDetector',
-           'Mar345Detector',
-           'MarCCDDetector',
-           'PerkinElmerDetector',
-           'PilatusDetector',
-           'PixiradDetector',
-           'PointGreyDetector',
-           'ProsilicaDetector',
-           'PSLDetector',
-           'PvcamDetector',
-           'RoperDetector',
-           'SimDetector',
-           'URLDetector',
-           ]
-
-
-class DetectorBase(ADBase):
-    """
-    The base class for the hardware-specific classes that follow.
-
-    Note that Plugin also inherits from ADBase.
-    This adds some AD-specific methods that are not shared by the plugins.
-    """
-    def dispatch(self, key, timestamp):
-        """When a new acquisition is finished, this method is called with a
-        key which is a label like 'light', 'dark', or 'gain8'.
-
-        It in turn calls all of the file plugins and makes them insert a
-        datum into FileStore.
-        """
-        file_plugins = [s for s in self._signals.values() if
-                        hasattr(s, 'generate_datum')]
-        for p in file_plugins:
-            p.generate_datum(key, timestamp)
-
-    def make_data_key(self):
-        source = 'PV:{}'.format(self.prefix)
-        shape = tuple(self.cam.array_size.get())
-        return dict(shape=shape, source=source, dtype='array',
-                    external='FILESTORE:')
-
-
-
[docs]class AreaDetector(DetectorBase): - cam = C(cam.AreaDetectorCam, 'cam1:')
- - -
[docs]class SimDetector(DetectorBase): - _html_docs = ['simDetectorDoc.html'] - cam = C(cam.SimDetectorCam, 'cam1:')
- - -
[docs]class AdscDetector(DetectorBase): - _html_docs = ['adscDoc.html'] - cam = C(cam.AdscDetectorCam, 'cam1:')
- - -
[docs]class AndorDetector(DetectorBase): - _html_docs = ['andorDoc.html'] - cam = C(cam.AndorDetectorCam, 'cam1:')
- - -
[docs]class Andor3Detector(DetectorBase): - _html_docs = ['andor3Doc.html'] - cam = C(cam.Andor3DetectorCam, 'cam1:')
- - -
[docs]class BrukerDetector(DetectorBase): - _html_docs = ['BrukerDoc.html'] - cam = C(cam.Andor3DetectorCam, 'cam1:')
- - -
[docs]class FirewireLinDetector(DetectorBase): - _html_docs = ['FirewireWinDoc.html'] - cam = C(cam.FirewireLinDetectorCam, 'cam1:')
- - -
[docs]class FirewireWinDetector(DetectorBase): - _html_docs = ['FirewireWinDoc.html'] - cam = C(cam.FirewireWinDetectorCam, 'cam1:')
- - -
[docs]class LightFieldDetector(DetectorBase): - _html_docs = ['LightFieldDoc.html'] - cam = C(cam.LightFieldDetectorCam, 'cam1:')
- - -
[docs]class Mar345Detector(DetectorBase): - _html_docs = ['Mar345Doc.html'] - cam = C(cam.Mar345DetectorCam, 'cam1:')
- - -
[docs]class MarCCDDetector(DetectorBase): - _html_docs = ['MarCCDDoc.html'] - cam = C(cam.MarCCDDetectorCam, 'cam1:')
- - -
[docs]class PerkinElmerDetector(DetectorBase): - _html_docs = ['PerkinElmerDoc.html'] - cam = C(cam.LightFieldDetectorCam, 'cam1:')
- - -
[docs]class PSLDetector(DetectorBase): - _html_docs = ['PSLDoc.html'] - cam = C(cam.PSLDetectorCam, 'cam1:')
- - -
[docs]class PilatusDetector(DetectorBase): - _html_docs = ['pilatusDoc.html'] - cam = C(cam.PilatusDetectorCam, 'cam1:')
- - -
[docs]class PixiradDetector(DetectorBase): - _html_docs = ['PixiradDoc.html'] - cam = C(cam.PixiradDetectorCam, 'cam1:')
- - -
[docs]class PointGreyDetector(DetectorBase): - _html_docs = ['PointGreyDoc.html'] - cam = C(cam.PointGreyDetectorCam, 'cam1:')
- - -
[docs]class ProsilicaDetector(DetectorBase): - _html_docs = ['prosilicaDoc.html'] - cam = C(cam.ProsilicaDetectorCam, 'cam1:')
- - -
[docs]class PvcamDetector(DetectorBase): - _html_docs = ['pvcamDoc.html'] - cam = C(cam.PvcamDetectorCam, 'cam1:')
- - -
[docs]class RoperDetector(DetectorBase): - _html_docs = ['RoperDoc.html'] - cam = C(cam.RoperDetectorCam, 'cam1:')
- - -
[docs]class URLDetector(DetectorBase): - _html_docs = ['URLDoc.html'] - cam = C(cam.URLDetectorCam, 'cam1:')
-
- -
-
- - -
-
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_modules/ophyd/areadetector/plugins.html b/ophyd/_modules/ophyd/areadetector/plugins.html deleted file mode 100644 index 514f4e3448..0000000000 --- a/ophyd/_modules/ophyd/areadetector/plugins.html +++ /dev/null @@ -1,979 +0,0 @@ - - - - - - - - - - - ophyd.areadetector.plugins — ophyd documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
-
- - - - - - -
- -
-
-
-
- -

Source code for ophyd.areadetector.plugins

-# vi: ts=4 sw=4
-'''
-:mod:`ophyd.control.areadetector.plugins` - areaDetector plugins
-======================================================
-
-.. module:: ophyd.control.areadetector.plugins
- :synopsis:  `areaDetector`_ plugin abstractions
-
-.. _areaDetector: http://cars.uchicago.edu/software/epics/areaDetector.html
-'''
-
-
-import re
-import time as ttime
-import logging
-from collections import OrderedDict
-import numpy as np
-
-import epics
-
-from .base import (ADBase, ADComponent as C, ad_group,
-                   EpicsSignalWithRBV as SignalWithRBV)
-from ..signal import (EpicsSignalRO, EpicsSignal)
-from ..device import DynamicDeviceComponent as DDC, GenerateDatumInterface
-from ..utils import enum, set_and_wait
-
-
-logger = logging.getLogger(__name__)
-__all__ = ['ColorConvPlugin',
-           'FilePlugin',
-           'HDF5Plugin',
-           'ImagePlugin',
-           'JPEGPlugin',
-           'MagickPlugin',
-           'NetCDFPlugin',
-           'NexusPlugin',
-           'OverlayPlugin',
-           'ProcessPlugin',
-           'ROIPlugin',
-           'StatsPlugin',
-           'TIFFPlugin',
-           'TransformPlugin',
-
-           'get_areadetector_plugin',
-           'plugin_from_pvname',
-           'register_plugin',
-           ]
-
-
-_plugin_class = {}
-
-
-def register_plugin(cls):
-    '''Register a plugin'''
-    global _plugin_class
-
-    _plugin_class[cls._plugin_type] = cls
-
-
-
[docs]class PluginBase(ADBase): - '''AreaDetector plugin base class''' - def __init__(self, *args, **kwargs): - # Turn array callbacks on during staging. - # Without this, no array data is sent to the plugins. - super().__init__(*args, **kwargs) - - if self.parent is not None and hasattr(self.parent, 'cam'): - self.stage_sigs.update([(self.parent.cam.array_callbacks, 1), - ]) - - _html_docs = ['pluginDoc.html'] - _plugin_type = None - _suffix_re = None - - array_counter = C(SignalWithRBV, 'ArrayCounter') - array_rate = C(EpicsSignalRO, 'ArrayRate_RBV') - asyn_io = C(EpicsSignal, 'AsynIO') - - nd_attributes_file = C(EpicsSignal, 'NDAttributesFile', string=True) - pool_alloc_buffers = C(EpicsSignalRO, 'PoolAllocBuffers') - pool_free_buffers = C(EpicsSignalRO, 'PoolFreeBuffers') - pool_max_buffers = C(EpicsSignalRO, 'PoolMaxBuffers') - pool_max_mem = C(EpicsSignalRO, 'PoolMaxMem') - pool_used_buffers = C(EpicsSignalRO, 'PoolUsedBuffers') - pool_used_mem = C(EpicsSignalRO, 'PoolUsedMem') - port_name = C(EpicsSignalRO, 'PortName_RBV', string=True) - - def stage(self): - # Ensure the plugin is enabled. We do not disable it on unstage. - set_and_wait(self.enable, 'Enable') - super().stage() - - @property - def array_pixels(self): - '''The total number of pixels, calculated from array_size''' - - array_size = self.array_size.get() - dimensions = self.ndimensions.get() - - if dimensions == 0: - return 0 - - pixels = array_size[0] - for dim in array_size[1:dimensions]: - pixels *= dim - - return pixels - - width = C(EpicsSignalRO, 'ArraySize0_RBV') - height = C(EpicsSignalRO, 'ArraySize1_RBV') - depth = C(EpicsSignalRO, 'ArraySize2_RBV') - array_size = DDC(ad_group(EpicsSignalRO, - (('height', 'ArraySize1_RBV'), - ('width', 'ArraySize0_RBV'), - ('depth', 'ArraySize2_RBV'))), - doc='The array size') - - bayer_pattern = C(EpicsSignalRO, 'BayerPattern_RBV') - blocking_callbacks = C(SignalWithRBV, 'BlockingCallbacks') - color_mode = C(EpicsSignalRO, 'ColorMode_RBV') - data_type = C(EpicsSignalRO, 'DataType_RBV') - - dim0_sa = C(EpicsSignal, 'Dim0SA') - dim1_sa = C(EpicsSignal, 'Dim1SA') - dim2_sa = C(EpicsSignal, 'Dim2SA') - dim_sa = DDC(ad_group(EpicsSignal, - (('dim0', 'Dim0SA'), - ('dim1', 'Dim1SA'), - ('dim2', 'Dim2SA'))), - doc='Dimension sub-arrays') - - dimensions = C(EpicsSignalRO, 'Dimensions_RBV') - dropped_arrays = C(SignalWithRBV, 'DroppedArrays') - enable = C(SignalWithRBV, 'EnableCallbacks') - min_callback_time = C(SignalWithRBV, 'MinCallbackTime') - nd_array_address = C(SignalWithRBV, 'NDArrayAddress') - nd_array_port = C(SignalWithRBV, 'NDArrayPort') - ndimensions = C(EpicsSignalRO, 'NDimensions_RBV') - plugin_type = C(EpicsSignalRO, 'PluginType_RBV') - - queue_free = C(EpicsSignal, 'QueueFree') - queue_free_low = C(EpicsSignal, 'QueueFreeLow') - queue_size = C(EpicsSignal, 'QueueSize') - queue_use = C(EpicsSignal, 'QueueUse') - queue_use_high = C(EpicsSignal, 'QueueUseHIGH') - queue_use_hihi = C(EpicsSignal, 'QueueUseHIHI') - time_stamp = C(EpicsSignalRO, 'TimeStamp_RBV') - unique_id = C(EpicsSignalRO, 'UniqueId_RBV')
- - -
[docs]class ImagePlugin(PluginBase): - _default_suffix = 'image1:' - _suffix_re = 'image\d:' - _html_docs = ['NDPluginStdArrays.html'] - _plugin_type = 'NDPluginStdArrays' - - array_data = C(EpicsSignal, 'ArrayData') - - @property - def image(self): - array_size = self.array_size.get() - if array_size == [0, 0, 0]: - raise RuntimeError('Invalid image; ensure array_callbacks are on') - - if array_size[-1] == 0: - array_size = array_size[:-1] - - pixel_count = self.array_pixels - image = self.array_data.get(count=pixel_count) - return np.array(image).reshape(array_size)
- - -
[docs]class StatsPlugin(PluginBase): - _default_suffix = 'Stats1:' - _suffix_re = 'Stats\d:' - _html_docs = ['NDPluginStats.html'] - _plugin_type = 'NDPluginStats' - - bgd_width = C(SignalWithRBV, 'BgdWidth') - centroid_threshold = C(SignalWithRBV, 'CentroidThreshold') - - centroid = DDC(ad_group(EpicsSignalRO, - (('x', 'CentroidX_RBV'), - ('y', 'CentroidY_RBV'))), - doc='The centroid XY') - - compute_centroid = C(SignalWithRBV, 'ComputeCentroid') - compute_histogram = C(SignalWithRBV, 'ComputeHistogram') - compute_profiles = C(SignalWithRBV, 'ComputeProfiles') - compute_statistics = C(SignalWithRBV, 'ComputeStatistics') - - cursor = DDC(ad_group(SignalWithRBV, - (('x', 'CursorX'), - ('y', 'CursorY'))), - doc='The cursor XY') - - hist_entropy = C(EpicsSignalRO, 'HistEntropy_RBV') - hist_max = C(SignalWithRBV, 'HistMax') - hist_min = C(SignalWithRBV, 'HistMin') - hist_size = C(SignalWithRBV, 'HistSize') - histogram = C(EpicsSignalRO, 'Histogram_RBV') - - max_size = DDC(ad_group(EpicsSignal, - (('x', 'MaxSizeX'), - ('y', 'MaxSizeY'))), - doc='The maximum size in XY') - - max_value = C(EpicsSignalRO, 'MaxValue_RBV') - max_xy = DDC(ad_group(EpicsSignalRO, - (('x', 'MaxX_RBV'), - ('y', 'MaxY_RBV'))), - doc='Maximum in XY') - - mean_value = C(EpicsSignalRO, 'MeanValue_RBV') - min_value = C(EpicsSignalRO, 'MinValue_RBV') - - min_xy = DDC(ad_group(EpicsSignalRO, - (('x', 'MinX_RBV'), - ('y', 'MinY_RBV'))), - doc='Minimum in XY') - - net = C(EpicsSignalRO, 'Net_RBV') - profile_average = DDC(ad_group(EpicsSignalRO, - (('x', 'ProfileAverageX_RBV'), - ('y', 'ProfileAverageY_RBV'))), - doc='Profile average in XY') - - profile_centroid = DDC(ad_group(EpicsSignalRO, - (('x', 'ProfileCentroidX_RBV'), - ('y', 'ProfileCentroidY_RBV'))), - doc='Profile centroid in XY') - - profile_cursor = DDC(ad_group(EpicsSignalRO, - (('x', 'ProfileCursorX_RBV'), - ('y', 'ProfileCursorY_RBV'))), - doc='Profile cursor in XY') - - profile_size = DDC(ad_group(EpicsSignalRO, - (('x', 'ProfileSizeX_RBV'), - ('y', 'ProfileSizeY_RBV'))), - doc='Profile size in XY') - - profile_threshold = DDC(ad_group(EpicsSignalRO, - (('x', 'ProfileThresholdX_RBV'), - ('y', 'ProfileThresholdY_RBV'))), - doc='Profile threshold in XY') - - set_xhopr = C(EpicsSignal, 'SetXHOPR') - set_yhopr = C(EpicsSignal, 'SetYHOPR') - sigma_xy = C(EpicsSignalRO, 'SigmaXY_RBV') - sigma_x = C(EpicsSignalRO, 'SigmaX_RBV') - sigma_y = C(EpicsSignalRO, 'SigmaY_RBV') - sigma = C(EpicsSignalRO, 'Sigma_RBV') - ts_acquiring = C(EpicsSignal, 'TSAcquiring') - - ts_centroid = DDC(ad_group(EpicsSignal, - (('x', 'TSCentroidX'), - ('y', 'TSCentroidY'))), - doc='Time series centroid in XY') - - ts_control = C(EpicsSignal, 'TSControl') - ts_current_point = C(EpicsSignal, 'TSCurrentPoint') - ts_max_value = C(EpicsSignal, 'TSMaxValue') - - ts_max = DDC(ad_group(EpicsSignal, - (('x', 'TSMaxX'), - ('y', 'TSMaxY'))), - doc='Time series maximum in XY') - - ts_mean_value = C(EpicsSignal, 'TSMeanValue') - ts_min_value = C(EpicsSignal, 'TSMinValue') - - ts_min = DDC(ad_group(EpicsSignal, - (('x', 'TSMinX'), - ('y', 'TSMinY'))), - doc='Time series minimum in XY') - - ts_net = C(EpicsSignal, 'TSNet') - ts_num_points = C(EpicsSignal, 'TSNumPoints') - ts_read = C(EpicsSignal, 'TSRead') - ts_sigma = C(EpicsSignal, 'TSSigma') - ts_sigma_x = C(EpicsSignal, 'TSSigmaX') - ts_sigma_xy = C(EpicsSignal, 'TSSigmaXY') - ts_sigma_y = C(EpicsSignal, 'TSSigmaY') - ts_total = C(EpicsSignal, 'TSTotal') - total = C(EpicsSignalRO, 'Total_RBV')
- - -
[docs]class ColorConvPlugin(PluginBase): - _default_suffix = 'CC1:' - _suffix_re = 'CC\d:' - _html_docs = ['NDPluginColorConvert.html'] - _plugin_type = 'NDPluginColorConvert' - - color_mode_out = C(SignalWithRBV, 'ColorModeOut') - false_color = C(SignalWithRBV, 'FalseColor')
- - -
[docs]class ProcessPlugin(PluginBase): - _default_suffix = 'Proc1:' - _suffix_re = 'Proc\d:' - _html_docs = ['NDPluginProcess.html'] - _plugin_type = 'NDPluginProcess' - - auto_offset_scale = C(EpicsSignal, 'AutoOffsetScale') - auto_reset_filter = C(SignalWithRBV, 'AutoResetFilter') - average_seq = C(EpicsSignal, 'AverageSeq') - copy_to_filter_seq = C(EpicsSignal, 'CopyToFilterSeq') - data_type_out = C(SignalWithRBV, 'DataTypeOut') - difference_seq = C(EpicsSignal, 'DifferenceSeq') - enable_background = C(SignalWithRBV, 'EnableBackground') - enable_filter = C(SignalWithRBV, 'EnableFilter') - enable_flat_field = C(SignalWithRBV, 'EnableFlatField') - enable_high_clip = C(SignalWithRBV, 'EnableHighClip') - enable_low_clip = C(SignalWithRBV, 'EnableLowClip') - enable_offset_scale = C(SignalWithRBV, 'EnableOffsetScale') - - fc = DDC(ad_group(SignalWithRBV, - (('fc1', 'FC1'), - ('fc2', 'FC2'), - ('fc3', 'FC3'), - ('fc4', 'FC4'))), - doc='Filter coefficients') - - foffset = C(SignalWithRBV, 'FOffset') - fscale = C(SignalWithRBV, 'FScale') - filter_callbacks = C(SignalWithRBV, 'FilterCallbacks') - filter_type = C(EpicsSignal, 'FilterType') - filter_type_seq = C(EpicsSignal, 'FilterTypeSeq') - high_clip = C(SignalWithRBV, 'HighClip') - low_clip = C(SignalWithRBV, 'LowClip') - num_filter = C(SignalWithRBV, 'NumFilter') - num_filter_recip = C(EpicsSignal, 'NumFilterRecip') - num_filtered = C(EpicsSignalRO, 'NumFiltered_RBV') - - oc = DDC(ad_group(SignalWithRBV, - (('oc1', 'OC1'), - ('oc2', 'OC2'), - ('oc3', 'OC3'), - ('oc4', 'OC4'))), - doc='Output coefficients') - - o_offset = C(SignalWithRBV, 'OOffset') - o_scale = C(SignalWithRBV, 'OScale') - offset = C(SignalWithRBV, 'Offset') - - rc = DDC(ad_group(SignalWithRBV, - (('rc1', 'RC1'), - ('rc2', 'RC2'))), - doc='Filter coefficients') - - roffset = C(SignalWithRBV, 'ROffset') - recursive_ave_diff_seq = C(EpicsSignal, 'RecursiveAveDiffSeq') - recursive_ave_seq = C(EpicsSignal, 'RecursiveAveSeq') - reset_filter = C(SignalWithRBV, 'ResetFilter') - save_background = C(SignalWithRBV, 'SaveBackground') - save_flat_field = C(SignalWithRBV, 'SaveFlatField') - scale = C(SignalWithRBV, 'Scale') - scale_flat_field = C(SignalWithRBV, 'ScaleFlatField') - sum_seq = C(EpicsSignal, 'SumSeq') - valid_background = C(EpicsSignalRO, 'ValidBackground_RBV') - valid_flat_field = C(EpicsSignalRO, 'ValidFlatField_RBV')
- - -class Overlay(ADBase): - _html_docs = ['NDPluginOverlay.html'] - - blue = C(SignalWithRBV, 'Blue') - draw_mode = C(SignalWithRBV, 'DrawMode') - green = C(SignalWithRBV, 'Green') - max_size_x = C(EpicsSignal, 'MaxSizeX') - max_size_y = C(EpicsSignal, 'MaxSizeY') - overlay_portname = C(SignalWithRBV, 'Name') - - position_x = C(SignalWithRBV, 'PositionX') - position_y = C(SignalWithRBV, 'PositionY') - - position_xlink = C(EpicsSignal, 'PositionXLink') - position_ylink = C(EpicsSignal, 'PositionYLink') - - red = C(SignalWithRBV, 'Red') - set_xhopr = C(EpicsSignal, 'SetXHOPR') - set_yhopr = C(EpicsSignal, 'SetYHOPR') - shape = C(SignalWithRBV, 'Shape') - - size_x = C(SignalWithRBV, 'SizeX') - size_y = C(SignalWithRBV, 'SizeY') - - size_xlink = C(EpicsSignal, 'SizeXLink') - size_ylink = C(EpicsSignal, 'SizeYLink') - use = C(SignalWithRBV, 'Use') - - -
[docs]class OverlayPlugin(PluginBase): - '''Plugin which adds graphics overlays to an NDArray image - - Keyword arguments are passed to the base class, PluginBase - - Parameters - ---------- - prefix : str - The areaDetector plugin prefix - ''' - _default_suffix = 'Over1:' - _suffix_re = 'Over\d:' - _html_docs = ['NDPluginOverlay.html'] - _plugin_type = 'NDPluginOverlay' - - max_size = DDC(ad_group(EpicsSignalRO, - (('x', 'MaxSizeX_RBV'), - ('y', 'MaxSizeY_RBV'))), - doc='The maximum size in XY') - - overlay_1 = C(Overlay, '1:') - overlay_2 = C(Overlay, '2:') - overlay_3 = C(Overlay, '3:') - overlay_4 = C(Overlay, '4:') - overlay_5 = C(Overlay, '5:') - overlay_6 = C(Overlay, '6:') - overlay_7 = C(Overlay, '7:') - overlay_8 = C(Overlay, '8:')
- - -
[docs]class ROIPlugin(PluginBase): - _default_suffix = 'ROI1:' - _suffix_re = 'ROI\d:' - _html_docs = ['NDPluginROI.html'] - _plugin_type = 'NDPluginROI' - - array_size = DDC(ad_group(EpicsSignalRO, - (('x', 'ArraySizeX_RBV'), - ('y', 'ArraySizeY_RBV'), - ('z', 'ArraySizeZ_RBV'))), - doc='Size of the ROI data in XYZ') - - auto_size = DDC(ad_group(SignalWithRBV, - (('x', 'AutoSizeX'), - ('y', 'AutoSizeY'), - ('z', 'AutoSizeZ'))), - doc=('Automatically set SizeXYZ to the input array size ' - 'minus MinXYZ')) - - bin_ = DDC(ad_group(SignalWithRBV, - (('x', 'BinX'), - ('y', 'BinY'), - ('z', 'BinZ'))), - doc='Binning in XYZ') - - data_type_out = C(SignalWithRBV, 'DataTypeOut') - enable_scale = C(SignalWithRBV, 'EnableScale') - - roi_enable = DDC(ad_group(SignalWithRBV, - (('x', 'EnableX'), - ('y', 'EnableY'), - ('z', 'EnableZ'))), - doc=('Enable ROI calculations in the X, Y, Z dimensions. ' - 'If not enabled then the start, size, binning, and ' - 'reverse operations are disabled in the X/Y/Z ' - 'dimension, and the values from the input array ' - 'are used.')) - - max_xy = DDC(ad_group(EpicsSignal, - (('x', 'MaxX'), - ('y', 'MaxY'))), - doc='Maximum in XY') - - max_size = DDC(ad_group(EpicsSignalRO, - (('x', 'MaxSizeX_RBV'), - ('y', 'MaxSizeY_RBV'), - ('z', 'MaxSizeZ_RBV'))), - doc='Maximum size of the ROI in XYZ') - - min_xyz = DDC(ad_group(SignalWithRBV, - (('min_x', 'MinX'), - ('min_y', 'MinY'), - ('min_z', 'MinZ'))), - doc='Minimum size of the ROI in XYZ') - - name_ = C(SignalWithRBV, 'Name', doc='ROI name') - reverse = DDC(ad_group(SignalWithRBV, - (('x', 'ReverseX'), - ('y', 'ReverseY'), - ('z', 'ReverseZ'))), - doc='Reverse ROI in the XYZ dimensions. (0=No, 1=Yes)') - - scale = C(SignalWithRBV, 'Scale') - set_xhopr = C(EpicsSignal, 'SetXHOPR') - set_yhopr = C(EpicsSignal, 'SetYHOPR') - - size = DDC(ad_group(SignalWithRBV, - (('x', 'SizeX'), - ('y', 'SizeY'), - ('z', 'SizeZ'))), - doc='Size of the ROI in XYZ') - - size_link = DDC(ad_group(EpicsSignal, - (('x', 'SizeXLink'), - ('y', 'SizeYLink'))), - doc='Size link in XY')
- - -
[docs]class TransformPlugin(PluginBase): - _default_suffix = 'Trans1:' - _suffix_re = 'Trans\d:' - _html_docs = ['NDPluginTransform.html'] - _plugin_type = 'NDPluginTransform' - - width = C(SignalWithRBV, 'ArraySize0') - height = C(SignalWithRBV, 'ArraySize1') - depth = C(SignalWithRBV, 'ArraySize2') - array_size = DDC(ad_group(SignalWithRBV, - (('height', 'ArraySize1'), - ('width', 'ArraySize0'), - ('depth', 'ArraySize2'))), - doc='Array size') - - name_ = C(EpicsSignal, 'Name') - origin_location = C(SignalWithRBV, 'OriginLocation') - t1_max_size = DDC(ad_group(EpicsSignal, - (('size0', 'T1MaxSize0'), - ('size1', 'T1MaxSize1'), - ('size2', 'T1MaxSize2'))), - doc='Transform 1 max size') - - t2_max_size = DDC(ad_group(EpicsSignal, - (('size0', 'T2MaxSize0'), - ('size1', 'T2MaxSize1'), - ('size2', 'T2MaxSize2'))), - doc='Transform 2 max size') - - t3_max_size = DDC(ad_group(EpicsSignal, - (('size0', 'T3MaxSize0'), - ('size1', 'T3MaxSize1'), - ('size2', 'T3MaxSize2'))), - doc='Transform 3 max size') - - t4_max_size = DDC(ad_group(EpicsSignal, - (('size0', 'T4MaxSize0'), - ('size1', 'T4MaxSize1'), - ('size2', 'T4MaxSize2'))), - doc='Transform 4 max size') - - types = DDC(ad_group(EpicsSignal, - (('type1', 'Type1'), - ('type2', 'Type2'), - ('type3', 'Type3'), - ('type4', 'Type4'))), - doc='Transform types')
- - -
[docs]class FilePlugin(PluginBase, GenerateDatumInterface): - _default_suffix = '' - _html_docs = ['NDPluginFile.html'] - _plugin_type = 'NDPluginFile' - - FileWriteMode = enum(SINGLE=0, CAPTURE=1, STREAM=2) - - auto_increment = C(SignalWithRBV, 'AutoIncrement') - auto_save = C(SignalWithRBV, 'AutoSave') - capture = C(SignalWithRBV, 'Capture') - delete_driver_file = C(SignalWithRBV, 'DeleteDriverFile') - file_format = C(SignalWithRBV, 'FileFormat') - file_name = C(SignalWithRBV, 'FileName', string=True) - file_number = C(SignalWithRBV, 'FileNumber') - file_number_sync = C(EpicsSignal, 'FileNumber_Sync') - file_number_write = C(EpicsSignal, 'FileNumber_write') - file_path = C(SignalWithRBV, 'FilePath', string=True) - file_path_exists = C(EpicsSignalRO, 'FilePathExists_RBV') - file_template = C(SignalWithRBV, 'FileTemplate', string=True) - file_write_mode = C(SignalWithRBV, 'FileWriteMode') - full_file_name = C(EpicsSignalRO, 'FullFileName_RBV', string=True) - num_capture = C(SignalWithRBV, 'NumCapture') - num_captured = C(EpicsSignalRO, 'NumCaptured_RBV') - read_file = C(SignalWithRBV, 'ReadFile') - write_file = C(SignalWithRBV, 'WriteFile') - write_message = C(EpicsSignal, 'WriteMessage', string=True) - write_status = C(EpicsSignal, 'WriteStatus')
- - -
[docs]class NetCDFPlugin(FilePlugin): - _default_suffix = 'netCDF1:' - _suffix_re = 'netCDF\d:' - _html_docs = ['NDFileNetCDF.html'] - _plugin_type = 'NDFileNetCDF'
- - -
[docs]class TIFFPlugin(FilePlugin): - _default_suffix = 'TIFF1:' - _suffix_re = 'TIFF\d:' - _html_docs = ['NDFileTIFF.html'] - _plugin_type = 'NDFileTIFF'
- - -
[docs]class JPEGPlugin(FilePlugin): - _default_suffix = 'JPEG1:' - _suffix_re = 'JPEG\d:' - _html_docs = ['NDFileJPEG.html'] - _plugin_type = 'NDFileJPEG' - - jpeg_quality = C(SignalWithRBV, 'JPEGQuality')
- - -
[docs]class NexusPlugin(FilePlugin): - _default_suffix = 'Nexus1:' - _suffix_re = 'Nexus\d:' - _html_docs = ['NDFileNexus.html'] - # _plugin_type = 'NDPluginFile' # TODO was this ever fixed? - _plugin_type = 'NDPluginNexus' - - file_template_valid = C(EpicsSignal, 'FileTemplateValid') - template_file_name = C(SignalWithRBV, 'TemplateFileName', string=True) - template_file_path = C(SignalWithRBV, 'TemplateFilePath', string=True)
- - -
[docs]class HDF5Plugin(FilePlugin): - _default_suffix = 'HDF1:' - _suffix_re = 'HDF\d:' - _html_docs = ['NDFileHDF5.html'] - _plugin_type = 'NDFileHDF5' - - boundary_align = C(SignalWithRBV, 'BoundaryAlign') - boundary_threshold = C(SignalWithRBV, 'BoundaryThreshold') - compression = C(SignalWithRBV, 'Compression') - data_bits_offset = C(SignalWithRBV, 'DataBitsOffset') - - extra_dim_name = DDC(ad_group(EpicsSignalRO, - (('name_x', 'ExtraDimNameX_RBV'), - ('name_y', 'ExtraDimNameY_RBV'), - ('name_n', 'ExtraDimNameN_RBV'))), - doc='Extra dimension names (XYN)') - extra_dim_size = DDC(ad_group(SignalWithRBV, - (('size_x', 'ExtraDimSizeX'), - ('size_y', 'ExtraDimSizeY'), - ('size_n', 'ExtraDimSizeN'))), - doc='Extra dimension sizes (XYN)') - - io_speed = C(EpicsSignal, 'IOSpeed') - num_col_chunks = C(SignalWithRBV, 'NumColChunks') - num_data_bits = C(SignalWithRBV, 'NumDataBits') - num_extra_dims = C(SignalWithRBV, 'NumExtraDims') - num_frames_chunks = C(SignalWithRBV, 'NumFramesChunks') - num_frames_flush = C(SignalWithRBV, 'NumFramesFlush') - num_row_chunks = C(SignalWithRBV, 'NumRowChunks') - run_time = C(EpicsSignal, 'RunTime') - szip_num_pixels = C(SignalWithRBV, 'SZipNumPixels') - store_attr = C(SignalWithRBV, 'StoreAttr') - store_perform = C(SignalWithRBV, 'StorePerform') - zlevel = C(SignalWithRBV, 'ZLevel') - -
[docs] def warmup(self): - """ - A convenience method for 'priming' the plugin. - - The plugin has to 'see' one acquisition before it is ready to capture. - This sets the array size, etc. - """ - set_and_wait(self.enable, 1) - sigs = OrderedDict([(self.parent.cam.array_callbacks, 1), - (self.parent.cam.image_mode, 'Single'), - (self.parent.cam.trigger_mode, 'Internal'), - # just in case tha acquisition time is set very long... - (self.parent.cam.acquire_time , 1), - (self.parent.cam.acquire_period, 1), - (self.parent.cam.acquire, 1)]) - - original_vals = {sig: sig.get() for sig in sigs} - - for sig, val in sigs.items(): - ttime.sleep(0.1) # abundance of caution - set_and_wait(sig, val) - - ttime.sleep(2) # wait for acquisition - - for sig, val in reversed(list(original_vals.items())): - ttime.sleep(0.1) - set_and_wait(sig, val)
- -
[docs]class MagickPlugin(FilePlugin): - _default_suffix = 'Magick1:' - _suffix_re = 'Magick\d:' - _html_docs = ['NDFileMagick'] # sic., no html extension - _plugin_type = 'NDFileMagick' - - bit_depth = C(SignalWithRBV, 'BitDepth') - compress_type = C(SignalWithRBV, 'CompressType') - quality = C(SignalWithRBV, 'Quality')
- - -# register_plugin(PluginBase) -register_plugin(ImagePlugin) -register_plugin(StatsPlugin) -register_plugin(ColorConvPlugin) -register_plugin(ProcessPlugin) -register_plugin(OverlayPlugin) -register_plugin(ROIPlugin) -register_plugin(TransformPlugin) -# register_plugin(FilePlugin) -register_plugin(NetCDFPlugin) -register_plugin(TIFFPlugin) -register_plugin(JPEGPlugin) -register_plugin(NexusPlugin) -register_plugin(HDF5Plugin) -register_plugin(MagickPlugin) - - -def plugin_from_pvname(pv): - '''Get the plugin class from a pvname, - using regular expressions defined in the classes (_suffix_re). - ''' - global _plugin_class - - for type_, cls in _plugin_class.items(): - m = re.search(cls._suffix_re, pv) - if m: - return cls - - return None - - -def get_areadetector_plugin_class(prefix, timeout=2.0): - '''Get an areadetector plugin class by supplying its PV prefix - - Uses `plugin_from_pvname` first, but falls back on using epics channel - access to determine the plugin type. - - Returns - ------- - plugin : Plugin - The plugin class - - Raises - ------ - ValueError - If the plugin type can't be determined - ''' - cls = plugin_from_pvname(prefix) - if cls is not None: - return cls - - type_rbv = prefix + 'PluginType_RBV' - type_ = epics.caget(type_rbv, timeout=timeout) - - if type_ is None: - raise ValueError('Unable to determine plugin type (caget timed out)') - - # HDF5 includes version number, remove it - type_ = type_.split(' ')[0] - - try: - return _plugin_class[type_] - except KeyError: - raise ValueError('Unable to determine plugin type (PluginType={})' - ''.format(type_)) - - -def get_areadetector_plugin(prefix, **kwargs): - '''Get an instance of an areadetector plugin by supplying its PV prefix - and any kwargs for the constructor. - - Uses `plugin_from_pvname` first, but falls back on using - epics channel access to determine the plugin type. - - Returns - ------- - plugin : Plugin - The plugin instance - - Raises - ------ - ValueError - If the plugin type can't be determined - ''' - - cls = get_areadetector_plugin_class(prefix) - if cls is None: - raise ValueError('Unable to determine plugin type') - - return cls(prefix, **kwargs) -
- -
-
- - -
-
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_modules/ophyd/commands.html b/ophyd/_modules/ophyd/commands.html deleted file mode 100644 index 117ff49b6d..0000000000 --- a/ophyd/_modules/ophyd/commands.html +++ /dev/null @@ -1,968 +0,0 @@ - - - - - - - - - - - ophyd.commands — ophyd documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
-
- - - - - - -
- -
-
-
-
- -

Source code for ophyd.commands

-
-"""Command Line Interface to opyd objects"""
-
-
-import time
-import functools
-import sys
-import warnings
-from contextlib import contextmanager, closing
-from operator import attrgetter
-from io import StringIO
-import collections
-
-import IPython
-from IPython.utils.coloransi import TermColors as tc
-
-from epics import caget, caput
-
-from . import (EpicsMotor, PositionerBase, PVPositioner, Device)
-from .utils import DisconnectedError
-from .utils.startup import setup as setup_ophyd
-from prettytable import PrettyTable
-import numpy as np
-
-
-__all__ = ['mov',
-           'movr',
-           'set_pos',
-           'wh_pos',
-           'set_lm',
-           'log_pos',
-           'log_pos_diff',
-           'log_pos_mov',
-           'get_all_positioners',
-           'get_logbook',
-           'setup_ophyd',
-           ]
-
-# Global Defs of certain strings
-
-FMT_LEN = 18
-FMT_PREC = 6
-DISCONNECTED = 'disconnected'
-
-
-def scrape_namespace():
-    """
-    Get all public objects from the user namespace, sorted by name.
-
-    If we are not in an IPython session, warn and return an empty list.
-    """
-    ip = IPython.get_ipython()
-    if ip is None:
-        warnings.warn('Unable to inspect Python global namespace; '
-                      'use IPython to enable these features.')
-        return []
-    else:
-        return [val for var, val in sorted(ip.user_ns.items())
-                if not var.startswith('_')]
-
-
-def instances_from_namespace(classes):
-    '''Get all instances of `classes` from the user namespace
-
-    Parameters
-    ----------
-    classes : type, or sequence of types
-        Passed directly to isinstance(), only instances of these classes
-        will be returned.
-    '''
-    return [val for val in scrape_namespace() if isinstance(val, classes)]
-
-
-def ducks_from_namespace(attr):
-    '''Get all instances that have a given attribute.
-
-    "Ducks" is a reference to "duck-typing." If it looks like a duck....
-
-    Parameters
-    ----------
-    attr : str
-        name of attribute
-    '''
-    return [val for val in scrape_namespace() if hasattr(val, attr)]
-
-
-
[docs]def get_all_positioners(): - '''Get all positioners defined in the IPython namespace''' - devices = instances_from_namespace((Device, PositionerBase)) - positioners = [] - for device in devices: - positioners.extend(_recursive_positioner_search(device)) - return positioners
- - -def _recursive_positioner_search(device): - "Return a flat list the device and any subdevices that can be 'set'." - # TODO Refactor this as a method on Device. - res = [] - - try: - if hasattr(device, 'position'): # duck-typed as a Positioner - res.append(device) - except DisconnectedError: - res.append(device) - - if isinstance(device, Device): # only Devices have `_signals` - for d in device._signals.values(): - if isinstance(d, (Device, PositionerBase)): - res.extend(_recursive_positioner_search(d)) - return res - - -def _normalize_positioners(positioners): - "input normalization used by wh_pos, log_pos, log_pos_mov" - if positioners is None: - # Grab IPython namespace, recursively find Positioners. - res = get_all_positioners() - elif isinstance(positioners, (Device, PositionerBase)): - # Explore children in case this is a composite Device. - res = _recursive_positioner_search(positioners) - else: - # Assume this is a list of Devices. - res = [] - for device in positioners: - if not isinstance(device, (Device, PositionerBase)): - raise TypeError("Input is not a Device: %r" % device) - res.extend(_recursive_positioner_search(device)) - return list(sorted(set(res), key=attrgetter('name'))) - - -def var_from_namespace(var): - ip = IPython.get_ipython() - if ip is not None: - return ip.user_ns[var] - else: - raise RuntimeError('No IPython session') - - -
[docs]def get_logbook(): - '''Get the logbook instance from the user namespace''' - try: - return var_from_namespace('logbook') - except (KeyError, RuntimeError): - return None
- - -def ensure(*ensure_args): - def wrap(f): - @functools.wraps(f) - def wrapper(*args, **kwargs): - # First check if we have an iterable first on the first arg. - # If not, then make these all lists - if len(args) > 0: - if not hasattr(args[0], "__iter__"): - args = tuple([[a] for a in args]) - # Now do type checking ignoring None - for n, (arg, t) in enumerate(zip(args, ensure_args)): - if t is None: - # Ignore when type is specified as None - continue - - invalid = [x for x in arg - if not isinstance(x, t)] - - if invalid: - raise TypeError('Incorrect type in parameter list.\n' - 'Parameter at 0-based position {} must be' - 'an instance of {}'.format(n, t)) - - f(*args, **kwargs) - return wrapper - return wrap - - -@ensure(PositionerBase, None) -
[docs]def mov(positioner, position): - """Move positioners to given positions - - Move positioners using the move method of the Positioner class. - - Parameters - ---------- - positioner : Positioner or list - Positioners to move - position : float or list of float - Values to move positioners to. - - Examples - -------- - Move a single positioner `slt1_xc` to 10:: - - >>>mov(slt1_xc, 10) - - Move positioner `slt1_xg` and `slt1_yg` to 2 and 3 respectively:: - - >>>mov([slt1_xg, slt1_yg], [2, 3]) - """ - - print('\n ', end='') - print(tc.Green, end='') - for p in positioner: - print_string(p.name) - print("\n") - - # Start Moving all Positioners in context manager to catch - # Keyboard interrupts - - # TODO : This should be a utility function - - pos_prec = [] - for p in positioner: - if hasattr(p, 'precision'): - pos_prec.append(p.precision) - else: - pos_prec.append(FMT_PREC) - - with catch_keyboard_interrupt(positioner): - stat = [p.move(v, wait=False) for p, v in - zip(positioner, position)] - - # The loop below ensures that at least a couple prints - # will happen - flag = 0 - done = False - - while not all(s.done for s in stat) or (flag < 2): - print(tc.LightGreen, end='') - print(' ', end='') - for p, prec in zip(positioner, pos_prec): - print_value(p.position, egu=p.egu, prec=prec) - print('\n') - print('\033[2A', end='') - time.sleep(0.01) - done = all(s.done for s in stat) - if done: - flag += 1 - - print(tc.Normal + '\n') - for err in [s for s in stat if not s.success]: - device = err.pos - reason = "Unknown" - if isinstance(device, EpicsMotor): - if device.high_limit_switch.get(): - reason = "Motor reached the high limit switch." - elif device.low_limit_switch.get(): - reason = "Motor reached the low limit switch." - - print('Warning: {} failed to reach the target position. ' - 'Reason: {}'.format(device.name, reason))
- - -@ensure(PositionerBase, None) -
[docs]def movr(positioner, position): - """Move positioners relative to their current positon. - - See Also - -------- - mov : move positioners to an absolute position. - """ - - _start_val = [p.position for p in positioner] - for v in _start_val: - if v is None: - raise IOError("Unable to read motor position for relative move") - - _new_val = [a + b for a, b in zip(_start_val, position)] - mov(positioner, _new_val)
- - -@ensure(PositionerBase, None) -
[docs]def set_lm(positioner, limits): - """Set the limits of the positioner - - Sets the limits of the positioner or list of positioners. For EpicsMotors - the fields .HLM and .LLM are set to the high and low limits respectively. - For PVPositioners the .DRVH and .DRVL fields are set on the setopoint - record. If neither method works then an IOError is raised. - - Parameters - ---------- - positioner : positioner or list of positioners - limits : single or list of tuple of form (+ve, -ve) limits - - Raises - ------ - IOError - If the caput (EPICS put) fails then an IOError is raised. - - Examples - -------- - Set the limits of motor `m1` to (10, -10):: - - >>>set_lm(slt1_xc, (10, -10)) - - Set the limits of motors `m1` and `m2` to (2, -2) and (3, -3) - respectively:: - - >>>set_lm([m1, m2], [[2,-2], [3, -3]]) - """ - - print('') - msg = '' - - high_fields = [] - low_fields = [] - for p in positioner: - if isinstance(p, EpicsMotor): - high_fields.append(p.prefix + '.HLM') - low_fields.append(p.prefix + '.LLM') - elif isinstance(p, PVPositioner): - high_fields.append(p.setpoint_pvname[0] + '.DRVH') - low_fields.append(p.setpoint_pvname[0] + '.DRVL') - else: - raise TypeError("Positioners must be EpicsMotors or PVPositioners" - "to set the limits") - - for p, lim, high_field, low_field in zip(positioner, - limits, - high_fields, low_fields): - lim1 = max(lim) - lim2 = min(lim) - if not caput(high_field, lim1): - raise IOError("Unable to set high limit for {}" - " writing to PV {}.".format(p.name, high_field)) - msg += "Upper limit set to {:.{prec}g} for positioner {}\n".format( - lim1, p.name, prec=FMT_PREC) - - if not caput(low_field, lim2): - raise IOError("Unable to set low limit for {}" - " writing to PV {}.".format(p.name, low_field)) - msg += "Lower limit set to {:.{prec}g} for positioner {}\n".format( - lim2, p.name, prec=FMT_PREC) - - print(msg) - logbook = get_logbook() - if logbook: - logbook.log(msg)
- - -@ensure(PositionerBase, (float, int)) -
[docs]def set_pos(positioner, position): - """Set the position of a positioner - - Set the position of a positioner or positioners to the value position. - This function only works for EpicsMotors (Based on the EPICS Motor Record) - and uses the .OFF field to set the current position to the value passed to - the function. - - Parameters - ---------- - positioner : Positioner or list of positioners. - position : float or list of floats. - New position of positioners - - Raises - ------ - TypeError - If positioner is not an instance of an EpicsMotor. - - Examples - -------- - Set the position of motor m1 to 4:: - - >>>set_pos(m1, 4) - - Set the position of motors m1 and m2 to 1 and 2 respectively:: - - >>>set_pos([m1, m2], [1, 2]) - - Raises: - TypeError: If positioner is not an instance of an EpicsMotor. - """ - for p in positioner: - if not isinstance(p, EpicsMotor): - raise TypeError("Positioner {} must be an EpicsMotor" - "to set position.".format(p.name)) - - # Get the current offset - - offset_pvs = [p.prefix + ".OFF" for p in positioner] - dial_pvs = [p.prefix + ".DRBV" for p in positioner] - - old_offsets = [caget(p) for p in offset_pvs] - dial = [caget(p) for p in dial_pvs] - - for v in old_offsets + dial: - if v is None: - raise ValueError("Could not read or invalid value for current" - "position of positioners") - - new_offsets = [a - b for a, b in zip(position, dial)] - - msg = '' - for o, old_o, p in zip(new_offsets, old_offsets, positioner): - if caput(p.prefix + '.OFF', o): - msg += 'Motor {0} set to position {1} (Offset = {2} was {3})\n'\ - .format(p.name, p.position, o, old_o) - else: - print('Unable to set position of positioner {0}'.format(p.name)) - - print(msg) - logbook = get_logbook() - if logbook: - lmsg = logbook_add_objects(positioner, dial_pvs + offset_pvs) - logbook.log(msg + '\n' + lmsg)
- - -
[docs]def wh_pos(positioners=None): - """Get the current position of Positioners and print to screen. - - Print to the screen the position of the positioners in a formated table. - - Parameters - ---------- - positioners : Positioner, list of Positioners or None - - See Also - -------- - log_pos : Log positioner values to logbook - - Examples - -------- - List all positioners:: - - >>>wh_pos() - - List positioners `m1`, `m2` and `m3`:: - - >>>wh_pos([m1, m2, m3]) - """ - positioners = _normalize_positioners(positioners) - _print_pos(positioners, file=sys.stdout)
- - -
[docs]def log_pos(positioners=None, extra_msg=None): - """Get the current position of Positioners and make a logbook entry. - - Print to the screen the position of the positioners and make a logbook text - entry. This routine also creates session information in the logbook so - positions can be recovered. - - Parameters - ---------- - positioners : Positioner, list of Positioners or None - - Returns - ------- - int - The ID of the logbook entry returned by the logbook.log method. - """ - positioners = _normalize_positioners(positioners) - logbook = get_logbook() - if extra_msg: - msg = extra_msg + '\n' - else: - msg = '' - - with closing(StringIO()) as sio: - _print_pos(positioners, file=sio) - msg += sio.getvalue() - - # Add the text representation of the positioners - - # Create the property for storing motor posisions - pdict = {} - pdict['values'] = {} - - msg += logbook_add_objects(positioners) - - for p in positioners: - try: - pdict['values'][p.name] = p.position - except DisconnectedError: - pdict['values'][p.name] = DISCONNECTED - - pdict['objects'] = repr(positioners) - pdict['values'] = repr(pdict['values']) - - if logbook: - id_ = logbook.log(msg, properties={'OphydPositioners': pdict}, - ensure=True) - - print('Logbook positions added as Logbook ID {}'.format(id_)) - return id_
- - -
[docs]def log_pos_mov(id=None, dry_run=False, positioners=None, **kwargs): - """Move to positions located in logboook - - This function moves to positions recorded in the experimental logbook using - the :py:func:`log_pos` function. - - Parameters - ---------- - id : integer, optional - ID of logbook entry to search for and move positions to. - dry_run : bool, optional - If True, do not move motors, but execute a dry_run - positioners : list, optional - List of string names of positioners to compare and move. Other - positioners in the log entry will be ignored. - """ - positioners = _normalize_positioners(positioners) - logpos, objects = logbook_to_objects(id, **kwargs) - objects = collections.OrderedDict(sorted(objects.items())) - - keys = set(positioners).intersection(set(objects.keys())) - objects = {x: objects[x] for x in keys} - - print('') - stat = [] - for key, value in objects.items(): - newpos = logpos[key] - if newpos == DISCONNECTED: - print('{}[!!] Unable to move positioner {} {}: position was stored' - 'as disconnected'.format(tc.Red, key, tc.Normal)) - continue - - try: - oldpos = value.position - except DisconnectedError: - print('{}[!!] Unable to move positioner {} {}: disconnected' - ''.format(tc.Red, key, tc.Normal)) - continue - - try: - if not dry_run: - stat.append(value.move(newpos, wait=False)) - except Exception as ex: - print('{}[!!] Unable to move positioner {} {} ({}: {})' - ''.format(tc.Red, key, tc.Normal, ex.__class__.__name__, ex)) - else: - print('{}[**] Moving positioner {} to {}' - ' from current position of {}{}`' - ''.format(tc.Green, key, newpos, oldpos, tc.Normal)) - - print('\n{}Waiting for positioners to complete .....' - ''.format(tc.LightGreen), end='') - - sys.stdout.flush() - - if len(stat) > 0: - while all(s.done for s in stat): - time.sleep(0.01) - - print(' Done{}\n'.format(tc.Normal))
- - -
[docs]def log_pos_diff(id=None, positioners=None, **kwargs): - """Move to positions located in logboook - - This function compares positions recorded in the experimental logbook - using the :py:func:`log_pos` function. - - Parameters - ---------- - id : integer - ID of logbook entry to search for and move positions to. - positioners : list - List of string names of positioners to compare. Other positioners - in the log entry will be ignored. - """ - - positioners = _normalize_positioners(positioners) - logpos, objects = logbook_to_objects(id, **kwargs) - objects = collections.OrderedDict(sorted(objects.items())) - - # Cycle through positioners and compare position with old value - # If we have an error, print a warning - - diff = [] - pos = [] - values = [] - - keys = set(positioners).intersection(set(objects.keys())) - objects = {x: objects[x] for x in keys} - - print('') - for key, value in objects.items(): - oldpos = logpos[key] - if oldpos == DISCONNECTED: - print('{}[!!] Unable to compare position {} {}: position was stored' - 'as disconnected'.format(tc.Red, key, tc.Normal)) - continue - - try: - newpos = value.position - except DisconnectedError: - print('{}[!!] Unable to compare position {} {}: disconnected' - ''.format(tc.Red, key, tc.Normal)) - continue - - try: - diff.append(newpos - oldpos) - except Exception as ex: - print('{}[!!] Unable to compare position {}{}: ({}: {})' - .format(tc.Red, key, tc.Normal, ex.__class__.__name__, ex)) - else: - pos.append(value) - values.append(newpos) - - header_len = 3 * (FMT_LEN + 3) + 1 - print_header(len=header_len) - print_string('Positioner', pre='| ', post=' | ') - print_string('Value', post=' | ') - print_string('Difference', post=' |\n') - - print_header(len=header_len) - - for p, v, d in zip(pos, values, diff): - print_string(p.name, pre='| ', post=' | ') - print_value(v, egu=p.egu, post=' | ') - print_value(d, egu=p.egu, post=' |\n') - - print_header(len=header_len) - print('')
- - -def logbook_to_objects(id=None, **kwargs): - """Search the logbook and return positioners""" - - logbook = get_logbook() - if logbook is None: - raise RuntimeError("No logbook is available") - - entry = logbook.find(id=id, **kwargs) - if len(entry) != 1: - raise ValueError("Search of logbook was not unique, please refine" - "search") - try: - prop = entry[0]['properties']['OphydPositioners'] - except KeyError: - raise KeyError('No property in log entry with positioner information') - - try: - obj = eval(prop['objects']) - val = eval(prop['values']) - except Exception as ex: - raise RuntimeError('Unable to create objects from log entry ' - '(%s)' % ex) - - objects = {o.name: o for o in obj} - return val, objects - - -def logbook_add_objects(objects, extra_pvs=None): - """Add to the logbook aditional information on ophyd objects. - - This routine takes objects and possible extra pvs and adds to the log entry - information which is not printed to stdout/stderr. - - Parameters - ---------- - objects : Ophyd objects - Objects to add to log entry. - extra_pvs : List of strings - Extra PVs to include in report - """ - - msg = '' - msg += '{:^43}|{:^22}|{:^50}\n'.format('PV Name', 'Name', 'Value') - msg += '{:-^120}\n'.format('') - - # Make a list of all PVs and positioners - reports = [o.report for o in objects] - pvs = [report.get('pv', str(None)) for report in reports] - names = [o.name for o in objects] - values = [str(v) for report in reports - for k, v in report.items() if k != 'pv'] - - if extra_pvs is not None: - pvs += extra_pvs - names += ['None' for e in extra_pvs] - values += [caget(e) for e in extra_pvs] - - for a, b, c in zip(pvs, names, values): - msg += 'PV:{:<40} {:<22} {:<50}\n'.format(a, b, c) - - return msg - - -def print_header(title='', char='-', len=80, file=sys.stdout): - print('{:{char}^{len}}'.format(title, char=char, len=len), file=file) - - -def print_string(val, size=FMT_LEN, pre='', post=' ', file=sys.stdout): - print('{}{:<{size}}{}'.format(pre, val, post, size=size), end='', file=file) - - -def print_value(val, prec=FMT_PREC, egu='', **kwargs): - if val is not None: - print_string('{: .{fmt}f} {}'.format(val, egu, fmt=prec), **kwargs) - else: - print_string('', **kwargs) - - -def blink(on=True, file=sys.stdout): - if on: - print("\x1b[?25h", end='', file=file) - else: - print("\x1b[?25l", end='', file=file) - - -@contextmanager -def catch_keyboard_interrupt(positioners): - """Context manager to capture Keyboard Interrupt and stop motors - - This context manager should be used when moving positioners via the cli - to capture the keyboardInterrupt and ensure that motors are stopped and - clean up the output to the screen. - """ - - blink(False) - - try: - yield - except KeyboardInterrupt: - print(tc.Red + "[!!] ABORTED " - ": Commanding all positioners to stop.") - for p in positioners: - p.stop() - print("{}[--] Stopping {}{}".format(tc.Red, tc.LightRed, p.name)) - print(tc.Normal, end='') - blink(True) - raise - print(tc.Normal, end='') - blink(True) - - -def _print_pos(positioners, file=sys.stdout): - """Pretty Print the positioners to file""" - - print('', file=file) - pos = [] - for p in positioners: - try: - pos.append(p.position) - except (DisconnectedError, TypeError): - pos.append(None) - - # Print out header - pt = PrettyTable(['Positioner', 'Value', 'Low Limit', 'High Limit']) - pt.align = 'r' - pt.align['Positioner'] = 'l' - pt.float_format = '8.5' - - for p, v in zip(positioners, pos): - if pos is None: - continue - if v is not None: - try: - prec = p.precision - except (AttributeError, DisconnectedError): - prec = FMT_PREC - value = np.round(v, decimals=prec) - else: - value = DISCONNECTED - - try: - low_limit, high_limit = p.low_limit, p.high_limit - except DisconnectedError: - low_limit = high_limit = DISCONNECTED - - pt.add_row([p.name, value, low_limit, high_limit]) - - print(pt, file=file) -
- -
-
- - -
-
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_modules/ophyd/device.html b/ophyd/_modules/ophyd/device.html deleted file mode 100644 index 214cc5116e..0000000000 --- a/ophyd/_modules/ophyd/device.html +++ /dev/null @@ -1,1059 +0,0 @@ - - - - - - - - - - - ophyd.device — ophyd documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
-
- - - - - - -
- -
-
-
-
- -

Source code for ophyd.device

-import time as ttime
-import logging
-import textwrap
-from enum import Enum
-from collections import (OrderedDict, namedtuple)
-
-from .ophydobj import OphydObject
-from .status import DeviceStatus
-from .utils import (ExceptionBundle, set_and_wait, RedundantStaging)
-
-logger = logging.getLogger(__name__)
-
-
-class Staged(Enum):
-    """Three-state switch"""
-    yes = 'yes'
-    no = 'no'
-    partially = 'partially'
-
-
-class Component:
-    '''A descriptor representing a device component (or signal)
-
-    Unrecognized keyword arguments will be passed directly to the component
-    class initializer.
-
-    Parameters
-    ----------
-    cls : class
-        Class of signal to create.  The required signature of
-        `cls.__init__` is (if `suffix` is given)::
-
-            def __init__(self, pv_name, parent=None, **kwargs):
-
-        or (if suffix is None) ::
-
-            def __init__(self, parent=None, **kwargs):
-
-        The class may have a `wait_for_connection()` which is called
-        during the component instance creation.
-
-    suffix : str, optional
-        The PV suffix, which gets appended onto the device prefix to
-        generate the final PV that the instance component will bind to.
-
-    lazy : bool, optional
-        Lazily instantiate the signal. If False, the signal will be
-        instantiated upon component instantiation
-    trigger_value : any, optional
-        Mark as a signal to be set on trigger. The value is sent to the signal
-        at trigger time.
-    add_prefix : sequence, optional
-        Keys in the kwargs to prefix with the Device PV prefix during
-        creation of the component instance.
-        Defaults to ('suffix', 'write_pv', )
-    doc : str, optional
-        string to attach to component DvcClass.component.__doc__
-    '''
-
-    def __init__(self, cls, suffix=None, *, lazy=False, trigger_value=None,
-                 add_prefix=None, doc=None, **kwargs):
-        self.attr = None  # attr is set later by the device when known
-        self.cls = cls
-        self.kwargs = kwargs
-        self.lazy = lazy
-        self.suffix = suffix
-        self.doc = doc
-        self.trigger_value = trigger_value  # TODO discuss
-
-        if add_prefix is None:
-            add_prefix = ('suffix', 'write_pv')
-
-        self.add_prefix = tuple(add_prefix)
-
-    def maybe_add_prefix(self, instance, kw, suffix):
-        """Add prefix to a suffix if kw is in self.add_prefix
-
-        Parameters
-        ----------
-        instance : Device
-            The instance to extract the prefix to maybe append to the
-            suffix from.
-
-        kw : str
-            The key of associated with the suffix.  If this key is
-            self.add_prefix than prepend the prefix to the suffix and
-            return, else just return the suffix.
-
-        suffix : str
-            The suffix to maybe have something prepended to.
-
-        Returns
-        -------
-        str
-        """
-        if kw in self.add_prefix:
-            return '{prefix}{suffix}'.format(prefix=instance.prefix,
-                                             suffix=suffix)
-        return suffix
-
-    def create_component(self, instance):
-        '''Create a component for the instance'''
-        kwargs = self.kwargs.copy()
-        kwargs['name'] = '{}_{}'.format(instance.name, self.attr)
-
-        for kw, val in list(kwargs.items()):
-            kwargs[kw] = self.maybe_add_prefix(instance, kw, val)
-
-        if self.suffix is not None:
-            pv_name = self.maybe_add_prefix(instance, 'suffix', self.suffix)
-            cpt_inst = self.cls(pv_name, parent=instance, **kwargs)
-        else:
-            cpt_inst = self.cls(parent=instance, **kwargs)
-
-        if self.lazy and hasattr(self.cls, 'wait_for_connection'):
-            cpt_inst.wait_for_connection()
-
-        return cpt_inst
-
-    def make_docstring(self, parent_class):
-        if self.doc is not None:
-            return self.doc
-
-        doc = ['{} attribute'.format(self.__class__.__name__),
-               '::',
-               '',
-               ]
-
-        doc.append(textwrap.indent(repr(self), prefix=' ' * 4))
-        doc.append('')
-        return '\n'.join(doc)
-
-    def __repr__(self):
-        kw_str = ', '.join('{}={!r}'.format(k, v)
-                           for k, v in self.kwargs.items())
-        if self.suffix is not None:
-            suffix_str = '{!r}'.format(self.suffix)
-            if self.kwargs:
-                suffix_str += ', '
-        else:
-            suffix_str = ''
-
-        if suffix_str or kw_str:
-            arg_str = ', {}{}'.format(suffix_str, kw_str)
-        else:
-            arg_str = ''
-
-        return ('{self.__class__.__name__}({self.cls.__name__}{arg_str})'
-                ''.format(self=self, arg_str=arg_str))
-
-    def __get__(self, instance, owner):
-        if instance is None:
-            return self
-
-        if self.attr not in instance._signals:
-            instance._signals[self.attr] = self.create_component(instance)
-
-        return instance._signals[self.attr]
-
-    def __set__(self, instance, owner):
-        raise RuntimeError('Use .put()')
-
-
-class FormattedComponent(Component):
-    '''A Component which takes a dynamic format string
-
-    This differs from Component in that the parent prefix is not automatically
-    added onto the Component suffix. Additionally, `str.format()` style strings
-    are accepted, allowing access to Device instance attributes:
-
-    >>> from ophyd import (Component as C, FormattedComponent as FC)
-    >>> class MyDevice(Device):
-    ...     # A normal component, where 'suffix' is added to prefix verbatim
-    ...     cpt = C(EpicsSignal, 'suffix')
-    ...     # A formatted component, where 'self' refers to the Device instance
-    ...     ch = FC(EpicsSignal, '{self.prefix}{self._ch_name}')
-    ...
-    ...     def __init__(self, prefix, ch_name=None, **kwargs):
-    ...         self._ch_name = ch_name
-    ...         super().__init__(prefix, **kwargs)
-
-    >>> dev = MyDevice('prefix:', ch_name='some_channel', name='dev')
-    >>> print(dev.cpt.pvname)
-    prefix:suffix
-    >>> print(dev.ch.pvname)
-    prefix:some_channel
-
-    For additional documentation, refer to Component.
-    '''
-
-    def maybe_add_prefix(self, instance, kw, suffix):
-        if kw not in self.add_prefix:
-            return suffix
-
-        return suffix.format(self=instance)
-
-
-class DynamicDeviceComponent:
-    '''An Device component that dynamically creates a OphyDevice
-
-    Parameters
-    ----------
-    defn : OrderedDict
-        The definition of all attributes to be created, in the form of:
-            defn['attribute_name'] = (SignalClass, pv_suffix, keyword_arg_dict)
-        This will create an attribute on the sub-device of type `SignalClass`,
-        with a suffix of pv_suffix, which looks something like this:
-            parent.attribute_name = SignalClass(pv_suffix, **keyword_arg_dict)
-        Keep in mind that this is actually done in the metaclass creation, and
-        not exactly as written above.
-    clsname : str, optional
-        The name of the class to be generated
-        This defaults to {parent_name}{this_attribute_name.capitalize()}
-    doc : str, optional
-        The docstring to put on the dynamically generated class
-    '''
-
-    def __init__(self, defn, *, clsname=None, doc=None):
-        self.defn = defn
-        self.clsname = clsname
-        self.attr = None  # attr is set later by the device when known
-        self.lazy = False
-        self.doc = doc
-
-        # TODO: component compatibility
-        self.trigger_value = None
-        self.attrs = list(defn.keys())
-
-    def make_docstring(self, parent_class):
-        if self.doc is not None:
-            return self.doc
-
-        doc = ['{} comprised of'.format(self.__class__.__name__),
-               '::',
-               '',
-               ]
-
-        doc.append(textwrap.indent(repr(self), prefix=' ' * 4))
-        doc.append('')
-        return '\n'.join(doc)
-
-    def __repr__(self):
-        doc = []
-        for attr, (cls, suffix, kwargs) in self.defn.items():
-            kw_str = ', '.join('{}={!r}'.format(k, v)
-                               for k, v in kwargs.items())
-            if suffix is not None:
-                suffix_str = '{!r}'.format(suffix)
-                if kwargs:
-                    suffix_str += ', '
-            else:
-                suffix_str = ''
-
-            if suffix_str or kw_str:
-                arg_str = ', {}{}'.format(suffix_str, kw_str)
-            else:
-                arg_str = ''
-
-            doc.append('{attr} = Component({cls.__name__}{arg_str})'
-                       ''.format(attr=attr, cls=cls, arg_str=arg_str))
-
-        return '\n'.join(doc)
-
-    def create_attr(self, attr_name):
-        cls, suffix, kwargs = self.defn[attr_name]
-        inst = Component(cls, suffix, **kwargs)
-        inst.attr = attr_name
-        return inst
-
-    def create_component(self, instance):
-        '''Create a component for the instance'''
-        clsname = self.clsname
-        if clsname is None:
-            # make up a class name based on the instance's class name
-            clsname = ''.join((instance.__class__.__name__,
-                               self.attr.capitalize()))
-
-            # TODO: and if the attribute has any underscores, convert that to
-            #       camelcase
-
-        docstring = self.doc
-        if docstring is None:
-            docstring = '{} sub-device'.format(clsname)
-
-        clsdict = OrderedDict(__doc__=docstring)
-
-        for attr in self.defn.keys():
-            clsdict[attr] = self.create_attr(attr)
-
-        attrs = set(self.defn.keys())
-        inst_read = set(instance.read_attrs)
-        if self.attr in inst_read:
-            # if the sub-device is in the read list, then add all attrs
-            read_attrs = attrs
-        else:
-            # otherwise, only add the attributes that exist in the sub-device
-            # to the read_attrs list
-            read_attrs = inst_read.intersection(attrs)
-
-        cls = type(clsname, (Device, ), clsdict)
-        return cls(instance.prefix, read_attrs=list(read_attrs),
-                   name='{}_{}'.format(instance.name, self.attr),
-                   parent=instance)
-
-    def __get__(self, instance, owner):
-        if instance is None:
-            return self
-
-        if self.attr not in instance._signals:
-            instance._signals[self.attr] = self.create_component(instance)
-
-        return instance._signals[self.attr]
-
-    def __set__(self, instance, owner):
-        raise RuntimeError('Use .put()')
-
-
-class ComponentMeta(type):
-    '''Creates attributes for Components by inspecting class definition'''
-
-    @classmethod
-    def __prepare__(self, name, bases):
-        '''Prepare allows the class attribute dictionary to be ordered as
-        defined by the user'''
-        return OrderedDict()
-
-    def __new__(cls, name, bases, clsdict):
-        clsobj = super().__new__(cls, name, bases, clsdict)
-
-        RESERVED_ATTRS = ['name', 'parent', 'signal_names', '_signals',
-                          'read_attrs', 'configuration_attrs', '_sig_attrs',
-                          '_sub_devices']
-        for attr in RESERVED_ATTRS:
-            if attr in clsdict:
-                raise TypeError("The attribute name %r is reserved for "
-                                "use by the Device class. Choose a different "
-                                "name." % attr)
-
-        clsobj._sig_attrs = OrderedDict()
-        for base in reversed(bases):
-            if not hasattr(base, '_sig_attrs'):
-                continue
-
-            for attr, cpt in base._sig_attrs.items():
-                clsobj._sig_attrs[attr] = cpt
-
-        # map component classes to their attribute names from this class
-        for attr, value in clsdict.items():
-            if isinstance(value, (Component, DynamicDeviceComponent)):
-                clsobj._sig_attrs[attr] = value
-
-        for cpt_attr, cpt in clsobj._sig_attrs.items():
-            # Notify the component of their attribute name
-            cpt.attr = cpt_attr
-
-        # List Signal attribute names.
-        clsobj.signal_names = list(clsobj._sig_attrs.keys())
-
-        # The namedtuple associated with the device
-        clsobj._device_tuple = namedtuple(name + 'Tuple', clsobj.signal_names,
-                                          rename=True)
-
-        # Finally, create all the component docstrings
-        for cpt in clsobj._sig_attrs.values():
-            cpt.__doc__ = cpt.make_docstring(clsobj)
-
-        # List the attributes that are Devices (not Signals).
-        # This list is used by stage/unstage. Only Devices need to be staged.
-        clsobj._sub_devices = []
-        for attr, cpt in clsobj._sig_attrs.items():
-            if isinstance(cpt, Component) and not issubclass(cpt.cls, Device):
-                continue
-            clsobj._sub_devices.append(attr)
-
-        return clsobj
-
-
-# These stub 'Interface' classes are the apex of the mro heirarchy for
-# their respective methods. They make multiple interitance more
-# forgiving, and let us define classes that customize these methods
-# but are not full Devices.
-
-
-class BlueskyInterface:
-    """Classes that inherit from this can safely customize the
-    these methods without breaking mro."""
-    def __init__(self, *args, **kwargs):
-        # Subclasses can populate this with (signal, value) pairs, to be
-        # set by stage() and restored back by unstage().
-        self.stage_sigs = OrderedDict()
-
-        self._staged = Staged.no
-        self._original_vals = OrderedDict()
-        super().__init__(*args, **kwargs)
-
-    def trigger(self):
-        pass
-
-    def read(self):
-        return OrderedDict()
-
-    def describe(self):
-        return OrderedDict()
-
-    def stage(self):
-        """
-        Prepare the device to be triggered.
-
-        Returns
-        -------
-        devices : list
-            list including self and all child devices staged
-        """
-        if self._staged == Staged.no:
-            pass  # to short-circuit checking individual cases
-        elif self._staged == Staged.yes:
-            raise RedundantStaging("Device {!r} is already staged. "
-                                   "Unstage it first.".format(self))
-        elif self._staged == Staged.partially:
-            raise RedundantStaging("Device {!r} has been partially staged. "
-                                   "Maybe the most recent unstaging "
-                                   "encountered an error before finishing. "
-                                   "Try unstaging again.".format(self))
-        logger.debug("Staging %s", self.name)
-        self._staged = Staged.partially
-
-        # Read current values, to be restored by unstage()
-        original_vals = {sig: sig.get() for sig, _ in self.stage_sigs.items()}
-
-        # We will add signals and values from original_vals to
-        # self._original_vals one at a time so that
-        # we can undo our partial work in the event of an error.
-
-        # Apply settings.
-        devices_staged = []
-        try:
-            for sig, val in self.stage_sigs.items():
-                logger.debug("Setting %s to %r (original value: %r)", self.name,
-                             val, original_vals[sig])
-                set_and_wait(sig, val)
-                # It worked -- now add it to this list of sigs to unstage.
-                self._original_vals[sig] = original_vals[sig]
-            devices_staged.append(self)
-
-            # Call stage() on child devices.
-            for attr in self._sub_devices:
-                device = getattr(self, attr)
-                if hasattr(device, 'stage'):
-                    device.stage()
-                    devices_staged.append(device)
-        except Exception:
-            logger.debug("An exception was raised while staging %s or "
-                         "one of its children. Attempting to restore "
-                         "original settings before re-raising the "
-                         "exception.", self.name)
-            self.unstage()
-            raise
-        else:
-            self._staged = Staged.yes
-        return devices_staged
-
-    def unstage(self):
-        """
-        Restore the device to 'standby'.
-
-        Multiple calls (without a new call to 'stage') have no effect.
-
-        Returns
-        -------
-        devices : list
-            list including self and all child devices unstaged
-        """
-        logger.debug("Unstaging %s", self.name)
-        self._staged = Staged.partially
-        devices_unstaged = []
-
-        # Call unstage() on child devices.
-        for attr in self._sub_devices[::-1]:
-            device = getattr(self, attr)
-            if hasattr(device, 'unstage'):
-                device.unstage()
-                devices_unstaged.append(device)
-
-        # Restore original values.
-        for sig, val in reversed(list(self._original_vals.items())):
-            logger.debug("Setting %s back to its original value: %r)", self.name,
-                         val)
-            set_and_wait(sig, val)
-            self._original_vals.pop(sig)
-        devices_unstaged.append(self)
-
-        self._staged = Staged.no
-        return devices_unstaged
-
-    def pause(self):
-        pass
-
-    def resume(self):
-        pass
-
-
-class GenerateDatumInterface:
-    """Classes that inherit from this can safely customize the
-    `generate_datum` method without breaking mro. If used along with the
-    BlueskyInterface, inherit from this second."""
-    def generate_datum(self, key, timestamp):
-        pass
-
-
-
[docs]class Device(BlueskyInterface, OphydObject, metaclass=ComponentMeta): - """Base class for device objects - - This class provides attribute access to one or more Signals, which can be - a mixture of read-only and writable. All must share the same base_name. - - Parameters - ---------- - prefix : str - The PV prefix for all components of the device - read_attrs : sequence of attribute names - the components to include in a normal reading (i.e., in ``read()``) - configuration_attrs : sequence of attribute names - the components to be read less often (i.e., in - ``read_configuration()``) and to adjust via ``configure()`` - name : str, optional - The name of the device - parent : instance or None - The instance of the parent device, if applicable - """ - - SUB_ACQ_DONE = 'acq_done' # requested acquire - - def __init__(self, prefix, *, read_attrs=None, configuration_attrs=None, - name=None, parent=None, **kwargs): - # Store EpicsSignal objects (only created once they are accessed) - self._signals = {} - - self.prefix = prefix - if self.signal_names and prefix is None: - raise ValueError('Must specify prefix if device signals are being ' - 'used') - - if name is None: - name = prefix - - super().__init__(name=name, parent=parent, **kwargs) - - if read_attrs is None: - read_attrs = self.signal_names - - if configuration_attrs is None: - configuration_attrs = [] - - self.read_attrs = list(read_attrs) - self.configuration_attrs = list(configuration_attrs) - - # Instantiate non-lazy signals - [getattr(self, attr) for attr, cpt in self._sig_attrs.items() - if not cpt.lazy] - -
[docs] def wait_for_connection(self, all_signals=False, timeout=2.0): - '''Wait for signals to connect - - Parameters - ---------- - all_signals : bool, optional - Wait for all signals to connect (including lazy ones) - timeout : float or None - Overall timeout - ''' - names = [attr for attr, cpt in self._sig_attrs.items() - if not cpt.lazy or all_signals] - - # Instantiate first to kickoff connection process - signals = [getattr(self, name) for name in names] - - t0 = ttime.time() - while timeout is None or (ttime.time() - t0) < timeout: - connected = [sig.connected for sig in signals] - if all(connected): - return - ttime.sleep(min((0.05, timeout / 10.0))) - - unconnected = ', '.join(self._get_unconnected()) - raise TimeoutError('Failed to connect to all signals: {}' - ''.format(unconnected))
- - def _get_unconnected(self): - '''Yields all of the signal pvnames or prefixes that are unconnected - - This recurses throughout the device hierarchy, only checking signals - that have already been instantiated. - ''' - for attr, sig in self.get_instantiated_signals(): - if sig.connected: - continue - - if hasattr(sig, 'pvname'): - prefix = sig.pvname - else: - prefix = sig.prefix - - yield '{} ({})'.format(attr, prefix) - - def get_instantiated_signals(self, *, attr_prefix=None): - '''Yields all of the instantiated signals in a device hierarchy - - Parameters - ---------- - attr_prefix : string, optional - The attribute prefix. If None, defaults to self.name - - Yields - ------ - (fully_qualified_attribute_name, signal_instance) - ''' - if attr_prefix is None: - attr_prefix = self.name - - for attr, sig in self._signals.items(): - # fully qualified attribute name from top-level device - full_attr = '{}.{}'.format(attr_prefix, attr) - if isinstance(sig, Device): - yield from sig.get_instantiated_signals(attr_prefix=full_attr) - else: - yield full_attr, sig - - @property - def connected(self): - return all(signal.connected for name, signal in self._signals.items()) - - def __getattr__(self, name): - '''Get a component from a fully-qualified name - - As a reminder, __getattr__ is only called if a real attribute doesn't - already exist, or a device component has yet to be instantiated. - ''' - if '.' not in name: - try: - # Initial access of signal - cpt = self._sig_attrs[name] - return cpt.__get__(self, None) - except KeyError: - raise AttributeError(name) - - attr_names = name.split('.') - try: - attr = getattr(self, attr_names[0]) - except AttributeError: - raise AttributeError('{} of {}'.format(attr_names[0], name)) - - if len(attr_names) > 1: - sub_attr_names = '.'.join(attr_names[1:]) - return getattr(attr, sub_attr_names) - - return attr - - def _read_attr_list(self, attr_list, *, config=False): - '''Get a 'read' dictionary containing attributes in attr_list''' - values = OrderedDict() - for attr in attr_list: - obj = getattr(self, attr) - if config: - values.update(obj.read_configuration()) - - values.update(obj.read()) - - return values - -
[docs] def read(self): - """returns dictionary mapping names to (value, timestamp) pairs - - To control which fields are included, adjust the ``read_attrs`` list. - """ - res = super().read() - res.update(self._read_attr_list(self.read_attrs)) - return res
- -
[docs] def read_configuration(self): - """ - returns dictionary mapping names to (value, timestamp) pairs - - To control which fields are included, adjust the - ``configuration_attrs`` list. - """ - return self._read_attr_list(self.configuration_attrs, config=True)
- - def _describe_attr_list(self, attr_list, *, config=False): - '''Get a 'describe' dictionary containing attributes in attr_list''' - desc = OrderedDict() - for attr in attr_list: - obj = getattr(self, attr) - if config: - desc.update(obj.describe_configuration()) - - desc.update(obj.describe()) - - return desc - -
[docs] def describe(self): - '''describe the read data keys' data types and other metadata''' - res = super().describe() - res.update(self._describe_attr_list(self.read_attrs)) - return res
- -
[docs] def describe_configuration(self): - '''describe the configuration data keys' data types/other metadata''' - return self._describe_attr_list(self.configuration_attrs, config=True)
- - @property - def trigger_signals(self): - names = [attr for attr, cpt in self._sig_attrs.items() - if cpt.trigger_value is not None] - - return [getattr(self, name) for name in names] - - def _done_acquiring(self, **kwargs): - '''Call when acquisition has completed.''' - self._run_subs(sub_type=self.SUB_ACQ_DONE, - success=True, **kwargs) - - self._reset_sub(self.SUB_ACQ_DONE) - -
[docs] def trigger(self): - """Start acquisition""" - signals = self.trigger_signals - if len(signals) > 1: - raise NotImplementedError('More than one trigger signal is not ' - 'currently supported') - status = DeviceStatus(self) - if not signals: - status._finished() - return status - - acq_signal, = signals - - self.subscribe(status._finished, - event_type=self.SUB_ACQ_DONE, run=False) - - def done_acquisition(**ignored_kwargs): - # Keyword arguments are ignored here from the EpicsSignal - # subscription, as the important part is that the put completion - # has finished - self._done_acquiring() - - acq_signal.put(1, wait=False, callback=done_acquisition) - return status
- - def stop(self): - '''Stop the Device and all (instantiated) subdevices''' - exc_list = [] - - for attr in self._sub_devices: - dev = getattr(self, attr) - - if not dev.connected: - logger.debug('stop: device %s (%s) is not connected; ' - 'skipping', attr, dev) - continue - - try: - dev.stop() - except ExceptionBundle as ex: - exc_list.extend([('{}.{}'.format(attr, sub_attr), ex) - for sub_attr, ex in ex.exceptions.items()]) - except Exception as ex: - exc_list.append((attr, ex)) - logger.error('Device %s (%s) stop failed', attr, dev, - exc_info=ex) - - if exc_list: - exc_info = '\n'.join('{} raised {!r}'.format(attr, ex) - for attr, ex in exc_list) - raise ExceptionBundle('{} exception(s) were raised during stop: \n' - '{}'.format(len(exc_list), exc_info), - exceptions=dict(exc_list)) - -
[docs] def get(self, **kwargs): - '''Get the value of all components in the device - - Keyword arguments are passed onto each signal.get() - ''' - values = {} - for attr in self.signal_names: - signal = getattr(self, attr) - values[attr] = signal.get(**kwargs) - - return self._device_tuple(**values)
- -
[docs] def put(self, dev_t, **kwargs): - '''Put a value to all components of the device - - Keyword arguments are passed onto each signal.put() - - Parameters - ---------- - dev_t : DeviceTuple or tuple - The device tuple with the value(s) to put (see get_device_tuple) - ''' - if not isinstance(dev_t, self._device_tuple): - try: - dev_t = self._device_tuple(dev_t) - except TypeError as ex: - raise ValueError('{}\n\tDevice tuple fields: {}' - ''.format(ex, self._device_tuple._fields)) - - for attr in self.signal_names: - value = getattr(dev_t, attr) - signal = getattr(self, attr) - signal.put(value, **kwargs)
- - @classmethod -
[docs] def get_device_tuple(cls): - '''The device tuple type associated with an Device class - - This is a tuple representing the full state of all components and - dynamic device sub-components. - ''' - return cls._device_tuple
- -
[docs] def configure(self, d): - '''Configure the device for something during a run - - This default implementation allows the user to change any of the - `configuration_attrs`. Subclasses might override this to perform - additional input validation, cleanup, etc. - - Parameters - ---------- - d : dict - The configuration dictionary. To specify the order that - the changes should be made, use an OrderedDict. - - Returns - ------- - (old, new) tuple of dictionaries - Where old and new are pre- and post-configure configuration states. - ''' - old = self.read_configuration() - for key, val in d.items(): - if key not in self.configuration_attrs: - # a little extra checking for a more specific error msg - if key not in self.signal_names: - raise ValueError("There is no signal named %s" % key) - else: - raise ValueError("%s is not one of the " - "configuration_fields, so it cannot be " - "changed using configure" % key) - set_and_wait(getattr(self, key), val) - new = self.read_configuration() - return old, new
- - def _repr_info(self): - yield ('prefix', self.prefix) - yield from super()._repr_info() - - yield ('read_attrs', self.read_attrs) - yield ('configuration_attrs', self.configuration_attrs)
-
- -
-
- - -
-
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_modules/ophyd/epics_motor.html b/ophyd/_modules/ophyd/epics_motor.html deleted file mode 100644 index 192a9b3097..0000000000 --- a/ophyd/_modules/ophyd/epics_motor.html +++ /dev/null @@ -1,457 +0,0 @@ - - - - - - - - - - - ophyd.epics_motor — ophyd documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
-
- - - - - - -
- -
-
-
-
- -

Source code for ophyd.epics_motor

-import logging
-
-from epics.pv import fmt_time
-
-from .signal import (EpicsSignal, EpicsSignalRO)
-from .utils import DisconnectedError
-from .utils.epics_pvs import raise_if_disconnected
-from .positioner import PositionerBase
-from .device import (Device, Component as Cpt)
-from .status import wait as status_wait
-from enum import Enum
-
-
-logger = logging.getLogger(__name__)
-
-
-class HomeEnum(str, Enum):
-    forward = "forward"
-    reverse = "reverse"
-
-
-
[docs]class EpicsMotor(Device, PositionerBase): - '''An EPICS motor record, wrapped in a :class:`Positioner` - - Keyword arguments are passed through to the base class, Positioner - - Parameters - ---------- - prefix : str - The record to use - read_attrs : sequence of attribute names - The signals to be read during data acquisition (i.e., in read() and - describe() calls) - name : str, optional - The name of the device - parent : instance or None - The instance of the parent device, if applicable - settle_time : float, optional - The amount of time to wait after moves to report status completion - timeout : float, optional - The default timeout to use for motion requests, in seconds. - ''' - user_offset = Cpt(EpicsSignal, '.OFF') - user_readback = Cpt(EpicsSignalRO, '.RBV') - user_setpoint = Cpt(EpicsSignal, '.VAL', limits=True) - motor_egu = Cpt(EpicsSignal, '.EGU') - motor_is_moving = Cpt(EpicsSignalRO, '.MOVN') - motor_done_move = Cpt(EpicsSignalRO, '.DMOV') - motor_stop = Cpt(EpicsSignal, '.STOP') - offset_freeze_switch = Cpt(EpicsSignal, '.FOFF') - velocity = Cpt(EpicsSignal, '.VELO') - acceleration = Cpt(EpicsSignal, '.ACCL') - set_use_switch = Cpt(EpicsSignal, '.SET') - high_limit_switch = Cpt(EpicsSignal, '.HLS') - low_limit_switch = Cpt(EpicsSignal, '.LLS') - home_forward = Cpt(EpicsSignal, '.HOMF') - home_reverse = Cpt(EpicsSignal, '.HOMR') - direction_of_travel = Cpt(EpicsSignal, '.TDIR') - - def __init__(self, prefix, *, read_attrs=None, configuration_attrs=None, - name=None, parent=None, **kwargs): - if read_attrs is None: - read_attrs = ['user_readback', 'user_setpoint'] - - if configuration_attrs is None: - configuration_attrs = ['motor_egu', ] - - super().__init__(prefix, read_attrs=read_attrs, - configuration_attrs=configuration_attrs, - name=name, parent=parent, **kwargs) - - # Make the default alias for the user_readback the name of the - # motor itself. - self.user_readback.name = self.name - - self.motor_done_move.subscribe(self._move_changed) - self.user_readback.subscribe(self._pos_changed) - - @property - @raise_if_disconnected - def precision(self): - '''The precision of the readback PV, as reported by EPICS''' - return self.user_readback.precision - - @property - @raise_if_disconnected - def egu(self): - '''The engineering units (EGU) for a position''' - return self.motor_egu.get() - - @property - @raise_if_disconnected - def limits(self): - return self.user_setpoint.limits - - @property - @raise_if_disconnected - def moving(self): - '''Whether or not the motor is moving - - Returns - ------- - moving : bool - ''' - return bool(self.motor_is_moving.get(use_monitor=False)) - - @raise_if_disconnected - def stop(self): - self.motor_stop.put(1, wait=False) - super().stop() - - @raise_if_disconnected -
[docs] def move(self, position, wait=True, **kwargs): - '''Move to a specified position, optionally waiting for motion to - complete. - - Parameters - ---------- - position - Position to move to - moved_cb : callable - Call this callback when movement has finished. This callback must - accept one keyword argument: 'obj' which will be set to this - positioner instance. - timeout : float, optional - Maximum time to wait for the motion. If None, the default timeout - for this positioner is used. - - Returns - ------- - status : MoveStatus - - Raises - ------ - TimeoutError - When motion takes longer than `timeout` - ValueError - On invalid positions - RuntimeError - If motion fails other than timing out - ''' - self._started_moving = False - - status = super().move(position, **kwargs) - self.user_setpoint.put(position, wait=False) - - try: - if wait: - status_wait(status) - except KeyboardInterrupt: - self.stop() - raise - - return status
- - @property - @raise_if_disconnected - def position(self): - '''The current position of the motor in its engineering units - - Returns - ------- - position : float - ''' - return self._position - - @raise_if_disconnected -
[docs] def set_current_position(self, pos): - '''Configure the motor user position to the given value - - Parameters - ---------- - pos - Position to set. - - ''' - self.set_use_switch.put(1, wait=True) - self.user_setpoint.put(pos, wait=True) - self.set_use_switch.put(0, wait=True)
- - @raise_if_disconnected -
[docs] def home(self, direction, wait=True, **kwargs): - '''Perform the default homing function in the desired direction - - Parameters - ---------- - direction : HomeEnum - Direction in which to perform the home search. - ''' - direction = HomeEnum(direction) - - self._started_moving = False - position = (self.low_limit+self.high_limit)/2 - status = super().move(position, **kwargs) - - if direction == HomeEnum.forward: - self.home_forward.put(1, wait=False) - else: - self.home_reverse.put(1, wait=False) - - try: - if wait: - status_wait(status) - except KeyboardInterrupt: - self.stop() - raise - - return status
- -
[docs] def check_value(self, pos): - '''Check that the position is within the soft limits''' - self.user_setpoint.check_value(pos)
- - def _pos_changed(self, timestamp=None, value=None, **kwargs): - '''Callback from EPICS, indicating a change in position''' - self._set_position(value) - - def _move_changed(self, timestamp=None, value=None, sub_type=None, - **kwargs): - '''Callback from EPICS, indicating that movement status has changed''' - was_moving = self._moving - self._moving = (value != 1) - - started = False - if not self._started_moving: - started = self._started_moving = (not was_moving and self._moving) - - logger.debug('[ts=%s] %s moving: %s (value=%s)', fmt_time(timestamp), - self, self._moving, value) - - if started: - self._run_subs(sub_type=self.SUB_START, timestamp=timestamp, - value=value, **kwargs) - - if was_moving and not self._moving: - success = True - # Check if we are moving towards the low limit switch - if self.direction_of_travel.get() == 0: - if self.low_limit_switch.get() == 1: - success = False - # No, we are going to the high limit switch - else: - if self.high_limit_switch.get() == 1: - success = False - - self._done_moving(success=success, timestamp=timestamp, value=value) - - @property - def report(self): - try: - rep = super().report - except DisconnectedError: - # TODO there might be more in this that gets lost - rep = {'position': 'disconnected'} - rep['pv'] = self.user_readback.pvname - return rep
-
- -
-
- - -
-
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_modules/ophyd/mca.html b/ophyd/_modules/ophyd/mca.html deleted file mode 100644 index 7c182d9666..0000000000 --- a/ophyd/_modules/ophyd/mca.html +++ /dev/null @@ -1,611 +0,0 @@ - - - - - - - - - - - ophyd.mca — ophyd documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
-
- - - - - - -
- -
-
-
-
- -

Source code for ophyd.mca

-
-import logging
-
-from collections import OrderedDict
-
-from .status import DeviceStatus
-from .signal import (Signal, EpicsSignal, EpicsSignalRO)
-from .device import (Device, Component as C, DynamicDeviceComponent as DDC,
-                     Staged, BlueskyInterface)
-from .areadetector import EpicsSignalWithRBV as SignalWithRBV
-
-
-logger = logging.getLogger(__name__)
-
-
-class ROI(Device):
-
-    # 'name' is not an allowed attribute
-    label = C(EpicsSignal, 'NM', lazy=True)
-    count = C(EpicsSignalRO, '', lazy=True)
-    net_count = C(EpicsSignalRO, 'N', lazy=True)
-    preset_count = C(EpicsSignal, 'P', lazy=True)
-    is_preset = C(EpicsSignal, 'IP', lazy=True)
-    bkgnd_chans = C(EpicsSignal, 'BG', lazy=True)
-    hi_chan = C(EpicsSignal, 'HI', lazy=True)
-    lo_chan = C(EpicsSignal, 'LO', lazy=True)
-
-    def __init__(self, prefix, *, read_attrs=None, configuration_attrs=None,
-                 name=None, parent=None, **kwargs):
-
-        super().__init__(prefix, read_attrs=read_attrs,
-                         configuration_attrs=configuration_attrs,
-                         name=name, parent=parent, **kwargs)
-
-
-def add_rois(range_, **kwargs):
-    '''Add one or more ROIs to an MCA instance
-
-       Parameters:
-       -----------
-       range_ : sequence of ints
-           Must be be in the set [0,31]
-
-       By default, an EpicsMCA is initialized with all 32 rois.
-       These provide the following Components as EpicsSignals (N=[0,31]):
-       EpicsMCA.rois.roiN.(label,count,net_count,preset_cnt, is_preset,
-       bkgnd_chans, hi_chan, lo_chan)
-       '''
-    defn = OrderedDict()
-
-    for roi in range_:
-        if not (0 <= roi < 32):
-            raise ValueError('roi must be in the set [0,31]')
-
-        attr = 'roi{}'.format(roi)
-        defn[attr] = (ROI, '.R{}'.format(roi), kwargs)
-
-    return defn
-
-
-
[docs]class EpicsMCARecord(Device): - '''SynApps MCA Record interface''' - stop_signal = C(EpicsSignal, '.STOP') - preset_real_time = C(EpicsSignal, '.PRTM') - preset_live_time = C(EpicsSignal, '.PLTM') - elapsed_real_time = C(EpicsSignalRO, '.ERTM') - elapsed_live_time = C(EpicsSignalRO, '.ELTM') - - spectrum = C(EpicsSignalRO, '.VAL') - background = C(EpicsSignalRO, '.BG') - mode = C(EpicsSignal, '.MODE', string=True) - - rois = DDC(add_rois(range(0, 32))) - - def __init__(self, prefix, *, read_attrs=None, configuration_attrs=None, - name=None, parent=None, **kwargs): - - if read_attrs is None: - read_attrs = ['spectrum', 'preset_real_time', 'elapsed_real_time'] - - if configuration_attrs is None: - configuration_attrs = ['preset_real_time'] - - super().__init__(prefix, read_attrs=read_attrs, - configuration_attrs=configuration_attrs, - name=name, parent=parent, **kwargs) - - # could arguably be made a configuration_attr instead... - self.stage_sigs[self.mode] = 'PHA' - - def stop(self): - self.stop_signal.put(1)
- - -class EpicsMCA(EpicsMCARecord): - '''mca records with extras from mca.db''' - start = C(EpicsSignal, 'Start') - stop_signal = C(EpicsSignal, 'Stop') - erase = C(EpicsSignal, 'Erase') - erase_start = C(EpicsSignal, 'EraseStart', trigger_value=1) - - check_acquiring = C(EpicsSignal, 'CheckACQG') - client_wait = C(EpicsSignal, 'ClientWait') - enable_wait = C(EpicsSignal, 'EnableWait') - read = C(EpicsSignal, 'Read') - set_client_wait = C(EpicsSignal, 'SetClientWait') - status = C(EpicsSignal, 'Status') - when_acq_stops = C(EpicsSignal, 'WhenAcqStops') - why1 = C(EpicsSignal, 'Why1') - why2 = C(EpicsSignal, 'Why2') - why3 = C(EpicsSignal, 'Why3') - why4 = C(EpicsSignal, 'Why4') - - -class EpicsMCAReadNotify(EpicsMCARecord): - '''mca record with extras from mcaReadNotify.db''' - start = C(EpicsSignal, 'Start') - stop_signal = C(EpicsSignal, 'Stop') - erase = C(EpicsSignal, 'Erase') - erase_start = C(EpicsSignal, 'EraseStart', trigger_value=1) - - check_acquiring = C(EpicsSignal, 'CheckACQG') - client_wait = C(EpicsSignal, 'ClientWait') - enable_wait = C(EpicsSignal, 'EnableWait') - read = C(EpicsSignal, 'Read') - set_client_wait = C(EpicsSignal, 'SetClientWait') - status = C(EpicsSignal, 'Status') - - -class EpicsMCACallback(Device): - '''Callback-related signals for MCA devices''' - read_callback = C(EpicsSignal, 'ReadCallback') - read_data_once = C(EpicsSignal, 'ReadDataOnce') - read_status_once = C(EpicsSignal, 'ReadStatusOnce') - collect_data = C(EpicsSignal, 'CollectData') - - -
[docs]class EpicsDXP(Device): - '''All high-level DXP parameters for each channel''' - preset_mode = C(EpicsSignal, 'PresetMode', string=True) - - live_time_output = C(SignalWithRBV, 'LiveTimeOutput', string=True) - elapsed_live_time = C(EpicsSignal, 'ElapsedLiveTime') - elapsed_real_time = C(EpicsSignal, 'ElapsedRealTime') - elapsed_trigger_live_time = C(EpicsSignal, 'ElapsedTriggerLiveTime') - - # Trigger Filter PVs - trigger_peaking_time = C(SignalWithRBV, 'TriggerPeakingTime') - trigger_threshold = C(SignalWithRBV, 'TriggerThreshold') - trigger_gap_time = C(SignalWithRBV, 'TriggerGapTime') - trigger_output = C(SignalWithRBV, 'TriggerOutput', string=True) - max_width = C(SignalWithRBV, 'MaxWidth') - - # Energy Filter PVs - peaking_time = C(SignalWithRBV, 'PeakingTime') - energy_threshold = C(SignalWithRBV, 'EnergyThreshold') - gap_time = C(SignalWithRBV, 'GapTime') - - # Baseline PVs - baseline_cut_percent = C(SignalWithRBV, 'BaselineCutPercent') - baseline_cut_enable = C(SignalWithRBV, 'BaselineCutEnable') - baseline_filter_length = C(SignalWithRBV, 'BaselineFilterLength') - baseline_threshold = C(SignalWithRBV, 'BaselineThreshold') - baseline_energy_array = C(EpicsSignal, 'BaselineEnergyArray') - baseline_histogram = C(EpicsSignal, 'BaselineHistogram') - baseline_threshold = C(SignalWithRBV, 'BaselineThreshold') - - # Misc PVs - preamp_gain = C(SignalWithRBV, 'PreampGain') - detector_polarity = C(SignalWithRBV, 'DetectorPolarity') - reset_delay = C(SignalWithRBV, 'ResetDelay') - decay_time = C(SignalWithRBV, 'DecayTime') - max_energy = C(SignalWithRBV, 'MaxEnergy') - adc_percent_rule = C(SignalWithRBV, 'ADCPercentRule') - max_width = C(SignalWithRBV, 'MaxWidth') - - # read-only diagnostics - triggers = C(EpicsSignalRO, 'Triggers', lazy=True) - events = C(EpicsSignalRO, 'Events', lazy=True) - overflows = C(EpicsSignalRO, 'Overflows', lazy=True) - underflows = C(EpicsSignalRO, 'Underflows', lazy=True) - input_count_rate = C(EpicsSignalRO, 'InputCountRate', lazy=True) - output_count_rate = C(EpicsSignalRO, 'OutputCountRate', lazy=True) - - mca_bin_width = C(EpicsSignalRO, 'MCABinWidth_RBV') - calibration_energy = C(EpicsSignalRO, 'CalibrationEnergy_RBV') - current_pixel = C(EpicsSignal, 'CurrentPixel') - dynamic_range = C(EpicsSignalRO, 'DynamicRange_RBV') - - # Preset options - preset_events = C(SignalWithRBV, 'PresetEvents') - preset_mode = C(SignalWithRBV, 'PresetMode', string=True) - preset_triggers = C(SignalWithRBV, 'PresetTriggers') - - # Trace options - trace_data = C(EpicsSignal, 'TraceData') - trace_mode = C(SignalWithRBV, 'TraceMode', string=True) - trace_time_array = C(EpicsSignal, 'TraceTimeArray') - trace_time = C(SignalWithRBV, 'TraceTime')
- - -class EpicsDXPLowLevelParameter(Device): - param_name = C(EpicsSignal, 'Name') - value = C(SignalWithRBV, 'Val') - - -class EpicsDXPLowLevel(Device): - num_low_level_params = C(EpicsSignal, 'NumLLParams') - read_low_level_params = C(EpicsSignal, 'ReadLLParams') - - parameter_prefix = 'LL{}' - - def __init__(self, *args, **kwargs): - super().__init__(*args, **kwargs) - self._parameter_cache = {} - - def get_low_level_parameter(self, index): - '''Get a DXP low level parameter - - Parameters - ---------- - index : int - In the range of [0, 229] - - Returns - ------- - param : EpicsDXPLowLevelParameter - ''' - try: - return self._parameter_cache[index] - except KeyError: - pass - - prefix = '{}{}'.format(self.prefix, self.parameter_prefix) - name = '{}_param{}'.format(self.name, index) - param = EpicsDXPLowLevelParameter(prefix, name=name) - self._parameter_cache[index] = param - return param - - -class EpicsDXPMapping(Device): - apply = C(EpicsSignal, 'Apply') - auto_apply = C(SignalWithRBV, 'AutoApply') - auto_pixels_per_buffer = C(SignalWithRBV, 'AutoPixelsPerBuffer') - buffer_size = C(EpicsSignalRO, 'BufferSize_RBV') - collect_mode = C(SignalWithRBV, 'CollectMode') - ignore_gate = C(SignalWithRBV, 'IgnoreGate') - input_logic_polarity = C(SignalWithRBV, 'InputLogicPolarity') - list_mode = C(SignalWithRBV, 'ListMode') - mbytes_read = C(EpicsSignalRO, 'MBytesRead_RBV') - next_pixel = C(EpicsSignal, 'NextPixel') - pixel_advance_mode = C(SignalWithRBV, 'PixelAdvanceMode') - pixels_per_buffer = C(SignalWithRBV, 'PixelsPerBuffer') - pixels_per_run = C(SignalWithRBV, 'PixelsPerRun') - read_rate = C(EpicsSignalRO, 'ReadRate_RBV') - sync_count = C(SignalWithRBV, 'SyncCount') - - -class EpicsDXPBaseSystem(Device): - channel_advance = C(EpicsSignal, 'ChannelAdvance') - client_wait = C(EpicsSignal, 'ClientWait') - dwell = C(EpicsSignal, 'Dwell') - max_scas = C(EpicsSignal, 'MaxSCAs') - num_scas = C(SignalWithRBV, 'NumSCAs') - poll_time = C(SignalWithRBV, 'PollTime') - prescale = C(EpicsSignal, 'Prescale') - save_system = C(SignalWithRBV, 'SaveSystem') - save_system_file = C(EpicsSignal, 'SaveSystemFile') - set_client_wait = C(EpicsSignal, 'SetClientWait') - - -class EpicsDXPMultiElementSystem(EpicsDXPBaseSystem): - # Preset info - preset_events = C(EpicsSignal, 'PresetEvents') - preset_live_time = C(EpicsSignal, 'PresetLive') - preset_real_time = C(EpicsSignal, 'PresetReal') - preset_mode = C(EpicsSignal, 'PresetMode', string=True) - preset_triggers = C(EpicsSignal, 'PresetTriggers') - - # Acquisition - erase_all = C(EpicsSignal, 'EraseAll') - erase_start = C(EpicsSignal, 'EraseStart', trigger_value=1) - start_all = C(EpicsSignal, 'StartAll') - stop_all = C(EpicsSignal, 'StopAll') - - # Status - set_acquire_busy = C(EpicsSignal, 'SetAcquireBusy') - acquire_busy = C(EpicsSignal, 'AcquireBusy') - status_all = C(EpicsSignal, 'StatusAll') - status_all_once = C(EpicsSignal, 'StatusAllOnce') - acquiring = C(EpicsSignal, 'Acquiring') - - # Reading - read_baseline_histograms = C(EpicsSignal, 'ReadBaselineHistograms') - read_all = C(EpicsSignal, 'ReadAll') - read_all_once = C(EpicsSignal, 'ReadAllOnce') - - # As a debugging note, if snl_connected is not '1', your IOC is - # misconfigured: - snl_connected = C(EpicsSignal, 'SNL_Connected') - - # Copying to individual elements - copy_adcp_ercent_rule = C(EpicsSignal, 'CopyADCPercentRule') - copy_baseline_cut_enable = C(EpicsSignal, 'CopyBaselineCutEnable') - copy_baseline_cut_percent = C(EpicsSignal, 'CopyBaselineCutPercent') - copy_baseline_filter_length = C(EpicsSignal, 'CopyBaselineFilterLength') - copy_baseline_threshold = C(EpicsSignal, 'CopyBaselineThreshold') - copy_decay_time = C(EpicsSignal, 'CopyDecayTime') - copy_detector_polarity = C(EpicsSignal, 'CopyDetectorPolarity') - copy_energy_threshold = C(EpicsSignal, 'CopyEnergyThreshold') - copy_gap_time = C(EpicsSignal, 'CopyGapTime') - copy_max_energy = C(EpicsSignal, 'CopyMaxEnergy') - copy_max_width = C(EpicsSignal, 'CopyMaxWidth') - copy_peaking_time = C(EpicsSignal, 'CopyPeakingTime') - copy_preamp_gain = C(EpicsSignal, 'CopyPreampGain') - copy_roic_hannel = C(EpicsSignal, 'CopyROIChannel') - copy_roie_nergy = C(EpicsSignal, 'CopyROIEnergy') - copy_roi_sca = C(EpicsSignal, 'CopyROI_SCA') - copy_reset_delay = C(EpicsSignal, 'CopyResetDelay') - copy_trigger_gap_time = C(EpicsSignal, 'CopyTriggerGapTime') - copy_trigger_peaking_time = C(EpicsSignal, 'CopyTriggerPeakingTime') - copy_trigger_threshold = C(EpicsSignal, 'CopyTriggerThreshold') - - # do_* executes the process: - do_read_all = C(EpicsSignal, 'DoReadAll') - do_read_baseline_histograms = C(EpicsSignal, 'DoReadBaselineHistograms') - do_read_traces = C(EpicsSignal, 'DoReadTraces') - do_status_all = C(EpicsSignal, 'DoStatusAll') - - # Time - dead_time = C(EpicsSignal, 'DeadTime') - elapsed_live = C(EpicsSignal, 'ElapsedLive') - elapsed_real = C(EpicsSignal, 'ElapsedReal') - idead_time = C(EpicsSignal, 'IDeadTime') - - # low-level - read_low_level_params = C(EpicsSignal, 'ReadLLParams') - - # Traces - read_traces = C(EpicsSignal, 'ReadTraces') - trace_modes = C(EpicsSignal, 'TraceModes', string=True) - trace_times = C(EpicsSignal, 'TraceTimes') - - -class SaturnMCA(EpicsMCA, EpicsMCACallback): - pass - - -class SaturnDXP(EpicsDXP, EpicsDXPLowLevel): - pass - - -class Saturn(EpicsDXPBaseSystem): - '''DXP Saturn with 1 channel example''' - dxp = C(SaturnDXP, 'dxp1:') - mca = C(SaturnMCA, 'mca1') - - -class MercuryDXP(EpicsDXP, EpicsDXPLowLevel): - pass - - -class Mercury1(EpicsDXPMultiElementSystem): - '''DXP Mercury with 1 channel example''' - dxp = C(MercuryDXP, 'dxp1:') - mca = C(EpicsMCARecord, 'mca1') - - -class SoftDXPTrigger(BlueskyInterface): - '''Simple soft trigger for DXP devices - - Parameters - ---------- - count_signal : str, optional - Signal to set acquisition time (default: 'preset_real_time') - preset_mode : str, optional - Default preset mode for the stage signals (default: 'Real time') - mode_signal : str, optional - Preset mode signal attribute (default 'preset_mode') - stop_signal : str, optional - Stop signal attribute (default 'stop_all') - ''' - - count_time = C(Signal, value=None, doc='bluesky count time') - - def __init__(self, *args, count_signal='preset_real_time', - stop_signal='stop_all', mode_signal='preset_mode', - preset_mode='Real time', - **kwargs): - super().__init__(*args, **kwargs) - self._status = None - self._count_signal = getattr(self, count_signal) - - stop_signal = getattr(self, stop_signal) - self.stage_sigs[stop_signal] = 1 - - mode_signal = getattr(self, mode_signal) - self.stage_sigs[mode_signal] = preset_mode - - def stage(self): - if self.count_time.get() is None: - # remove count_time from the stage signals if count_time unset - try: - del self.stage_sigs[self._count_signal] - except KeyError: - pass - else: - self.stage_sigs[self._count_signal] = self.count_time.get() - - super().stage() -
- -
-
- - -
-
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_modules/ophyd/positioner.html b/ophyd/_modules/ophyd/positioner.html deleted file mode 100644 index cb148b081e..0000000000 --- a/ophyd/_modules/ophyd/positioner.html +++ /dev/null @@ -1,531 +0,0 @@ - - - - - - - - - - - ophyd.positioner — ophyd documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
-
- - - - - - -
- -
-
-
-
- -

Source code for ophyd.positioner

-import logging
-import time
-from functools import partial
-from collections import OrderedDict
-
-from .ophydobj import OphydObject
-from .status import (MoveStatus, wait as status_wait)
-from .utils.epics_pvs import (data_type, data_shape)
-
-logger = logging.getLogger(__name__)
-
-
-
[docs]class PositionerBase(OphydObject): - '''The positioner base class - - Subclass from this to implement your own positioners. - - Note: Subclasses should add an additional 'wait' keyword argument on the - move method. The MoveStatus object returned from PositionerBase can then be - waited on after the subclass finishes the motion configuration. - ''' - - SUB_START = 'start_moving' - SUB_DONE = 'done_moving' - SUB_READBACK = 'readback' - _SUB_REQ_DONE = '_req_done' # requested move finished subscription - _default_sub = SUB_READBACK - - def __init__(self, *, name=None, parent=None, settle_time=0.0, - timeout=None, **kwargs): - super().__init__(name=name, parent=parent, **kwargs) - - self._started_moving = False - self._moving = False - self._position = None - self._settle_time = settle_time - self._timeout = timeout - - @property - def report(self): - rep = super().report - rep['position'] = self.position - return rep - - @property - def settle_time(self): - '''Amount of time to wait after moves to report status completion''' - return self._settle_time - - @settle_time.setter - def settle_time(self, settle_time): - self._settle_time = settle_time - - @property - def timeout(self): - '''Amount of time to wait before to considering a motion as failed''' - return self._timeout - - @timeout.setter - def timeout(self, timeout): - if timeout is None: - self._timeout = None - else: - self._timeout = float(timeout) - - @property - def egu(self): - '''The engineering units (EGU) for positions''' - raise NotImplementedError('Subclass must implement egu') - - @property - def limits(self): - return (0, 0) - - @property - def low_limit(self): - return self.limits[0] - - @property - def high_limit(self): - return self.limits[1] - - def move(self, position, moved_cb=None, timeout=None): - '''Move to a specified position, optionally waiting for motion to - complete. - - Parameters - ---------- - position - Position to move to - moved_cb : callable - Call this callback when movement has finished. This callback - must accept one keyword argument: 'obj' which will be set to - this positioner instance. - timeout : float, optional - Maximum time to wait for the motion. If None, the default timeout - for this positioner is used. - - Returns - ------- - status : MoveStatus - - Raises - ------ - TimeoutError - When motion takes longer than `timeout` - ValueError - On invalid positions - RuntimeError - If motion fails other than timing out - ''' - if timeout is None: - timeout = self._timeout - - self.check_value(position) - - self._run_subs(sub_type=self._SUB_REQ_DONE, success=False) - self._reset_sub(self._SUB_REQ_DONE) - - status = MoveStatus(self, position, timeout=timeout, - settle_time=self._settle_time) - - if moved_cb is not None: - status.finished_cb = partial(moved_cb, obj=self) - # the status object will run this callback when finished - - self.subscribe(status._finished, event_type=self._SUB_REQ_DONE, - run=False) - - return status - - def _done_moving(self, success=True, timestamp=None, value=None, **kwargs): - '''Call when motion has completed. Runs SUB_DONE subscription.''' - if success: - self._run_subs(sub_type=self.SUB_DONE, timestamp=timestamp, - value=value) - - self._run_subs(sub_type=self._SUB_REQ_DONE, success=success, - timestamp=timestamp) - self._reset_sub(self._SUB_REQ_DONE) - - def stop(self): - '''Stops motion''' - self._done_moving(success=False) - - @property - def position(self): - '''The current position of the motor in its engineering units - - Returns - ------- - position : any - ''' - return self._position - - def _set_position(self, value, **kwargs): - '''Set the current internal position, run the readback subscription''' - self._position = value - - timestamp = kwargs.pop('timestamp', time.time()) - self._run_subs(sub_type=self.SUB_READBACK, timestamp=timestamp, - value=value, **kwargs) - - @property - def moving(self): - '''Whether or not the motor is moving - - Returns - ------- - moving : bool - ''' - return self._moving - - def set(self, new_position, *, wait=False, moved_cb=None, timeout=None): - """ - Bluesky-compatible API for controlling movers. - - Parameters - ---------- - new_position : dict - A dictionary of new positions keyed on axes name. This is - symmetric with read such that `mot.set(mot.read())` works as - as expected. - """ - return self.move(new_position, wait=wait, moved_cb=moved_cb, - timeout=timeout) - - def _repr_info(self): - yield from super()._repr_info() - yield ('settle_time', self._settle_time) - yield ('timeout', self._timeout)
- - -
[docs]class SoftPositioner(PositionerBase): - '''A positioner which does not communicate with any hardware - - SoftPositioner 'moves' immediately to the target position when commanded to - do so. - - Parameters - ---------- - limits : (low_limit, high_limit) - Soft limits to use - egu : str, optional - Engineering units (EGU) for a position - source : str, optional - Metadata indicating the source of this positioner's position. Defaults - to 'computed' - ''' - - def __init__(self, *, egu='', limits=None, source='computed', **kwargs): - super().__init__(**kwargs) - - self._egu = egu - if limits is None: - limits = (0, 0) - - self._limits = tuple(limits) - self.source = source - - @property - def limits(self): - return self._limits - - @property - def egu(self): - '''The engineering units (EGU) for positions''' - return self._egu - - def _setup_move(self, position, status): - '''Move requested to position - - This is a SoftPositioner method which allows customization of what - happens when a motion request happens without re-implementing - all of `move`. - - Parameters - ---------- - position : any - Position to move to (already verified by `check_value`) - status : MoveStatus - Status object created by PositionerBase.move() - ''' - # A soft positioner immediately 'moves' to the target position when - # requested. - self._run_subs(sub_type=self.SUB_START, timestamp=time.time()) - - self._started_moving = True - self._moving = False - - self._set_position(position) - self._done_moving() - - def move(self, position, wait=True, timeout=None, moved_cb=None): - '''Move to a specified position, optionally waiting for motion to - complete. - - Parameters - ---------- - position - Position to move to - moved_cb : callable - Call this callback when movement has finished. This callback - must accept one keyword argument: 'obj' which will be set to - this positioner instance. - wait : bool, optional - Wait until motion has completed - timeout : float, optional - Maximum time to wait for a motion - - Returns - ------- - status : MoveStatus - - Raises - ------ - TimeoutError - When motion takes longer than `timeout` - ValueError - On invalid positions - RuntimeError - If motion fails other than timing out - ''' - status = super().move(position, moved_cb=moved_cb, timeout=timeout) - - self._setup_move(position, status) - - if wait: - try: - status_wait(status) - except RuntimeError: - raise RuntimeError('Motion did not complete successfully') - - return status - - def _repr_info(self): - yield from super()._repr_info() - yield ('egu', self._egu) - yield ('limits', self._limits) - yield ('source', self.source) - - def read(self): - d = OrderedDict() - d[self.name] = {'value': self.position, - 'timestamp': time.time()} - return d - - def describe(self): - """Return the description as a dictionary - - Returns - ------- - dict - Dictionary of name and formatted description string - """ - desc = OrderedDict() - desc[self.name] = {'source': str(self.source), - 'dtype': data_type(self.position), - 'shape': data_shape(self.position), - 'units': self.egu, - 'lower_ctrl_limit': self.low_limit, - 'upper_ctrl_limit': self.high_limit, - } - return desc - - def read_configuration(self): - return OrderedDict() - - def describe_configuration(self): - return OrderedDict()
-
- -
-
- - -
-
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_modules/ophyd/pseudopos.html b/ophyd/_modules/ophyd/pseudopos.html deleted file mode 100644 index db0462b704..0000000000 --- a/ophyd/_modules/ophyd/pseudopos.html +++ /dev/null @@ -1,1017 +0,0 @@ - - - - - - - - - - - ophyd.pseudopos — ophyd documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
-
- - - - - - -
- -
-
-
-
- -

Source code for ophyd.pseudopos

-# vi: ts=4 sw=4
-'''
-:mod:`ophyd.control.pseudopos` - Pseudo positioners
-===================================================
-
-.. module:: ophyd.control.pseudopos
-   :synopsis: Pseudo positioner support
-'''
-
-
-import logging
-import time
-import threading
-import functools
-
-from collections import (OrderedDict, namedtuple, Sequence)
-
-from .utils import DisconnectedError
-from .positioner import (PositionerBase, SoftPositioner)
-from .device import Device
-from .status import (wait as status_wait)
-
-logger = logging.getLogger(__name__)
-
-
-
[docs]class PseudoSingle(SoftPositioner): - '''A single axis of a PseudoPositioner - - This should not be instantiated on its own, but rather used as a Component - in a PseudoPositioner subclass. - - Parameters - ---------- - prefix : str, optional - The PV prefix, for compatibility with the Device hierarchy - limits : (low_limit, high_limit) - User-defined limits for this pseudo axis. - egu : str, optional - The engineering units (EGU) for the position - parent : PseudoPositioner instance - The instance of the parent PseudoPositioner - name : str, optional - The name of the positioner - source : str, optional - Metadata indicating the source of this positioner's position. Defaults - to 'computed' - settle_time : float, optional - The amount of time to wait after moves to report status completion - timeout : float, optional - The default timeout to use for motion requests, in seconds. - ''' - - def __init__(self, prefix=None, *, limits=None, egu='', parent=None, - name=None, source='computed', **kwargs): - super().__init__(name=name, parent=parent, limits=limits, - egu=egu, source=source, **kwargs) - - self._target = None - - # The index of this PseudoSingle in the parent PseudoPositioner tuple - # will be set post-instantiation: - self._idx = None - - self._parent.subscribe(self._sub_proxy, event_type=self.SUB_START) - self._parent.subscribe(self._sub_proxy, event_type=self.SUB_DONE) - self._parent.subscribe(self._sub_proxy_idx, - event_type=self.SUB_READBACK) - - def _repr_info(self): - yield from super()._repr_info() - - yield ('idx', self._idx) - - def _sub_proxy(self, obj=None, **kwargs): - '''Parent callbacks such as start of motion, motion finished, etc. will - be simply passed through. - ''' - return self._run_subs(obj=self, **kwargs) - - def _sub_proxy_idx(self, obj=None, value=None, **kwargs): - '''Parent callbacks including a position value will be filtered through - this function and re-broadcast using only the relevant position to this - pseudo axis. - ''' - if hasattr(value, '__getitem__'): - value = value[self._idx] - - return self._run_subs(obj=self, value=value, **kwargs) - - @property - def target(self): - '''Last commanded target position''' - if self._target is None: - return self.position - else: - return self._target - - def sync(self): - '''Synchronize target position with current readback position''' - self._target = None - - def check_value(self, pos): - self._parent.check_single(self, pos) - - @property - def moving(self): - return self._parent.moving - - @property - def position(self): - '''The current position of the motor in its engineering units - - Returns - ------- - position - ''' - return self._parent.position[self._idx] - - def stop(self): - '''Stop motion on the PseudoPositioner''' - return self._parent.stop() - - @property - def _started_moving(self): - '''Has motion started since the motion request? - - This is a property on PseudoSingle, which overrides the default - behavior of Positioner. It reflects the motion status of the - PseudoPositioner as a whole. - ''' - return self._parent._started_moving - - @_started_moving.setter - def _started_moving(self, value): - # Don't allow the base class to specify whether it has started moving - pass - - def _setup_move(self, position, status): - '''PseudoSingle.move overrides SoftPositioner move implementation, so - this method is not called. - ''' - pass - - def move(self, pos, **kwargs): - '''Move this pseudo axis to a specific position. - - See `PseudoPositioner.move_single` for more information. - - Parameters - ---------- - pos : float - Position to move to - kwargs : dict - Passed onto parent.move_single() - ''' - self._target = pos - return self._parent.move_single(self, pos, **kwargs)
- - -def position_argument_wrapper(type_): - '''Wrapper to convert positional arguments to a PositionTuple''' - if type_ not in ('pseudo', 'real'): - raise ValueError("position_type should be either 'pseudo' or 'real'") - - def wrapper(method): - @functools.wraps(method) - def wrapped(self, *args, **kwargs): - if type_ == 'pseudo': - pos, new_kwargs = self.to_pseudo_tuple(*args, **kwargs) - else: - pos, new_kwargs = self.to_real_tuple(*args, **kwargs) - - return method(self, pos, **new_kwargs) - - return wrapped - - return wrapper - - -real_position_argument = position_argument_wrapper('real') -pseudo_position_argument = position_argument_wrapper('pseudo') - -_to_position_tuple_usage_info = '''Positions can be passed in a number of ways. - -As positional arguments: - pseudo.method(px, py, pz, **kwargs) -As a sequence or PseudoPosition/RealPosition: - pseudo.method((px, py, pz), **kwargs) -As kwargs: - pseudo.method(px=1, py=2, pz=3, **kwargs) - -''' - - -def to_position_tuple(cls, *args, **kwargs): - '''Convert user-specified arguments to a Position namedtuple and kwargs - - Example: - Tuple = namedtuple('Tuple', 'px py pz') - - All of the following will return the same thing: - t, kwargs = to_position_tuple(Tuple, px, py, pz, a=4) - t, kwargs = to_position_tuple(Tuple, (px, py, pz), a=4) - t, kwargs = to_position_tuple(Tuple, Tuple(px, py, pz), a=4) - t, kwargs = to_position_tuple(Tuple, px=1, py=2, pz=3, a=4) - - t will be Tuple(px, py, pz), and kwargs will be {'a': 4}. - - Parameters - ---------- - cls : namedtuple - The position class to use. This is likely a RealPosition or a - PseudoPosition from a PseudoPositioner. - args : - User-specified positional arguments - kwargs : dict - User-specified keyword arguments - - Returns - ------- - position_tuple : cls - The position tuple - kwargs : dict - Keyword arguments not related to the position tuple - - Raises - ------ - TypeError - On an empty or invalid namedtuple - ValueError - On a mismatch of parameters - ''' - try: - fields = cls._fields - except AttributeError: - raise TypeError('Invalid position tuple') - - if not fields: - raise TypeError('Invalid position tuple') - - if args and isinstance(args[0], (cls, Sequence)): - # Position is in the first positional argument - if len(args) > 1: - raise ValueError(_to_position_tuple_usage_info + - 'Cannot specify more than one positional ' - 'argument if the first one is a {} ' - ''.format(cls.__name__)) - - position = args[0] - if not isinstance(position, cls): - # Ensure a position tuple is passed back - position = cls(*position) - - return position, kwargs - - elif len(args) == len(fields): - # Position is in positional arguments - return cls(*args), kwargs - - elif len(args) > 0: - # Position is in positional arguments - raise ValueError(_to_position_tuple_usage_info + - 'Wrong number of arguments for {}. ' - 'Got {}, expected {}' - ''.format(cls.__name__, len(args), len(fields))) - - if not kwargs: - # no positional arguments or kwargs, just show usage information - raise ValueError(_to_position_tuple_usage_info) - - # No positional arguments, position described in terms of kwargs - missing_fields = [field for field in fields - if field not in kwargs] - - if missing_fields: - raise ValueError(_to_position_tuple_usage_info + - 'Missing keyword arguments for field names of {}:' - ' {}'.format(cls.__name__, - ', '.join(missing_fields))) - - # separate position tuple kwargs from other kwargs - position_kw = {field: kwargs[field] for field in fields} - other_kw = {key: value for key, value in kwargs.items() - if key not in fields} - position = cls(**position_kw) - return position, other_kw - - -
[docs]class PseudoPositioner(Device, SoftPositioner): - '''A pseudo positioner which can be comprised of multiple positioners - - Parameters - ---------- - prefix : str - The PV prefix for all components of the device - concurrent : bool, optional - If set, all real motors will be moved concurrently. If not, they will - be moved in order of how they were defined initially - read_attrs : sequence of attribute names - the components to include in a normal reading (i.e., in ``read()``) - configuration_attrs : sequence of attribute names - the components to be read less often (i.e., in - ``read_configuration()``) and to adjust via ``configure()`` - name : str, optional - The name of the device - parent : instance or None - The instance of the parent device, if applicable - settle_time : float, optional - The amount of time to wait after moves to report status completion - timeout : float, optional - The default timeout to use for motion requests, in seconds. - ''' - def __init__(self, prefix, *, concurrent=True, read_attrs=None, - configuration_attrs=None, name=None, egu='', **kwargs): - - self._finished_lock = threading.RLock() - self._concurrent = bool(concurrent) - self._finish_thread = None - self._real_waiting = [] - self._move_queue = [] - - if self.__class__ is PseudoPositioner: - raise TypeError('PseudoPositioner must be subclassed with the ' - 'correct signals set in the class definition.') - - super().__init__(prefix, read_attrs=read_attrs, - configuration_attrs=configuration_attrs, - name=name, egu=egu, **kwargs) - - self._real = [getattr(self, attr) - for attr, cpt in self._get_real_positioners()] - self._pseudo = [getattr(self, attr) - for attr, cpt in self._get_pseudo_positioners()] - - if not self._pseudo or not self._real: - raise ValueError('Must have at least 1 positioner and ' - 'pseudo-positioner') - - if not self._egu: - # Make the PseudoPositioner units based on the PseudoSingle - # units - self._egu = self.composite_egu - - self.RealPosition = self._real_position_tuple() - self.PseudoPosition = self._pseudo_position_tuple() - - logger.debug('Real positioners: %s', self._real) - logger.debug('Pseudo positioners: %s', self._pseudo) - - for idx, pseudo in enumerate(self._pseudo): - pseudo._idx = idx - - self._real_cur_pos = OrderedDict((real, None) for real in self._real) - - for real in self._real: - # Subscribe to events from all the real motors and update the - # internal state of their position - real.subscribe(self._real_pos_update, event_type=real.SUB_READBACK, - run=True) - - @property - def composite_egu(self): - '''The composite engineering units (EGU) from all PseudoSingles''' - return ', '.join(pseudo.egu for pseudo in self._pseudo - if pseudo.egu) - - @property - def pseudo_positioners(self): - '''Pseudo positioners instances in a namedtuple - - Returns - ------- - positioner_instances : PseudoPosition - ''' - return self.PseudoPosition(*self._pseudo) - - @property - def real_positioners(self): - '''Real positioners instances in a namedtuple - - Returns - ------- - positioner_instances : RealPosition - ''' - return self.RealPosition(*self._real) - - @classmethod - def _real_position_tuple(cls): - '''A namedtuple for a real motor position - - This is automatically generated at the class-level for all - non-PseudoSingle-based positioners. - ''' - name = cls.__name__ + 'RealPos' - return namedtuple(name, [name for name, cpt in - cls._get_real_positioners()]) - - @classmethod - def _pseudo_position_tuple(cls): - '''A namedtuple for a pseudo motor position - - This is automatically generated at the class-level for all - PseudoSingle-based positioners. - ''' - name = cls.__name__ + 'PseudoPos' - return namedtuple(name, [name for name, cpt in - cls._get_pseudo_positioners()]) - - @classmethod - def _get_pseudo_positioners(cls): - '''Inspect the components and find the pseudo positioners - - All `PseudoSingle` (and subclassed) components will be returned, by - default. - - The built-in mechanism to override the list of pseudo positioners on a - PseudoPositioner is to define '_pseudo' on the class-level. It should - be a list of attribute names. - - Yields - ------ - (attr, component) - ''' - if hasattr(cls, '_pseudo'): - for pseudo in cls._pseudo: - yield pseudo, getattr(cls, pseudo) - else: - for attr, cpt in cls._sig_attrs.items(): - if issubclass(cpt.cls, PseudoSingle): - yield attr, cpt - - @classmethod - def _get_real_positioners(cls): - '''Inspect the components and find the real positioners - - All `Positioner` components which are not `PseudoSingle`s will be - returned, by default. - - The built-in mechanism to override the list of real positioners on a - PseudoPositioner is to define '_real' on the class-level. It should be - a list of attribute names. This allows you to group real motors - logically on the device but not have them included in motions or - calculations. - - Yields - ------ - (attr, component) - ''' - if hasattr(cls, '_real'): - for real in cls._real: - yield real, getattr(cls, real) - else: - for attr, cpt in cls._sig_attrs.items(): - is_pseudo = issubclass(cpt.cls, PseudoSingle) - is_positioner = issubclass(cpt.cls, PositionerBase) - if is_positioner and not is_pseudo: - yield attr, cpt - - def _repr_info(self): - yield from super()._repr_info() - yield ('concurrent', self._concurrent) - - @property - def connected(self): - return all(mtr.connected for mtr in self._real) - - def stop(self): - del self._move_queue[:] - - for pos in self._real: - try: - pos.stop() - except Exception as ex: - logger.error('%s failed to stop positioner: %s', self.name, - pos.name, exc_info=ex) - - super().stop() - - def check_single(self, pseudo_single, single_pos): - '''Check if a new position for a single pseudo positioner is valid''' - idx = pseudo_single._idx - target = list(self.target) - target[idx] = single_pos - return self.check_value(self.PseudoPosition(*target)) - - def to_pseudo_tuple(self, *args, **kwargs): - '''Convert arguments to a PseudoPosition namedtuple and kwargs''' - return to_position_tuple(self.PseudoPosition, *args, **kwargs) - - def to_real_tuple(self, *args, **kwargs): - '''Convert arguments to a RealPosition namedtuple and kwargs''' - return to_position_tuple(self.RealPosition, *args, **kwargs) - - def check_value(self, pseudo_pos): - '''Check if a new position for all pseudo positioners is valid - - First checks limits against those set for individual pseudo axes. - Second, calculates forward(pseudo_pos) => real_pos and checks it - against the real positioners. - - NOTE: If you have limits that are coupled together or are somehow more - complicated than the above procedure, you should redefine this method - in your subclass. - ''' - try: - pseudo_pos = self.PseudoPosition(*pseudo_pos) - except TypeError as ex: - raise ValueError('Not all required values for a PseudoPosition: {}' - '({})'.format(self.PseudoPosition._fields, ex)) - - for pseudo, pos in zip(self._pseudo, pseudo_pos): - low, high = pseudo.limits - if (high > low) and not (low <= pos <= high): - raise ValueError('Position is outside of pseudo single limits:' - ' {}, {} < {} < {}'.format(pseudo.name, low, - pos, high)) - - real_pos = self.forward(pseudo_pos) - for real, pos in zip(self._real, real_pos): - real.check_value(pos) - - @property - def limits(self): - '''All PseudoSingle limits as a namedtuple''' - # NOTE: overrides SoftPositioner implementation - return self.PseudoPosition(*(pseudo.limits for pseudo in self._pseudo)) - - @property - def low_limit(self): - '''All PseudoSingle low limits as a namedtuple''' - # NOTE: overrides SoftPositioner implementation - return self.PseudoPosition(*(pseudo.low_limit - for pseudo in self._pseudo)) - - @property - def high_limit(self): - '''All PseudoSingle high limits as a namedtuple''' - # NOTE: overrides SoftPositioner implementation - return self.PseudoPosition(*(pseudo.high_limit - for pseudo in self._pseudo)) - - @property - def moving(self): - return any(pos.moving for pos in self._real) - - @property - def sequential(self): - '''If sequential is set, motors will move in the sequence they were - defined in (i.e., in series) - ''' - return not self._concurrent - - @property - def concurrent(self): - '''If concurrent is set, motors will move concurrently (in parallel)''' - return self._concurrent - - @property - def _started_moving(self): - return any(pos._started_moving for pos in self._real) - - @_started_moving.setter - def _started_moving(self, value): - # Don't allow the base class to specify whether it has started moving - pass - - @property - def position(self): - '''Pseudo motor position namedtuple''' - return self.inverse(self.real_position) - - @property - def real_position(self): - '''Real motor position namedtuple''' - return self.RealPosition(*self._real_cur_pos.values()) - - def _update_position(self): - '''Update the internal position based on all of the real positioners''' - real_cur_pos = self.real_position - if None in real_cur_pos: - raise DisconnectedError('Not all positioners connected') - - calc_pseudo_pos = self.inverse(real_cur_pos) - self._set_position(calc_pseudo_pos) - return calc_pseudo_pos - - def _real_pos_update(self, obj=None, value=None, **kwargs): - '''Callback: A single real positioner has moved''' - real = obj - self._real_cur_pos[real] = value - # Only update the position if all real motors are connected - try: - self._update_position() - except DisconnectedError: - pass - - def _done_moving(self, success=True): - '''Call this when motion has completed. Runs SUB_DONE subscription.''' - del self._real_waiting[:] - super()._done_moving(success=success) - - def _real_finished(self, obj=None): - '''Callback: A single real positioner has finished moving. - - Used for asynchronous motion, if all have finished moving then fire a - callback (via `Positioner._done_moving`) - ''' - with self._finished_lock: - real = obj - logger.debug('Real motor %s finished moving', real.name) - - if real in self._real_waiting: - self._real_waiting.remove(real) - - if not self._real_waiting: - self._done_moving() - - def move_single(self, pseudo, position, **kwargs): - '''Move one PseudoSingle axis to a position - - All other positioners will use their current setpoint/target value, if - available. Failing that, their current readback value will be used (see - `PseudoSingle.sync` and `PseudoSingle.target`). - - Parameters - ---------- - pseudo : PseudoSingle - PseudoSingle positioner to move - position : float - Position only for the PseudoSingle - kwargs : dict - Passed onto move - ''' - idx = pseudo._idx - target = list(self.target) - target[idx] = position - return self.move(self.PseudoPosition(*target), **kwargs) - - @property - def target(self): - '''Last commanded target positions''' - return self.PseudoPosition(*(pos.target for pos in self._pseudo)) - - def _sequential_move(self, real_pos, timeout=None, **kwargs): - '''Move all real positioners to a certain position, in series''' - self._move_queue[:] = zip(self._real, real_pos) - pending_status = [] - t0 = time.time() - - def move_next(obj=None): - # last motion complete message came from 'obj' - logger.debug('[%s:sequential] move_next called', self.name) - with self._finished_lock: - if pending_status: - last_status = pending_status[-1] - if not last_status.success: - logger.error('Failing due to last motion') - self._done_moving(success=False) - return - - try: - real, position = self._move_queue.pop(0) - except IndexError: - self._done_moving(success=True) - return - - logger.debug('[%s:sequential] Moving next motor: %s', - self.name, real.name) - - elapsed = time.time() - t0 - if timeout is None: - sub_timeout = None - else: - sub_timeout = timeout - elapsed - - logger.debug('[%s:sequential] Moving %s to %s (timeout=%s)', - self.name, real.name, position, sub_timeout) - - if sub_timeout is not None and sub_timeout < 0: - logger.error('Motion timeout') - self._done_moving(success=False) - else: - status = real.move(position, wait=False, - timeout=sub_timeout, - moved_cb=move_next, - **kwargs) - pending_status.append(status) - logger.debug('[%s:sequential] waiting on %s', - self.name, real.name) - - logger.debug('[%s:sequential] started', self.name) - move_next() - - def _concurrent_move(self, real_pos, **kwargs): - '''Move all real positioners to a certain position, in parallel''' - self._real_waiting.extend(self._real) - - for real, value in zip(self._real, real_pos): - logger.debug('[concurrent] Moving %s to %s', real.name, value) - real.move(value, wait=False, moved_cb=self._real_finished, - **kwargs) - - @pseudo_position_argument - def move(self, position, wait=True, timeout=None, moved_cb=None): - '''Move to a specified position, optionally waiting for motion to - complete. - - Parameters - ---------- - position - Pseudo position to move to - moved_cb : callable - Call this callback when movement has finished. This callback must - accept one keyword argument: 'obj' which will be set to this - positioner instance. - timeout : float, optional - Maximum time to wait for the motion. If None, the default timeout - for this positioner is used. - - Returns - ------- - status : MoveStatus - - Raises - ------ - TimeoutError - When motion takes longer than `timeout` - ValueError - On invalid positions - RuntimeError - If motion fails other than timing out - ''' - return super().move(position, wait=wait, timeout=timeout, - moved_cb=moved_cb) - - move.__doc__ = SoftPositioner.move.__doc__ - - def _setup_move(self, position, status): - '''Move requested to position - - This is a customization of SoftPositioner's _setup_move method which - is what gets called when a motion request happens. - - Parameters - ---------- - position : PseudoPosition - Position to move to (already verified by `check_value`) - status : MoveStatus - Status object created by PositionerBase.move() - ''' - # Clear all old statuses for not yet completed real motions - del self._real_waiting[:] - - timeout = status.timeout - real_pos = self.forward(position) - - with self._finished_lock: - # ensure we don't get any motion complete messages before motion - # setup is finished - if self.sequential: - self._sequential_move(real_pos, timeout=timeout) - else: - self._concurrent_move(real_pos, timeout=timeout) - - @pseudo_position_argument - def forward(self, pseudo_pos): - '''Calculate a RealPosition from a given PseudoPosition - - Must be defined on the subclass. - - Parameters - ---------- - pseudo_pos : PseudoPosition - The pseudo position input - - Returns - ------- - real_position : RealPosition - The real position output - ''' - # return self.RealPosition() - raise NotImplementedError() - - @real_position_argument - def inverse(self, real_pos): - '''Calculate a PseudoPosition from a given RealPosition - - Must be defined on the subclass. - - Parameters - ---------- - real_position : RealPosition - The real position input - - Returns - ------- - pseudo_pos : PseudoPosition - The pseudo position output - ''' - # return self.PseudoPosition() - raise NotImplementedError() - - @pseudo_position_argument - def set(self, position, **kwargs): - '''Move to a new position asynchronously - - Parameters - ---------- - position : PseudoPosition - Position for the all of the pseudo axes - - Returns - ------- - status : MoveStatus - ''' - return super().set(position, **kwargs)
-
- -
-
- - -
-
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_modules/ophyd/pv_positioner.html b/ophyd/_modules/ophyd/pv_positioner.html deleted file mode 100644 index 58b082acd3..0000000000 --- a/ophyd/_modules/ophyd/pv_positioner.html +++ /dev/null @@ -1,497 +0,0 @@ - - - - - - - - - - - ophyd.pv_positioner — ophyd documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
-
- - - - - - -
- -
-
-
-
- -

Source code for ophyd.pv_positioner

-# vi: ts=4 sw=4
-'''
-:mod:`ophyd.control.pvpositioner` - Ophyd PV positioners
-========================================================
-
-.. module:: ophyd.control.pvpositioner
-   :synopsis:
-'''
-
-import logging
-
-from epics.pv import fmt_time
-
-from .device import Device
-from .positioner import PositionerBase
-from .status import wait as status_wait
-
-logger = logging.getLogger(__name__)
-
-
-
[docs]class PVPositioner(Device, PositionerBase): - '''A Positioner which is controlled using multiple user-defined signals - - Keyword arguments are passed through to the base class, Positioner - - Parameters - ---------- - prefix : str, optional - The device prefix used for all sub-positioners. This is optional as it - may be desirable to specify full PV names for PVPositioners. - limits : 2-element sequence, optional - (low_limit, high_limit) - name : str - The device name - egu : str, optional - The engineering units (EGU) for the position - settle_time : float, optional - The amount of time to wait after moves to report status completion - timeout : float, optional - The default timeout to use for motion requests, in seconds. - - Attributes - ---------- - setpoint : Signal - The setpoint (request) signal - readback : Signal or None - The readback PV (e.g., encoder position PV) - actuate : Signal or None - The actuation PV to set when movement is requested - actuate_value : any, optional - The actuation value, sent to the actuate signal when motion is - requested - stop_signal : Signal or None - The stop PV to set when motion should be stopped - stop_value : any, optional - The value sent to stop_signal when a stop is requested - egu : str, optional - The engineering units (EGU) for a position - done : Signal - A readback value indicating whether motion is finished - done_val : any, optional - The value that the done pv should be when motion has completed - put_complete : bool, optional - If set, the specified PV should allow for asynchronous put completion - to indicate motion has finished. If `actuate` is specified, it will be - used for put completion. Otherwise, the `setpoint` will be used. See - the `-c` option from `caput` for more information. - ''' - - setpoint = None # TODO: should add limits=True - readback = None - actuate = None - actuate_value = 1 - - stop_signal = None - stop_value = 1 - - done = None - done_value = 1 - put_complete = False - - def __init__(self, prefix='', *, limits=None, name=None, read_attrs=None, - configuration_attrs=None, parent=None, egu='', **kwargs): - super().__init__(prefix=prefix, read_attrs=read_attrs, - configuration_attrs=configuration_attrs, - name=name, parent=parent, **kwargs) - - if self.__class__ is PVPositioner: - raise TypeError('PVPositioner must be subclassed with the correct ' - 'signals set in the class definition.') - - self._egu = egu - - if limits is not None: - self._limits = tuple(limits) - else: - self._limits = None - - if self.readback is not None: - self.readback.subscribe(self._pos_changed) - elif self.setpoint is not None: - self.setpoint.subscribe(self._pos_changed) - else: - raise ValueError('A setpoint or a readback must be specified') - - if self.done is None and not self.put_complete: - msg = ('PVPositioner {} is mis-configured. A "done" Signal must be' - ' provided or use PVPositionerPC (which uses put completion' - ' to determine when motion has completed).' - ''.format(self.name)) - raise ValueError(msg) - - if self.done is not None: - self.done.subscribe(self._move_changed) - - @property - def egu(self): - '''The engineering units (EGU) for a position''' - return self._egu - - @property - def put_complete(self): - return isinstance(self, PVPositionerPC) - - def check_value(self, pos): - '''Check that the position is within the soft limits''' - if self.limits is not None: - low, high = self.limits - if low != high and not (low <= pos <= high): - raise ValueError('{} outside of user-specified limits' - ''.format(pos)) - else: - self.setpoint.check_value(pos) - - @property - def moving(self): - '''Whether or not the motor is moving - - If a `done` PV is specified, it will be read directly to get the motion - status. If not, it determined from the internal state of PVPositioner. - - Returns - ------- - bool - ''' - if self.done is not None: - dval = self.done.get(use_monitor=False) - return (dval != self.done_value) - else: - return self._moving - - def _setup_move(self, position): - '''Move and do not wait until motion is complete (asynchronous)''' - logger.debug('%s.setpoint = %s', self.name, position) - self.setpoint.put(position, wait=True) - if self.actuate is not None: - logger.debug('%s.actuate = %s', self.name, self.actuate_value) - self.actuate.put(self.actuate_value, wait=False) - - def move(self, position, wait=True, timeout=None, moved_cb=None): - '''Move to a specified position, optionally waiting for motion to - complete. - - Parameters - ---------- - position - Position to move to - moved_cb : callable - Call this callback when movement has finished. This callback must - accept one keyword argument: 'obj' which will be set to this - positioner instance. - timeout : float, optional - Maximum time to wait for the motion. If None, the default timeout - for this positioner is used. - - Returns - ------- - status : MoveStatus - - Raises - ------ - TimeoutError - When motion takes longer than `timeout` - ValueError - On invalid positions - RuntimeError - If motion fails other than timing out - ''' - status = super().move(position, timeout=timeout, moved_cb=moved_cb) - - has_done = self.done is not None - if not has_done: - moving_val = 1 - self.done_value - self._move_changed(value=self.done_value) - self._move_changed(value=moving_val) - - try: - self._setup_move(position) - if wait: - status_wait(status) - except KeyboardInterrupt: - self.stop() - raise - - return status - - def _move_changed(self, timestamp=None, value=None, sub_type=None, - **kwargs): - was_moving = self._moving - self._moving = (value != self.done_value) - - started = False - if not self._started_moving: - started = self._started_moving = (not was_moving and self._moving) - logger.debug('[ts=%s] %s started moving: %s', fmt_time(timestamp), - self.name, started) - - logger.debug('[ts=%s] %s moving: %s (value=%s)', fmt_time(timestamp), - self.name, self._moving, value) - - if started: - self._run_subs(sub_type=self.SUB_START, timestamp=timestamp, - value=value, **kwargs) - - if not self.put_complete: - # In the case of put completion, motion complete - if was_moving and not self._moving: - self._done_moving(success=True, timestamp=timestamp, - value=value) - - def _pos_changed(self, timestamp=None, value=None, **kwargs): - '''Callback from EPICS, indicating a change in position''' - self._set_position(value) - - def stop(self): - if self.stop_signal is not None: - self.stop_signal.put(self.stop_value, wait=False) - super().stop() - - @property - def report(self): - rep = super().report - rep['pv'] = self.readback.pvname - return rep - - @property - def limits(self): - if self._limits is not None: - return tuple(self._limits) - else: - return self.setpoint.limits - - def _repr_info(self): - yield from super()._repr_info() - - yield ('limits', self._limits) - yield ('egu', self._egu) - - def _done_moving(self, **kwargs): - has_done = self.done is not None - if not has_done: - self._move_changed(value=self.done_value) - - super()._done_moving(**kwargs)
- - -class PVPositionerPC(PVPositioner): - def __init__(self, *args, **kwargs): - if self.__class__ is PVPositionerPC: - raise TypeError('PVPositionerPC must be subclassed with the ' - 'correct signals set in the class definition.') - - super().__init__(*args, **kwargs) - - def _setup_move(self, position): - '''Move and do not wait until motion is complete (asynchronous)''' - def done_moving(**kwargs): - logger.debug('%s async motion done', self.name) - self._done_moving(success=True) - - if self.done is None: - # No done signal, so we rely on put completion - moving_val = 1 - self.done_value - self._move_changed(value=moving_val) - - logger.debug('%s.setpoint = %s', self.name, position) - - if self.actuate is not None: - self.setpoint.put(position, wait=True) - - logger.debug('%s.actuate = %s', self.name, self.actuate_value) - self.actuate.put(self.actuate_value, wait=False, - callback=done_moving) - else: - self.setpoint.put(position, wait=False, - callback=done_moving) -
- -
-
- - -
-
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_modules/ophyd/scaler.html b/ophyd/_modules/ophyd/scaler.html deleted file mode 100644 index ab83d6039b..0000000000 --- a/ophyd/_modules/ophyd/scaler.html +++ /dev/null @@ -1,248 +0,0 @@ - - - - - - - - - - - ophyd.scaler — ophyd documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
-
- - - - - - -
- -
-
-
-
- -

Source code for ophyd.scaler

-
-import logging
-
-from collections import OrderedDict
-
-from .signal import (EpicsSignal, EpicsSignalRO)
-from .device import Device
-from .device import (Component as C, DynamicDeviceComponent as DDC)
-
-logger = logging.getLogger(__name__)
-
-
-def _scaler_fields(attr_base, field_base, range_, **kwargs):
-    defn = OrderedDict()
-    for i in range_:
-        attr = '{attr}{i}'.format(attr=attr_base, i=i)
-        suffix = '{field}{i}'.format(field=field_base, i=i)
-        defn[attr] = (EpicsSignalRO, suffix, kwargs)
-
-    return defn
-
-
-
[docs]class EpicsScaler(Device): - '''SynApps Scaler Record interface''' - - count = C(EpicsSignal, '.CNT', trigger_value=1) - count_mode = C(EpicsSignal, '.CONT', string=True) - time = C(EpicsSignal, '.T') - preset_time = C(EpicsSignal, '.TP') - auto_count_time = C(EpicsSignal, '.TP1') - channels = DDC(_scaler_fields('chan', '.S', range(1, 33))) - presets = DDC(_scaler_fields('preset', '.PR', range(1, 33))) - gates = DDC(_scaler_fields('gate', '.G', range(1, 33))) - - def __init__(self, prefix, *, read_attrs=None, configuration_attrs=None, - name=None, parent=None, **kwargs): - if read_attrs is None: - read_attrs = ['channels', 'time'] - - if configuration_attrs is None: - configuration_attrs = ['preset_time', 'presets', 'gates'] - - super().__init__(prefix, read_attrs=read_attrs, - configuration_attrs=configuration_attrs, - name=name, parent=parent, **kwargs) - - self.stage_sigs.update([(self.count_mode, 0)])
-
- -
-
- - -
-
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_modules/ophyd/signal.html b/ophyd/_modules/ophyd/signal.html deleted file mode 100644 index f163467042..0000000000 --- a/ophyd/_modules/ophyd/signal.html +++ /dev/null @@ -1,1120 +0,0 @@ - - - - - - - - - - - ophyd.signal — ophyd documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - -
- - - - - - -
-
- - - - - - -
- -
-
-
-
- -

Source code for ophyd.signal

-# vi: ts=4 sw=4
-import logging
-import time
-
-import numpy as np
-import epics
-
-from .utils import (ReadOnlyError, LimitError)
-from .utils.epics_pvs import (pv_form, waveform_to_string,
-                              raise_if_disconnected, data_type, data_shape)
-from .ophydobj import OphydObject
-from .status import Status
-from .utils import set_and_wait
-
-
-logger = logging.getLogger(__name__)
-
-
-
[docs]class Signal(OphydObject): - '''A signal, which can have a read-write or read-only value. - - - Parameters - ---------- - value : any, optional - The initial value - timestamp : float, optional - The timestamp associated with the initial value. Defaults to the - current local time. - tolerance : any, optional - The absolute tolerance associated with the value - rtolerance : any, optional - The relative tolerance associated with the value, used in - set_and_wait as follows: - absolute(setpoint - readback) <= (tolerance + rtolerance * - absolute(readback)) - - Attributes - ---------- - rtolerance : any, optional - The relative tolerance associated with the value - ''' - SUB_VALUE = 'value' - _default_sub = SUB_VALUE - - def __init__(self, *, value=None, timestamp=None, name=None, parent=None, - tolerance=None, rtolerance=None): - super().__init__(name=name, parent=parent) - - self._readback = value - - if timestamp is None: - timestamp = time.time() - - self._timestamp = timestamp - self._set_thread = None - self._tolerance = tolerance - # self.tolerance is a property - self.rtolerance = rtolerance - -
[docs] def trigger(self): - '''Call that is used by bluesky prior to read()''' - # NOTE: this is a no-op that exists here for bluesky purposes - # it may need to be moved in the future - d = Status(self) - d._finished() - return d
- -
[docs] def wait_for_connection(self, timeout=0.0): - '''Wait for the underlying signals to initialize or connect''' - pass
- - @property - def timestamp(self): - '''Timestamp of the readback value''' - return self._timestamp - - @property - def tolerance(self): - '''The absolute tolerance associated with the value.''' - return self._tolerance - - @tolerance.setter - def tolerance(self, tolerance): - self._tolerance = tolerance - - def _repr_info(self): - yield from super()._repr_info() - value = self.value - if value is not None: - yield ('value', value) - if self.timestamp is not None: - yield ('timestamp', self.timestamp) - if self.tolerance is not None: - yield ('tolerance', self.tolerance) - if self.rtolerance is not None: - yield ('rtolerance', self.rtolerance) - -
[docs] def get(self, **kwargs): - '''The readback value''' - return self._readback
- -
[docs] def put(self, value, *, timestamp=None, force=False, **kwargs): - '''Put updates the internal readback value - - The value is optionally checked first, depending on the value of force. - In addition, VALUE subscriptions are run. - - Extra kwargs are ignored (for API compatibility with EpicsSignal kwargs - pass through). - - Parameters - ---------- - value : any - Value to set - timestamp : float, optional - The timestamp associated with the value, defaults to time.time() - force : bool, optional - Check the value prior to setting it, defaults to False - - ''' - - # TODO: consider adding set_and_wait here as a kwarg - if not force: - self.check_value(value) - - old_value = self._readback - self._readback = value - - if timestamp is None: - timestamp = time.time() - - self._timestamp = timestamp - self._run_subs(sub_type=self.SUB_VALUE, old_value=old_value, - value=value, timestamp=self._timestamp)
- -
[docs] def set(self, value, *, timeout=None, settle_time=None): - '''Set is like `put`, but is here for bluesky compatibility - - Returns - ------- - st : Status - This status object will be finished upon return in the - case of basic soft Signals - ''' - def set_thread(): - nonlocal timeout - - if timeout is None: - timeout = 10 - # TODO set_and_wait does not support a timeout of None - # and 10 is its default timeout - - try: - set_and_wait(self, value, timeout=timeout, atol=self.tolerance, - rtol=self.rtolerance) - except TimeoutError: - logger.debug('set_and_wait(%r, %s) timed out', self.name, - value) - success = False - except Exception as ex: - logger.debug('set_and_wait(%r, %s) failed', self.name, value, - exc_info=ex) - success = False - else: - logger.debug('set_and_wait(%r, %s) succeeded => %s', self.name, - value, self.value) - success = True - if settle_time is not None: - time.sleep(settle_time) - finally: - st._finished(success=success) - self._set_thread = None - - if self._set_thread is not None: - raise RuntimeError('Another set() call is still in progress') - - st = Status(self) - self._status = st - self._set_thread = epics.ca.CAThread(target=set_thread) - self._set_thread.daemon = True - self._set_thread.start() - return self._status
- - @property - def value(self): - '''The signal's value''' - return self.get() - - @value.setter - def value(self, value): - self.put(value) - -
[docs] def read(self): - '''Put the status of the signal into a simple dictionary format - for data acquisition - - Returns - ------- - dict - ''' - return {self.name: {'value': self.get(), - 'timestamp': self.timestamp}}
- -
[docs] def describe(self): - """Return the description as a dictionary""" - return {self.name: {'source': 'SIM:{}'.format(self.name), - 'dtype': 'number', - 'shape': []}}
- -
[docs] def read_configuration(self): - "Subclasses may customize this." - return self.read()
- -
[docs] def describe_configuration(self): - "Subclasses may customize this." - return self.describe()
- - @property - def limits(self): - # Always override, never extend this - return (0, 0) - - @property - def low_limit(self): - return self.limits[0] - - @property - def high_limit(self): - return self.limits[1]
- - -class DerivedSignal(Signal): - def __init__(self, derived_from, *, name=None, parent=None, **kwargs): - '''A signal which is derived from another one - - Parameters - ---------- - derived_from : Signal - The signal from which this one is derived - name : str, optional - The signal name - parent : Device, optional - The parent device - ''' - super().__init__(name=name, parent=parent, **kwargs) - - self._derived_from = derived_from - if self._derived_from.connected: - # set up the initial timestamp reporting, if connected - self._timestamp = self._derived_from.timestamp - - @property - def derived_from(self): - '''Signal that this one is derived from''' - return self._derived_from - - def describe(self): - '''Description based on the original signal description''' - desc = self._derived_from.describe()[self._derived_from.name] - desc['derived_from'] = self._derived_from.name - return {self.name: desc} - - def get(self, **kwargs): - '''Get the value from the original signal''' - value = self._derived_from.get(**kwargs) - self._timestamp = self._derived_from.timestamp - return value - - def put(self, value, **kwargs): - '''Put the value to the original signal''' - res = self._derived_from.put(value, **kwargs) - self._timestamp = self._derived_from.timestamp - return res - - def wait_for_connection(self, timeout=0.0): - '''Wait for the original signal to connect''' - return self._derived_from.wait_for_connection(timeout=timeout) - - @property - def connected(self): - '''Mirrors the connection state of the original signal''' - return self._derived_from.connected - - @property - def limits(self): - '''Limits from the original signal''' - return self._derived_from.limits - - def _repr_info(self): - yield from super()._repr_info() - yield ('derived_from', self._derived_from) - - -
[docs]class EpicsSignalBase(Signal): - '''A read-only EpicsSignal -- that is, one with no `write_pv` - - Keyword arguments are passed on to the base class (Signal) initializer - - Parameters - ---------- - read_pv : str - The PV to read from - pv_kw : dict, optional - Keyword arguments for epics.PV(**pv_kw) - auto_monitor : bool, optional - Use automonitor with epics.PV - name : str, optional - Name of signal. If not given defaults to read_pv - string : bool, optional - Attempt to cast the EPICS PV value to a string by default - ''' - def __init__(self, read_pv, *, - pv_kw=None, - string=False, - auto_monitor=False, - name=None, - **kwargs): - - if 'rw' in kwargs: - if kwargs['rw']: - new_class = EpicsSignal - else: - new_class = EpicsSignalRO - - raise RuntimeError('rw is no longer an option for EpicsSignal. ' - 'Based on your setting of `rw`, you should be ' - 'using this class: {}' - ''.format(new_class.__name__)) - - if pv_kw is None: - pv_kw = dict() - - self._read_pv = None - self._string = bool(string) - self._pv_kw = pv_kw - self._auto_monitor = auto_monitor - - if name is None: - name = read_pv - - super().__init__(name=name, **kwargs) - - self._read_pv = epics.PV(read_pv, form=pv_form, - auto_monitor=auto_monitor, - **pv_kw) - - self._read_pv.add_callback(self._read_changed, - run_now=self._read_pv.connected) - - @property - def as_string(self): - '''Attempt to cast the EPICS PV value to a string by default''' - return self._string - - @property - @raise_if_disconnected - def precision(self): - '''The precision of the read PV, as reported by EPICS''' - return self._read_pv.precision - - @property - @raise_if_disconnected - def enum_strs(self): - """List of strings if PV is an enum type""" - return self._read_pv.enum_strs - - def _reinitialize_pv(self, old_instance, **pv_kw): - '''Reinitialize a PV instance - - Takes care of clearing callbacks, setting PV form, and ensuring - connectivity status remains the same - - Parameters - ---------- - old_instance : epics.PV - The old PV instance - pv_kw : kwargs - The parameters to pass to the initializer - ''' - - old_instance.clear_callbacks() - was_connected = old_instance.connected - - new_instance = epics.PV(old_instance.pvname, form=old_instance.form, - **pv_kw) - if was_connected: - new_instance.wait_for_connection() - - return new_instance - - def subscribe(self, callback, event_type=None, run=True): - if event_type is None: - event_type = self._default_sub - - # check if this is a setpoint subscription, and we are not explicitly - # auto monitoring - obj_mon = (event_type == self.SUB_VALUE and - self._auto_monitor is not True) - - # but if the epics.PV has already connected and determined that it - # should automonitor (based on the maximum automonitor length), then we - # don't need to reinitialize it - if obj_mon and not self._read_pv.auto_monitor: - self._read_pv = self._reinitialize_pv(self._read_pv, - auto_monitor=True, - **self._pv_kw) - self._read_pv.add_callback(self._read_changed, - run_now=self._read_pv.connected) - - return super().subscribe(callback, event_type=event_type, run=run) - - def wait_for_connection(self, timeout=1.0): - if not self._read_pv.connected: - if not self._read_pv.wait_for_connection(timeout=timeout): - raise TimeoutError('Failed to connect to %s' % - self._read_pv.pvname) - - @property - @raise_if_disconnected - def timestamp(self): - '''Timestamp of readback PV, according to EPICS''' - if not self._read_pv.auto_monitor: - # force updating the timestamp when not using auto monitoring - self._read_pv.get_timevars() - return self._read_pv.timestamp - - @property - def pvname(self): - '''The readback PV name''' - return self._read_pv.pvname - - def _repr_info(self): - yield ('read_pv', self._read_pv.pvname) - yield from super()._repr_info() - yield ('pv_kw', self._pv_kw) - yield ('auto_monitor', self._auto_monitor) - yield ('string', self._string) - - @property - def connected(self): - return self._read_pv.connected - - @property - @raise_if_disconnected - def limits(self): - '''The read PV limits''' - - # This overrides the base limits - pv = self._read_pv - pv.get_ctrlvars() - return (pv.lower_ctrl_limit, pv.upper_ctrl_limit) - -
[docs] def get(self, *, as_string=None, **kwargs): - '''Get the readback value through an explicit call to EPICS - - Parameters - ---------- - count : int, optional - Explicitly limit count for array data - as_string : bool, optional - Get a string representation of the value, defaults to as_string - from this signal, optional - as_numpy : bool - Use numpy array as the return type for array data. - timeout : float, optional - maximum time to wait for value to be received. - (default = 0.5 + log10(count) seconds) - use_monitor : bool, optional - to use value from latest monitor callback or to make an - explicit CA call for the value. (default: True) - ''' - # NOTE: in the future this should be improved to grab self._readback - # instead, when all of the kwargs match up - if as_string is None: - as_string = self._string - - if not self._read_pv.connected: - if not self._read_pv.wait_for_connection(): - raise TimeoutError('Failed to connect to %s' % - self._read_pv.pvname) - - ret = self._read_pv.get(as_string=as_string, **kwargs) - - if as_string: - return waveform_to_string(ret) - - return ret
- - def _fix_type(self, value): - if self._string: - value = waveform_to_string(value) - - return value - - def _read_changed(self, value=None, timestamp=None, **kwargs): - '''A callback indicating that the read value has changed''' - if timestamp is None: - timestamp = time.time() - - value = self._fix_type(value) - super().put(value, timestamp=timestamp, force=True) - -
[docs] def describe(self): - """Return the description as a dictionary - - Returns - ------- - dict - Dictionary of name and formatted description string - """ - desc = {'source': 'PV:{}'.format(self._read_pv.pvname), } - - val = self.value - desc['dtype'] = data_type(val) - desc['shape'] = data_shape(val) - - try: - desc['precision'] = int(self.precision) - except (ValueError, TypeError): - pass - desc['units'] = self._read_pv.units - - if hasattr(self, '_write_pv'): - desc['lower_ctrl_limit'] = self._write_pv.lower_ctrl_limit - desc['upper_ctrl_limit'] = self._write_pv.upper_ctrl_limit - - if self.enum_strs: - desc['enum_strs'] = list(self.enum_strs) - - return {self.name: desc}
- - @raise_if_disconnected -
[docs] def read(self): - """Read the signal and format for data collection - - Returns - ------- - dict - Dictionary of value timestamp pairs - """ - - return {self.name: {'value': self.value, - 'timestamp': self.timestamp}}
- - -
[docs]class EpicsSignalRO(EpicsSignalBase): - '''A read-only EpicsSignal -- that is, one with no `write_pv` - - Keyword arguments are passed on to the base class (Signal) initializer - - Parameters - ---------- - read_pv : str - The PV to read from - pv_kw : dict, optional - Keyword arguments for epics.PV(**pv_kw) - limits : bool, optional - Check limits prior to writing value - auto_monitor : bool, optional - Use automonitor with epics.PV - name : str, optional - Name of signal. If not given defaults to read_pv - ''' - def put(self, *args, **kwargs): - raise ReadOnlyError('Read-only signals cannot be put to') - - def set(self, *args, **kwargs): - raise ReadOnlyError('Read-only signals cannot be set')
- - -
[docs]class EpicsSignal(EpicsSignalBase): - '''An EPICS signal, comprised of either one or two EPICS PVs - - Keyword arguments are passed on to the base class (Signal) initializer - - Parameters - ---------- - read_pv : str - The PV to read from - write_pv : str, optional - The PV to write to if different from the read PV - pv_kw : dict, optional - Keyword arguments for epics.PV(**pv_kw) - limits : bool, optional - Check limits prior to writing value - auto_monitor : bool, optional - Use automonitor with epics.PV - name : str, optional - Name of signal. If not given defaults to read_pv - put_complete : bool, optional - Use put completion when writing the value - tolerance : any, optional - The absolute tolerance associated with the value. - If specified, this overrides any precision information calculated from - the write PV - rtolerance : any, optional - The relative tolerance associated with the value - ''' - SUB_SETPOINT = 'setpoint' - - def __init__(self, read_pv, write_pv=None, *, pv_kw=None, - put_complete=False, string=False, limits=False, - auto_monitor=False, name=None, **kwargs): - - self._write_pv = None - self._use_limits = bool(limits) - self._put_complete = put_complete - - self._setpoint = None - self._setpoint_ts = None - - if write_pv == read_pv: - write_pv = None - - super().__init__(read_pv, pv_kw=pv_kw, string=string, - auto_monitor=auto_monitor, name=name, **kwargs) - - if write_pv is not None: - self._write_pv = epics.PV(write_pv, form=pv_form, - auto_monitor=self._auto_monitor, - **self._pv_kw) - self._write_pv.add_callback(self._write_changed, - run_now=self._write_pv.connected) - else: - self._write_pv = self._read_pv - - def subscribe(self, callback, event_type=None, run=True): - if event_type is None: - event_type = self._default_sub - - # check if this is a setpoint subscription, and we are not explicitly - # auto monitoring - obj_mon = (event_type == self.SUB_SETPOINT and - self._auto_monitor is not True) - - # but if the epics.PV has already connected and determined that it - # should automonitor (based on the maximum automonitor length), then we - # don't need to reinitialize it - if obj_mon and not self._write_pv.auto_monitor: - self._write_pv = self._reinitialize_pv(self._write_pv, - auto_monitor=True, - **self._pv_kw) - self._write_pv.add_callback(self._write_changed, - run_now=self._write_pv.connected) - - return super().subscribe(callback, event_type=event_type, run=run) - - def wait_for_connection(self, timeout=1.0): - super().wait_for_connection(timeout=timeout) - - if self._write_pv is not None and not self._write_pv.connected: - if not self._write_pv.wait_for_connection(timeout=timeout): - raise TimeoutError('Failed to connect to %s' % - self._write_pv.pvname) - - @property - @raise_if_disconnected - def tolerance(self): - '''The tolerance of the write PV, as reported by EPICS - - Can be overidden by the user at the EpicsSignal level. - - Returns - ------- - tolerance : float or None - Using the write PV's precision: - If precision == 0, tolerance will be None - If precision > 0, calculated to be 10**(-precision) - ''' - # NOTE: overrides Signal.tolerance property - if self._tolerance is not None: - return self._tolerance - - precision = self.precision - if precision == 0 or precision is None: - return None - - return 10. ** (-precision) - - @tolerance.setter - def tolerance(self, tolerance): - self._tolerance = tolerance - - @property - @raise_if_disconnected - def setpoint_ts(self): - '''Timestamp of setpoint PV, according to EPICS''' - if not self._write_pv.auto_monitor: - # force updating the timestamp when not using auto monitoring - self._write_pv.get_timevars() - return self._write_pv.timestamp - - @property - def setpoint_pvname(self): - '''The setpoint PV name''' - return self._write_pv.pvname - - def _repr_info(self): - yield from super()._repr_info() - if self._write_pv is not None: - yield ('write_pv', self._write_pv.pvname) - - yield ('limits', self._use_limits) - yield ('put_complete', self._put_complete) - - @property - def connected(self): - return self._read_pv.connected and self._write_pv.connected - - @property - @raise_if_disconnected - def limits(self): - '''The write PV limits''' - # read_pv_limits = super().limits - pv = self._write_pv - pv.get_ctrlvars() - return (pv.lower_ctrl_limit, pv.upper_ctrl_limit) - -
[docs] def check_value(self, value): - '''Check if the value is within the setpoint PV's control limits - - Raises - ------ - ValueError - ''' - super().check_value(value) - - if value is None: - raise ValueError('Cannot write None to epics PVs') - if not self._use_limits: - return - - low_limit, high_limit = self.limits - if low_limit >= high_limit: - return - - if not (low_limit <= value <= high_limit): - raise LimitError('Value {} outside of range: [{}, {}]' - .format(value, low_limit, high_limit))
- - @raise_if_disconnected -
[docs] def get_setpoint(self, **kwargs): - '''Get the setpoint value (use only if the setpoint PV and the readback - PV differ) - - Keyword arguments are passed on to epics.PV.get() - ''' - setpoint = self._write_pv.get(**kwargs) - return self._fix_type(setpoint)
- - def _write_changed(self, value=None, timestamp=None, **kwargs): - '''A callback indicating that the write value has changed''' - if timestamp is None: - timestamp = time.time() - - value = self._fix_type(value) - - old_value = self._setpoint - self._setpoint = value - self._setpoint_ts = timestamp - - if self._read_pv is not self._write_pv: - self._run_subs(sub_type=self.SUB_SETPOINT, - old_value=old_value, value=value, - timestamp=self._setpoint_ts, **kwargs) - -
[docs] def put(self, value, force=False, **kwargs): - '''Using channel access, set the write PV to `value`. - - Keyword arguments are passed on to callbacks - - Parameters - ---------- - value : any - The value to set - force : bool, optional - Skip checking the value in Python first - ''' - if not force: - self.check_value(value) - - if not self._write_pv.connected: - if not self._write_pv.wait_for_connection(): - raise TimeoutError('Failed to connect to %s' % - self._write_pv.pvname) - - use_complete = kwargs.pop('use_complete', self._put_complete) - - self._write_pv.put(value, use_complete=use_complete, - **kwargs) - - old_value = self._setpoint - self._setpoint = value - - if self._read_pv is self._write_pv: - # readback and setpoint PV are one in the same, so update the - # readback as well - super().put(value, timestamp=time.time(), force=True) - self._run_subs(sub_type=self.SUB_SETPOINT, - old_value=old_value, value=value, - timestamp=self.timestamp, **kwargs)
- -
[docs] def set(self, value, *, timeout=None, settle_time=None): - '''Set is like `EpicsSignal.put`, but is here for bluesky compatibility - - If put completion is used for this EpicsSignal, the status object will - complete once EPICS reports the put has completed. - - Otherwise, set_and_wait will be used (as in `Signal.set`) - - Parameters - ---------- - value : any - timeout : float, optional - Maximum time to wait. Note that set_and_wait does not support - an infinite timeout. - settle_time: float, optional - Delay after the set() has completed to indicate completion - to the caller - - Returns - ------- - st : Status - - See Also - -------- - `Signal.set` - ''' - if not self._put_complete: - return super().set(value, timeout=timeout, settle_time=settle_time) - - # using put completion: - # timeout and settle time is handled by the status object. - st = Status(self, timeout=timeout, settle_time=settle_time) - - def put_callback(**kwargs): - st._finished(success=True) - - self.put(value, use_complete=True, callback=put_callback) - return st
- - @property - def setpoint(self): - '''The setpoint PV value''' - return self.get_setpoint() - - @setpoint.setter - def setpoint(self, value): - self.put(value)
- - -
[docs]class AttributeSignal(Signal): - '''Signal derived from a Python object instance's attribute - - Parameters - ---------- - attr : str - The dotted attribute name, relative to this signal's parent. - name : str, optional - The signal name - parent : Device, optional - The parent device instance - ''' - def __init__(self, attr, *, name=None, parent=None, **kwargs): - super().__init__(name=name, parent=parent, **kwargs) - - if '.' in attr: - self.attr_base, self.attr = attr.rsplit('.', 1) - else: - self.attr_base, self.attr = None, attr - - @property - def full_attr(self): - '''The full attribute name''' - if not self.attr_base: - return self.attr - else: - return '.'.join((self.attr_base, self.attr)) - - @property - def base(self): - '''The parent instance which has the final attribute''' - if self.attr_base is None: - return self.parent - - obj = self.parent - for i, part in enumerate(self.attr_base.split('.')): - try: - obj = getattr(obj, part) - except AttributeError as ex: - attr = '.'.join(self.parent_attr[:i + 1]) - raise AttributeError('{} ({})'.format(attr, ex)) - - return obj - - def get(self, **kwargs): - return getattr(self.base, self.attr) - - def put(self, value, **kwargs): - return setattr(self.base, self.attr, value) - - def describe(self): - value = self.value - desc = {'source': 'PY:{}.{}'.format(self.parent.name, self.full_attr), - 'dtype': data_type(value), - 'shape': data_shape(value), - } - return {self.name: desc}
- - -
[docs]class ArrayAttributeSignal(AttributeSignal): - '''An AttributeSignal which is cast to an ndarray on get - - This is used where data_type and data_shape may otherwise fail to determine - how to store the data into metadatastore. - ''' - def get(self, **kwargs): - return np.asarray(super().get(**kwargs))
-
- -
-
- - -
-
- -
- -
- - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/OEP/OEP_001.rst.txt b/ophyd/_sources/OEP/OEP_001.rst.txt deleted file mode 100644 index a4d7032ec9..0000000000 --- a/ophyd/_sources/OEP/OEP_001.rst.txt +++ /dev/null @@ -1,52 +0,0 @@ -=============================== -OEP 1 : AD refactor/unification -=============================== - - -.. contents:: - :local: - -Status -====== - -**Discussion** - -Branches and Pull requests -========================== - - - https://gist.github.com/danielballan/61fd3448f50027423a54 - -Abstract -======== - -Merge the two AreaDetector implementations. - -Detailed description -==================== - -Requirements ------------- - - - support full BlueSky API - - interact with filestore (may be super-ceded by FS integration at c-level) - - provide access to all PVs and plugins on the EPICS layer area - detector - - set up AD pipelines - - frame squashing - - be able to change at run-time what is inserted into the result of - ``read`` (ex, just return ROI values without saving full data) - - deal with dark-frames - - 'frequency' attribute to set acquire time - -Implementation -============== - -Backward compatibility -====================== - -None, break all the things - -Alternatives -============ - -Status quo diff --git a/ophyd/_sources/OEP/OEP_001.txt b/ophyd/_sources/OEP/OEP_001.txt deleted file mode 100644 index a4d7032ec9..0000000000 --- a/ophyd/_sources/OEP/OEP_001.txt +++ /dev/null @@ -1,52 +0,0 @@ -=============================== -OEP 1 : AD refactor/unification -=============================== - - -.. contents:: - :local: - -Status -====== - -**Discussion** - -Branches and Pull requests -========================== - - - https://gist.github.com/danielballan/61fd3448f50027423a54 - -Abstract -======== - -Merge the two AreaDetector implementations. - -Detailed description -==================== - -Requirements ------------- - - - support full BlueSky API - - interact with filestore (may be super-ceded by FS integration at c-level) - - provide access to all PVs and plugins on the EPICS layer area - detector - - set up AD pipelines - - frame squashing - - be able to change at run-time what is inserted into the result of - ``read`` (ex, just return ROI values without saving full data) - - deal with dark-frames - - 'frequency' attribute to set acquire time - -Implementation -============== - -Backward compatibility -====================== - -None, break all the things - -Alternatives -============ - -Status quo diff --git a/ophyd/_sources/OEP/index.rst.txt b/ophyd/_sources/OEP/index.rst.txt deleted file mode 100644 index 7e2593642b..0000000000 --- a/ophyd/_sources/OEP/index.rst.txt +++ /dev/null @@ -1,8 +0,0 @@ -Ophyd Enhancement Proposals -=========================== - -.. toctree:: - :glob: - :maxdepth: 1 - - OEP* diff --git a/ophyd/_sources/_as_gen/ophyd.areadetector.base.ADBase.get_asyn_digraph.rst.txt b/ophyd/_sources/_as_gen/ophyd.areadetector.base.ADBase.get_asyn_digraph.rst.txt deleted file mode 100644 index 49b1446924..0000000000 --- a/ophyd/_sources/_as_gen/ophyd.areadetector.base.ADBase.get_asyn_digraph.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -ophyd\.areadetector\.base\.ADBase\.get\_asyn\_digraph -===================================================== - -.. currentmodule:: ophyd.areadetector.base - -.. automethod:: ADBase.get_asyn_digraph \ No newline at end of file diff --git a/ophyd/_sources/_as_gen/ophyd.areadetector.base.ADBase.get_asyn_port_dictionary.rst.txt b/ophyd/_sources/_as_gen/ophyd.areadetector.base.ADBase.get_asyn_port_dictionary.rst.txt deleted file mode 100644 index 4e05314094..0000000000 --- a/ophyd/_sources/_as_gen/ophyd.areadetector.base.ADBase.get_asyn_port_dictionary.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -ophyd\.areadetector\.base\.ADBase\.get\_asyn\_port\_dictionary -============================================================== - -.. currentmodule:: ophyd.areadetector.base - -.. automethod:: ADBase.get_asyn_port_dictionary \ No newline at end of file diff --git a/ophyd/_sources/_as_gen/ophyd.areadetector.base.ADBase.get_plugin_by_asyn_port.rst.txt b/ophyd/_sources/_as_gen/ophyd.areadetector.base.ADBase.get_plugin_by_asyn_port.rst.txt deleted file mode 100644 index 14640d712b..0000000000 --- a/ophyd/_sources/_as_gen/ophyd.areadetector.base.ADBase.get_plugin_by_asyn_port.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -ophyd\.areadetector\.base\.ADBase\.get\_plugin\_by\_asyn\_port -============================================================== - -.. currentmodule:: ophyd.areadetector.base - -.. automethod:: ADBase.get_plugin_by_asyn_port \ No newline at end of file diff --git a/ophyd/_sources/_as_gen/ophyd.areadetector.base.ADBase.missing_plugins.rst.txt b/ophyd/_sources/_as_gen/ophyd.areadetector.base.ADBase.missing_plugins.rst.txt deleted file mode 100644 index 5c1179aa92..0000000000 --- a/ophyd/_sources/_as_gen/ophyd.areadetector.base.ADBase.missing_plugins.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -ophyd\.areadetector\.base\.ADBase\.missing\_plugins -=================================================== - -.. currentmodule:: ophyd.areadetector.base - -.. automethod:: ADBase.missing_plugins \ No newline at end of file diff --git a/ophyd/_sources/_as_gen/ophyd.areadetector.base.ADBase.rst.txt b/ophyd/_sources/_as_gen/ophyd.areadetector.base.ADBase.rst.txt deleted file mode 100644 index 104d997fe9..0000000000 --- a/ophyd/_sources/_as_gen/ophyd.areadetector.base.ADBase.rst.txt +++ /dev/null @@ -1,49 +0,0 @@ -ophyd\.areadetector\.base\.ADBase -================================= - -.. currentmodule:: ophyd.areadetector.base - -.. autoclass:: ADBase - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~ADBase.__init__ - ~ADBase.check_value - ~ADBase.clear_sub - ~ADBase.configure - ~ADBase.describe - ~ADBase.describe_configuration - ~ADBase.find_signal - ~ADBase.get - ~ADBase.get_asyn_digraph - ~ADBase.get_asyn_port_dictionary - ~ADBase.get_device_tuple - ~ADBase.get_instantiated_signals - ~ADBase.get_plugin_by_asyn_port - ~ADBase.missing_plugins - ~ADBase.pause - ~ADBase.put - ~ADBase.read - ~ADBase.read_configuration - ~ADBase.resume - ~ADBase.stage - ~ADBase.stop - ~ADBase.subscribe - ~ADBase.summary - ~ADBase.trigger - ~ADBase.unstage - ~ADBase.unsubscribe - ~ADBase.validate_asyn_ports - ~ADBase.wait_for_connection - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/_as_gen/ophyd.areadetector.base.ADBase.validate_asyn_ports.rst.txt b/ophyd/_sources/_as_gen/ophyd.areadetector.base.ADBase.validate_asyn_ports.rst.txt deleted file mode 100644 index 704ed4180a..0000000000 --- a/ophyd/_sources/_as_gen/ophyd.areadetector.base.ADBase.validate_asyn_ports.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -ophyd\.areadetector\.base\.ADBase\.validate\_asyn\_ports -======================================================== - -.. currentmodule:: ophyd.areadetector.base - -.. automethod:: ADBase.validate_asyn_ports \ No newline at end of file diff --git a/ophyd/_sources/_as_gen/ophyd.areadetector.base.ADComponent.rst.txt b/ophyd/_sources/_as_gen/ophyd.areadetector.base.ADComponent.rst.txt deleted file mode 100644 index 076b0baf28..0000000000 --- a/ophyd/_sources/_as_gen/ophyd.areadetector.base.ADComponent.rst.txt +++ /dev/null @@ -1,26 +0,0 @@ -ophyd\.areadetector\.base\.ADComponent -====================================== - -.. currentmodule:: ophyd.areadetector.base - -.. autoclass:: ADComponent - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~ADComponent.__init__ - ~ADComponent.create_component - ~ADComponent.find_docs - ~ADComponent.make_docstring - ~ADComponent.maybe_add_prefix - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/_as_gen/ophyd.areadetector.base.EpicsSignalWithRBV.rst.txt b/ophyd/_sources/_as_gen/ophyd.areadetector.base.EpicsSignalWithRBV.rst.txt deleted file mode 100644 index 75a465565c..0000000000 --- a/ophyd/_sources/_as_gen/ophyd.areadetector.base.EpicsSignalWithRBV.rst.txt +++ /dev/null @@ -1,36 +0,0 @@ -ophyd\.areadetector\.base\.EpicsSignalWithRBV -============================================= - -.. currentmodule:: ophyd.areadetector.base - -.. autoclass:: EpicsSignalWithRBV - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~EpicsSignalWithRBV.__init__ - ~EpicsSignalWithRBV.check_value - ~EpicsSignalWithRBV.clear_sub - ~EpicsSignalWithRBV.describe - ~EpicsSignalWithRBV.describe_configuration - ~EpicsSignalWithRBV.get - ~EpicsSignalWithRBV.get_setpoint - ~EpicsSignalWithRBV.put - ~EpicsSignalWithRBV.read - ~EpicsSignalWithRBV.read_configuration - ~EpicsSignalWithRBV.set - ~EpicsSignalWithRBV.subscribe - ~EpicsSignalWithRBV.trigger - ~EpicsSignalWithRBV.unsubscribe - ~EpicsSignalWithRBV.wait_for_connection - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/_as_gen/ophyd.areadetector.base.ad_group.rst.txt b/ophyd/_sources/_as_gen/ophyd.areadetector.base.ad_group.rst.txt deleted file mode 100644 index 4d6d3c197d..0000000000 --- a/ophyd/_sources/_as_gen/ophyd.areadetector.base.ad_group.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -ophyd\.areadetector\.base\.ad\_group -==================================== - -.. currentmodule:: ophyd.areadetector.base - -.. autofunction:: ad_group \ No newline at end of file diff --git a/ophyd/_sources/_as_gen/ophyd.areadetector.base.rst.txt b/ophyd/_sources/_as_gen/ophyd.areadetector.base.rst.txt deleted file mode 100644 index 45d5d7e065..0000000000 --- a/ophyd/_sources/_as_gen/ophyd.areadetector.base.rst.txt +++ /dev/null @@ -1,30 +0,0 @@ -ophyd\.areadetector\.base -========================= - -.. automodule:: ophyd.areadetector.base - - - - .. rubric:: Functions - - .. autosummary:: - - ad_group - - - - - - .. rubric:: Classes - - .. autosummary:: - - ADBase - ADComponent - EpicsSignalWithRBV - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/_as_gen/ophyd.areadetector.cam.AdscDetectorCam.rst.txt b/ophyd/_sources/_as_gen/ophyd.areadetector.cam.AdscDetectorCam.rst.txt deleted file mode 100644 index e657599e2c..0000000000 --- a/ophyd/_sources/_as_gen/ophyd.areadetector.cam.AdscDetectorCam.rst.txt +++ /dev/null @@ -1,49 +0,0 @@ -ophyd\.areadetector\.cam\.AdscDetectorCam -========================================= - -.. currentmodule:: ophyd.areadetector.cam - -.. autoclass:: AdscDetectorCam - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~AdscDetectorCam.__init__ - ~AdscDetectorCam.check_value - ~AdscDetectorCam.clear_sub - ~AdscDetectorCam.configure - ~AdscDetectorCam.describe - ~AdscDetectorCam.describe_configuration - ~AdscDetectorCam.find_signal - ~AdscDetectorCam.get - ~AdscDetectorCam.get_asyn_digraph - ~AdscDetectorCam.get_asyn_port_dictionary - ~AdscDetectorCam.get_device_tuple - ~AdscDetectorCam.get_instantiated_signals - ~AdscDetectorCam.get_plugin_by_asyn_port - ~AdscDetectorCam.missing_plugins - ~AdscDetectorCam.pause - ~AdscDetectorCam.put - ~AdscDetectorCam.read - ~AdscDetectorCam.read_configuration - ~AdscDetectorCam.resume - ~AdscDetectorCam.stage - ~AdscDetectorCam.stop - ~AdscDetectorCam.subscribe - ~AdscDetectorCam.summary - ~AdscDetectorCam.trigger - ~AdscDetectorCam.unstage - ~AdscDetectorCam.unsubscribe - ~AdscDetectorCam.validate_asyn_ports - ~AdscDetectorCam.wait_for_connection - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/_as_gen/ophyd.areadetector.cam.Andor3DetectorCam.rst.txt b/ophyd/_sources/_as_gen/ophyd.areadetector.cam.Andor3DetectorCam.rst.txt deleted file mode 100644 index 9a1051f283..0000000000 --- a/ophyd/_sources/_as_gen/ophyd.areadetector.cam.Andor3DetectorCam.rst.txt +++ /dev/null @@ -1,49 +0,0 @@ -ophyd\.areadetector\.cam\.Andor3DetectorCam -=========================================== - -.. currentmodule:: ophyd.areadetector.cam - -.. autoclass:: Andor3DetectorCam - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~Andor3DetectorCam.__init__ - ~Andor3DetectorCam.check_value - ~Andor3DetectorCam.clear_sub - ~Andor3DetectorCam.configure - ~Andor3DetectorCam.describe - ~Andor3DetectorCam.describe_configuration - ~Andor3DetectorCam.find_signal - ~Andor3DetectorCam.get - ~Andor3DetectorCam.get_asyn_digraph - ~Andor3DetectorCam.get_asyn_port_dictionary - ~Andor3DetectorCam.get_device_tuple - ~Andor3DetectorCam.get_instantiated_signals - ~Andor3DetectorCam.get_plugin_by_asyn_port - ~Andor3DetectorCam.missing_plugins - ~Andor3DetectorCam.pause - ~Andor3DetectorCam.put - ~Andor3DetectorCam.read - ~Andor3DetectorCam.read_configuration - ~Andor3DetectorCam.resume - ~Andor3DetectorCam.stage - ~Andor3DetectorCam.stop - ~Andor3DetectorCam.subscribe - ~Andor3DetectorCam.summary - ~Andor3DetectorCam.trigger - ~Andor3DetectorCam.unstage - ~Andor3DetectorCam.unsubscribe - ~Andor3DetectorCam.validate_asyn_ports - ~Andor3DetectorCam.wait_for_connection - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/_as_gen/ophyd.areadetector.cam.AndorDetectorCam.rst.txt b/ophyd/_sources/_as_gen/ophyd.areadetector.cam.AndorDetectorCam.rst.txt deleted file mode 100644 index 389b15ec37..0000000000 --- a/ophyd/_sources/_as_gen/ophyd.areadetector.cam.AndorDetectorCam.rst.txt +++ /dev/null @@ -1,49 +0,0 @@ -ophyd\.areadetector\.cam\.AndorDetectorCam -========================================== - -.. currentmodule:: ophyd.areadetector.cam - -.. autoclass:: AndorDetectorCam - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~AndorDetectorCam.__init__ - ~AndorDetectorCam.check_value - ~AndorDetectorCam.clear_sub - ~AndorDetectorCam.configure - ~AndorDetectorCam.describe - ~AndorDetectorCam.describe_configuration - ~AndorDetectorCam.find_signal - ~AndorDetectorCam.get - ~AndorDetectorCam.get_asyn_digraph - ~AndorDetectorCam.get_asyn_port_dictionary - ~AndorDetectorCam.get_device_tuple - ~AndorDetectorCam.get_instantiated_signals - ~AndorDetectorCam.get_plugin_by_asyn_port - ~AndorDetectorCam.missing_plugins - ~AndorDetectorCam.pause - ~AndorDetectorCam.put - ~AndorDetectorCam.read - ~AndorDetectorCam.read_configuration - ~AndorDetectorCam.resume - ~AndorDetectorCam.stage - ~AndorDetectorCam.stop - ~AndorDetectorCam.subscribe - ~AndorDetectorCam.summary - ~AndorDetectorCam.trigger - ~AndorDetectorCam.unstage - ~AndorDetectorCam.unsubscribe - ~AndorDetectorCam.validate_asyn_ports - ~AndorDetectorCam.wait_for_connection - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/_as_gen/ophyd.areadetector.cam.BrukerDetectorCam.rst.txt b/ophyd/_sources/_as_gen/ophyd.areadetector.cam.BrukerDetectorCam.rst.txt deleted file mode 100644 index a14e6d36b3..0000000000 --- a/ophyd/_sources/_as_gen/ophyd.areadetector.cam.BrukerDetectorCam.rst.txt +++ /dev/null @@ -1,49 +0,0 @@ -ophyd\.areadetector\.cam\.BrukerDetectorCam -=========================================== - -.. currentmodule:: ophyd.areadetector.cam - -.. autoclass:: BrukerDetectorCam - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~BrukerDetectorCam.__init__ - ~BrukerDetectorCam.check_value - ~BrukerDetectorCam.clear_sub - ~BrukerDetectorCam.configure - ~BrukerDetectorCam.describe - ~BrukerDetectorCam.describe_configuration - ~BrukerDetectorCam.find_signal - ~BrukerDetectorCam.get - ~BrukerDetectorCam.get_asyn_digraph - ~BrukerDetectorCam.get_asyn_port_dictionary - ~BrukerDetectorCam.get_device_tuple - ~BrukerDetectorCam.get_instantiated_signals - ~BrukerDetectorCam.get_plugin_by_asyn_port - ~BrukerDetectorCam.missing_plugins - ~BrukerDetectorCam.pause - ~BrukerDetectorCam.put - ~BrukerDetectorCam.read - ~BrukerDetectorCam.read_configuration - ~BrukerDetectorCam.resume - ~BrukerDetectorCam.stage - ~BrukerDetectorCam.stop - ~BrukerDetectorCam.subscribe - ~BrukerDetectorCam.summary - ~BrukerDetectorCam.trigger - ~BrukerDetectorCam.unstage - ~BrukerDetectorCam.unsubscribe - ~BrukerDetectorCam.validate_asyn_ports - ~BrukerDetectorCam.wait_for_connection - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/_as_gen/ophyd.areadetector.cam.CamBase.rst.txt b/ophyd/_sources/_as_gen/ophyd.areadetector.cam.CamBase.rst.txt deleted file mode 100644 index 2929bcba38..0000000000 --- a/ophyd/_sources/_as_gen/ophyd.areadetector.cam.CamBase.rst.txt +++ /dev/null @@ -1,49 +0,0 @@ -ophyd\.areadetector\.cam\.CamBase -================================= - -.. currentmodule:: ophyd.areadetector.cam - -.. autoclass:: CamBase - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~CamBase.__init__ - ~CamBase.check_value - ~CamBase.clear_sub - ~CamBase.configure - ~CamBase.describe - ~CamBase.describe_configuration - ~CamBase.find_signal - ~CamBase.get - ~CamBase.get_asyn_digraph - ~CamBase.get_asyn_port_dictionary - ~CamBase.get_device_tuple - ~CamBase.get_instantiated_signals - ~CamBase.get_plugin_by_asyn_port - ~CamBase.missing_plugins - ~CamBase.pause - ~CamBase.put - ~CamBase.read - ~CamBase.read_configuration - ~CamBase.resume - ~CamBase.stage - ~CamBase.stop - ~CamBase.subscribe - ~CamBase.summary - ~CamBase.trigger - ~CamBase.unstage - ~CamBase.unsubscribe - ~CamBase.validate_asyn_ports - ~CamBase.wait_for_connection - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/_as_gen/ophyd.areadetector.cam.FirewireLinDetectorCam.rst.txt b/ophyd/_sources/_as_gen/ophyd.areadetector.cam.FirewireLinDetectorCam.rst.txt deleted file mode 100644 index 3183d9ac7a..0000000000 --- a/ophyd/_sources/_as_gen/ophyd.areadetector.cam.FirewireLinDetectorCam.rst.txt +++ /dev/null @@ -1,49 +0,0 @@ -ophyd\.areadetector\.cam\.FirewireLinDetectorCam -================================================ - -.. currentmodule:: ophyd.areadetector.cam - -.. autoclass:: FirewireLinDetectorCam - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~FirewireLinDetectorCam.__init__ - ~FirewireLinDetectorCam.check_value - ~FirewireLinDetectorCam.clear_sub - ~FirewireLinDetectorCam.configure - ~FirewireLinDetectorCam.describe - ~FirewireLinDetectorCam.describe_configuration - ~FirewireLinDetectorCam.find_signal - ~FirewireLinDetectorCam.get - ~FirewireLinDetectorCam.get_asyn_digraph - ~FirewireLinDetectorCam.get_asyn_port_dictionary - ~FirewireLinDetectorCam.get_device_tuple - ~FirewireLinDetectorCam.get_instantiated_signals - ~FirewireLinDetectorCam.get_plugin_by_asyn_port - ~FirewireLinDetectorCam.missing_plugins - ~FirewireLinDetectorCam.pause - ~FirewireLinDetectorCam.put - ~FirewireLinDetectorCam.read - ~FirewireLinDetectorCam.read_configuration - ~FirewireLinDetectorCam.resume - ~FirewireLinDetectorCam.stage - ~FirewireLinDetectorCam.stop - ~FirewireLinDetectorCam.subscribe - ~FirewireLinDetectorCam.summary - ~FirewireLinDetectorCam.trigger - ~FirewireLinDetectorCam.unstage - ~FirewireLinDetectorCam.unsubscribe - ~FirewireLinDetectorCam.validate_asyn_ports - ~FirewireLinDetectorCam.wait_for_connection - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/_as_gen/ophyd.areadetector.cam.FirewireWinDetectorCam.rst.txt b/ophyd/_sources/_as_gen/ophyd.areadetector.cam.FirewireWinDetectorCam.rst.txt deleted file mode 100644 index 4f4f0bfffd..0000000000 --- a/ophyd/_sources/_as_gen/ophyd.areadetector.cam.FirewireWinDetectorCam.rst.txt +++ /dev/null @@ -1,49 +0,0 @@ -ophyd\.areadetector\.cam\.FirewireWinDetectorCam -================================================ - -.. currentmodule:: ophyd.areadetector.cam - -.. autoclass:: FirewireWinDetectorCam - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~FirewireWinDetectorCam.__init__ - ~FirewireWinDetectorCam.check_value - ~FirewireWinDetectorCam.clear_sub - ~FirewireWinDetectorCam.configure - ~FirewireWinDetectorCam.describe - ~FirewireWinDetectorCam.describe_configuration - ~FirewireWinDetectorCam.find_signal - ~FirewireWinDetectorCam.get - ~FirewireWinDetectorCam.get_asyn_digraph - ~FirewireWinDetectorCam.get_asyn_port_dictionary - ~FirewireWinDetectorCam.get_device_tuple - ~FirewireWinDetectorCam.get_instantiated_signals - ~FirewireWinDetectorCam.get_plugin_by_asyn_port - ~FirewireWinDetectorCam.missing_plugins - ~FirewireWinDetectorCam.pause - ~FirewireWinDetectorCam.put - ~FirewireWinDetectorCam.read - ~FirewireWinDetectorCam.read_configuration - ~FirewireWinDetectorCam.resume - ~FirewireWinDetectorCam.stage - ~FirewireWinDetectorCam.stop - ~FirewireWinDetectorCam.subscribe - ~FirewireWinDetectorCam.summary - ~FirewireWinDetectorCam.trigger - ~FirewireWinDetectorCam.unstage - ~FirewireWinDetectorCam.unsubscribe - ~FirewireWinDetectorCam.validate_asyn_ports - ~FirewireWinDetectorCam.wait_for_connection - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/_as_gen/ophyd.areadetector.cam.LightFieldDetectorCam.rst.txt b/ophyd/_sources/_as_gen/ophyd.areadetector.cam.LightFieldDetectorCam.rst.txt deleted file mode 100644 index bfb4d943d3..0000000000 --- a/ophyd/_sources/_as_gen/ophyd.areadetector.cam.LightFieldDetectorCam.rst.txt +++ /dev/null @@ -1,49 +0,0 @@ -ophyd\.areadetector\.cam\.LightFieldDetectorCam -=============================================== - -.. currentmodule:: ophyd.areadetector.cam - -.. autoclass:: LightFieldDetectorCam - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~LightFieldDetectorCam.__init__ - ~LightFieldDetectorCam.check_value - ~LightFieldDetectorCam.clear_sub - ~LightFieldDetectorCam.configure - ~LightFieldDetectorCam.describe - ~LightFieldDetectorCam.describe_configuration - ~LightFieldDetectorCam.find_signal - ~LightFieldDetectorCam.get - ~LightFieldDetectorCam.get_asyn_digraph - ~LightFieldDetectorCam.get_asyn_port_dictionary - ~LightFieldDetectorCam.get_device_tuple - ~LightFieldDetectorCam.get_instantiated_signals - ~LightFieldDetectorCam.get_plugin_by_asyn_port - ~LightFieldDetectorCam.missing_plugins - ~LightFieldDetectorCam.pause - ~LightFieldDetectorCam.put - ~LightFieldDetectorCam.read - ~LightFieldDetectorCam.read_configuration - ~LightFieldDetectorCam.resume - ~LightFieldDetectorCam.stage - ~LightFieldDetectorCam.stop - ~LightFieldDetectorCam.subscribe - ~LightFieldDetectorCam.summary - ~LightFieldDetectorCam.trigger - ~LightFieldDetectorCam.unstage - ~LightFieldDetectorCam.unsubscribe - ~LightFieldDetectorCam.validate_asyn_ports - ~LightFieldDetectorCam.wait_for_connection - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/_as_gen/ophyd.areadetector.cam.Mar345DetectorCam.rst.txt b/ophyd/_sources/_as_gen/ophyd.areadetector.cam.Mar345DetectorCam.rst.txt deleted file mode 100644 index dc4871ffad..0000000000 --- a/ophyd/_sources/_as_gen/ophyd.areadetector.cam.Mar345DetectorCam.rst.txt +++ /dev/null @@ -1,49 +0,0 @@ -ophyd\.areadetector\.cam\.Mar345DetectorCam -=========================================== - -.. currentmodule:: ophyd.areadetector.cam - -.. autoclass:: Mar345DetectorCam - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~Mar345DetectorCam.__init__ - ~Mar345DetectorCam.check_value - ~Mar345DetectorCam.clear_sub - ~Mar345DetectorCam.configure - ~Mar345DetectorCam.describe - ~Mar345DetectorCam.describe_configuration - ~Mar345DetectorCam.find_signal - ~Mar345DetectorCam.get - ~Mar345DetectorCam.get_asyn_digraph - ~Mar345DetectorCam.get_asyn_port_dictionary - ~Mar345DetectorCam.get_device_tuple - ~Mar345DetectorCam.get_instantiated_signals - ~Mar345DetectorCam.get_plugin_by_asyn_port - ~Mar345DetectorCam.missing_plugins - ~Mar345DetectorCam.pause - ~Mar345DetectorCam.put - ~Mar345DetectorCam.read - ~Mar345DetectorCam.read_configuration - ~Mar345DetectorCam.resume - ~Mar345DetectorCam.stage - ~Mar345DetectorCam.stop - ~Mar345DetectorCam.subscribe - ~Mar345DetectorCam.summary - ~Mar345DetectorCam.trigger - ~Mar345DetectorCam.unstage - ~Mar345DetectorCam.unsubscribe - ~Mar345DetectorCam.validate_asyn_ports - ~Mar345DetectorCam.wait_for_connection - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/_as_gen/ophyd.areadetector.cam.MarCCDDetectorCam.rst.txt b/ophyd/_sources/_as_gen/ophyd.areadetector.cam.MarCCDDetectorCam.rst.txt deleted file mode 100644 index 2256d8cce8..0000000000 --- a/ophyd/_sources/_as_gen/ophyd.areadetector.cam.MarCCDDetectorCam.rst.txt +++ /dev/null @@ -1,49 +0,0 @@ -ophyd\.areadetector\.cam\.MarCCDDetectorCam -=========================================== - -.. currentmodule:: ophyd.areadetector.cam - -.. autoclass:: MarCCDDetectorCam - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~MarCCDDetectorCam.__init__ - ~MarCCDDetectorCam.check_value - ~MarCCDDetectorCam.clear_sub - ~MarCCDDetectorCam.configure - ~MarCCDDetectorCam.describe - ~MarCCDDetectorCam.describe_configuration - ~MarCCDDetectorCam.find_signal - ~MarCCDDetectorCam.get - ~MarCCDDetectorCam.get_asyn_digraph - ~MarCCDDetectorCam.get_asyn_port_dictionary - ~MarCCDDetectorCam.get_device_tuple - ~MarCCDDetectorCam.get_instantiated_signals - ~MarCCDDetectorCam.get_plugin_by_asyn_port - ~MarCCDDetectorCam.missing_plugins - ~MarCCDDetectorCam.pause - ~MarCCDDetectorCam.put - ~MarCCDDetectorCam.read - ~MarCCDDetectorCam.read_configuration - ~MarCCDDetectorCam.resume - ~MarCCDDetectorCam.stage - ~MarCCDDetectorCam.stop - ~MarCCDDetectorCam.subscribe - ~MarCCDDetectorCam.summary - ~MarCCDDetectorCam.trigger - ~MarCCDDetectorCam.unstage - ~MarCCDDetectorCam.unsubscribe - ~MarCCDDetectorCam.validate_asyn_ports - ~MarCCDDetectorCam.wait_for_connection - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/_as_gen/ophyd.areadetector.cam.PSLDetectorCam.rst.txt b/ophyd/_sources/_as_gen/ophyd.areadetector.cam.PSLDetectorCam.rst.txt deleted file mode 100644 index 3c03fbc904..0000000000 --- a/ophyd/_sources/_as_gen/ophyd.areadetector.cam.PSLDetectorCam.rst.txt +++ /dev/null @@ -1,49 +0,0 @@ -ophyd\.areadetector\.cam\.PSLDetectorCam -======================================== - -.. currentmodule:: ophyd.areadetector.cam - -.. autoclass:: PSLDetectorCam - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~PSLDetectorCam.__init__ - ~PSLDetectorCam.check_value - ~PSLDetectorCam.clear_sub - ~PSLDetectorCam.configure - ~PSLDetectorCam.describe - ~PSLDetectorCam.describe_configuration - ~PSLDetectorCam.find_signal - ~PSLDetectorCam.get - ~PSLDetectorCam.get_asyn_digraph - ~PSLDetectorCam.get_asyn_port_dictionary - ~PSLDetectorCam.get_device_tuple - ~PSLDetectorCam.get_instantiated_signals - ~PSLDetectorCam.get_plugin_by_asyn_port - ~PSLDetectorCam.missing_plugins - ~PSLDetectorCam.pause - ~PSLDetectorCam.put - ~PSLDetectorCam.read - ~PSLDetectorCam.read_configuration - ~PSLDetectorCam.resume - ~PSLDetectorCam.stage - ~PSLDetectorCam.stop - ~PSLDetectorCam.subscribe - ~PSLDetectorCam.summary - ~PSLDetectorCam.trigger - ~PSLDetectorCam.unstage - ~PSLDetectorCam.unsubscribe - ~PSLDetectorCam.validate_asyn_ports - ~PSLDetectorCam.wait_for_connection - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/_as_gen/ophyd.areadetector.cam.PcoDetectorCam.rst.txt b/ophyd/_sources/_as_gen/ophyd.areadetector.cam.PcoDetectorCam.rst.txt deleted file mode 100644 index 44a34dff72..0000000000 --- a/ophyd/_sources/_as_gen/ophyd.areadetector.cam.PcoDetectorCam.rst.txt +++ /dev/null @@ -1,49 +0,0 @@ -ophyd\.areadetector\.cam\.PcoDetectorCam -======================================== - -.. currentmodule:: ophyd.areadetector.cam - -.. autoclass:: PcoDetectorCam - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~PcoDetectorCam.__init__ - ~PcoDetectorCam.check_value - ~PcoDetectorCam.clear_sub - ~PcoDetectorCam.configure - ~PcoDetectorCam.describe - ~PcoDetectorCam.describe_configuration - ~PcoDetectorCam.find_signal - ~PcoDetectorCam.get - ~PcoDetectorCam.get_asyn_digraph - ~PcoDetectorCam.get_asyn_port_dictionary - ~PcoDetectorCam.get_device_tuple - ~PcoDetectorCam.get_instantiated_signals - ~PcoDetectorCam.get_plugin_by_asyn_port - ~PcoDetectorCam.missing_plugins - ~PcoDetectorCam.pause - ~PcoDetectorCam.put - ~PcoDetectorCam.read - ~PcoDetectorCam.read_configuration - ~PcoDetectorCam.resume - ~PcoDetectorCam.stage - ~PcoDetectorCam.stop - ~PcoDetectorCam.subscribe - ~PcoDetectorCam.summary - ~PcoDetectorCam.trigger - ~PcoDetectorCam.unstage - ~PcoDetectorCam.unsubscribe - ~PcoDetectorCam.validate_asyn_ports - ~PcoDetectorCam.wait_for_connection - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/_as_gen/ophyd.areadetector.cam.PcoDetectorIO.rst.txt b/ophyd/_sources/_as_gen/ophyd.areadetector.cam.PcoDetectorIO.rst.txt deleted file mode 100644 index dbcc986573..0000000000 --- a/ophyd/_sources/_as_gen/ophyd.areadetector.cam.PcoDetectorIO.rst.txt +++ /dev/null @@ -1,49 +0,0 @@ -ophyd\.areadetector\.cam\.PcoDetectorIO -======================================= - -.. currentmodule:: ophyd.areadetector.cam - -.. autoclass:: PcoDetectorIO - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~PcoDetectorIO.__init__ - ~PcoDetectorIO.check_value - ~PcoDetectorIO.clear_sub - ~PcoDetectorIO.configure - ~PcoDetectorIO.describe - ~PcoDetectorIO.describe_configuration - ~PcoDetectorIO.find_signal - ~PcoDetectorIO.get - ~PcoDetectorIO.get_asyn_digraph - ~PcoDetectorIO.get_asyn_port_dictionary - ~PcoDetectorIO.get_device_tuple - ~PcoDetectorIO.get_instantiated_signals - ~PcoDetectorIO.get_plugin_by_asyn_port - ~PcoDetectorIO.missing_plugins - ~PcoDetectorIO.pause - ~PcoDetectorIO.put - ~PcoDetectorIO.read - ~PcoDetectorIO.read_configuration - ~PcoDetectorIO.resume - ~PcoDetectorIO.stage - ~PcoDetectorIO.stop - ~PcoDetectorIO.subscribe - ~PcoDetectorIO.summary - ~PcoDetectorIO.trigger - ~PcoDetectorIO.unstage - ~PcoDetectorIO.unsubscribe - ~PcoDetectorIO.validate_asyn_ports - ~PcoDetectorIO.wait_for_connection - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/_as_gen/ophyd.areadetector.cam.PcoDetectorSimIO.rst.txt b/ophyd/_sources/_as_gen/ophyd.areadetector.cam.PcoDetectorSimIO.rst.txt deleted file mode 100644 index b79c88c33d..0000000000 --- a/ophyd/_sources/_as_gen/ophyd.areadetector.cam.PcoDetectorSimIO.rst.txt +++ /dev/null @@ -1,49 +0,0 @@ -ophyd\.areadetector\.cam\.PcoDetectorSimIO -========================================== - -.. currentmodule:: ophyd.areadetector.cam - -.. autoclass:: PcoDetectorSimIO - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~PcoDetectorSimIO.__init__ - ~PcoDetectorSimIO.check_value - ~PcoDetectorSimIO.clear_sub - ~PcoDetectorSimIO.configure - ~PcoDetectorSimIO.describe - ~PcoDetectorSimIO.describe_configuration - ~PcoDetectorSimIO.find_signal - ~PcoDetectorSimIO.get - ~PcoDetectorSimIO.get_asyn_digraph - ~PcoDetectorSimIO.get_asyn_port_dictionary - ~PcoDetectorSimIO.get_device_tuple - ~PcoDetectorSimIO.get_instantiated_signals - ~PcoDetectorSimIO.get_plugin_by_asyn_port - ~PcoDetectorSimIO.missing_plugins - ~PcoDetectorSimIO.pause - ~PcoDetectorSimIO.put - ~PcoDetectorSimIO.read - ~PcoDetectorSimIO.read_configuration - ~PcoDetectorSimIO.resume - ~PcoDetectorSimIO.stage - ~PcoDetectorSimIO.stop - ~PcoDetectorSimIO.subscribe - ~PcoDetectorSimIO.summary - ~PcoDetectorSimIO.trigger - ~PcoDetectorSimIO.unstage - ~PcoDetectorSimIO.unsubscribe - ~PcoDetectorSimIO.validate_asyn_ports - ~PcoDetectorSimIO.wait_for_connection - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/_as_gen/ophyd.areadetector.cam.PerkinElmerDetectorCam.rst.txt b/ophyd/_sources/_as_gen/ophyd.areadetector.cam.PerkinElmerDetectorCam.rst.txt deleted file mode 100644 index 7b729290bf..0000000000 --- a/ophyd/_sources/_as_gen/ophyd.areadetector.cam.PerkinElmerDetectorCam.rst.txt +++ /dev/null @@ -1,49 +0,0 @@ -ophyd\.areadetector\.cam\.PerkinElmerDetectorCam -================================================ - -.. currentmodule:: ophyd.areadetector.cam - -.. autoclass:: PerkinElmerDetectorCam - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~PerkinElmerDetectorCam.__init__ - ~PerkinElmerDetectorCam.check_value - ~PerkinElmerDetectorCam.clear_sub - ~PerkinElmerDetectorCam.configure - ~PerkinElmerDetectorCam.describe - ~PerkinElmerDetectorCam.describe_configuration - ~PerkinElmerDetectorCam.find_signal - ~PerkinElmerDetectorCam.get - ~PerkinElmerDetectorCam.get_asyn_digraph - ~PerkinElmerDetectorCam.get_asyn_port_dictionary - ~PerkinElmerDetectorCam.get_device_tuple - ~PerkinElmerDetectorCam.get_instantiated_signals - ~PerkinElmerDetectorCam.get_plugin_by_asyn_port - ~PerkinElmerDetectorCam.missing_plugins - ~PerkinElmerDetectorCam.pause - ~PerkinElmerDetectorCam.put - ~PerkinElmerDetectorCam.read - ~PerkinElmerDetectorCam.read_configuration - ~PerkinElmerDetectorCam.resume - ~PerkinElmerDetectorCam.stage - ~PerkinElmerDetectorCam.stop - ~PerkinElmerDetectorCam.subscribe - ~PerkinElmerDetectorCam.summary - ~PerkinElmerDetectorCam.trigger - ~PerkinElmerDetectorCam.unstage - ~PerkinElmerDetectorCam.unsubscribe - ~PerkinElmerDetectorCam.validate_asyn_ports - ~PerkinElmerDetectorCam.wait_for_connection - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/_as_gen/ophyd.areadetector.cam.PilatusDetectorCam.rst.txt b/ophyd/_sources/_as_gen/ophyd.areadetector.cam.PilatusDetectorCam.rst.txt deleted file mode 100644 index 6a997e1d77..0000000000 --- a/ophyd/_sources/_as_gen/ophyd.areadetector.cam.PilatusDetectorCam.rst.txt +++ /dev/null @@ -1,49 +0,0 @@ -ophyd\.areadetector\.cam\.PilatusDetectorCam -============================================ - -.. currentmodule:: ophyd.areadetector.cam - -.. autoclass:: PilatusDetectorCam - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~PilatusDetectorCam.__init__ - ~PilatusDetectorCam.check_value - ~PilatusDetectorCam.clear_sub - ~PilatusDetectorCam.configure - ~PilatusDetectorCam.describe - ~PilatusDetectorCam.describe_configuration - ~PilatusDetectorCam.find_signal - ~PilatusDetectorCam.get - ~PilatusDetectorCam.get_asyn_digraph - ~PilatusDetectorCam.get_asyn_port_dictionary - ~PilatusDetectorCam.get_device_tuple - ~PilatusDetectorCam.get_instantiated_signals - ~PilatusDetectorCam.get_plugin_by_asyn_port - ~PilatusDetectorCam.missing_plugins - ~PilatusDetectorCam.pause - ~PilatusDetectorCam.put - ~PilatusDetectorCam.read - ~PilatusDetectorCam.read_configuration - ~PilatusDetectorCam.resume - ~PilatusDetectorCam.stage - ~PilatusDetectorCam.stop - ~PilatusDetectorCam.subscribe - ~PilatusDetectorCam.summary - ~PilatusDetectorCam.trigger - ~PilatusDetectorCam.unstage - ~PilatusDetectorCam.unsubscribe - ~PilatusDetectorCam.validate_asyn_ports - ~PilatusDetectorCam.wait_for_connection - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/_as_gen/ophyd.areadetector.cam.PixiradDetectorCam.rst.txt b/ophyd/_sources/_as_gen/ophyd.areadetector.cam.PixiradDetectorCam.rst.txt deleted file mode 100644 index 2a8a55f643..0000000000 --- a/ophyd/_sources/_as_gen/ophyd.areadetector.cam.PixiradDetectorCam.rst.txt +++ /dev/null @@ -1,49 +0,0 @@ -ophyd\.areadetector\.cam\.PixiradDetectorCam -============================================ - -.. currentmodule:: ophyd.areadetector.cam - -.. autoclass:: PixiradDetectorCam - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~PixiradDetectorCam.__init__ - ~PixiradDetectorCam.check_value - ~PixiradDetectorCam.clear_sub - ~PixiradDetectorCam.configure - ~PixiradDetectorCam.describe - ~PixiradDetectorCam.describe_configuration - ~PixiradDetectorCam.find_signal - ~PixiradDetectorCam.get - ~PixiradDetectorCam.get_asyn_digraph - ~PixiradDetectorCam.get_asyn_port_dictionary - ~PixiradDetectorCam.get_device_tuple - ~PixiradDetectorCam.get_instantiated_signals - ~PixiradDetectorCam.get_plugin_by_asyn_port - ~PixiradDetectorCam.missing_plugins - ~PixiradDetectorCam.pause - ~PixiradDetectorCam.put - ~PixiradDetectorCam.read - ~PixiradDetectorCam.read_configuration - ~PixiradDetectorCam.resume - ~PixiradDetectorCam.stage - ~PixiradDetectorCam.stop - ~PixiradDetectorCam.subscribe - ~PixiradDetectorCam.summary - ~PixiradDetectorCam.trigger - ~PixiradDetectorCam.unstage - ~PixiradDetectorCam.unsubscribe - ~PixiradDetectorCam.validate_asyn_ports - ~PixiradDetectorCam.wait_for_connection - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/_as_gen/ophyd.areadetector.cam.PointGreyDetectorCam.rst.txt b/ophyd/_sources/_as_gen/ophyd.areadetector.cam.PointGreyDetectorCam.rst.txt deleted file mode 100644 index 9aacc7a135..0000000000 --- a/ophyd/_sources/_as_gen/ophyd.areadetector.cam.PointGreyDetectorCam.rst.txt +++ /dev/null @@ -1,49 +0,0 @@ -ophyd\.areadetector\.cam\.PointGreyDetectorCam -============================================== - -.. currentmodule:: ophyd.areadetector.cam - -.. autoclass:: PointGreyDetectorCam - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~PointGreyDetectorCam.__init__ - ~PointGreyDetectorCam.check_value - ~PointGreyDetectorCam.clear_sub - ~PointGreyDetectorCam.configure - ~PointGreyDetectorCam.describe - ~PointGreyDetectorCam.describe_configuration - ~PointGreyDetectorCam.find_signal - ~PointGreyDetectorCam.get - ~PointGreyDetectorCam.get_asyn_digraph - ~PointGreyDetectorCam.get_asyn_port_dictionary - ~PointGreyDetectorCam.get_device_tuple - ~PointGreyDetectorCam.get_instantiated_signals - ~PointGreyDetectorCam.get_plugin_by_asyn_port - ~PointGreyDetectorCam.missing_plugins - ~PointGreyDetectorCam.pause - ~PointGreyDetectorCam.put - ~PointGreyDetectorCam.read - ~PointGreyDetectorCam.read_configuration - ~PointGreyDetectorCam.resume - ~PointGreyDetectorCam.stage - ~PointGreyDetectorCam.stop - ~PointGreyDetectorCam.subscribe - ~PointGreyDetectorCam.summary - ~PointGreyDetectorCam.trigger - ~PointGreyDetectorCam.unstage - ~PointGreyDetectorCam.unsubscribe - ~PointGreyDetectorCam.validate_asyn_ports - ~PointGreyDetectorCam.wait_for_connection - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/_as_gen/ophyd.areadetector.cam.ProsilicaDetectorCam.rst.txt b/ophyd/_sources/_as_gen/ophyd.areadetector.cam.ProsilicaDetectorCam.rst.txt deleted file mode 100644 index ae3e736d2c..0000000000 --- a/ophyd/_sources/_as_gen/ophyd.areadetector.cam.ProsilicaDetectorCam.rst.txt +++ /dev/null @@ -1,49 +0,0 @@ -ophyd\.areadetector\.cam\.ProsilicaDetectorCam -============================================== - -.. currentmodule:: ophyd.areadetector.cam - -.. autoclass:: ProsilicaDetectorCam - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~ProsilicaDetectorCam.__init__ - ~ProsilicaDetectorCam.check_value - ~ProsilicaDetectorCam.clear_sub - ~ProsilicaDetectorCam.configure - ~ProsilicaDetectorCam.describe - ~ProsilicaDetectorCam.describe_configuration - ~ProsilicaDetectorCam.find_signal - ~ProsilicaDetectorCam.get - ~ProsilicaDetectorCam.get_asyn_digraph - ~ProsilicaDetectorCam.get_asyn_port_dictionary - ~ProsilicaDetectorCam.get_device_tuple - ~ProsilicaDetectorCam.get_instantiated_signals - ~ProsilicaDetectorCam.get_plugin_by_asyn_port - ~ProsilicaDetectorCam.missing_plugins - ~ProsilicaDetectorCam.pause - ~ProsilicaDetectorCam.put - ~ProsilicaDetectorCam.read - ~ProsilicaDetectorCam.read_configuration - ~ProsilicaDetectorCam.resume - ~ProsilicaDetectorCam.stage - ~ProsilicaDetectorCam.stop - ~ProsilicaDetectorCam.subscribe - ~ProsilicaDetectorCam.summary - ~ProsilicaDetectorCam.trigger - ~ProsilicaDetectorCam.unstage - ~ProsilicaDetectorCam.unsubscribe - ~ProsilicaDetectorCam.validate_asyn_ports - ~ProsilicaDetectorCam.wait_for_connection - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/_as_gen/ophyd.areadetector.cam.PvcamDetectorCam.rst.txt b/ophyd/_sources/_as_gen/ophyd.areadetector.cam.PvcamDetectorCam.rst.txt deleted file mode 100644 index 16a7484fd1..0000000000 --- a/ophyd/_sources/_as_gen/ophyd.areadetector.cam.PvcamDetectorCam.rst.txt +++ /dev/null @@ -1,49 +0,0 @@ -ophyd\.areadetector\.cam\.PvcamDetectorCam -========================================== - -.. currentmodule:: ophyd.areadetector.cam - -.. autoclass:: PvcamDetectorCam - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~PvcamDetectorCam.__init__ - ~PvcamDetectorCam.check_value - ~PvcamDetectorCam.clear_sub - ~PvcamDetectorCam.configure - ~PvcamDetectorCam.describe - ~PvcamDetectorCam.describe_configuration - ~PvcamDetectorCam.find_signal - ~PvcamDetectorCam.get - ~PvcamDetectorCam.get_asyn_digraph - ~PvcamDetectorCam.get_asyn_port_dictionary - ~PvcamDetectorCam.get_device_tuple - ~PvcamDetectorCam.get_instantiated_signals - ~PvcamDetectorCam.get_plugin_by_asyn_port - ~PvcamDetectorCam.missing_plugins - ~PvcamDetectorCam.pause - ~PvcamDetectorCam.put - ~PvcamDetectorCam.read - ~PvcamDetectorCam.read_configuration - ~PvcamDetectorCam.resume - ~PvcamDetectorCam.stage - ~PvcamDetectorCam.stop - ~PvcamDetectorCam.subscribe - ~PvcamDetectorCam.summary - ~PvcamDetectorCam.trigger - ~PvcamDetectorCam.unstage - ~PvcamDetectorCam.unsubscribe - ~PvcamDetectorCam.validate_asyn_ports - ~PvcamDetectorCam.wait_for_connection - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/_as_gen/ophyd.areadetector.cam.RoperDetectorCam.rst.txt b/ophyd/_sources/_as_gen/ophyd.areadetector.cam.RoperDetectorCam.rst.txt deleted file mode 100644 index 95ed5e7aef..0000000000 --- a/ophyd/_sources/_as_gen/ophyd.areadetector.cam.RoperDetectorCam.rst.txt +++ /dev/null @@ -1,49 +0,0 @@ -ophyd\.areadetector\.cam\.RoperDetectorCam -========================================== - -.. currentmodule:: ophyd.areadetector.cam - -.. autoclass:: RoperDetectorCam - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~RoperDetectorCam.__init__ - ~RoperDetectorCam.check_value - ~RoperDetectorCam.clear_sub - ~RoperDetectorCam.configure - ~RoperDetectorCam.describe - ~RoperDetectorCam.describe_configuration - ~RoperDetectorCam.find_signal - ~RoperDetectorCam.get - ~RoperDetectorCam.get_asyn_digraph - ~RoperDetectorCam.get_asyn_port_dictionary - ~RoperDetectorCam.get_device_tuple - ~RoperDetectorCam.get_instantiated_signals - ~RoperDetectorCam.get_plugin_by_asyn_port - ~RoperDetectorCam.missing_plugins - ~RoperDetectorCam.pause - ~RoperDetectorCam.put - ~RoperDetectorCam.read - ~RoperDetectorCam.read_configuration - ~RoperDetectorCam.resume - ~RoperDetectorCam.stage - ~RoperDetectorCam.stop - ~RoperDetectorCam.subscribe - ~RoperDetectorCam.summary - ~RoperDetectorCam.trigger - ~RoperDetectorCam.unstage - ~RoperDetectorCam.unsubscribe - ~RoperDetectorCam.validate_asyn_ports - ~RoperDetectorCam.wait_for_connection - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/_as_gen/ophyd.areadetector.cam.SimDetectorCam.rst.txt b/ophyd/_sources/_as_gen/ophyd.areadetector.cam.SimDetectorCam.rst.txt deleted file mode 100644 index cf74c373a2..0000000000 --- a/ophyd/_sources/_as_gen/ophyd.areadetector.cam.SimDetectorCam.rst.txt +++ /dev/null @@ -1,49 +0,0 @@ -ophyd\.areadetector\.cam\.SimDetectorCam -======================================== - -.. currentmodule:: ophyd.areadetector.cam - -.. autoclass:: SimDetectorCam - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~SimDetectorCam.__init__ - ~SimDetectorCam.check_value - ~SimDetectorCam.clear_sub - ~SimDetectorCam.configure - ~SimDetectorCam.describe - ~SimDetectorCam.describe_configuration - ~SimDetectorCam.find_signal - ~SimDetectorCam.get - ~SimDetectorCam.get_asyn_digraph - ~SimDetectorCam.get_asyn_port_dictionary - ~SimDetectorCam.get_device_tuple - ~SimDetectorCam.get_instantiated_signals - ~SimDetectorCam.get_plugin_by_asyn_port - ~SimDetectorCam.missing_plugins - ~SimDetectorCam.pause - ~SimDetectorCam.put - ~SimDetectorCam.read - ~SimDetectorCam.read_configuration - ~SimDetectorCam.resume - ~SimDetectorCam.stage - ~SimDetectorCam.stop - ~SimDetectorCam.subscribe - ~SimDetectorCam.summary - ~SimDetectorCam.trigger - ~SimDetectorCam.unstage - ~SimDetectorCam.unsubscribe - ~SimDetectorCam.validate_asyn_ports - ~SimDetectorCam.wait_for_connection - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/_as_gen/ophyd.areadetector.cam.URLDetectorCam.rst.txt b/ophyd/_sources/_as_gen/ophyd.areadetector.cam.URLDetectorCam.rst.txt deleted file mode 100644 index 0d486e7c90..0000000000 --- a/ophyd/_sources/_as_gen/ophyd.areadetector.cam.URLDetectorCam.rst.txt +++ /dev/null @@ -1,49 +0,0 @@ -ophyd\.areadetector\.cam\.URLDetectorCam -======================================== - -.. currentmodule:: ophyd.areadetector.cam - -.. autoclass:: URLDetectorCam - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~URLDetectorCam.__init__ - ~URLDetectorCam.check_value - ~URLDetectorCam.clear_sub - ~URLDetectorCam.configure - ~URLDetectorCam.describe - ~URLDetectorCam.describe_configuration - ~URLDetectorCam.find_signal - ~URLDetectorCam.get - ~URLDetectorCam.get_asyn_digraph - ~URLDetectorCam.get_asyn_port_dictionary - ~URLDetectorCam.get_device_tuple - ~URLDetectorCam.get_instantiated_signals - ~URLDetectorCam.get_plugin_by_asyn_port - ~URLDetectorCam.missing_plugins - ~URLDetectorCam.pause - ~URLDetectorCam.put - ~URLDetectorCam.read - ~URLDetectorCam.read_configuration - ~URLDetectorCam.resume - ~URLDetectorCam.stage - ~URLDetectorCam.stop - ~URLDetectorCam.subscribe - ~URLDetectorCam.summary - ~URLDetectorCam.trigger - ~URLDetectorCam.unstage - ~URLDetectorCam.unsubscribe - ~URLDetectorCam.validate_asyn_ports - ~URLDetectorCam.wait_for_connection - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/_as_gen/ophyd.areadetector.cam.rst.txt b/ophyd/_sources/_as_gen/ophyd.areadetector.cam.rst.txt deleted file mode 100644 index 87601a3f63..0000000000 --- a/ophyd/_sources/_as_gen/ophyd.areadetector.cam.rst.txt +++ /dev/null @@ -1,45 +0,0 @@ -ophyd\.areadetector\.cam -======================== - -.. automodule:: ophyd.areadetector.cam - - - - - - - - .. rubric:: Classes - - .. autosummary:: - - AdscDetectorCam - Andor3DetectorCam - AndorDetectorCam - AreaDetectorCam - BrukerDetectorCam - CamBase - FirewireLinDetectorCam - FirewireWinDetectorCam - LightFieldDetectorCam - Mar345DetectorCam - MarCCDDetectorCam - PSLDetectorCam - PcoDetectorCam - PcoDetectorIO - PcoDetectorSimIO - PerkinElmerDetectorCam - PilatusDetectorCam - PixiradDetectorCam - PointGreyDetectorCam - ProsilicaDetectorCam - PvcamDetectorCam - RoperDetectorCam - SimDetectorCam - URLDetectorCam - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/_as_gen/ophyd.areadetector.detectors.AdscDetector.rst.txt b/ophyd/_sources/_as_gen/ophyd.areadetector.detectors.AdscDetector.rst.txt deleted file mode 100644 index 9e629ee4b2..0000000000 --- a/ophyd/_sources/_as_gen/ophyd.areadetector.detectors.AdscDetector.rst.txt +++ /dev/null @@ -1,51 +0,0 @@ -ophyd\.areadetector\.detectors\.AdscDetector -============================================ - -.. currentmodule:: ophyd.areadetector.detectors - -.. autoclass:: AdscDetector - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~AdscDetector.__init__ - ~AdscDetector.check_value - ~AdscDetector.clear_sub - ~AdscDetector.configure - ~AdscDetector.describe - ~AdscDetector.describe_configuration - ~AdscDetector.dispatch - ~AdscDetector.find_signal - ~AdscDetector.get - ~AdscDetector.get_asyn_digraph - ~AdscDetector.get_asyn_port_dictionary - ~AdscDetector.get_device_tuple - ~AdscDetector.get_instantiated_signals - ~AdscDetector.get_plugin_by_asyn_port - ~AdscDetector.make_data_key - ~AdscDetector.missing_plugins - ~AdscDetector.pause - ~AdscDetector.put - ~AdscDetector.read - ~AdscDetector.read_configuration - ~AdscDetector.resume - ~AdscDetector.stage - ~AdscDetector.stop - ~AdscDetector.subscribe - ~AdscDetector.summary - ~AdscDetector.trigger - ~AdscDetector.unstage - ~AdscDetector.unsubscribe - ~AdscDetector.validate_asyn_ports - ~AdscDetector.wait_for_connection - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/_as_gen/ophyd.areadetector.detectors.Andor3Detector.rst.txt b/ophyd/_sources/_as_gen/ophyd.areadetector.detectors.Andor3Detector.rst.txt deleted file mode 100644 index a686690e37..0000000000 --- a/ophyd/_sources/_as_gen/ophyd.areadetector.detectors.Andor3Detector.rst.txt +++ /dev/null @@ -1,51 +0,0 @@ -ophyd\.areadetector\.detectors\.Andor3Detector -============================================== - -.. currentmodule:: ophyd.areadetector.detectors - -.. autoclass:: Andor3Detector - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~Andor3Detector.__init__ - ~Andor3Detector.check_value - ~Andor3Detector.clear_sub - ~Andor3Detector.configure - ~Andor3Detector.describe - ~Andor3Detector.describe_configuration - ~Andor3Detector.dispatch - ~Andor3Detector.find_signal - ~Andor3Detector.get - ~Andor3Detector.get_asyn_digraph - ~Andor3Detector.get_asyn_port_dictionary - ~Andor3Detector.get_device_tuple - ~Andor3Detector.get_instantiated_signals - ~Andor3Detector.get_plugin_by_asyn_port - ~Andor3Detector.make_data_key - ~Andor3Detector.missing_plugins - ~Andor3Detector.pause - ~Andor3Detector.put - ~Andor3Detector.read - ~Andor3Detector.read_configuration - ~Andor3Detector.resume - ~Andor3Detector.stage - ~Andor3Detector.stop - ~Andor3Detector.subscribe - ~Andor3Detector.summary - ~Andor3Detector.trigger - ~Andor3Detector.unstage - ~Andor3Detector.unsubscribe - ~Andor3Detector.validate_asyn_ports - ~Andor3Detector.wait_for_connection - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/_as_gen/ophyd.areadetector.detectors.AndorDetector.rst.txt b/ophyd/_sources/_as_gen/ophyd.areadetector.detectors.AndorDetector.rst.txt deleted file mode 100644 index 5e019cbb51..0000000000 --- a/ophyd/_sources/_as_gen/ophyd.areadetector.detectors.AndorDetector.rst.txt +++ /dev/null @@ -1,51 +0,0 @@ -ophyd\.areadetector\.detectors\.AndorDetector -============================================= - -.. currentmodule:: ophyd.areadetector.detectors - -.. autoclass:: AndorDetector - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~AndorDetector.__init__ - ~AndorDetector.check_value - ~AndorDetector.clear_sub - ~AndorDetector.configure - ~AndorDetector.describe - ~AndorDetector.describe_configuration - ~AndorDetector.dispatch - ~AndorDetector.find_signal - ~AndorDetector.get - ~AndorDetector.get_asyn_digraph - ~AndorDetector.get_asyn_port_dictionary - ~AndorDetector.get_device_tuple - ~AndorDetector.get_instantiated_signals - ~AndorDetector.get_plugin_by_asyn_port - ~AndorDetector.make_data_key - ~AndorDetector.missing_plugins - ~AndorDetector.pause - ~AndorDetector.put - ~AndorDetector.read - ~AndorDetector.read_configuration - ~AndorDetector.resume - ~AndorDetector.stage - ~AndorDetector.stop - ~AndorDetector.subscribe - ~AndorDetector.summary - ~AndorDetector.trigger - ~AndorDetector.unstage - ~AndorDetector.unsubscribe - ~AndorDetector.validate_asyn_ports - ~AndorDetector.wait_for_connection - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/_as_gen/ophyd.areadetector.detectors.AreaDetector.rst.txt b/ophyd/_sources/_as_gen/ophyd.areadetector.detectors.AreaDetector.rst.txt deleted file mode 100644 index cacdfa0888..0000000000 --- a/ophyd/_sources/_as_gen/ophyd.areadetector.detectors.AreaDetector.rst.txt +++ /dev/null @@ -1,51 +0,0 @@ -ophyd\.areadetector\.detectors\.AreaDetector -============================================ - -.. currentmodule:: ophyd.areadetector.detectors - -.. autoclass:: AreaDetector - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~AreaDetector.__init__ - ~AreaDetector.check_value - ~AreaDetector.clear_sub - ~AreaDetector.configure - ~AreaDetector.describe - ~AreaDetector.describe_configuration - ~AreaDetector.dispatch - ~AreaDetector.find_signal - ~AreaDetector.get - ~AreaDetector.get_asyn_digraph - ~AreaDetector.get_asyn_port_dictionary - ~AreaDetector.get_device_tuple - ~AreaDetector.get_instantiated_signals - ~AreaDetector.get_plugin_by_asyn_port - ~AreaDetector.make_data_key - ~AreaDetector.missing_plugins - ~AreaDetector.pause - ~AreaDetector.put - ~AreaDetector.read - ~AreaDetector.read_configuration - ~AreaDetector.resume - ~AreaDetector.stage - ~AreaDetector.stop - ~AreaDetector.subscribe - ~AreaDetector.summary - ~AreaDetector.trigger - ~AreaDetector.unstage - ~AreaDetector.unsubscribe - ~AreaDetector.validate_asyn_ports - ~AreaDetector.wait_for_connection - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/_as_gen/ophyd.areadetector.detectors.BrukerDetector.rst.txt b/ophyd/_sources/_as_gen/ophyd.areadetector.detectors.BrukerDetector.rst.txt deleted file mode 100644 index f914512796..0000000000 --- a/ophyd/_sources/_as_gen/ophyd.areadetector.detectors.BrukerDetector.rst.txt +++ /dev/null @@ -1,51 +0,0 @@ -ophyd\.areadetector\.detectors\.BrukerDetector -============================================== - -.. currentmodule:: ophyd.areadetector.detectors - -.. autoclass:: BrukerDetector - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~BrukerDetector.__init__ - ~BrukerDetector.check_value - ~BrukerDetector.clear_sub - ~BrukerDetector.configure - ~BrukerDetector.describe - ~BrukerDetector.describe_configuration - ~BrukerDetector.dispatch - ~BrukerDetector.find_signal - ~BrukerDetector.get - ~BrukerDetector.get_asyn_digraph - ~BrukerDetector.get_asyn_port_dictionary - ~BrukerDetector.get_device_tuple - ~BrukerDetector.get_instantiated_signals - ~BrukerDetector.get_plugin_by_asyn_port - ~BrukerDetector.make_data_key - ~BrukerDetector.missing_plugins - ~BrukerDetector.pause - ~BrukerDetector.put - ~BrukerDetector.read - ~BrukerDetector.read_configuration - ~BrukerDetector.resume - ~BrukerDetector.stage - ~BrukerDetector.stop - ~BrukerDetector.subscribe - ~BrukerDetector.summary - ~BrukerDetector.trigger - ~BrukerDetector.unstage - ~BrukerDetector.unsubscribe - ~BrukerDetector.validate_asyn_ports - ~BrukerDetector.wait_for_connection - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/_as_gen/ophyd.areadetector.detectors.DetectorBase.dispatch.rst.txt b/ophyd/_sources/_as_gen/ophyd.areadetector.detectors.DetectorBase.dispatch.rst.txt deleted file mode 100644 index 94d5fbc971..0000000000 --- a/ophyd/_sources/_as_gen/ophyd.areadetector.detectors.DetectorBase.dispatch.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -ophyd\.areadetector\.detectors\.DetectorBase\.dispatch -====================================================== - -.. currentmodule:: ophyd.areadetector.detectors - -.. automethod:: DetectorBase.dispatch \ No newline at end of file diff --git a/ophyd/_sources/_as_gen/ophyd.areadetector.detectors.DetectorBase.make_data_key.rst.txt b/ophyd/_sources/_as_gen/ophyd.areadetector.detectors.DetectorBase.make_data_key.rst.txt deleted file mode 100644 index e50c93f42a..0000000000 --- a/ophyd/_sources/_as_gen/ophyd.areadetector.detectors.DetectorBase.make_data_key.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -ophyd\.areadetector\.detectors\.DetectorBase\.make\_data\_key -============================================================= - -.. currentmodule:: ophyd.areadetector.detectors - -.. automethod:: DetectorBase.make_data_key \ No newline at end of file diff --git a/ophyd/_sources/_as_gen/ophyd.areadetector.detectors.DetectorBase.rst.txt b/ophyd/_sources/_as_gen/ophyd.areadetector.detectors.DetectorBase.rst.txt deleted file mode 100644 index 2b55b81477..0000000000 --- a/ophyd/_sources/_as_gen/ophyd.areadetector.detectors.DetectorBase.rst.txt +++ /dev/null @@ -1,51 +0,0 @@ -ophyd\.areadetector\.detectors\.DetectorBase -============================================ - -.. currentmodule:: ophyd.areadetector.detectors - -.. autoclass:: DetectorBase - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~DetectorBase.__init__ - ~DetectorBase.check_value - ~DetectorBase.clear_sub - ~DetectorBase.configure - ~DetectorBase.describe - ~DetectorBase.describe_configuration - ~DetectorBase.dispatch - ~DetectorBase.find_signal - ~DetectorBase.get - ~DetectorBase.get_asyn_digraph - ~DetectorBase.get_asyn_port_dictionary - ~DetectorBase.get_device_tuple - ~DetectorBase.get_instantiated_signals - ~DetectorBase.get_plugin_by_asyn_port - ~DetectorBase.make_data_key - ~DetectorBase.missing_plugins - ~DetectorBase.pause - ~DetectorBase.put - ~DetectorBase.read - ~DetectorBase.read_configuration - ~DetectorBase.resume - ~DetectorBase.stage - ~DetectorBase.stop - ~DetectorBase.subscribe - ~DetectorBase.summary - ~DetectorBase.trigger - ~DetectorBase.unstage - ~DetectorBase.unsubscribe - ~DetectorBase.validate_asyn_ports - ~DetectorBase.wait_for_connection - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/_as_gen/ophyd.areadetector.detectors.FirewireLinDetector.rst.txt b/ophyd/_sources/_as_gen/ophyd.areadetector.detectors.FirewireLinDetector.rst.txt deleted file mode 100644 index a8d0fd4b33..0000000000 --- a/ophyd/_sources/_as_gen/ophyd.areadetector.detectors.FirewireLinDetector.rst.txt +++ /dev/null @@ -1,51 +0,0 @@ -ophyd\.areadetector\.detectors\.FirewireLinDetector -=================================================== - -.. currentmodule:: ophyd.areadetector.detectors - -.. autoclass:: FirewireLinDetector - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~FirewireLinDetector.__init__ - ~FirewireLinDetector.check_value - ~FirewireLinDetector.clear_sub - ~FirewireLinDetector.configure - ~FirewireLinDetector.describe - ~FirewireLinDetector.describe_configuration - ~FirewireLinDetector.dispatch - ~FirewireLinDetector.find_signal - ~FirewireLinDetector.get - ~FirewireLinDetector.get_asyn_digraph - ~FirewireLinDetector.get_asyn_port_dictionary - ~FirewireLinDetector.get_device_tuple - ~FirewireLinDetector.get_instantiated_signals - ~FirewireLinDetector.get_plugin_by_asyn_port - ~FirewireLinDetector.make_data_key - ~FirewireLinDetector.missing_plugins - ~FirewireLinDetector.pause - ~FirewireLinDetector.put - ~FirewireLinDetector.read - ~FirewireLinDetector.read_configuration - ~FirewireLinDetector.resume - ~FirewireLinDetector.stage - ~FirewireLinDetector.stop - ~FirewireLinDetector.subscribe - ~FirewireLinDetector.summary - ~FirewireLinDetector.trigger - ~FirewireLinDetector.unstage - ~FirewireLinDetector.unsubscribe - ~FirewireLinDetector.validate_asyn_ports - ~FirewireLinDetector.wait_for_connection - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/_as_gen/ophyd.areadetector.detectors.FirewireWinDetector.rst.txt b/ophyd/_sources/_as_gen/ophyd.areadetector.detectors.FirewireWinDetector.rst.txt deleted file mode 100644 index a0253adc00..0000000000 --- a/ophyd/_sources/_as_gen/ophyd.areadetector.detectors.FirewireWinDetector.rst.txt +++ /dev/null @@ -1,51 +0,0 @@ -ophyd\.areadetector\.detectors\.FirewireWinDetector -=================================================== - -.. currentmodule:: ophyd.areadetector.detectors - -.. autoclass:: FirewireWinDetector - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~FirewireWinDetector.__init__ - ~FirewireWinDetector.check_value - ~FirewireWinDetector.clear_sub - ~FirewireWinDetector.configure - ~FirewireWinDetector.describe - ~FirewireWinDetector.describe_configuration - ~FirewireWinDetector.dispatch - ~FirewireWinDetector.find_signal - ~FirewireWinDetector.get - ~FirewireWinDetector.get_asyn_digraph - ~FirewireWinDetector.get_asyn_port_dictionary - ~FirewireWinDetector.get_device_tuple - ~FirewireWinDetector.get_instantiated_signals - ~FirewireWinDetector.get_plugin_by_asyn_port - ~FirewireWinDetector.make_data_key - ~FirewireWinDetector.missing_plugins - ~FirewireWinDetector.pause - ~FirewireWinDetector.put - ~FirewireWinDetector.read - ~FirewireWinDetector.read_configuration - ~FirewireWinDetector.resume - ~FirewireWinDetector.stage - ~FirewireWinDetector.stop - ~FirewireWinDetector.subscribe - ~FirewireWinDetector.summary - ~FirewireWinDetector.trigger - ~FirewireWinDetector.unstage - ~FirewireWinDetector.unsubscribe - ~FirewireWinDetector.validate_asyn_ports - ~FirewireWinDetector.wait_for_connection - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/_as_gen/ophyd.areadetector.detectors.LightFieldDetector.rst.txt b/ophyd/_sources/_as_gen/ophyd.areadetector.detectors.LightFieldDetector.rst.txt deleted file mode 100644 index 51b2f33974..0000000000 --- a/ophyd/_sources/_as_gen/ophyd.areadetector.detectors.LightFieldDetector.rst.txt +++ /dev/null @@ -1,51 +0,0 @@ -ophyd\.areadetector\.detectors\.LightFieldDetector -================================================== - -.. currentmodule:: ophyd.areadetector.detectors - -.. autoclass:: LightFieldDetector - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~LightFieldDetector.__init__ - ~LightFieldDetector.check_value - ~LightFieldDetector.clear_sub - ~LightFieldDetector.configure - ~LightFieldDetector.describe - ~LightFieldDetector.describe_configuration - ~LightFieldDetector.dispatch - ~LightFieldDetector.find_signal - ~LightFieldDetector.get - ~LightFieldDetector.get_asyn_digraph - ~LightFieldDetector.get_asyn_port_dictionary - ~LightFieldDetector.get_device_tuple - ~LightFieldDetector.get_instantiated_signals - ~LightFieldDetector.get_plugin_by_asyn_port - ~LightFieldDetector.make_data_key - ~LightFieldDetector.missing_plugins - ~LightFieldDetector.pause - ~LightFieldDetector.put - ~LightFieldDetector.read - ~LightFieldDetector.read_configuration - ~LightFieldDetector.resume - ~LightFieldDetector.stage - ~LightFieldDetector.stop - ~LightFieldDetector.subscribe - ~LightFieldDetector.summary - ~LightFieldDetector.trigger - ~LightFieldDetector.unstage - ~LightFieldDetector.unsubscribe - ~LightFieldDetector.validate_asyn_ports - ~LightFieldDetector.wait_for_connection - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/_as_gen/ophyd.areadetector.detectors.Mar345Detector.rst.txt b/ophyd/_sources/_as_gen/ophyd.areadetector.detectors.Mar345Detector.rst.txt deleted file mode 100644 index b242a256e6..0000000000 --- a/ophyd/_sources/_as_gen/ophyd.areadetector.detectors.Mar345Detector.rst.txt +++ /dev/null @@ -1,51 +0,0 @@ -ophyd\.areadetector\.detectors\.Mar345Detector -============================================== - -.. currentmodule:: ophyd.areadetector.detectors - -.. autoclass:: Mar345Detector - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~Mar345Detector.__init__ - ~Mar345Detector.check_value - ~Mar345Detector.clear_sub - ~Mar345Detector.configure - ~Mar345Detector.describe - ~Mar345Detector.describe_configuration - ~Mar345Detector.dispatch - ~Mar345Detector.find_signal - ~Mar345Detector.get - ~Mar345Detector.get_asyn_digraph - ~Mar345Detector.get_asyn_port_dictionary - ~Mar345Detector.get_device_tuple - ~Mar345Detector.get_instantiated_signals - ~Mar345Detector.get_plugin_by_asyn_port - ~Mar345Detector.make_data_key - ~Mar345Detector.missing_plugins - ~Mar345Detector.pause - ~Mar345Detector.put - ~Mar345Detector.read - ~Mar345Detector.read_configuration - ~Mar345Detector.resume - ~Mar345Detector.stage - ~Mar345Detector.stop - ~Mar345Detector.subscribe - ~Mar345Detector.summary - ~Mar345Detector.trigger - ~Mar345Detector.unstage - ~Mar345Detector.unsubscribe - ~Mar345Detector.validate_asyn_ports - ~Mar345Detector.wait_for_connection - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/_as_gen/ophyd.areadetector.detectors.MarCCDDetector.rst.txt b/ophyd/_sources/_as_gen/ophyd.areadetector.detectors.MarCCDDetector.rst.txt deleted file mode 100644 index 7d451cf880..0000000000 --- a/ophyd/_sources/_as_gen/ophyd.areadetector.detectors.MarCCDDetector.rst.txt +++ /dev/null @@ -1,51 +0,0 @@ -ophyd\.areadetector\.detectors\.MarCCDDetector -============================================== - -.. currentmodule:: ophyd.areadetector.detectors - -.. autoclass:: MarCCDDetector - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~MarCCDDetector.__init__ - ~MarCCDDetector.check_value - ~MarCCDDetector.clear_sub - ~MarCCDDetector.configure - ~MarCCDDetector.describe - ~MarCCDDetector.describe_configuration - ~MarCCDDetector.dispatch - ~MarCCDDetector.find_signal - ~MarCCDDetector.get - ~MarCCDDetector.get_asyn_digraph - ~MarCCDDetector.get_asyn_port_dictionary - ~MarCCDDetector.get_device_tuple - ~MarCCDDetector.get_instantiated_signals - ~MarCCDDetector.get_plugin_by_asyn_port - ~MarCCDDetector.make_data_key - ~MarCCDDetector.missing_plugins - ~MarCCDDetector.pause - ~MarCCDDetector.put - ~MarCCDDetector.read - ~MarCCDDetector.read_configuration - ~MarCCDDetector.resume - ~MarCCDDetector.stage - ~MarCCDDetector.stop - ~MarCCDDetector.subscribe - ~MarCCDDetector.summary - ~MarCCDDetector.trigger - ~MarCCDDetector.unstage - ~MarCCDDetector.unsubscribe - ~MarCCDDetector.validate_asyn_ports - ~MarCCDDetector.wait_for_connection - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/_as_gen/ophyd.areadetector.detectors.PSLDetector.rst.txt b/ophyd/_sources/_as_gen/ophyd.areadetector.detectors.PSLDetector.rst.txt deleted file mode 100644 index 14f35c43dd..0000000000 --- a/ophyd/_sources/_as_gen/ophyd.areadetector.detectors.PSLDetector.rst.txt +++ /dev/null @@ -1,51 +0,0 @@ -ophyd\.areadetector\.detectors\.PSLDetector -=========================================== - -.. currentmodule:: ophyd.areadetector.detectors - -.. autoclass:: PSLDetector - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~PSLDetector.__init__ - ~PSLDetector.check_value - ~PSLDetector.clear_sub - ~PSLDetector.configure - ~PSLDetector.describe - ~PSLDetector.describe_configuration - ~PSLDetector.dispatch - ~PSLDetector.find_signal - ~PSLDetector.get - ~PSLDetector.get_asyn_digraph - ~PSLDetector.get_asyn_port_dictionary - ~PSLDetector.get_device_tuple - ~PSLDetector.get_instantiated_signals - ~PSLDetector.get_plugin_by_asyn_port - ~PSLDetector.make_data_key - ~PSLDetector.missing_plugins - ~PSLDetector.pause - ~PSLDetector.put - ~PSLDetector.read - ~PSLDetector.read_configuration - ~PSLDetector.resume - ~PSLDetector.stage - ~PSLDetector.stop - ~PSLDetector.subscribe - ~PSLDetector.summary - ~PSLDetector.trigger - ~PSLDetector.unstage - ~PSLDetector.unsubscribe - ~PSLDetector.validate_asyn_ports - ~PSLDetector.wait_for_connection - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/_as_gen/ophyd.areadetector.detectors.PerkinElmerDetector.rst.txt b/ophyd/_sources/_as_gen/ophyd.areadetector.detectors.PerkinElmerDetector.rst.txt deleted file mode 100644 index b1a86eae24..0000000000 --- a/ophyd/_sources/_as_gen/ophyd.areadetector.detectors.PerkinElmerDetector.rst.txt +++ /dev/null @@ -1,51 +0,0 @@ -ophyd\.areadetector\.detectors\.PerkinElmerDetector -=================================================== - -.. currentmodule:: ophyd.areadetector.detectors - -.. autoclass:: PerkinElmerDetector - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~PerkinElmerDetector.__init__ - ~PerkinElmerDetector.check_value - ~PerkinElmerDetector.clear_sub - ~PerkinElmerDetector.configure - ~PerkinElmerDetector.describe - ~PerkinElmerDetector.describe_configuration - ~PerkinElmerDetector.dispatch - ~PerkinElmerDetector.find_signal - ~PerkinElmerDetector.get - ~PerkinElmerDetector.get_asyn_digraph - ~PerkinElmerDetector.get_asyn_port_dictionary - ~PerkinElmerDetector.get_device_tuple - ~PerkinElmerDetector.get_instantiated_signals - ~PerkinElmerDetector.get_plugin_by_asyn_port - ~PerkinElmerDetector.make_data_key - ~PerkinElmerDetector.missing_plugins - ~PerkinElmerDetector.pause - ~PerkinElmerDetector.put - ~PerkinElmerDetector.read - ~PerkinElmerDetector.read_configuration - ~PerkinElmerDetector.resume - ~PerkinElmerDetector.stage - ~PerkinElmerDetector.stop - ~PerkinElmerDetector.subscribe - ~PerkinElmerDetector.summary - ~PerkinElmerDetector.trigger - ~PerkinElmerDetector.unstage - ~PerkinElmerDetector.unsubscribe - ~PerkinElmerDetector.validate_asyn_ports - ~PerkinElmerDetector.wait_for_connection - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/_as_gen/ophyd.areadetector.detectors.PilatusDetector.rst.txt b/ophyd/_sources/_as_gen/ophyd.areadetector.detectors.PilatusDetector.rst.txt deleted file mode 100644 index 80c7282715..0000000000 --- a/ophyd/_sources/_as_gen/ophyd.areadetector.detectors.PilatusDetector.rst.txt +++ /dev/null @@ -1,51 +0,0 @@ -ophyd\.areadetector\.detectors\.PilatusDetector -=============================================== - -.. currentmodule:: ophyd.areadetector.detectors - -.. autoclass:: PilatusDetector - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~PilatusDetector.__init__ - ~PilatusDetector.check_value - ~PilatusDetector.clear_sub - ~PilatusDetector.configure - ~PilatusDetector.describe - ~PilatusDetector.describe_configuration - ~PilatusDetector.dispatch - ~PilatusDetector.find_signal - ~PilatusDetector.get - ~PilatusDetector.get_asyn_digraph - ~PilatusDetector.get_asyn_port_dictionary - ~PilatusDetector.get_device_tuple - ~PilatusDetector.get_instantiated_signals - ~PilatusDetector.get_plugin_by_asyn_port - ~PilatusDetector.make_data_key - ~PilatusDetector.missing_plugins - ~PilatusDetector.pause - ~PilatusDetector.put - ~PilatusDetector.read - ~PilatusDetector.read_configuration - ~PilatusDetector.resume - ~PilatusDetector.stage - ~PilatusDetector.stop - ~PilatusDetector.subscribe - ~PilatusDetector.summary - ~PilatusDetector.trigger - ~PilatusDetector.unstage - ~PilatusDetector.unsubscribe - ~PilatusDetector.validate_asyn_ports - ~PilatusDetector.wait_for_connection - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/_as_gen/ophyd.areadetector.detectors.PixiradDetector.rst.txt b/ophyd/_sources/_as_gen/ophyd.areadetector.detectors.PixiradDetector.rst.txt deleted file mode 100644 index 06128593a3..0000000000 --- a/ophyd/_sources/_as_gen/ophyd.areadetector.detectors.PixiradDetector.rst.txt +++ /dev/null @@ -1,51 +0,0 @@ -ophyd\.areadetector\.detectors\.PixiradDetector -=============================================== - -.. currentmodule:: ophyd.areadetector.detectors - -.. autoclass:: PixiradDetector - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~PixiradDetector.__init__ - ~PixiradDetector.check_value - ~PixiradDetector.clear_sub - ~PixiradDetector.configure - ~PixiradDetector.describe - ~PixiradDetector.describe_configuration - ~PixiradDetector.dispatch - ~PixiradDetector.find_signal - ~PixiradDetector.get - ~PixiradDetector.get_asyn_digraph - ~PixiradDetector.get_asyn_port_dictionary - ~PixiradDetector.get_device_tuple - ~PixiradDetector.get_instantiated_signals - ~PixiradDetector.get_plugin_by_asyn_port - ~PixiradDetector.make_data_key - ~PixiradDetector.missing_plugins - ~PixiradDetector.pause - ~PixiradDetector.put - ~PixiradDetector.read - ~PixiradDetector.read_configuration - ~PixiradDetector.resume - ~PixiradDetector.stage - ~PixiradDetector.stop - ~PixiradDetector.subscribe - ~PixiradDetector.summary - ~PixiradDetector.trigger - ~PixiradDetector.unstage - ~PixiradDetector.unsubscribe - ~PixiradDetector.validate_asyn_ports - ~PixiradDetector.wait_for_connection - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/_as_gen/ophyd.areadetector.detectors.PointGreyDetector.rst.txt b/ophyd/_sources/_as_gen/ophyd.areadetector.detectors.PointGreyDetector.rst.txt deleted file mode 100644 index 99745911d5..0000000000 --- a/ophyd/_sources/_as_gen/ophyd.areadetector.detectors.PointGreyDetector.rst.txt +++ /dev/null @@ -1,51 +0,0 @@ -ophyd\.areadetector\.detectors\.PointGreyDetector -================================================= - -.. currentmodule:: ophyd.areadetector.detectors - -.. autoclass:: PointGreyDetector - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~PointGreyDetector.__init__ - ~PointGreyDetector.check_value - ~PointGreyDetector.clear_sub - ~PointGreyDetector.configure - ~PointGreyDetector.describe - ~PointGreyDetector.describe_configuration - ~PointGreyDetector.dispatch - ~PointGreyDetector.find_signal - ~PointGreyDetector.get - ~PointGreyDetector.get_asyn_digraph - ~PointGreyDetector.get_asyn_port_dictionary - ~PointGreyDetector.get_device_tuple - ~PointGreyDetector.get_instantiated_signals - ~PointGreyDetector.get_plugin_by_asyn_port - ~PointGreyDetector.make_data_key - ~PointGreyDetector.missing_plugins - ~PointGreyDetector.pause - ~PointGreyDetector.put - ~PointGreyDetector.read - ~PointGreyDetector.read_configuration - ~PointGreyDetector.resume - ~PointGreyDetector.stage - ~PointGreyDetector.stop - ~PointGreyDetector.subscribe - ~PointGreyDetector.summary - ~PointGreyDetector.trigger - ~PointGreyDetector.unstage - ~PointGreyDetector.unsubscribe - ~PointGreyDetector.validate_asyn_ports - ~PointGreyDetector.wait_for_connection - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/_as_gen/ophyd.areadetector.detectors.ProsilicaDetector.rst.txt b/ophyd/_sources/_as_gen/ophyd.areadetector.detectors.ProsilicaDetector.rst.txt deleted file mode 100644 index 23fc649011..0000000000 --- a/ophyd/_sources/_as_gen/ophyd.areadetector.detectors.ProsilicaDetector.rst.txt +++ /dev/null @@ -1,51 +0,0 @@ -ophyd\.areadetector\.detectors\.ProsilicaDetector -================================================= - -.. currentmodule:: ophyd.areadetector.detectors - -.. autoclass:: ProsilicaDetector - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~ProsilicaDetector.__init__ - ~ProsilicaDetector.check_value - ~ProsilicaDetector.clear_sub - ~ProsilicaDetector.configure - ~ProsilicaDetector.describe - ~ProsilicaDetector.describe_configuration - ~ProsilicaDetector.dispatch - ~ProsilicaDetector.find_signal - ~ProsilicaDetector.get - ~ProsilicaDetector.get_asyn_digraph - ~ProsilicaDetector.get_asyn_port_dictionary - ~ProsilicaDetector.get_device_tuple - ~ProsilicaDetector.get_instantiated_signals - ~ProsilicaDetector.get_plugin_by_asyn_port - ~ProsilicaDetector.make_data_key - ~ProsilicaDetector.missing_plugins - ~ProsilicaDetector.pause - ~ProsilicaDetector.put - ~ProsilicaDetector.read - ~ProsilicaDetector.read_configuration - ~ProsilicaDetector.resume - ~ProsilicaDetector.stage - ~ProsilicaDetector.stop - ~ProsilicaDetector.subscribe - ~ProsilicaDetector.summary - ~ProsilicaDetector.trigger - ~ProsilicaDetector.unstage - ~ProsilicaDetector.unsubscribe - ~ProsilicaDetector.validate_asyn_ports - ~ProsilicaDetector.wait_for_connection - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/_as_gen/ophyd.areadetector.detectors.PvcamDetector.rst.txt b/ophyd/_sources/_as_gen/ophyd.areadetector.detectors.PvcamDetector.rst.txt deleted file mode 100644 index a050fa31cf..0000000000 --- a/ophyd/_sources/_as_gen/ophyd.areadetector.detectors.PvcamDetector.rst.txt +++ /dev/null @@ -1,51 +0,0 @@ -ophyd\.areadetector\.detectors\.PvcamDetector -============================================= - -.. currentmodule:: ophyd.areadetector.detectors - -.. autoclass:: PvcamDetector - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~PvcamDetector.__init__ - ~PvcamDetector.check_value - ~PvcamDetector.clear_sub - ~PvcamDetector.configure - ~PvcamDetector.describe - ~PvcamDetector.describe_configuration - ~PvcamDetector.dispatch - ~PvcamDetector.find_signal - ~PvcamDetector.get - ~PvcamDetector.get_asyn_digraph - ~PvcamDetector.get_asyn_port_dictionary - ~PvcamDetector.get_device_tuple - ~PvcamDetector.get_instantiated_signals - ~PvcamDetector.get_plugin_by_asyn_port - ~PvcamDetector.make_data_key - ~PvcamDetector.missing_plugins - ~PvcamDetector.pause - ~PvcamDetector.put - ~PvcamDetector.read - ~PvcamDetector.read_configuration - ~PvcamDetector.resume - ~PvcamDetector.stage - ~PvcamDetector.stop - ~PvcamDetector.subscribe - ~PvcamDetector.summary - ~PvcamDetector.trigger - ~PvcamDetector.unstage - ~PvcamDetector.unsubscribe - ~PvcamDetector.validate_asyn_ports - ~PvcamDetector.wait_for_connection - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/_as_gen/ophyd.areadetector.detectors.RoperDetector.rst.txt b/ophyd/_sources/_as_gen/ophyd.areadetector.detectors.RoperDetector.rst.txt deleted file mode 100644 index 8a75040fda..0000000000 --- a/ophyd/_sources/_as_gen/ophyd.areadetector.detectors.RoperDetector.rst.txt +++ /dev/null @@ -1,51 +0,0 @@ -ophyd\.areadetector\.detectors\.RoperDetector -============================================= - -.. currentmodule:: ophyd.areadetector.detectors - -.. autoclass:: RoperDetector - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~RoperDetector.__init__ - ~RoperDetector.check_value - ~RoperDetector.clear_sub - ~RoperDetector.configure - ~RoperDetector.describe - ~RoperDetector.describe_configuration - ~RoperDetector.dispatch - ~RoperDetector.find_signal - ~RoperDetector.get - ~RoperDetector.get_asyn_digraph - ~RoperDetector.get_asyn_port_dictionary - ~RoperDetector.get_device_tuple - ~RoperDetector.get_instantiated_signals - ~RoperDetector.get_plugin_by_asyn_port - ~RoperDetector.make_data_key - ~RoperDetector.missing_plugins - ~RoperDetector.pause - ~RoperDetector.put - ~RoperDetector.read - ~RoperDetector.read_configuration - ~RoperDetector.resume - ~RoperDetector.stage - ~RoperDetector.stop - ~RoperDetector.subscribe - ~RoperDetector.summary - ~RoperDetector.trigger - ~RoperDetector.unstage - ~RoperDetector.unsubscribe - ~RoperDetector.validate_asyn_ports - ~RoperDetector.wait_for_connection - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/_as_gen/ophyd.areadetector.detectors.SimDetector.rst.txt b/ophyd/_sources/_as_gen/ophyd.areadetector.detectors.SimDetector.rst.txt deleted file mode 100644 index 1020050f80..0000000000 --- a/ophyd/_sources/_as_gen/ophyd.areadetector.detectors.SimDetector.rst.txt +++ /dev/null @@ -1,51 +0,0 @@ -ophyd\.areadetector\.detectors\.SimDetector -=========================================== - -.. currentmodule:: ophyd.areadetector.detectors - -.. autoclass:: SimDetector - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~SimDetector.__init__ - ~SimDetector.check_value - ~SimDetector.clear_sub - ~SimDetector.configure - ~SimDetector.describe - ~SimDetector.describe_configuration - ~SimDetector.dispatch - ~SimDetector.find_signal - ~SimDetector.get - ~SimDetector.get_asyn_digraph - ~SimDetector.get_asyn_port_dictionary - ~SimDetector.get_device_tuple - ~SimDetector.get_instantiated_signals - ~SimDetector.get_plugin_by_asyn_port - ~SimDetector.make_data_key - ~SimDetector.missing_plugins - ~SimDetector.pause - ~SimDetector.put - ~SimDetector.read - ~SimDetector.read_configuration - ~SimDetector.resume - ~SimDetector.stage - ~SimDetector.stop - ~SimDetector.subscribe - ~SimDetector.summary - ~SimDetector.trigger - ~SimDetector.unstage - ~SimDetector.unsubscribe - ~SimDetector.validate_asyn_ports - ~SimDetector.wait_for_connection - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/_as_gen/ophyd.areadetector.detectors.URLDetector.rst.txt b/ophyd/_sources/_as_gen/ophyd.areadetector.detectors.URLDetector.rst.txt deleted file mode 100644 index 96e511bad1..0000000000 --- a/ophyd/_sources/_as_gen/ophyd.areadetector.detectors.URLDetector.rst.txt +++ /dev/null @@ -1,51 +0,0 @@ -ophyd\.areadetector\.detectors\.URLDetector -=========================================== - -.. currentmodule:: ophyd.areadetector.detectors - -.. autoclass:: URLDetector - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~URLDetector.__init__ - ~URLDetector.check_value - ~URLDetector.clear_sub - ~URLDetector.configure - ~URLDetector.describe - ~URLDetector.describe_configuration - ~URLDetector.dispatch - ~URLDetector.find_signal - ~URLDetector.get - ~URLDetector.get_asyn_digraph - ~URLDetector.get_asyn_port_dictionary - ~URLDetector.get_device_tuple - ~URLDetector.get_instantiated_signals - ~URLDetector.get_plugin_by_asyn_port - ~URLDetector.make_data_key - ~URLDetector.missing_plugins - ~URLDetector.pause - ~URLDetector.put - ~URLDetector.read - ~URLDetector.read_configuration - ~URLDetector.resume - ~URLDetector.stage - ~URLDetector.stop - ~URLDetector.subscribe - ~URLDetector.summary - ~URLDetector.trigger - ~URLDetector.unstage - ~URLDetector.unsubscribe - ~URLDetector.validate_asyn_ports - ~URLDetector.wait_for_connection - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/_as_gen/ophyd.areadetector.detectors.rst.txt b/ophyd/_sources/_as_gen/ophyd.areadetector.detectors.rst.txt deleted file mode 100644 index 36e7cf3087..0000000000 --- a/ophyd/_sources/_as_gen/ophyd.areadetector.detectors.rst.txt +++ /dev/null @@ -1,42 +0,0 @@ -ophyd\.areadetector\.detectors -============================== - -.. automodule:: ophyd.areadetector.detectors - - - - - - - - .. rubric:: Classes - - .. autosummary:: - - AdscDetector - Andor3Detector - AndorDetector - AreaDetector - BrukerDetector - DetectorBase - FirewireLinDetector - FirewireWinDetector - LightFieldDetector - Mar345Detector - MarCCDDetector - PSLDetector - PerkinElmerDetector - PilatusDetector - PixiradDetector - PointGreyDetector - ProsilicaDetector - PvcamDetector - RoperDetector - SimDetector - URLDetector - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/_as_gen/ophyd.areadetector.docs.rst.txt b/ophyd/_sources/_as_gen/ophyd.areadetector.docs.rst.txt deleted file mode 100644 index fe390abc34..0000000000 --- a/ophyd/_sources/_as_gen/ophyd.areadetector.docs.rst.txt +++ /dev/null @@ -1,16 +0,0 @@ -ophyd\.areadetector\.docs -========================= - -.. automodule:: ophyd.areadetector.docs - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/_as_gen/ophyd.areadetector.filestore_mixins.FileStoreBase.fs_root.rst.txt b/ophyd/_sources/_as_gen/ophyd.areadetector.filestore_mixins.FileStoreBase.fs_root.rst.txt deleted file mode 100644 index 904dae3636..0000000000 --- a/ophyd/_sources/_as_gen/ophyd.areadetector.filestore_mixins.FileStoreBase.fs_root.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -ophyd\.areadetector\.filestore\_mixins\.FileStoreBase\.fs\_root -=============================================================== - -.. currentmodule:: ophyd.areadetector.filestore_mixins - -.. autoattribute:: FileStoreBase.fs_root \ No newline at end of file diff --git a/ophyd/_sources/_as_gen/ophyd.areadetector.filestore_mixins.FileStoreBase.generate_datum.rst.txt b/ophyd/_sources/_as_gen/ophyd.areadetector.filestore_mixins.FileStoreBase.generate_datum.rst.txt deleted file mode 100644 index e9f2f94056..0000000000 --- a/ophyd/_sources/_as_gen/ophyd.areadetector.filestore_mixins.FileStoreBase.generate_datum.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -ophyd\.areadetector\.filestore\_mixins\.FileStoreBase\.generate\_datum -====================================================================== - -.. currentmodule:: ophyd.areadetector.filestore_mixins - -.. automethod:: FileStoreBase.generate_datum \ No newline at end of file diff --git a/ophyd/_sources/_as_gen/ophyd.areadetector.filestore_mixins.FileStoreBase.read_path_template.rst.txt b/ophyd/_sources/_as_gen/ophyd.areadetector.filestore_mixins.FileStoreBase.read_path_template.rst.txt deleted file mode 100644 index 10e25a5918..0000000000 --- a/ophyd/_sources/_as_gen/ophyd.areadetector.filestore_mixins.FileStoreBase.read_path_template.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -ophyd\.areadetector\.filestore\_mixins\.FileStoreBase\.read\_path\_template -=========================================================================== - -.. currentmodule:: ophyd.areadetector.filestore_mixins - -.. autoattribute:: FileStoreBase.read_path_template \ No newline at end of file diff --git a/ophyd/_sources/_as_gen/ophyd.areadetector.filestore_mixins.FileStoreBase.reg_root.rst.txt b/ophyd/_sources/_as_gen/ophyd.areadetector.filestore_mixins.FileStoreBase.reg_root.rst.txt deleted file mode 100644 index 0f6f6742c5..0000000000 --- a/ophyd/_sources/_as_gen/ophyd.areadetector.filestore_mixins.FileStoreBase.reg_root.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -ophyd\.areadetector\.filestore\_mixins\.FileStoreBase\.reg\_root -================================================================ - -.. currentmodule:: ophyd.areadetector.filestore_mixins - -.. autoattribute:: FileStoreBase.reg_root \ No newline at end of file diff --git a/ophyd/_sources/_as_gen/ophyd.areadetector.filestore_mixins.FileStoreBase.root.rst.txt b/ophyd/_sources/_as_gen/ophyd.areadetector.filestore_mixins.FileStoreBase.root.rst.txt deleted file mode 100644 index b2e646a88a..0000000000 --- a/ophyd/_sources/_as_gen/ophyd.areadetector.filestore_mixins.FileStoreBase.root.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -ophyd\.areadetector\.filestore\_mixins\.FileStoreBase\.root -=========================================================== - -.. currentmodule:: ophyd.areadetector.filestore_mixins - -.. autoattribute:: FileStoreBase.root \ No newline at end of file diff --git a/ophyd/_sources/_as_gen/ophyd.areadetector.filestore_mixins.FileStoreBase.rst.txt b/ophyd/_sources/_as_gen/ophyd.areadetector.filestore_mixins.FileStoreBase.rst.txt deleted file mode 100644 index 2578611c45..0000000000 --- a/ophyd/_sources/_as_gen/ophyd.areadetector.filestore_mixins.FileStoreBase.rst.txt +++ /dev/null @@ -1,30 +0,0 @@ -ophyd\.areadetector\.filestore\_mixins\.FileStoreBase -===================================================== - -.. currentmodule:: ophyd.areadetector.filestore_mixins - -.. autoclass:: FileStoreBase - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~FileStoreBase.__init__ - ~FileStoreBase.describe - ~FileStoreBase.generate_datum - ~FileStoreBase.pause - ~FileStoreBase.read - ~FileStoreBase.resume - ~FileStoreBase.stage - ~FileStoreBase.trigger - ~FileStoreBase.unstage - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/_as_gen/ophyd.areadetector.filestore_mixins.FileStoreBase.write_path_template.rst.txt b/ophyd/_sources/_as_gen/ophyd.areadetector.filestore_mixins.FileStoreBase.write_path_template.rst.txt deleted file mode 100644 index 40809dd42a..0000000000 --- a/ophyd/_sources/_as_gen/ophyd.areadetector.filestore_mixins.FileStoreBase.write_path_template.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -ophyd\.areadetector\.filestore\_mixins\.FileStoreBase\.write\_path\_template -============================================================================ - -.. currentmodule:: ophyd.areadetector.filestore_mixins - -.. autoattribute:: FileStoreBase.write_path_template \ No newline at end of file diff --git a/ophyd/_sources/_as_gen/ophyd.areadetector.filestore_mixins.FileStoreBulkWrite.rst.txt b/ophyd/_sources/_as_gen/ophyd.areadetector.filestore_mixins.FileStoreBulkWrite.rst.txt deleted file mode 100644 index e47c19082e..0000000000 --- a/ophyd/_sources/_as_gen/ophyd.areadetector.filestore_mixins.FileStoreBulkWrite.rst.txt +++ /dev/null @@ -1,16 +0,0 @@ -ophyd\.areadetector\.filestore\_mixins\.FileStoreBulkWrite -========================================================== - -.. currentmodule:: ophyd.areadetector.filestore_mixins - -.. autoclass:: FileStoreBulkWrite - - - .. automethod:: __init__ - - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/_as_gen/ophyd.areadetector.filestore_mixins.FileStoreHDF5.rst.txt b/ophyd/_sources/_as_gen/ophyd.areadetector.filestore_mixins.FileStoreHDF5.rst.txt deleted file mode 100644 index e125836555..0000000000 --- a/ophyd/_sources/_as_gen/ophyd.areadetector.filestore_mixins.FileStoreHDF5.rst.txt +++ /dev/null @@ -1,32 +0,0 @@ -ophyd\.areadetector\.filestore\_mixins\.FileStoreHDF5 -===================================================== - -.. currentmodule:: ophyd.areadetector.filestore_mixins - -.. autoclass:: FileStoreHDF5 - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~FileStoreHDF5.__init__ - ~FileStoreHDF5.describe - ~FileStoreHDF5.generate_datum - ~FileStoreHDF5.get_frames_per_point - ~FileStoreHDF5.make_filename - ~FileStoreHDF5.pause - ~FileStoreHDF5.read - ~FileStoreHDF5.resume - ~FileStoreHDF5.stage - ~FileStoreHDF5.trigger - ~FileStoreHDF5.unstage - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/_as_gen/ophyd.areadetector.filestore_mixins.FileStoreHDF5BulkWrite.rst.txt b/ophyd/_sources/_as_gen/ophyd.areadetector.filestore_mixins.FileStoreHDF5BulkWrite.rst.txt deleted file mode 100644 index 42cf4a3af6..0000000000 --- a/ophyd/_sources/_as_gen/ophyd.areadetector.filestore_mixins.FileStoreHDF5BulkWrite.rst.txt +++ /dev/null @@ -1,16 +0,0 @@ -ophyd\.areadetector\.filestore\_mixins\.FileStoreHDF5BulkWrite -============================================================== - -.. currentmodule:: ophyd.areadetector.filestore_mixins - -.. autoclass:: FileStoreHDF5BulkWrite - - - .. automethod:: __init__ - - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/_as_gen/ophyd.areadetector.filestore_mixins.FileStoreHDF5IterativeWrite.rst.txt b/ophyd/_sources/_as_gen/ophyd.areadetector.filestore_mixins.FileStoreHDF5IterativeWrite.rst.txt deleted file mode 100644 index a822feded0..0000000000 --- a/ophyd/_sources/_as_gen/ophyd.areadetector.filestore_mixins.FileStoreHDF5IterativeWrite.rst.txt +++ /dev/null @@ -1,32 +0,0 @@ -ophyd\.areadetector\.filestore\_mixins\.FileStoreHDF5IterativeWrite -=================================================================== - -.. currentmodule:: ophyd.areadetector.filestore_mixins - -.. autoclass:: FileStoreHDF5IterativeWrite - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~FileStoreHDF5IterativeWrite.__init__ - ~FileStoreHDF5IterativeWrite.describe - ~FileStoreHDF5IterativeWrite.generate_datum - ~FileStoreHDF5IterativeWrite.get_frames_per_point - ~FileStoreHDF5IterativeWrite.make_filename - ~FileStoreHDF5IterativeWrite.pause - ~FileStoreHDF5IterativeWrite.read - ~FileStoreHDF5IterativeWrite.resume - ~FileStoreHDF5IterativeWrite.stage - ~FileStoreHDF5IterativeWrite.trigger - ~FileStoreHDF5IterativeWrite.unstage - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/_as_gen/ophyd.areadetector.filestore_mixins.FileStoreIterativeWrite.rst.txt b/ophyd/_sources/_as_gen/ophyd.areadetector.filestore_mixins.FileStoreIterativeWrite.rst.txt deleted file mode 100644 index 0c6235d564..0000000000 --- a/ophyd/_sources/_as_gen/ophyd.areadetector.filestore_mixins.FileStoreIterativeWrite.rst.txt +++ /dev/null @@ -1,30 +0,0 @@ -ophyd\.areadetector\.filestore\_mixins\.FileStoreIterativeWrite -=============================================================== - -.. currentmodule:: ophyd.areadetector.filestore_mixins - -.. autoclass:: FileStoreIterativeWrite - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~FileStoreIterativeWrite.__init__ - ~FileStoreIterativeWrite.describe - ~FileStoreIterativeWrite.generate_datum - ~FileStoreIterativeWrite.pause - ~FileStoreIterativeWrite.read - ~FileStoreIterativeWrite.resume - ~FileStoreIterativeWrite.stage - ~FileStoreIterativeWrite.trigger - ~FileStoreIterativeWrite.unstage - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/_as_gen/ophyd.areadetector.filestore_mixins.FileStorePluginBase.make_filename.rst.txt b/ophyd/_sources/_as_gen/ophyd.areadetector.filestore_mixins.FileStorePluginBase.make_filename.rst.txt deleted file mode 100644 index b57e08df54..0000000000 --- a/ophyd/_sources/_as_gen/ophyd.areadetector.filestore_mixins.FileStorePluginBase.make_filename.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -ophyd\.areadetector\.filestore\_mixins\.FileStorePluginBase\.make\_filename -=========================================================================== - -.. currentmodule:: ophyd.areadetector.filestore_mixins - -.. automethod:: FileStorePluginBase.make_filename \ No newline at end of file diff --git a/ophyd/_sources/_as_gen/ophyd.areadetector.filestore_mixins.FileStorePluginBase.rst.txt b/ophyd/_sources/_as_gen/ophyd.areadetector.filestore_mixins.FileStorePluginBase.rst.txt deleted file mode 100644 index 397b501b5d..0000000000 --- a/ophyd/_sources/_as_gen/ophyd.areadetector.filestore_mixins.FileStorePluginBase.rst.txt +++ /dev/null @@ -1,31 +0,0 @@ -ophyd\.areadetector\.filestore\_mixins\.FileStorePluginBase -=========================================================== - -.. currentmodule:: ophyd.areadetector.filestore_mixins - -.. autoclass:: FileStorePluginBase - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~FileStorePluginBase.__init__ - ~FileStorePluginBase.describe - ~FileStorePluginBase.generate_datum - ~FileStorePluginBase.make_filename - ~FileStorePluginBase.pause - ~FileStorePluginBase.read - ~FileStorePluginBase.resume - ~FileStorePluginBase.stage - ~FileStorePluginBase.trigger - ~FileStorePluginBase.unstage - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/_as_gen/ophyd.areadetector.filestore_mixins.FileStoreTIFF.rst.txt b/ophyd/_sources/_as_gen/ophyd.areadetector.filestore_mixins.FileStoreTIFF.rst.txt deleted file mode 100644 index 239eb07a91..0000000000 --- a/ophyd/_sources/_as_gen/ophyd.areadetector.filestore_mixins.FileStoreTIFF.rst.txt +++ /dev/null @@ -1,32 +0,0 @@ -ophyd\.areadetector\.filestore\_mixins\.FileStoreTIFF -===================================================== - -.. currentmodule:: ophyd.areadetector.filestore_mixins - -.. autoclass:: FileStoreTIFF - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~FileStoreTIFF.__init__ - ~FileStoreTIFF.describe - ~FileStoreTIFF.generate_datum - ~FileStoreTIFF.get_frames_per_point - ~FileStoreTIFF.make_filename - ~FileStoreTIFF.pause - ~FileStoreTIFF.read - ~FileStoreTIFF.resume - ~FileStoreTIFF.stage - ~FileStoreTIFF.trigger - ~FileStoreTIFF.unstage - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/_as_gen/ophyd.areadetector.filestore_mixins.FileStoreTIFFBulkWrite.rst.txt b/ophyd/_sources/_as_gen/ophyd.areadetector.filestore_mixins.FileStoreTIFFBulkWrite.rst.txt deleted file mode 100644 index 8eb8301859..0000000000 --- a/ophyd/_sources/_as_gen/ophyd.areadetector.filestore_mixins.FileStoreTIFFBulkWrite.rst.txt +++ /dev/null @@ -1,16 +0,0 @@ -ophyd\.areadetector\.filestore\_mixins\.FileStoreTIFFBulkWrite -============================================================== - -.. currentmodule:: ophyd.areadetector.filestore_mixins - -.. autoclass:: FileStoreTIFFBulkWrite - - - .. automethod:: __init__ - - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/_as_gen/ophyd.areadetector.filestore_mixins.FileStoreTIFFIterativeWrite.rst.txt b/ophyd/_sources/_as_gen/ophyd.areadetector.filestore_mixins.FileStoreTIFFIterativeWrite.rst.txt deleted file mode 100644 index 471fa1c92c..0000000000 --- a/ophyd/_sources/_as_gen/ophyd.areadetector.filestore_mixins.FileStoreTIFFIterativeWrite.rst.txt +++ /dev/null @@ -1,32 +0,0 @@ -ophyd\.areadetector\.filestore\_mixins\.FileStoreTIFFIterativeWrite -=================================================================== - -.. currentmodule:: ophyd.areadetector.filestore_mixins - -.. autoclass:: FileStoreTIFFIterativeWrite - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~FileStoreTIFFIterativeWrite.__init__ - ~FileStoreTIFFIterativeWrite.describe - ~FileStoreTIFFIterativeWrite.generate_datum - ~FileStoreTIFFIterativeWrite.get_frames_per_point - ~FileStoreTIFFIterativeWrite.make_filename - ~FileStoreTIFFIterativeWrite.pause - ~FileStoreTIFFIterativeWrite.read - ~FileStoreTIFFIterativeWrite.resume - ~FileStoreTIFFIterativeWrite.stage - ~FileStoreTIFFIterativeWrite.trigger - ~FileStoreTIFFIterativeWrite.unstage - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/_as_gen/ophyd.areadetector.filestore_mixins.FileStoreTIFFSquashing.rst.txt b/ophyd/_sources/_as_gen/ophyd.areadetector.filestore_mixins.FileStoreTIFFSquashing.rst.txt deleted file mode 100644 index d5a8743099..0000000000 --- a/ophyd/_sources/_as_gen/ophyd.areadetector.filestore_mixins.FileStoreTIFFSquashing.rst.txt +++ /dev/null @@ -1,32 +0,0 @@ -ophyd\.areadetector\.filestore\_mixins\.FileStoreTIFFSquashing -============================================================== - -.. currentmodule:: ophyd.areadetector.filestore_mixins - -.. autoclass:: FileStoreTIFFSquashing - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~FileStoreTIFFSquashing.__init__ - ~FileStoreTIFFSquashing.describe - ~FileStoreTIFFSquashing.generate_datum - ~FileStoreTIFFSquashing.get_frames_per_point - ~FileStoreTIFFSquashing.make_filename - ~FileStoreTIFFSquashing.pause - ~FileStoreTIFFSquashing.read - ~FileStoreTIFFSquashing.resume - ~FileStoreTIFFSquashing.stage - ~FileStoreTIFFSquashing.trigger - ~FileStoreTIFFSquashing.unstage - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/_as_gen/ophyd.areadetector.filestore_mixins.rst.txt b/ophyd/_sources/_as_gen/ophyd.areadetector.filestore_mixins.rst.txt deleted file mode 100644 index 2fc68b85e5..0000000000 --- a/ophyd/_sources/_as_gen/ophyd.areadetector.filestore_mixins.rst.txt +++ /dev/null @@ -1,36 +0,0 @@ -ophyd\.areadetector\.filestore\_mixins -====================================== - -.. automodule:: ophyd.areadetector.filestore_mixins - - - - .. rubric:: Functions - - .. autosummary:: - - new_short_uid - new_uid - - - - - - .. rubric:: Classes - - .. autosummary:: - - FileStoreBase - FileStoreHDF5 - FileStoreHDF5IterativeWrite - FileStoreIterativeWrite - FileStorePluginBase - FileStoreTIFF - FileStoreTIFFIterativeWrite - FileStoreTIFFSquashing - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/_as_gen/ophyd.areadetector.plugins.ColorConvPlugin.rst.txt b/ophyd/_sources/_as_gen/ophyd.areadetector.plugins.ColorConvPlugin.rst.txt deleted file mode 100644 index 50cefbf359..0000000000 --- a/ophyd/_sources/_as_gen/ophyd.areadetector.plugins.ColorConvPlugin.rst.txt +++ /dev/null @@ -1,53 +0,0 @@ -ophyd\.areadetector\.plugins\.ColorConvPlugin -============================================= - -.. currentmodule:: ophyd.areadetector.plugins - -.. autoclass:: ColorConvPlugin - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~ColorConvPlugin.__init__ - ~ColorConvPlugin.check_value - ~ColorConvPlugin.clear_sub - ~ColorConvPlugin.configure - ~ColorConvPlugin.describe - ~ColorConvPlugin.describe_configuration - ~ColorConvPlugin.disable_on_stage - ~ColorConvPlugin.enable_on_stage - ~ColorConvPlugin.ensure_blocking - ~ColorConvPlugin.ensure_nonblocking - ~ColorConvPlugin.find_signal - ~ColorConvPlugin.get - ~ColorConvPlugin.get_asyn_digraph - ~ColorConvPlugin.get_asyn_port_dictionary - ~ColorConvPlugin.get_device_tuple - ~ColorConvPlugin.get_instantiated_signals - ~ColorConvPlugin.get_plugin_by_asyn_port - ~ColorConvPlugin.missing_plugins - ~ColorConvPlugin.pause - ~ColorConvPlugin.put - ~ColorConvPlugin.read - ~ColorConvPlugin.read_configuration - ~ColorConvPlugin.resume - ~ColorConvPlugin.stage - ~ColorConvPlugin.stop - ~ColorConvPlugin.subscribe - ~ColorConvPlugin.summary - ~ColorConvPlugin.trigger - ~ColorConvPlugin.unstage - ~ColorConvPlugin.unsubscribe - ~ColorConvPlugin.validate_asyn_ports - ~ColorConvPlugin.wait_for_connection - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/_as_gen/ophyd.areadetector.plugins.FilePlugin.rst.txt b/ophyd/_sources/_as_gen/ophyd.areadetector.plugins.FilePlugin.rst.txt deleted file mode 100644 index e6046c7d3d..0000000000 --- a/ophyd/_sources/_as_gen/ophyd.areadetector.plugins.FilePlugin.rst.txt +++ /dev/null @@ -1,54 +0,0 @@ -ophyd\.areadetector\.plugins\.FilePlugin -======================================== - -.. currentmodule:: ophyd.areadetector.plugins - -.. autoclass:: FilePlugin - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~FilePlugin.__init__ - ~FilePlugin.check_value - ~FilePlugin.clear_sub - ~FilePlugin.configure - ~FilePlugin.describe - ~FilePlugin.describe_configuration - ~FilePlugin.disable_on_stage - ~FilePlugin.enable_on_stage - ~FilePlugin.ensure_blocking - ~FilePlugin.ensure_nonblocking - ~FilePlugin.find_signal - ~FilePlugin.generate_datum - ~FilePlugin.get - ~FilePlugin.get_asyn_digraph - ~FilePlugin.get_asyn_port_dictionary - ~FilePlugin.get_device_tuple - ~FilePlugin.get_instantiated_signals - ~FilePlugin.get_plugin_by_asyn_port - ~FilePlugin.missing_plugins - ~FilePlugin.pause - ~FilePlugin.put - ~FilePlugin.read - ~FilePlugin.read_configuration - ~FilePlugin.resume - ~FilePlugin.stage - ~FilePlugin.stop - ~FilePlugin.subscribe - ~FilePlugin.summary - ~FilePlugin.trigger - ~FilePlugin.unstage - ~FilePlugin.unsubscribe - ~FilePlugin.validate_asyn_ports - ~FilePlugin.wait_for_connection - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/_as_gen/ophyd.areadetector.plugins.HDF5Plugin.rst.txt b/ophyd/_sources/_as_gen/ophyd.areadetector.plugins.HDF5Plugin.rst.txt deleted file mode 100644 index 41e585527b..0000000000 --- a/ophyd/_sources/_as_gen/ophyd.areadetector.plugins.HDF5Plugin.rst.txt +++ /dev/null @@ -1,55 +0,0 @@ -ophyd\.areadetector\.plugins\.HDF5Plugin -======================================== - -.. currentmodule:: ophyd.areadetector.plugins - -.. autoclass:: HDF5Plugin - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~HDF5Plugin.__init__ - ~HDF5Plugin.check_value - ~HDF5Plugin.clear_sub - ~HDF5Plugin.configure - ~HDF5Plugin.describe - ~HDF5Plugin.describe_configuration - ~HDF5Plugin.disable_on_stage - ~HDF5Plugin.enable_on_stage - ~HDF5Plugin.ensure_blocking - ~HDF5Plugin.ensure_nonblocking - ~HDF5Plugin.find_signal - ~HDF5Plugin.generate_datum - ~HDF5Plugin.get - ~HDF5Plugin.get_asyn_digraph - ~HDF5Plugin.get_asyn_port_dictionary - ~HDF5Plugin.get_device_tuple - ~HDF5Plugin.get_instantiated_signals - ~HDF5Plugin.get_plugin_by_asyn_port - ~HDF5Plugin.missing_plugins - ~HDF5Plugin.pause - ~HDF5Plugin.put - ~HDF5Plugin.read - ~HDF5Plugin.read_configuration - ~HDF5Plugin.resume - ~HDF5Plugin.stage - ~HDF5Plugin.stop - ~HDF5Plugin.subscribe - ~HDF5Plugin.summary - ~HDF5Plugin.trigger - ~HDF5Plugin.unstage - ~HDF5Plugin.unsubscribe - ~HDF5Plugin.validate_asyn_ports - ~HDF5Plugin.wait_for_connection - ~HDF5Plugin.warmup - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/_as_gen/ophyd.areadetector.plugins.ImagePlugin.rst.txt b/ophyd/_sources/_as_gen/ophyd.areadetector.plugins.ImagePlugin.rst.txt deleted file mode 100644 index 8de2877807..0000000000 --- a/ophyd/_sources/_as_gen/ophyd.areadetector.plugins.ImagePlugin.rst.txt +++ /dev/null @@ -1,53 +0,0 @@ -ophyd\.areadetector\.plugins\.ImagePlugin -========================================= - -.. currentmodule:: ophyd.areadetector.plugins - -.. autoclass:: ImagePlugin - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~ImagePlugin.__init__ - ~ImagePlugin.check_value - ~ImagePlugin.clear_sub - ~ImagePlugin.configure - ~ImagePlugin.describe - ~ImagePlugin.describe_configuration - ~ImagePlugin.disable_on_stage - ~ImagePlugin.enable_on_stage - ~ImagePlugin.ensure_blocking - ~ImagePlugin.ensure_nonblocking - ~ImagePlugin.find_signal - ~ImagePlugin.get - ~ImagePlugin.get_asyn_digraph - ~ImagePlugin.get_asyn_port_dictionary - ~ImagePlugin.get_device_tuple - ~ImagePlugin.get_instantiated_signals - ~ImagePlugin.get_plugin_by_asyn_port - ~ImagePlugin.missing_plugins - ~ImagePlugin.pause - ~ImagePlugin.put - ~ImagePlugin.read - ~ImagePlugin.read_configuration - ~ImagePlugin.resume - ~ImagePlugin.stage - ~ImagePlugin.stop - ~ImagePlugin.subscribe - ~ImagePlugin.summary - ~ImagePlugin.trigger - ~ImagePlugin.unstage - ~ImagePlugin.unsubscribe - ~ImagePlugin.validate_asyn_ports - ~ImagePlugin.wait_for_connection - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/_as_gen/ophyd.areadetector.plugins.JPEGPlugin.rst.txt b/ophyd/_sources/_as_gen/ophyd.areadetector.plugins.JPEGPlugin.rst.txt deleted file mode 100644 index e576072a1f..0000000000 --- a/ophyd/_sources/_as_gen/ophyd.areadetector.plugins.JPEGPlugin.rst.txt +++ /dev/null @@ -1,54 +0,0 @@ -ophyd\.areadetector\.plugins\.JPEGPlugin -======================================== - -.. currentmodule:: ophyd.areadetector.plugins - -.. autoclass:: JPEGPlugin - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~JPEGPlugin.__init__ - ~JPEGPlugin.check_value - ~JPEGPlugin.clear_sub - ~JPEGPlugin.configure - ~JPEGPlugin.describe - ~JPEGPlugin.describe_configuration - ~JPEGPlugin.disable_on_stage - ~JPEGPlugin.enable_on_stage - ~JPEGPlugin.ensure_blocking - ~JPEGPlugin.ensure_nonblocking - ~JPEGPlugin.find_signal - ~JPEGPlugin.generate_datum - ~JPEGPlugin.get - ~JPEGPlugin.get_asyn_digraph - ~JPEGPlugin.get_asyn_port_dictionary - ~JPEGPlugin.get_device_tuple - ~JPEGPlugin.get_instantiated_signals - ~JPEGPlugin.get_plugin_by_asyn_port - ~JPEGPlugin.missing_plugins - ~JPEGPlugin.pause - ~JPEGPlugin.put - ~JPEGPlugin.read - ~JPEGPlugin.read_configuration - ~JPEGPlugin.resume - ~JPEGPlugin.stage - ~JPEGPlugin.stop - ~JPEGPlugin.subscribe - ~JPEGPlugin.summary - ~JPEGPlugin.trigger - ~JPEGPlugin.unstage - ~JPEGPlugin.unsubscribe - ~JPEGPlugin.validate_asyn_ports - ~JPEGPlugin.wait_for_connection - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/_as_gen/ophyd.areadetector.plugins.MagickPlugin.rst.txt b/ophyd/_sources/_as_gen/ophyd.areadetector.plugins.MagickPlugin.rst.txt deleted file mode 100644 index 6ebd434534..0000000000 --- a/ophyd/_sources/_as_gen/ophyd.areadetector.plugins.MagickPlugin.rst.txt +++ /dev/null @@ -1,54 +0,0 @@ -ophyd\.areadetector\.plugins\.MagickPlugin -========================================== - -.. currentmodule:: ophyd.areadetector.plugins - -.. autoclass:: MagickPlugin - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~MagickPlugin.__init__ - ~MagickPlugin.check_value - ~MagickPlugin.clear_sub - ~MagickPlugin.configure - ~MagickPlugin.describe - ~MagickPlugin.describe_configuration - ~MagickPlugin.disable_on_stage - ~MagickPlugin.enable_on_stage - ~MagickPlugin.ensure_blocking - ~MagickPlugin.ensure_nonblocking - ~MagickPlugin.find_signal - ~MagickPlugin.generate_datum - ~MagickPlugin.get - ~MagickPlugin.get_asyn_digraph - ~MagickPlugin.get_asyn_port_dictionary - ~MagickPlugin.get_device_tuple - ~MagickPlugin.get_instantiated_signals - ~MagickPlugin.get_plugin_by_asyn_port - ~MagickPlugin.missing_plugins - ~MagickPlugin.pause - ~MagickPlugin.put - ~MagickPlugin.read - ~MagickPlugin.read_configuration - ~MagickPlugin.resume - ~MagickPlugin.stage - ~MagickPlugin.stop - ~MagickPlugin.subscribe - ~MagickPlugin.summary - ~MagickPlugin.trigger - ~MagickPlugin.unstage - ~MagickPlugin.unsubscribe - ~MagickPlugin.validate_asyn_ports - ~MagickPlugin.wait_for_connection - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/_as_gen/ophyd.areadetector.plugins.NetCDFPlugin.rst.txt b/ophyd/_sources/_as_gen/ophyd.areadetector.plugins.NetCDFPlugin.rst.txt deleted file mode 100644 index cab43e913f..0000000000 --- a/ophyd/_sources/_as_gen/ophyd.areadetector.plugins.NetCDFPlugin.rst.txt +++ /dev/null @@ -1,54 +0,0 @@ -ophyd\.areadetector\.plugins\.NetCDFPlugin -========================================== - -.. currentmodule:: ophyd.areadetector.plugins - -.. autoclass:: NetCDFPlugin - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~NetCDFPlugin.__init__ - ~NetCDFPlugin.check_value - ~NetCDFPlugin.clear_sub - ~NetCDFPlugin.configure - ~NetCDFPlugin.describe - ~NetCDFPlugin.describe_configuration - ~NetCDFPlugin.disable_on_stage - ~NetCDFPlugin.enable_on_stage - ~NetCDFPlugin.ensure_blocking - ~NetCDFPlugin.ensure_nonblocking - ~NetCDFPlugin.find_signal - ~NetCDFPlugin.generate_datum - ~NetCDFPlugin.get - ~NetCDFPlugin.get_asyn_digraph - ~NetCDFPlugin.get_asyn_port_dictionary - ~NetCDFPlugin.get_device_tuple - ~NetCDFPlugin.get_instantiated_signals - ~NetCDFPlugin.get_plugin_by_asyn_port - ~NetCDFPlugin.missing_plugins - ~NetCDFPlugin.pause - ~NetCDFPlugin.put - ~NetCDFPlugin.read - ~NetCDFPlugin.read_configuration - ~NetCDFPlugin.resume - ~NetCDFPlugin.stage - ~NetCDFPlugin.stop - ~NetCDFPlugin.subscribe - ~NetCDFPlugin.summary - ~NetCDFPlugin.trigger - ~NetCDFPlugin.unstage - ~NetCDFPlugin.unsubscribe - ~NetCDFPlugin.validate_asyn_ports - ~NetCDFPlugin.wait_for_connection - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/_as_gen/ophyd.areadetector.plugins.NexusPlugin.rst.txt b/ophyd/_sources/_as_gen/ophyd.areadetector.plugins.NexusPlugin.rst.txt deleted file mode 100644 index dcd153acca..0000000000 --- a/ophyd/_sources/_as_gen/ophyd.areadetector.plugins.NexusPlugin.rst.txt +++ /dev/null @@ -1,54 +0,0 @@ -ophyd\.areadetector\.plugins\.NexusPlugin -========================================= - -.. currentmodule:: ophyd.areadetector.plugins - -.. autoclass:: NexusPlugin - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~NexusPlugin.__init__ - ~NexusPlugin.check_value - ~NexusPlugin.clear_sub - ~NexusPlugin.configure - ~NexusPlugin.describe - ~NexusPlugin.describe_configuration - ~NexusPlugin.disable_on_stage - ~NexusPlugin.enable_on_stage - ~NexusPlugin.ensure_blocking - ~NexusPlugin.ensure_nonblocking - ~NexusPlugin.find_signal - ~NexusPlugin.generate_datum - ~NexusPlugin.get - ~NexusPlugin.get_asyn_digraph - ~NexusPlugin.get_asyn_port_dictionary - ~NexusPlugin.get_device_tuple - ~NexusPlugin.get_instantiated_signals - ~NexusPlugin.get_plugin_by_asyn_port - ~NexusPlugin.missing_plugins - ~NexusPlugin.pause - ~NexusPlugin.put - ~NexusPlugin.read - ~NexusPlugin.read_configuration - ~NexusPlugin.resume - ~NexusPlugin.stage - ~NexusPlugin.stop - ~NexusPlugin.subscribe - ~NexusPlugin.summary - ~NexusPlugin.trigger - ~NexusPlugin.unstage - ~NexusPlugin.unsubscribe - ~NexusPlugin.validate_asyn_ports - ~NexusPlugin.wait_for_connection - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/_as_gen/ophyd.areadetector.plugins.OverlayPlugin.rst.txt b/ophyd/_sources/_as_gen/ophyd.areadetector.plugins.OverlayPlugin.rst.txt deleted file mode 100644 index 25d4efd8ed..0000000000 --- a/ophyd/_sources/_as_gen/ophyd.areadetector.plugins.OverlayPlugin.rst.txt +++ /dev/null @@ -1,53 +0,0 @@ -ophyd\.areadetector\.plugins\.OverlayPlugin -=========================================== - -.. currentmodule:: ophyd.areadetector.plugins - -.. autoclass:: OverlayPlugin - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~OverlayPlugin.__init__ - ~OverlayPlugin.check_value - ~OverlayPlugin.clear_sub - ~OverlayPlugin.configure - ~OverlayPlugin.describe - ~OverlayPlugin.describe_configuration - ~OverlayPlugin.disable_on_stage - ~OverlayPlugin.enable_on_stage - ~OverlayPlugin.ensure_blocking - ~OverlayPlugin.ensure_nonblocking - ~OverlayPlugin.find_signal - ~OverlayPlugin.get - ~OverlayPlugin.get_asyn_digraph - ~OverlayPlugin.get_asyn_port_dictionary - ~OverlayPlugin.get_device_tuple - ~OverlayPlugin.get_instantiated_signals - ~OverlayPlugin.get_plugin_by_asyn_port - ~OverlayPlugin.missing_plugins - ~OverlayPlugin.pause - ~OverlayPlugin.put - ~OverlayPlugin.read - ~OverlayPlugin.read_configuration - ~OverlayPlugin.resume - ~OverlayPlugin.stage - ~OverlayPlugin.stop - ~OverlayPlugin.subscribe - ~OverlayPlugin.summary - ~OverlayPlugin.trigger - ~OverlayPlugin.unstage - ~OverlayPlugin.unsubscribe - ~OverlayPlugin.validate_asyn_ports - ~OverlayPlugin.wait_for_connection - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/_as_gen/ophyd.areadetector.plugins.PluginBase.rst.txt b/ophyd/_sources/_as_gen/ophyd.areadetector.plugins.PluginBase.rst.txt deleted file mode 100644 index 91cab8f30f..0000000000 --- a/ophyd/_sources/_as_gen/ophyd.areadetector.plugins.PluginBase.rst.txt +++ /dev/null @@ -1,53 +0,0 @@ -ophyd\.areadetector\.plugins\.PluginBase -======================================== - -.. currentmodule:: ophyd.areadetector.plugins - -.. autoclass:: PluginBase - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~PluginBase.__init__ - ~PluginBase.check_value - ~PluginBase.clear_sub - ~PluginBase.configure - ~PluginBase.describe - ~PluginBase.describe_configuration - ~PluginBase.disable_on_stage - ~PluginBase.enable_on_stage - ~PluginBase.ensure_blocking - ~PluginBase.ensure_nonblocking - ~PluginBase.find_signal - ~PluginBase.get - ~PluginBase.get_asyn_digraph - ~PluginBase.get_asyn_port_dictionary - ~PluginBase.get_device_tuple - ~PluginBase.get_instantiated_signals - ~PluginBase.get_plugin_by_asyn_port - ~PluginBase.missing_plugins - ~PluginBase.pause - ~PluginBase.put - ~PluginBase.read - ~PluginBase.read_configuration - ~PluginBase.resume - ~PluginBase.stage - ~PluginBase.stop - ~PluginBase.subscribe - ~PluginBase.summary - ~PluginBase.trigger - ~PluginBase.unstage - ~PluginBase.unsubscribe - ~PluginBase.validate_asyn_ports - ~PluginBase.wait_for_connection - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/_as_gen/ophyd.areadetector.plugins.ProcessPlugin.rst.txt b/ophyd/_sources/_as_gen/ophyd.areadetector.plugins.ProcessPlugin.rst.txt deleted file mode 100644 index 1b891b3b8f..0000000000 --- a/ophyd/_sources/_as_gen/ophyd.areadetector.plugins.ProcessPlugin.rst.txt +++ /dev/null @@ -1,53 +0,0 @@ -ophyd\.areadetector\.plugins\.ProcessPlugin -=========================================== - -.. currentmodule:: ophyd.areadetector.plugins - -.. autoclass:: ProcessPlugin - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~ProcessPlugin.__init__ - ~ProcessPlugin.check_value - ~ProcessPlugin.clear_sub - ~ProcessPlugin.configure - ~ProcessPlugin.describe - ~ProcessPlugin.describe_configuration - ~ProcessPlugin.disable_on_stage - ~ProcessPlugin.enable_on_stage - ~ProcessPlugin.ensure_blocking - ~ProcessPlugin.ensure_nonblocking - ~ProcessPlugin.find_signal - ~ProcessPlugin.get - ~ProcessPlugin.get_asyn_digraph - ~ProcessPlugin.get_asyn_port_dictionary - ~ProcessPlugin.get_device_tuple - ~ProcessPlugin.get_instantiated_signals - ~ProcessPlugin.get_plugin_by_asyn_port - ~ProcessPlugin.missing_plugins - ~ProcessPlugin.pause - ~ProcessPlugin.put - ~ProcessPlugin.read - ~ProcessPlugin.read_configuration - ~ProcessPlugin.resume - ~ProcessPlugin.stage - ~ProcessPlugin.stop - ~ProcessPlugin.subscribe - ~ProcessPlugin.summary - ~ProcessPlugin.trigger - ~ProcessPlugin.unstage - ~ProcessPlugin.unsubscribe - ~ProcessPlugin.validate_asyn_ports - ~ProcessPlugin.wait_for_connection - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/_as_gen/ophyd.areadetector.plugins.ROIPlugin.rst.txt b/ophyd/_sources/_as_gen/ophyd.areadetector.plugins.ROIPlugin.rst.txt deleted file mode 100644 index a854991c62..0000000000 --- a/ophyd/_sources/_as_gen/ophyd.areadetector.plugins.ROIPlugin.rst.txt +++ /dev/null @@ -1,53 +0,0 @@ -ophyd\.areadetector\.plugins\.ROIPlugin -======================================= - -.. currentmodule:: ophyd.areadetector.plugins - -.. autoclass:: ROIPlugin - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~ROIPlugin.__init__ - ~ROIPlugin.check_value - ~ROIPlugin.clear_sub - ~ROIPlugin.configure - ~ROIPlugin.describe - ~ROIPlugin.describe_configuration - ~ROIPlugin.disable_on_stage - ~ROIPlugin.enable_on_stage - ~ROIPlugin.ensure_blocking - ~ROIPlugin.ensure_nonblocking - ~ROIPlugin.find_signal - ~ROIPlugin.get - ~ROIPlugin.get_asyn_digraph - ~ROIPlugin.get_asyn_port_dictionary - ~ROIPlugin.get_device_tuple - ~ROIPlugin.get_instantiated_signals - ~ROIPlugin.get_plugin_by_asyn_port - ~ROIPlugin.missing_plugins - ~ROIPlugin.pause - ~ROIPlugin.put - ~ROIPlugin.read - ~ROIPlugin.read_configuration - ~ROIPlugin.resume - ~ROIPlugin.stage - ~ROIPlugin.stop - ~ROIPlugin.subscribe - ~ROIPlugin.summary - ~ROIPlugin.trigger - ~ROIPlugin.unstage - ~ROIPlugin.unsubscribe - ~ROIPlugin.validate_asyn_ports - ~ROIPlugin.wait_for_connection - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/_as_gen/ophyd.areadetector.plugins.StatsPlugin.rst.txt b/ophyd/_sources/_as_gen/ophyd.areadetector.plugins.StatsPlugin.rst.txt deleted file mode 100644 index 9eeb45ea86..0000000000 --- a/ophyd/_sources/_as_gen/ophyd.areadetector.plugins.StatsPlugin.rst.txt +++ /dev/null @@ -1,53 +0,0 @@ -ophyd\.areadetector\.plugins\.StatsPlugin -========================================= - -.. currentmodule:: ophyd.areadetector.plugins - -.. autoclass:: StatsPlugin - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~StatsPlugin.__init__ - ~StatsPlugin.check_value - ~StatsPlugin.clear_sub - ~StatsPlugin.configure - ~StatsPlugin.describe - ~StatsPlugin.describe_configuration - ~StatsPlugin.disable_on_stage - ~StatsPlugin.enable_on_stage - ~StatsPlugin.ensure_blocking - ~StatsPlugin.ensure_nonblocking - ~StatsPlugin.find_signal - ~StatsPlugin.get - ~StatsPlugin.get_asyn_digraph - ~StatsPlugin.get_asyn_port_dictionary - ~StatsPlugin.get_device_tuple - ~StatsPlugin.get_instantiated_signals - ~StatsPlugin.get_plugin_by_asyn_port - ~StatsPlugin.missing_plugins - ~StatsPlugin.pause - ~StatsPlugin.put - ~StatsPlugin.read - ~StatsPlugin.read_configuration - ~StatsPlugin.resume - ~StatsPlugin.stage - ~StatsPlugin.stop - ~StatsPlugin.subscribe - ~StatsPlugin.summary - ~StatsPlugin.trigger - ~StatsPlugin.unstage - ~StatsPlugin.unsubscribe - ~StatsPlugin.validate_asyn_ports - ~StatsPlugin.wait_for_connection - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/_as_gen/ophyd.areadetector.plugins.TIFFPlugin.rst.txt b/ophyd/_sources/_as_gen/ophyd.areadetector.plugins.TIFFPlugin.rst.txt deleted file mode 100644 index e0991cdf8b..0000000000 --- a/ophyd/_sources/_as_gen/ophyd.areadetector.plugins.TIFFPlugin.rst.txt +++ /dev/null @@ -1,54 +0,0 @@ -ophyd\.areadetector\.plugins\.TIFFPlugin -======================================== - -.. currentmodule:: ophyd.areadetector.plugins - -.. autoclass:: TIFFPlugin - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~TIFFPlugin.__init__ - ~TIFFPlugin.check_value - ~TIFFPlugin.clear_sub - ~TIFFPlugin.configure - ~TIFFPlugin.describe - ~TIFFPlugin.describe_configuration - ~TIFFPlugin.disable_on_stage - ~TIFFPlugin.enable_on_stage - ~TIFFPlugin.ensure_blocking - ~TIFFPlugin.ensure_nonblocking - ~TIFFPlugin.find_signal - ~TIFFPlugin.generate_datum - ~TIFFPlugin.get - ~TIFFPlugin.get_asyn_digraph - ~TIFFPlugin.get_asyn_port_dictionary - ~TIFFPlugin.get_device_tuple - ~TIFFPlugin.get_instantiated_signals - ~TIFFPlugin.get_plugin_by_asyn_port - ~TIFFPlugin.missing_plugins - ~TIFFPlugin.pause - ~TIFFPlugin.put - ~TIFFPlugin.read - ~TIFFPlugin.read_configuration - ~TIFFPlugin.resume - ~TIFFPlugin.stage - ~TIFFPlugin.stop - ~TIFFPlugin.subscribe - ~TIFFPlugin.summary - ~TIFFPlugin.trigger - ~TIFFPlugin.unstage - ~TIFFPlugin.unsubscribe - ~TIFFPlugin.validate_asyn_ports - ~TIFFPlugin.wait_for_connection - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/_as_gen/ophyd.areadetector.plugins.TransformPlugin.rst.txt b/ophyd/_sources/_as_gen/ophyd.areadetector.plugins.TransformPlugin.rst.txt deleted file mode 100644 index cef1d94fa6..0000000000 --- a/ophyd/_sources/_as_gen/ophyd.areadetector.plugins.TransformPlugin.rst.txt +++ /dev/null @@ -1,53 +0,0 @@ -ophyd\.areadetector\.plugins\.TransformPlugin -============================================= - -.. currentmodule:: ophyd.areadetector.plugins - -.. autoclass:: TransformPlugin - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~TransformPlugin.__init__ - ~TransformPlugin.check_value - ~TransformPlugin.clear_sub - ~TransformPlugin.configure - ~TransformPlugin.describe - ~TransformPlugin.describe_configuration - ~TransformPlugin.disable_on_stage - ~TransformPlugin.enable_on_stage - ~TransformPlugin.ensure_blocking - ~TransformPlugin.ensure_nonblocking - ~TransformPlugin.find_signal - ~TransformPlugin.get - ~TransformPlugin.get_asyn_digraph - ~TransformPlugin.get_asyn_port_dictionary - ~TransformPlugin.get_device_tuple - ~TransformPlugin.get_instantiated_signals - ~TransformPlugin.get_plugin_by_asyn_port - ~TransformPlugin.missing_plugins - ~TransformPlugin.pause - ~TransformPlugin.put - ~TransformPlugin.read - ~TransformPlugin.read_configuration - ~TransformPlugin.resume - ~TransformPlugin.stage - ~TransformPlugin.stop - ~TransformPlugin.subscribe - ~TransformPlugin.summary - ~TransformPlugin.trigger - ~TransformPlugin.unstage - ~TransformPlugin.unsubscribe - ~TransformPlugin.validate_asyn_ports - ~TransformPlugin.wait_for_connection - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/_as_gen/ophyd.areadetector.plugins.rst.txt b/ophyd/_sources/_as_gen/ophyd.areadetector.plugins.rst.txt deleted file mode 100644 index fd828a13b1..0000000000 --- a/ophyd/_sources/_as_gen/ophyd.areadetector.plugins.rst.txt +++ /dev/null @@ -1,46 +0,0 @@ -ophyd\.areadetector\.plugins -============================ - -.. automodule:: ophyd.areadetector.plugins - - - - .. rubric:: Functions - - .. autosummary:: - - get_areadetector_plugin - get_areadetector_plugin_class - plugin_from_pvname - register_plugin - - - - - - .. rubric:: Classes - - .. autosummary:: - - ColorConvPlugin - FilePlugin - HDF5Plugin - ImagePlugin - JPEGPlugin - MagickPlugin - NetCDFPlugin - NexusPlugin - Overlay - OverlayPlugin - PluginBase - ProcessPlugin - ROIPlugin - StatsPlugin - TIFFPlugin - TransformPlugin - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/_as_gen/ophyd.areadetector.rst.txt b/ophyd/_sources/_as_gen/ophyd.areadetector.rst.txt deleted file mode 100644 index da097ef50e..0000000000 --- a/ophyd/_sources/_as_gen/ophyd.areadetector.rst.txt +++ /dev/null @@ -1,16 +0,0 @@ -ophyd\.areadetector -=================== - -.. automodule:: ophyd.areadetector - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/_as_gen/ophyd.areadetector.trigger_mixins.MultiTrigger.rst.txt b/ophyd/_sources/_as_gen/ophyd.areadetector.trigger_mixins.MultiTrigger.rst.txt deleted file mode 100644 index 2d55b421b8..0000000000 --- a/ophyd/_sources/_as_gen/ophyd.areadetector.trigger_mixins.MultiTrigger.rst.txt +++ /dev/null @@ -1,29 +0,0 @@ -ophyd\.areadetector\.trigger\_mixins\.MultiTrigger -================================================== - -.. currentmodule:: ophyd.areadetector.trigger_mixins - -.. autoclass:: MultiTrigger - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~MultiTrigger.__init__ - ~MultiTrigger.describe - ~MultiTrigger.pause - ~MultiTrigger.read - ~MultiTrigger.resume - ~MultiTrigger.stage - ~MultiTrigger.trigger - ~MultiTrigger.unstage - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/_as_gen/ophyd.areadetector.trigger_mixins.SingleTrigger.rst.txt b/ophyd/_sources/_as_gen/ophyd.areadetector.trigger_mixins.SingleTrigger.rst.txt deleted file mode 100644 index 1ef26c6fca..0000000000 --- a/ophyd/_sources/_as_gen/ophyd.areadetector.trigger_mixins.SingleTrigger.rst.txt +++ /dev/null @@ -1,29 +0,0 @@ -ophyd\.areadetector\.trigger\_mixins\.SingleTrigger -=================================================== - -.. currentmodule:: ophyd.areadetector.trigger_mixins - -.. autoclass:: SingleTrigger - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~SingleTrigger.__init__ - ~SingleTrigger.describe - ~SingleTrigger.pause - ~SingleTrigger.read - ~SingleTrigger.resume - ~SingleTrigger.stage - ~SingleTrigger.trigger - ~SingleTrigger.unstage - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/_as_gen/ophyd.areadetector.trigger_mixins.TriggerBase.rst.txt b/ophyd/_sources/_as_gen/ophyd.areadetector.trigger_mixins.TriggerBase.rst.txt deleted file mode 100644 index ad45104a5b..0000000000 --- a/ophyd/_sources/_as_gen/ophyd.areadetector.trigger_mixins.TriggerBase.rst.txt +++ /dev/null @@ -1,29 +0,0 @@ -ophyd\.areadetector\.trigger\_mixins\.TriggerBase -================================================= - -.. currentmodule:: ophyd.areadetector.trigger_mixins - -.. autoclass:: TriggerBase - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~TriggerBase.__init__ - ~TriggerBase.describe - ~TriggerBase.pause - ~TriggerBase.read - ~TriggerBase.resume - ~TriggerBase.stage - ~TriggerBase.trigger - ~TriggerBase.unstage - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/_as_gen/ophyd.areadetector.trigger_mixins.rst.txt b/ophyd/_sources/_as_gen/ophyd.areadetector.trigger_mixins.rst.txt deleted file mode 100644 index edce5232e9..0000000000 --- a/ophyd/_sources/_as_gen/ophyd.areadetector.trigger_mixins.rst.txt +++ /dev/null @@ -1,25 +0,0 @@ -ophyd\.areadetector\.trigger\_mixins -==================================== - -.. automodule:: ophyd.areadetector.trigger_mixins - - - - - - - - .. rubric:: Classes - - .. autosummary:: - - ADTriggerStatus - MultiTrigger - SingleTrigger - TriggerBase - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/_as_gen/ophyd.areadetector.util.rst.txt b/ophyd/_sources/_as_gen/ophyd.areadetector.util.rst.txt deleted file mode 100644 index 3009114c2f..0000000000 --- a/ophyd/_sources/_as_gen/ophyd.areadetector.util.rst.txt +++ /dev/null @@ -1,31 +0,0 @@ -ophyd\.areadetector\.util -========================= - -.. automodule:: ophyd.areadetector.util - - - - .. rubric:: Functions - - .. autosummary:: - - create_detector_stub - get_prop_name - get_stub_info - stub_templates - - - - - - .. rubric:: Classes - - .. autosummary:: - - StubInfo - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/_as_gen/ophyd.callbacks.rst.txt b/ophyd/_sources/_as_gen/ophyd.callbacks.rst.txt deleted file mode 100644 index 08faa9b427..0000000000 --- a/ophyd/_sources/_as_gen/ophyd.callbacks.rst.txt +++ /dev/null @@ -1,23 +0,0 @@ -ophyd\.callbacks -================ - -.. automodule:: ophyd.callbacks - - - - - - - - .. rubric:: Classes - - .. autosummary:: - - LastUidPublish - UidPublish - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/_as_gen/ophyd.commands.get_all_positioners.rst.txt b/ophyd/_sources/_as_gen/ophyd.commands.get_all_positioners.rst.txt deleted file mode 100644 index 21164fc1c3..0000000000 --- a/ophyd/_sources/_as_gen/ophyd.commands.get_all_positioners.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -ophyd\.commands\.get\_all\_positioners -====================================== - -.. currentmodule:: ophyd.commands - -.. autofunction:: get_all_positioners \ No newline at end of file diff --git a/ophyd/_sources/_as_gen/ophyd.commands.log_pos.rst.txt b/ophyd/_sources/_as_gen/ophyd.commands.log_pos.rst.txt deleted file mode 100644 index 8efa085fe6..0000000000 --- a/ophyd/_sources/_as_gen/ophyd.commands.log_pos.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -ophyd\.commands\.log\_pos -========================= - -.. currentmodule:: ophyd.commands - -.. autofunction:: log_pos \ No newline at end of file diff --git a/ophyd/_sources/_as_gen/ophyd.commands.log_pos_diff.rst.txt b/ophyd/_sources/_as_gen/ophyd.commands.log_pos_diff.rst.txt deleted file mode 100644 index aeb093ba5c..0000000000 --- a/ophyd/_sources/_as_gen/ophyd.commands.log_pos_diff.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -ophyd\.commands\.log\_pos\_diff -=============================== - -.. currentmodule:: ophyd.commands - -.. autofunction:: log_pos_diff \ No newline at end of file diff --git a/ophyd/_sources/_as_gen/ophyd.commands.log_pos_mov.rst.txt b/ophyd/_sources/_as_gen/ophyd.commands.log_pos_mov.rst.txt deleted file mode 100644 index f1f3d376a2..0000000000 --- a/ophyd/_sources/_as_gen/ophyd.commands.log_pos_mov.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -ophyd\.commands\.log\_pos\_mov -============================== - -.. currentmodule:: ophyd.commands - -.. autofunction:: log_pos_mov \ No newline at end of file diff --git a/ophyd/_sources/_as_gen/ophyd.commands.rst.txt b/ophyd/_sources/_as_gen/ophyd.commands.rst.txt deleted file mode 100644 index 70dd04c168..0000000000 --- a/ophyd/_sources/_as_gen/ophyd.commands.rst.txt +++ /dev/null @@ -1,43 +0,0 @@ -ophyd\.commands -=============== - -.. automodule:: ophyd.commands - - - - .. rubric:: Functions - - .. autosummary:: - - blink - catch_keyboard_interrupt - ducks_from_namespace - ensure - get_all_positioners - get_logbook - instances_from_namespace - log_pos - log_pos_diff - log_pos_mov - logbook_add_objects - logbook_to_objects - mov - movr - print_header - print_string - print_value - scrape_namespace - set_lm - set_pos - var_from_namespace - wh_pos - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/_as_gen/ophyd.commands.wh_pos.rst.txt b/ophyd/_sources/_as_gen/ophyd.commands.wh_pos.rst.txt deleted file mode 100644 index af57feec4a..0000000000 --- a/ophyd/_sources/_as_gen/ophyd.commands.wh_pos.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -ophyd\.commands\.wh\_pos -======================== - -.. currentmodule:: ophyd.commands - -.. autofunction:: wh_pos \ No newline at end of file diff --git a/ophyd/_sources/_as_gen/ophyd.device.BlueskyInterface.describe.rst.txt b/ophyd/_sources/_as_gen/ophyd.device.BlueskyInterface.describe.rst.txt deleted file mode 100644 index 7fa40f90ba..0000000000 --- a/ophyd/_sources/_as_gen/ophyd.device.BlueskyInterface.describe.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -ophyd\.device\.BlueskyInterface\.describe -========================================= - -.. currentmodule:: ophyd.device - -.. automethod:: BlueskyInterface.describe \ No newline at end of file diff --git a/ophyd/_sources/_as_gen/ophyd.device.BlueskyInterface.pause.rst.txt b/ophyd/_sources/_as_gen/ophyd.device.BlueskyInterface.pause.rst.txt deleted file mode 100644 index 080a91dbbe..0000000000 --- a/ophyd/_sources/_as_gen/ophyd.device.BlueskyInterface.pause.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -ophyd\.device\.BlueskyInterface\.pause -====================================== - -.. currentmodule:: ophyd.device - -.. automethod:: BlueskyInterface.pause \ No newline at end of file diff --git a/ophyd/_sources/_as_gen/ophyd.device.BlueskyInterface.read.rst.txt b/ophyd/_sources/_as_gen/ophyd.device.BlueskyInterface.read.rst.txt deleted file mode 100644 index 111739b74e..0000000000 --- a/ophyd/_sources/_as_gen/ophyd.device.BlueskyInterface.read.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -ophyd\.device\.BlueskyInterface\.read -===================================== - -.. currentmodule:: ophyd.device - -.. automethod:: BlueskyInterface.read \ No newline at end of file diff --git a/ophyd/_sources/_as_gen/ophyd.device.BlueskyInterface.resume.rst.txt b/ophyd/_sources/_as_gen/ophyd.device.BlueskyInterface.resume.rst.txt deleted file mode 100644 index 3493a0f105..0000000000 --- a/ophyd/_sources/_as_gen/ophyd.device.BlueskyInterface.resume.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -ophyd\.device\.BlueskyInterface\.resume -======================================= - -.. currentmodule:: ophyd.device - -.. automethod:: BlueskyInterface.resume \ No newline at end of file diff --git a/ophyd/_sources/_as_gen/ophyd.device.BlueskyInterface.stage.rst.txt b/ophyd/_sources/_as_gen/ophyd.device.BlueskyInterface.stage.rst.txt deleted file mode 100644 index ca86cc2cdb..0000000000 --- a/ophyd/_sources/_as_gen/ophyd.device.BlueskyInterface.stage.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -ophyd\.device\.BlueskyInterface\.stage -====================================== - -.. currentmodule:: ophyd.device - -.. automethod:: BlueskyInterface.stage \ No newline at end of file diff --git a/ophyd/_sources/_as_gen/ophyd.device.BlueskyInterface.trigger.rst.txt b/ophyd/_sources/_as_gen/ophyd.device.BlueskyInterface.trigger.rst.txt deleted file mode 100644 index 9fbb0658e3..0000000000 --- a/ophyd/_sources/_as_gen/ophyd.device.BlueskyInterface.trigger.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -ophyd\.device\.BlueskyInterface\.trigger -======================================== - -.. currentmodule:: ophyd.device - -.. automethod:: BlueskyInterface.trigger \ No newline at end of file diff --git a/ophyd/_sources/_as_gen/ophyd.device.BlueskyInterface.unstage.rst.txt b/ophyd/_sources/_as_gen/ophyd.device.BlueskyInterface.unstage.rst.txt deleted file mode 100644 index e0b05b2818..0000000000 --- a/ophyd/_sources/_as_gen/ophyd.device.BlueskyInterface.unstage.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -ophyd\.device\.BlueskyInterface\.unstage -======================================== - -.. currentmodule:: ophyd.device - -.. automethod:: BlueskyInterface.unstage \ No newline at end of file diff --git a/ophyd/_sources/_as_gen/ophyd.device.Component.rst.txt b/ophyd/_sources/_as_gen/ophyd.device.Component.rst.txt deleted file mode 100644 index 3943d2b473..0000000000 --- a/ophyd/_sources/_as_gen/ophyd.device.Component.rst.txt +++ /dev/null @@ -1,25 +0,0 @@ -ophyd\.device\.Component -======================== - -.. currentmodule:: ophyd.device - -.. autoclass:: Component - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~Component.__init__ - ~Component.create_component - ~Component.make_docstring - ~Component.maybe_add_prefix - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/_as_gen/ophyd.device.ComponentMeta.__new__.rst.txt b/ophyd/_sources/_as_gen/ophyd.device.ComponentMeta.__new__.rst.txt deleted file mode 100644 index 3d29fd55c3..0000000000 --- a/ophyd/_sources/_as_gen/ophyd.device.ComponentMeta.__new__.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -ophyd\.device\.ComponentMeta\.\_\_new\_\_ -========================================= - -.. currentmodule:: ophyd.device - -.. automethod:: ComponentMeta.__new__ \ No newline at end of file diff --git a/ophyd/_sources/_as_gen/ophyd.device.ComponentMeta.__prepare__.rst.txt b/ophyd/_sources/_as_gen/ophyd.device.ComponentMeta.__prepare__.rst.txt deleted file mode 100644 index fded076273..0000000000 --- a/ophyd/_sources/_as_gen/ophyd.device.ComponentMeta.__prepare__.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -ophyd\.device\.ComponentMeta\.\_\_prepare\_\_ -============================================= - -.. currentmodule:: ophyd.device - -.. automethod:: ComponentMeta.__prepare__ \ No newline at end of file diff --git a/ophyd/_sources/_as_gen/ophyd.device.ComponentMeta.rst.txt b/ophyd/_sources/_as_gen/ophyd.device.ComponentMeta.rst.txt deleted file mode 100644 index 5c1c274f27..0000000000 --- a/ophyd/_sources/_as_gen/ophyd.device.ComponentMeta.rst.txt +++ /dev/null @@ -1,22 +0,0 @@ -ophyd\.device\.ComponentMeta -============================ - -.. currentmodule:: ophyd.device - -.. autoclass:: ComponentMeta - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~ComponentMeta.mro - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/_as_gen/ophyd.device.Device.configure.rst.txt b/ophyd/_sources/_as_gen/ophyd.device.Device.configure.rst.txt deleted file mode 100644 index b0ba0cee0a..0000000000 --- a/ophyd/_sources/_as_gen/ophyd.device.Device.configure.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -ophyd\.device\.Device\.configure -================================ - -.. currentmodule:: ophyd.device - -.. automethod:: Device.configure \ No newline at end of file diff --git a/ophyd/_sources/_as_gen/ophyd.device.Device.connected.rst.txt b/ophyd/_sources/_as_gen/ophyd.device.Device.connected.rst.txt deleted file mode 100644 index ec490c28ea..0000000000 --- a/ophyd/_sources/_as_gen/ophyd.device.Device.connected.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -ophyd\.device\.Device\.connected -================================ - -.. currentmodule:: ophyd.device - -.. autoattribute:: Device.connected \ No newline at end of file diff --git a/ophyd/_sources/_as_gen/ophyd.device.Device.describe_configuration.rst.txt b/ophyd/_sources/_as_gen/ophyd.device.Device.describe_configuration.rst.txt deleted file mode 100644 index 8756224724..0000000000 --- a/ophyd/_sources/_as_gen/ophyd.device.Device.describe_configuration.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -ophyd\.device\.Device\.describe\_configuration -============================================== - -.. currentmodule:: ophyd.device - -.. automethod:: Device.describe_configuration \ No newline at end of file diff --git a/ophyd/_sources/_as_gen/ophyd.device.Device.get.rst.txt b/ophyd/_sources/_as_gen/ophyd.device.Device.get.rst.txt deleted file mode 100644 index d5715b1c5d..0000000000 --- a/ophyd/_sources/_as_gen/ophyd.device.Device.get.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -ophyd\.device\.Device\.get -========================== - -.. currentmodule:: ophyd.device - -.. automethod:: Device.get \ No newline at end of file diff --git a/ophyd/_sources/_as_gen/ophyd.device.Device.get_device_tuple.rst.txt b/ophyd/_sources/_as_gen/ophyd.device.Device.get_device_tuple.rst.txt deleted file mode 100644 index 99f426235d..0000000000 --- a/ophyd/_sources/_as_gen/ophyd.device.Device.get_device_tuple.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -ophyd\.device\.Device\.get\_device\_tuple -========================================= - -.. currentmodule:: ophyd.device - -.. automethod:: Device.get_device_tuple \ No newline at end of file diff --git a/ophyd/_sources/_as_gen/ophyd.device.Device.get_instantiated_signals.rst.txt b/ophyd/_sources/_as_gen/ophyd.device.Device.get_instantiated_signals.rst.txt deleted file mode 100644 index 0a3bc41252..0000000000 --- a/ophyd/_sources/_as_gen/ophyd.device.Device.get_instantiated_signals.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -ophyd\.device\.Device\.get\_instantiated\_signals -================================================= - -.. currentmodule:: ophyd.device - -.. automethod:: Device.get_instantiated_signals \ No newline at end of file diff --git a/ophyd/_sources/_as_gen/ophyd.device.Device.put.rst.txt b/ophyd/_sources/_as_gen/ophyd.device.Device.put.rst.txt deleted file mode 100644 index 2540341a43..0000000000 --- a/ophyd/_sources/_as_gen/ophyd.device.Device.put.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -ophyd\.device\.Device\.put -========================== - -.. currentmodule:: ophyd.device - -.. automethod:: Device.put \ No newline at end of file diff --git a/ophyd/_sources/_as_gen/ophyd.device.Device.read_configuration.rst.txt b/ophyd/_sources/_as_gen/ophyd.device.Device.read_configuration.rst.txt deleted file mode 100644 index f476dcfb02..0000000000 --- a/ophyd/_sources/_as_gen/ophyd.device.Device.read_configuration.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -ophyd\.device\.Device\.read\_configuration -========================================== - -.. currentmodule:: ophyd.device - -.. automethod:: Device.read_configuration \ No newline at end of file diff --git a/ophyd/_sources/_as_gen/ophyd.device.Device.rst.txt b/ophyd/_sources/_as_gen/ophyd.device.Device.rst.txt deleted file mode 100644 index 34f9000306..0000000000 --- a/ophyd/_sources/_as_gen/ophyd.device.Device.rst.txt +++ /dev/null @@ -1,43 +0,0 @@ -ophyd\.device\.Device -===================== - -.. currentmodule:: ophyd.device - -.. autoclass:: Device - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~Device.__init__ - ~Device.check_value - ~Device.clear_sub - ~Device.configure - ~Device.describe - ~Device.describe_configuration - ~Device.get - ~Device.get_device_tuple - ~Device.get_instantiated_signals - ~Device.pause - ~Device.put - ~Device.read - ~Device.read_configuration - ~Device.resume - ~Device.stage - ~Device.stop - ~Device.subscribe - ~Device.summary - ~Device.trigger - ~Device.unstage - ~Device.unsubscribe - ~Device.wait_for_connection - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/_as_gen/ophyd.device.Device.wait_for_connection.rst.txt b/ophyd/_sources/_as_gen/ophyd.device.Device.wait_for_connection.rst.txt deleted file mode 100644 index ed71c55383..0000000000 --- a/ophyd/_sources/_as_gen/ophyd.device.Device.wait_for_connection.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -ophyd\.device\.Device\.wait\_for\_connection -============================================ - -.. currentmodule:: ophyd.device - -.. automethod:: Device.wait_for_connection \ No newline at end of file diff --git a/ophyd/_sources/_as_gen/ophyd.device.DynamicDeviceComponent.rst.txt b/ophyd/_sources/_as_gen/ophyd.device.DynamicDeviceComponent.rst.txt deleted file mode 100644 index 5ab3d3b779..0000000000 --- a/ophyd/_sources/_as_gen/ophyd.device.DynamicDeviceComponent.rst.txt +++ /dev/null @@ -1,25 +0,0 @@ -ophyd\.device\.DynamicDeviceComponent -===================================== - -.. currentmodule:: ophyd.device - -.. autoclass:: DynamicDeviceComponent - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~DynamicDeviceComponent.__init__ - ~DynamicDeviceComponent.create_attr - ~DynamicDeviceComponent.create_component - ~DynamicDeviceComponent.make_docstring - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/_as_gen/ophyd.device.FormattedComponent.rst.txt b/ophyd/_sources/_as_gen/ophyd.device.FormattedComponent.rst.txt deleted file mode 100644 index 711d7d1ecf..0000000000 --- a/ophyd/_sources/_as_gen/ophyd.device.FormattedComponent.rst.txt +++ /dev/null @@ -1,25 +0,0 @@ -ophyd\.device\.FormattedComponent -================================= - -.. currentmodule:: ophyd.device - -.. autoclass:: FormattedComponent - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~FormattedComponent.__init__ - ~FormattedComponent.create_component - ~FormattedComponent.make_docstring - ~FormattedComponent.maybe_add_prefix - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/_as_gen/ophyd.device.rst.txt b/ophyd/_sources/_as_gen/ophyd.device.rst.txt deleted file mode 100644 index f49ed988d8..0000000000 --- a/ophyd/_sources/_as_gen/ophyd.device.rst.txt +++ /dev/null @@ -1,30 +0,0 @@ -ophyd\.device -============= - -.. automodule:: ophyd.device - - - - - - - - .. rubric:: Classes - - .. autosummary:: - - BlueskyInterface - Component - ComponentMeta - Device - DynamicDeviceComponent - FormattedComponent - GenerateDatumInterface - OrderedDictType - Staged - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/_as_gen/ophyd.epics_motor.rst.txt b/ophyd/_sources/_as_gen/ophyd.epics_motor.rst.txt deleted file mode 100644 index 93cb90d1c8..0000000000 --- a/ophyd/_sources/_as_gen/ophyd.epics_motor.rst.txt +++ /dev/null @@ -1,24 +0,0 @@ -ophyd\.epics\_motor -=================== - -.. automodule:: ophyd.epics_motor - - - - - - - - .. rubric:: Classes - - .. autosummary:: - - EpicsMotor - HomeEnum - MotorBundle - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/_as_gen/ophyd.flyers.FlyerInterface.collect.rst.txt b/ophyd/_sources/_as_gen/ophyd.flyers.FlyerInterface.collect.rst.txt deleted file mode 100644 index 2cbcf87806..0000000000 --- a/ophyd/_sources/_as_gen/ophyd.flyers.FlyerInterface.collect.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -ophyd\.flyers\.FlyerInterface\.collect -====================================== - -.. currentmodule:: ophyd.flyers - -.. automethod:: FlyerInterface.collect \ No newline at end of file diff --git a/ophyd/_sources/_as_gen/ophyd.flyers.FlyerInterface.complete.rst.txt b/ophyd/_sources/_as_gen/ophyd.flyers.FlyerInterface.complete.rst.txt deleted file mode 100644 index 155f40014c..0000000000 --- a/ophyd/_sources/_as_gen/ophyd.flyers.FlyerInterface.complete.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -ophyd\.flyers\.FlyerInterface\.complete -======================================= - -.. currentmodule:: ophyd.flyers - -.. automethod:: FlyerInterface.complete \ No newline at end of file diff --git a/ophyd/_sources/_as_gen/ophyd.flyers.FlyerInterface.describe_collect.rst.txt b/ophyd/_sources/_as_gen/ophyd.flyers.FlyerInterface.describe_collect.rst.txt deleted file mode 100644 index ac453de038..0000000000 --- a/ophyd/_sources/_as_gen/ophyd.flyers.FlyerInterface.describe_collect.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -ophyd\.flyers\.FlyerInterface\.describe\_collect -================================================ - -.. currentmodule:: ophyd.flyers - -.. automethod:: FlyerInterface.describe_collect \ No newline at end of file diff --git a/ophyd/_sources/_as_gen/ophyd.flyers.FlyerInterface.kickoff.rst.txt b/ophyd/_sources/_as_gen/ophyd.flyers.FlyerInterface.kickoff.rst.txt deleted file mode 100644 index e9dfcbedea..0000000000 --- a/ophyd/_sources/_as_gen/ophyd.flyers.FlyerInterface.kickoff.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -ophyd\.flyers\.FlyerInterface\.kickoff -====================================== - -.. currentmodule:: ophyd.flyers - -.. automethod:: FlyerInterface.kickoff \ No newline at end of file diff --git a/ophyd/_sources/_as_gen/ophyd.flyers.rst.txt b/ophyd/_sources/_as_gen/ophyd.flyers.rst.txt deleted file mode 100644 index f61e1e4b2f..0000000000 --- a/ophyd/_sources/_as_gen/ophyd.flyers.rst.txt +++ /dev/null @@ -1,25 +0,0 @@ -ophyd\.flyers -============= - -.. automodule:: ophyd.flyers - - - - - - - - .. rubric:: Classes - - .. autosummary:: - - AreaDetectorTimeseriesCollector - FlyerInterface - MonitorFlyerMixin - WaveformCollector - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/_as_gen/ophyd.mca.rst.txt b/ophyd/_sources/_as_gen/ophyd.mca.rst.txt deleted file mode 100644 index ebd2e74ce8..0000000000 --- a/ophyd/_sources/_as_gen/ophyd.mca.rst.txt +++ /dev/null @@ -1,44 +0,0 @@ -ophyd\.mca -========== - -.. automodule:: ophyd.mca - - - - .. rubric:: Functions - - .. autosummary:: - - add_rois - - - - - - .. rubric:: Classes - - .. autosummary:: - - EpicsDXP - EpicsDXPBaseSystem - EpicsDXPLowLevel - EpicsDXPLowLevelParameter - EpicsDXPMapping - EpicsDXPMultiElementSystem - EpicsMCA - EpicsMCACallback - EpicsMCAReadNotify - EpicsMCARecord - Mercury1 - MercuryDXP - ROI - Saturn - SaturnDXP - SaturnMCA - SoftDXPTrigger - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/_as_gen/ophyd.mixins.rst.txt b/ophyd/_sources/_as_gen/ophyd.mixins.rst.txt deleted file mode 100644 index 321aa17d78..0000000000 --- a/ophyd/_sources/_as_gen/ophyd.mixins.rst.txt +++ /dev/null @@ -1,23 +0,0 @@ -ophyd\.mixins -============= - -.. automodule:: ophyd.mixins - - - - - - - - .. rubric:: Classes - - .. autosummary:: - - EpicsSignalPositioner - SignalPositionerMixin - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/_as_gen/ophyd.ophydobj.OphydObject._reset_sub.rst.txt b/ophyd/_sources/_as_gen/ophyd.ophydobj.OphydObject._reset_sub.rst.txt deleted file mode 100644 index d8842e85bb..0000000000 --- a/ophyd/_sources/_as_gen/ophyd.ophydobj.OphydObject._reset_sub.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -ophyd\.ophydobj\.OphydObject\.\_reset\_sub -========================================== - -.. currentmodule:: ophyd.ophydobj - -.. automethod:: OphydObject._reset_sub \ No newline at end of file diff --git a/ophyd/_sources/_as_gen/ophyd.ophydobj.OphydObject._run_subs.rst.txt b/ophyd/_sources/_as_gen/ophyd.ophydobj.OphydObject._run_subs.rst.txt deleted file mode 100644 index 00369ee6d6..0000000000 --- a/ophyd/_sources/_as_gen/ophyd.ophydobj.OphydObject._run_subs.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -ophyd\.ophydobj\.OphydObject\.\_run\_subs -========================================= - -.. currentmodule:: ophyd.ophydobj - -.. automethod:: OphydObject._run_subs \ No newline at end of file diff --git a/ophyd/_sources/_as_gen/ophyd.ophydobj.OphydObject.clear_sub.rst.txt b/ophyd/_sources/_as_gen/ophyd.ophydobj.OphydObject.clear_sub.rst.txt deleted file mode 100644 index a87ae0e1e1..0000000000 --- a/ophyd/_sources/_as_gen/ophyd.ophydobj.OphydObject.clear_sub.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -ophyd\.ophydobj\.OphydObject\.clear\_sub -======================================== - -.. currentmodule:: ophyd.ophydobj - -.. automethod:: OphydObject.clear_sub \ No newline at end of file diff --git a/ophyd/_sources/_as_gen/ophyd.ophydobj.OphydObject.connected.rst.txt b/ophyd/_sources/_as_gen/ophyd.ophydobj.OphydObject.connected.rst.txt deleted file mode 100644 index 7c61a55b73..0000000000 --- a/ophyd/_sources/_as_gen/ophyd.ophydobj.OphydObject.connected.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -ophyd.ophydobj.OphydObject.connected -==================================== - -.. currentmodule:: ophyd.ophydobj - -.. autoattribute:: OphydObject.connected \ No newline at end of file diff --git a/ophyd/_sources/_as_gen/ophyd.ophydobj.OphydObject.event_types.rst.txt b/ophyd/_sources/_as_gen/ophyd.ophydobj.OphydObject.event_types.rst.txt deleted file mode 100644 index 51eb5c44d6..0000000000 --- a/ophyd/_sources/_as_gen/ophyd.ophydobj.OphydObject.event_types.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -ophyd\.ophydobj\.OphydObject\.event\_types -========================================== - -.. currentmodule:: ophyd.ophydobj - -.. autoattribute:: OphydObject.event_types \ No newline at end of file diff --git a/ophyd/_sources/_as_gen/ophyd.ophydobj.OphydObject.name.rst.txt b/ophyd/_sources/_as_gen/ophyd.ophydobj.OphydObject.name.rst.txt deleted file mode 100644 index 4d05c3e77b..0000000000 --- a/ophyd/_sources/_as_gen/ophyd.ophydobj.OphydObject.name.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -ophyd\.ophydobj\.OphydObject\.name -================================== - -.. currentmodule:: ophyd.ophydobj - -.. autoattribute:: OphydObject.name \ No newline at end of file diff --git a/ophyd/_sources/_as_gen/ophyd.ophydobj.OphydObject.parent.rst.txt b/ophyd/_sources/_as_gen/ophyd.ophydobj.OphydObject.parent.rst.txt deleted file mode 100644 index 1c6129ef7a..0000000000 --- a/ophyd/_sources/_as_gen/ophyd.ophydobj.OphydObject.parent.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -ophyd\.ophydobj\.OphydObject\.parent -==================================== - -.. currentmodule:: ophyd.ophydobj - -.. autoattribute:: OphydObject.parent \ No newline at end of file diff --git a/ophyd/_sources/_as_gen/ophyd.ophydobj.OphydObject.root.rst.txt b/ophyd/_sources/_as_gen/ophyd.ophydobj.OphydObject.root.rst.txt deleted file mode 100644 index ac1981d7df..0000000000 --- a/ophyd/_sources/_as_gen/ophyd.ophydobj.OphydObject.root.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -ophyd\.ophydobj\.OphydObject\.root -================================== - -.. currentmodule:: ophyd.ophydobj - -.. autoattribute:: OphydObject.root \ No newline at end of file diff --git a/ophyd/_sources/_as_gen/ophyd.ophydobj.OphydObject.rst.txt b/ophyd/_sources/_as_gen/ophyd.ophydobj.OphydObject.rst.txt deleted file mode 100644 index 6825335eda..0000000000 --- a/ophyd/_sources/_as_gen/ophyd.ophydobj.OphydObject.rst.txt +++ /dev/null @@ -1,26 +0,0 @@ -ophyd\.ophydobj\.OphydObject -============================ - -.. currentmodule:: ophyd.ophydobj - -.. autoclass:: OphydObject - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~OphydObject.__init__ - ~OphydObject.check_value - ~OphydObject.clear_sub - ~OphydObject.subscribe - ~OphydObject.unsubscribe - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/_as_gen/ophyd.ophydobj.OphydObject.subscribe.rst.txt b/ophyd/_sources/_as_gen/ophyd.ophydobj.OphydObject.subscribe.rst.txt deleted file mode 100644 index 562db4e4fc..0000000000 --- a/ophyd/_sources/_as_gen/ophyd.ophydobj.OphydObject.subscribe.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -ophyd\.ophydobj\.OphydObject\.subscribe -======================================= - -.. currentmodule:: ophyd.ophydobj - -.. automethod:: OphydObject.subscribe \ No newline at end of file diff --git a/ophyd/_sources/_as_gen/ophyd.ophydobj.OphydObject.unsubscribe.rst.txt b/ophyd/_sources/_as_gen/ophyd.ophydobj.OphydObject.unsubscribe.rst.txt deleted file mode 100644 index 1d4329ec67..0000000000 --- a/ophyd/_sources/_as_gen/ophyd.ophydobj.OphydObject.unsubscribe.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -ophyd\.ophydobj\.OphydObject\.unsubscribe -========================================= - -.. currentmodule:: ophyd.ophydobj - -.. automethod:: OphydObject.unsubscribe \ No newline at end of file diff --git a/ophyd/_sources/_as_gen/ophyd.ophydobj.rst.txt b/ophyd/_sources/_as_gen/ophyd.ophydobj.rst.txt deleted file mode 100644 index 2704d5fce2..0000000000 --- a/ophyd/_sources/_as_gen/ophyd.ophydobj.rst.txt +++ /dev/null @@ -1,28 +0,0 @@ -ophyd\.ophydobj -=============== - -.. automodule:: ophyd.ophydobj - - - - - - - - .. rubric:: Classes - - .. autosummary:: - - OphydObject - - - - - - .. rubric:: Exceptions - - .. autosummary:: - - UnknownSubscription - - \ No newline at end of file diff --git a/ophyd/_sources/_as_gen/ophyd.positioner.PositionerBase.set.rst.txt b/ophyd/_sources/_as_gen/ophyd.positioner.PositionerBase.set.rst.txt deleted file mode 100644 index 39facc6164..0000000000 --- a/ophyd/_sources/_as_gen/ophyd.positioner.PositionerBase.set.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -ophyd\.positioner\.PositionerBase\.set -====================================== - -.. currentmodule:: ophyd.positioner - -.. automethod:: PositionerBase.set \ No newline at end of file diff --git a/ophyd/_sources/_as_gen/ophyd.positioner.PositionerBase.stop.rst.txt b/ophyd/_sources/_as_gen/ophyd.positioner.PositionerBase.stop.rst.txt deleted file mode 100644 index 5629983535..0000000000 --- a/ophyd/_sources/_as_gen/ophyd.positioner.PositionerBase.stop.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -ophyd\.positioner\.PositionerBase\.stop -======================================= - -.. currentmodule:: ophyd.positioner - -.. automethod:: PositionerBase.stop \ No newline at end of file diff --git a/ophyd/_sources/_as_gen/ophyd.positioner.rst.txt b/ophyd/_sources/_as_gen/ophyd.positioner.rst.txt deleted file mode 100644 index 3cf8fda3e1..0000000000 --- a/ophyd/_sources/_as_gen/ophyd.positioner.rst.txt +++ /dev/null @@ -1,23 +0,0 @@ -ophyd\.positioner -================= - -.. automodule:: ophyd.positioner - - - - - - - - .. rubric:: Classes - - .. autosummary:: - - PositionerBase - SoftPositioner - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/_as_gen/ophyd.pseudopos.rst.txt b/ophyd/_sources/_as_gen/ophyd.pseudopos.rst.txt deleted file mode 100644 index 40760582a2..0000000000 --- a/ophyd/_sources/_as_gen/ophyd.pseudopos.rst.txt +++ /dev/null @@ -1,30 +0,0 @@ -ophyd\.pseudopos -================ - -.. automodule:: ophyd.pseudopos - - - - .. rubric:: Functions - - .. autosummary:: - - pseudo_position_argument - real_position_argument - - - - - - .. rubric:: Classes - - .. autosummary:: - - PseudoPositioner - PseudoSingle - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/_as_gen/ophyd.pv_positioner.rst.txt b/ophyd/_sources/_as_gen/ophyd.pv_positioner.rst.txt deleted file mode 100644 index fa6adc56f9..0000000000 --- a/ophyd/_sources/_as_gen/ophyd.pv_positioner.rst.txt +++ /dev/null @@ -1,23 +0,0 @@ -ophyd\.pv\_positioner -===================== - -.. automodule:: ophyd.pv_positioner - - - - - - - - .. rubric:: Classes - - .. autosummary:: - - PVPositioner - PVPositionerPC - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/_as_gen/ophyd.quadem.rst.txt b/ophyd/_sources/_as_gen/ophyd.quadem.rst.txt deleted file mode 100644 index e238f53088..0000000000 --- a/ophyd/_sources/_as_gen/ophyd.quadem.rst.txt +++ /dev/null @@ -1,25 +0,0 @@ -ophyd\.quadem -============= - -.. automodule:: ophyd.quadem - - - - - - - - .. rubric:: Classes - - .. autosummary:: - - APS_EM - NSLS_EM - QuadEM - TetrAMM - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/_as_gen/ophyd.rst.txt b/ophyd/_sources/_as_gen/ophyd.rst.txt deleted file mode 100644 index 5b6f833d46..0000000000 --- a/ophyd/_sources/_as_gen/ophyd.rst.txt +++ /dev/null @@ -1,16 +0,0 @@ -ophyd -===== - -.. automodule:: ophyd - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/_as_gen/ophyd.scaler.rst.txt b/ophyd/_sources/_as_gen/ophyd.scaler.rst.txt deleted file mode 100644 index 89ea86b7e8..0000000000 --- a/ophyd/_sources/_as_gen/ophyd.scaler.rst.txt +++ /dev/null @@ -1,24 +0,0 @@ -ophyd\.scaler -============= - -.. automodule:: ophyd.scaler - - - - - - - - .. rubric:: Classes - - .. autosummary:: - - EpicsScaler - ScalerCH - ScalerChannel - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/_as_gen/ophyd.signal.rst.txt b/ophyd/_sources/_as_gen/ophyd.signal.rst.txt deleted file mode 100644 index debcebbb7a..0000000000 --- a/ophyd/_sources/_as_gen/ophyd.signal.rst.txt +++ /dev/null @@ -1,28 +0,0 @@ -ophyd\.signal -============= - -.. automodule:: ophyd.signal - - - - - - - - .. rubric:: Classes - - .. autosummary:: - - ArrayAttributeSignal - AttributeSignal - DerivedSignal - EpicsSignal - EpicsSignalBase - EpicsSignalRO - Signal - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/_as_gen/ophyd.status.DeviceStatus.rst.txt b/ophyd/_sources/_as_gen/ophyd.status.DeviceStatus.rst.txt deleted file mode 100644 index 0e49b7c973..0000000000 --- a/ophyd/_sources/_as_gen/ophyd.status.DeviceStatus.rst.txt +++ /dev/null @@ -1,24 +0,0 @@ -ophyd\.status\.DeviceStatus -=========================== - -.. currentmodule:: ophyd.status - -.. autoclass:: DeviceStatus - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~DeviceStatus.__init__ - ~DeviceStatus.add_callback - ~DeviceStatus.watch - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/_as_gen/ophyd.status.MoveStatus.rst.txt b/ophyd/_sources/_as_gen/ophyd.status.MoveStatus.rst.txt deleted file mode 100644 index 65f6dbb228..0000000000 --- a/ophyd/_sources/_as_gen/ophyd.status.MoveStatus.rst.txt +++ /dev/null @@ -1,24 +0,0 @@ -ophyd\.status\.MoveStatus -========================= - -.. currentmodule:: ophyd.status - -.. autoclass:: MoveStatus - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~MoveStatus.__init__ - ~MoveStatus.add_callback - ~MoveStatus.watch - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/_as_gen/ophyd.status.Status.rst.txt b/ophyd/_sources/_as_gen/ophyd.status.Status.rst.txt deleted file mode 100644 index 4dfe240960..0000000000 --- a/ophyd/_sources/_as_gen/ophyd.status.Status.rst.txt +++ /dev/null @@ -1,23 +0,0 @@ -ophyd\.status\.Status -===================== - -.. currentmodule:: ophyd.status - -.. autoclass:: Status - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~Status.__init__ - ~Status.add_callback - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/_as_gen/ophyd.status.StatusBase._finished.rst.txt b/ophyd/_sources/_as_gen/ophyd.status.StatusBase._finished.rst.txt deleted file mode 100644 index 63548d41bd..0000000000 --- a/ophyd/_sources/_as_gen/ophyd.status.StatusBase._finished.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -ophyd\.status\.StatusBase\.\_finished -===================================== - -.. currentmodule:: ophyd.status - -.. automethod:: StatusBase._finished \ No newline at end of file diff --git a/ophyd/_sources/_as_gen/ophyd.status.StatusBase.finished_cb.rst.txt b/ophyd/_sources/_as_gen/ophyd.status.StatusBase.finished_cb.rst.txt deleted file mode 100644 index 6f2dfe8353..0000000000 --- a/ophyd/_sources/_as_gen/ophyd.status.StatusBase.finished_cb.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -ophyd\.status\.StatusBase\.finished\_cb -======================================= - -.. currentmodule:: ophyd.status - -.. autoattribute:: StatusBase.finished_cb \ No newline at end of file diff --git a/ophyd/_sources/_as_gen/ophyd.status.StatusBase.rst.txt b/ophyd/_sources/_as_gen/ophyd.status.StatusBase.rst.txt deleted file mode 100644 index da19220b32..0000000000 --- a/ophyd/_sources/_as_gen/ophyd.status.StatusBase.rst.txt +++ /dev/null @@ -1,23 +0,0 @@ -ophyd\.status\.StatusBase -========================= - -.. currentmodule:: ophyd.status - -.. autoclass:: StatusBase - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~StatusBase.__init__ - ~StatusBase.add_callback - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/_as_gen/ophyd.status.rst.txt b/ophyd/_sources/_as_gen/ophyd.status.rst.txt deleted file mode 100644 index 19d69c1466..0000000000 --- a/ophyd/_sources/_as_gen/ophyd.status.rst.txt +++ /dev/null @@ -1,39 +0,0 @@ -ophyd\.status -============= - -.. automodule:: ophyd.status - - - - .. rubric:: Functions - - .. autosummary:: - - wait - - - - - - .. rubric:: Classes - - .. autosummary:: - - AndStatus - DeviceStatus - MoveStatus - Status - StatusBase - SubscriptionStatus - - - - - - .. rubric:: Exceptions - - .. autosummary:: - - UseNewProperty - - \ No newline at end of file diff --git a/ophyd/_sources/_as_gen/ophyd.utils.epics_pvs.rst.txt b/ophyd/_sources/_as_gen/ophyd.utils.epics_pvs.rst.txt deleted file mode 100644 index 60b1377bf9..0000000000 --- a/ophyd/_sources/_as_gen/ophyd.utils.epics_pvs.rst.txt +++ /dev/null @@ -1,45 +0,0 @@ -ophyd\.utils\.epics\_pvs -======================== - -.. automodule:: ophyd.utils.epics_pvs - - - - .. rubric:: Functions - - .. autosummary:: - - data_shape - data_type - fmt_time - raise_if_disconnected - record_field - records_from_db - set_and_wait - split_record_field - strip_field - validate_pv_name - waveform_to_string - - - - - - .. rubric:: Classes - - .. autosummary:: - - AlarmSeverity - AlarmStatus - - - - - - .. rubric:: Exceptions - - .. autosummary:: - - BadPVName - - \ No newline at end of file diff --git a/ophyd/_sources/_as_gen/ophyd.utils.errors.rst.txt b/ophyd/_sources/_as_gen/ophyd.utils.errors.rst.txt deleted file mode 100644 index a48f37c661..0000000000 --- a/ophyd/_sources/_as_gen/ophyd.utils.errors.rst.txt +++ /dev/null @@ -1,27 +0,0 @@ -ophyd\.utils\.errors -==================== - -.. automodule:: ophyd.utils.errors - - - - - - - - - - - - .. rubric:: Exceptions - - .. autosummary:: - - DisconnectedError - ExceptionBundle - LimitError - OpException - ReadOnlyError - RedundantStaging - - \ No newline at end of file diff --git a/ophyd/_sources/_as_gen/ophyd.utils.paths.rst.txt b/ophyd/_sources/_as_gen/ophyd.utils.paths.rst.txt deleted file mode 100644 index 0ef88dfddc..0000000000 --- a/ophyd/_sources/_as_gen/ophyd.utils.paths.rst.txt +++ /dev/null @@ -1,23 +0,0 @@ -ophyd\.utils\.paths -=================== - -.. automodule:: ophyd.utils.paths - - - - .. rubric:: Functions - - .. autosummary:: - - make_dir_tree - makedirs - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/_as_gen/ophyd.utils.rst.txt b/ophyd/_sources/_as_gen/ophyd.utils.rst.txt deleted file mode 100644 index 3163d852b3..0000000000 --- a/ophyd/_sources/_as_gen/ophyd.utils.rst.txt +++ /dev/null @@ -1,29 +0,0 @@ -ophyd\.utils -============ - -.. automodule:: ophyd.utils - - - - .. rubric:: Functions - - .. autosummary:: - - doc_annotation_forwarder - enum - - - - - - .. rubric:: Classes - - .. autosummary:: - - OrderedDefaultDict - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/_as_gen/ophyd.utils.startup.rst.txt b/ophyd/_sources/_as_gen/ophyd.utils.startup.rst.txt deleted file mode 100644 index 2085e463b6..0000000000 --- a/ophyd/_sources/_as_gen/ophyd.utils.startup.rst.txt +++ /dev/null @@ -1,22 +0,0 @@ -ophyd\.utils\.startup -===================== - -.. automodule:: ophyd.utils.startup - - - - .. rubric:: Functions - - .. autosummary:: - - setup - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/api.rst.txt b/ophyd/_sources/api.rst.txt deleted file mode 100644 index 1243c128f1..0000000000 --- a/ophyd/_sources/api.rst.txt +++ /dev/null @@ -1,38 +0,0 @@ -API Reference -============= - - - -.. autosummary:: - :toctree: generated - - ophyd - ophyd.signal - ophyd.callbacks - ophyd.device - ophyd.epics_motor - ophyd.flyers - ophyd.mca - ophyd.mixins - ophyd.ophydobj - ophyd.positioner - ophyd.pseudopos - ophyd.pv_positioner - ophyd.quadem - ophyd.scaler - ophyd.signal - ophyd.status - ophyd.areadetector - ophyd.areadetector.base - ophyd.areadetector.cam - ophyd.areadetector.detectors - ophyd.areadetector.docs - ophyd.areadetector.filestore_mixins - ophyd.areadetector.plugins - ophyd.areadetector.trigger_mixins - ophyd.areadetector.util - ophyd.utils - ophyd.utils.epics_pvs - ophyd.utils.errors - ophyd.utils.paths - ophyd.utils.startup diff --git a/ophyd/_sources/architecture.rst.txt b/ophyd/_sources/architecture.rst.txt deleted file mode 100644 index 46de9bb66c..0000000000 --- a/ophyd/_sources/architecture.rst.txt +++ /dev/null @@ -1,243 +0,0 @@ -.. currentmodule:: ophyd - -============== - Architecture -============== - -Hardware abstraction -==================== - - -``Ophyd`` is the hardware abstraction layer that provides a consistent -interface between the underlying control communication protocol and -`bluesky `_. This is done by -bundling sets of the underlying process variables into hierarchical -devices and exposing a semantic API in terms of control system -primitives. Two terms that will be used throughout are - - - **Signal** - - Represents an atomic 'process variable'. This is nominally a - 'scalar' value and cannot be decomposed any further by layers - above :mod:`ophyd`. In this context an array (waveform) or string - would be a scalar because there is no ophyd API to read only part - of it. - - **Device** - - Hierarchy composed of Signals and other Devices. The components - of a Device can be introspected by layers above :mod:`ophyd` and - may be decomposed to, ultimately, the underlying Signals. - - -Put another way, if a hierarchical device is a tree, **Signals** are the leaves -and **Devices** are the nodes. - -Names ------ - -In ophyd, we can think of a Device as a tree of sub-devices and -eventually the 'leaf' nodes which are Signals (and map to 1 or 2 PVs). -At the bottom of the tree, each Signal (leaf-node) has 3 names -associated with it: - - 1. *The PV name it is going to talk to*. Typically, this name must - be globally unique within the control system you are using. This - can lead to them being both verbose and cryptic. From - ``ophyd``\'s point of view these strings are taken as given and - does not require any particular pattern, scheme, rhyme, or reason - in the names. - 2. *The Python attribute name*. These are the names of the - components of a device and allow attribute-style access to the sub - components as ``dev.cpt_name``. These names are set in the - `ophyd.Device` sub-class definitions. They need to be a valid - Python identifiers (which Python enforces) and should be chosen to - makes sense to the people directly working with the ophyd instances. - They need be unique within a `~ophyd.Device` and hence Python ensures that - the fully qualified name will be unique within a namespace. - 3. *The ``obj.name`` attribute*. This name is the one that will be - used in the data returned by `~ophyd.Device.read` and will - eventually end up in the flowing through `bluesky` and into - `databroker` to be eventually exposed to the users at analysis - times. By default, these names are derived from the Python - attribute name of the sub-device and the name of it's parent, but - can be set at runtime. These names should be picked to make - scientific sense at analysis time and must be unique among devices - that will be used simultaneously. - -.. _hl_api: - -Uniform High-level Interface -============================ - -All ophyd objects implemented a small set of methods which are used by -`bluesky`_ plans. It is the responsibility of the `ophyd` objects to -correctly implement these methods in terms of the underlying control -system. - - -Read-able Interface -------------------- - -The minimum set of methods an object must implement is - -.. autosummary:: - :toctree: generated - - ~device.BlueskyInterface.trigger - ~device.BlueskyInterface.read - ~device.BlueskyInterface.describe - -along with three properties: - -.. autosummary:: - :toctree: generated - - ~ophydobj.OphydObject.name - ~ophydobj.OphydObject.parent - ~ophydobj.OphydObject.root - - -There are two optional methods which plans may use to 'enable' or -'disable' a device for data collection. For example, a beam position -monitor maybe in continuous mode when not collecting data but be -stitched to a triggered mode for scanning. By convention ``unstage`` -'undoes' whatever ``stage`` did to the state of the underlying -hardware and should return it to the state it was before ``stage`` was -called. - - -.. autosummary:: - :toctree: generated - - ~device.BlueskyInterface.stage - ~device.BlueskyInterface.unstage - -Two additional optional methods are used to notify devices if, -during a scan, the run is suspended. The semantics of these methods -is coupled to :class:`~bluesky.run_engine.RunEngine`. - -.. autosummary:: - :toctree: generated - - ~device.BlueskyInterface.pause - ~device.BlueskyInterface.resume - -Set-able Interface ------------------- - -Of course, most interesting uses of hardware requires telling it to do -rather than just reading from it! To do that the high-level API has -the ``set`` method and a corresponding ``stop`` method to halt motion -before it is complete. - -The ``set`` method which returns `Status` that can be used to tell -when motion is done. It is the responsibility of the `ophyd` objects -to implement this functionality in terms of the underlying control -system. Thus, from the perspective of the `bluesky`_, a motor, a -temperature controller, a gate valve, and software pseudo-positioner -can all be treated the same. - - -.. autosummary:: - :toctree: generated - - ~positioner.PositionerBase.set - ~positioner.PositionerBase.stop - - -Configuration -------------- - -In addition to values we will want to read, as 'data', or set, as a -'position', there tend to be many values associated with the -configuration of hardware. This is things like the velocity of a -motor, the PID loop parameters of a feedback loop, or the chip -temperature of a detector. In general these are measurements that are -not directly related to the measurement of interest, but maybe needed for -understanding the measured data. - -.. autosummary:: - :toctree: generated - - ~device.Device.configure - ~device.Device.read_configuration - ~device.Device.describe_configuration - - - -Fly-able Interface ------------------- - -There is some hardware where instead of the fine-grained control -provided by ``set``, ``trigger``, and ``read`` we just want to tell it -"Go!" and check back later when it is done. This is typically done -when there needs to coordinated motion or triggering at rates beyond -what can reasonably done in via EPICS/Python and tend to be called 'fly scans'. - -The flyable interface provides four methods - -.. autosummary:: - :toctree: generated - - ~flyers.FlyerInterface.kickoff - ~flyers.FlyerInterface.complete - ~flyers.FlyerInterface.describe_collect - ~flyers.FlyerInterface.collect - -Asynchronous status -=================== - -Hardware control and data collection is an inherently asynchronous -activity. The many devices on a beamline are (in general) uncoupled -and can move / read independently. This is reflected in the API as -most of the methods in :obj:`BlueskyInterface` returning `Status` -objects and in the callback registry at the core of -:obj:`~ophydobj.OphydObject`. The :class:`StatusBase` objects are the -bridge between the asynchronous behavior of the underlying control -system and the asynchronous behavior of -:class:`~bluesky.run_engine.RunEngine`. - -The core API of the status objects is a property and a private method: - -.. autosummary:: - :nosignatures: - - status.StatusBase.finished_cb - status.StatusBase._finished - -The `bluesky`_ side assigns a callback to -:attr:`status.StatusBase.finished_cb` which is triggered when the -:meth:`status.StatusBase._finished` method is called. The status object -conveys both that the action it 'done' and if the action was -successful or not. - - - -Callbacks -========= - -The base class of almost all objects in ``ophyd`` is :obj:`~ophydobj.OphydObject` - a callback registry - -.. currentmodule:: ophyd.ophydobj - -.. autosummary:: - :toctree: generated - :nosignatures: - - OphydObject - OphydObject.event_types - OphydObject.subscribe - OphydObject.unsubscribe - OphydObject.clear_sub - - OphydObject._run_subs - - OphydObject._reset_sub - -This registry is used to connect to the underlying events from the -control system and propagate them up to bluesky, either via -`~status.StatusBase` objects or via direct subscription from the -:class:`~bluesky.run_engine.RunEngine`. diff --git a/ophyd/_sources/architecture.txt b/ophyd/_sources/architecture.txt deleted file mode 100644 index 3f4aa8b911..0000000000 --- a/ophyd/_sources/architecture.txt +++ /dev/null @@ -1,15 +0,0 @@ -Project Architecture -******************** - -This is the class inheritance diagram for the key pieces of ophyd. This is -a selection meant to give a readable and representative picture of the -package's organization. - -.. inheritance-diagram:: ophyd.Device ophyd.Component ophyd.EpicsSignal ophyd.EpicsSignalRO ophyd.Signal ophyd.EpicsMotor ophyd.EpicsScaler ophyd.EpicsMCA ophyd.AreaDetector ophyd.HDF5Plugin ophyd.DynamicDeviceComponent ophyd.PVPositioner ophyd.SingleTrigger - :parts: 2 - -Device classes use metaclass magic to inspect and lazily instantiate their -Components. The examples illustrate how easy it is to define new kinds of -devices, and this is largely because the "dirty work" of handling connections -is hidden in the ``Component`` and ``ComponentMeta``. To understand further, -read the source code of ``device.py`` or contact the developers. diff --git a/ophyd/_sources/area-detector.rst.txt b/ophyd/_sources/area-detector.rst.txt deleted file mode 100644 index b1770c31be..0000000000 --- a/ophyd/_sources/area-detector.rst.txt +++ /dev/null @@ -1,574 +0,0 @@ -.. currentmodule:: ophyd.areadetector - -================ - Area Detectors -================ - -Area Detector devices require some customization to use. Here is the simplest -possible configuration. - -.. code-block:: python - - from ophyd import AreaDetector, SingleTrigger - - class MyDetector(SingleTrigger, AreaDetector): - pass - - prefix = 'XF:23ID1-ES{Tst-Cam:1}' - det = MyDetector(prefix) - -The above should work correctly with any EPICS `Area Detector -`_. We test -on versions 1.9.1 and 2.2. For preliminary support for AD33 see the -``nslsii`` package. - -.. warning - - When making new detector classes the ``Trigger`` class must come first in the inheretance - or the default ``Device`` trigger method will be used instead of the trigger method from - the trigger mix in. - - -Callbacks -========= - -Internally, Area Detector provides a `flexible array processing -pipeline `_. -The pipeline is a chain of 'plugins' which can be re-configured at -runtime by setting the ``.nd_array_port`` on a downstream plugin to -the ``.port_name`` of the upstream plugin. Internally the plugins -pass data between each other by passing a pointer to an ``NDArray`` C++ -object (which is an array plus some meta-data). The arrays are -allocated out of a shared pool when they are created (typically by the -'cam' plugin which wraps the detector driver) and freed when the last -plugin is done with them. Each plugin can trigger its children in -two ways: - -- *blocking* : The next plugin is called syncronously, blocking the - parent plugin until all of the (blocking) children are finished. - This is single-threaded. -- *non-blocking* : The pointer is put on a queue that the child - consumes from. This allows multi-threaded processing with each - plugin running on its own thread. - -This behavior is controlled by the ``.blocking_callbacks`` signal on -the plugin. - -The :obj:`~ophyd.areadetector.trigger_mixins.SingleTrigger` sets the -acquire bit 'high' and then watches for it to go low (indicating that -acquisition is complete). If any of the down-stream plugins are in -non-blocking mode are likely to have the following sequence of events -when using, for example, the ``Stats`` plugin and taking one frame - -1. detector produces the frame -2. puts the frame on the queue for the stats plugin to consume -3. flips the acquire bit to 'low' -4. ophyd sees the acquire bit go low and marks the status object as done -5. bluesky continues with the plan and reads the Stats plugin (which still contains old data) -6. the Stats plugin processes the frame (updating the values for the just-collected frame) - -Because (6) happens after (5) bluesky reads 'stale' data from the -stats plugin and produces an event which associates other measurements -with the incorrect reading from the camera. This issue has resulted -in alignment scans systematically returning the values from the -previous point. To avoid this, we ensure in ``stage()`` that all -plugins are in 'blocking' mode. This has the downside of slowing the -detector down as we are only using a single thread but has the -advantage of giving correct measurements. - -Prior to AD3-3, AD did not track if a given frame had fully propagated -through the pipeline. We looked into tracking this from the outside -and using this to determine when the data acquisition was done. In -principle this could be done by watching a combination of queue size -and the ``.uniqueID`` signal, however this work was abandoned due to -the complexity of supporting this for all of the version of AD on the -floor. - -In `AD3-3 -`_, -the camera now tracks if all of the frames it produces have been -processed (added to support ophyd [#]_ ). There is now a -``.wait_for_plugins`` signal that controls the behavior of -put-complete on the ``.acquire`` signal. If ``.wait_for_plugins`` is -``True``, then the put-complete callback on the ``.acquire`` signal -will not process until all of the frames have been processed by all of -the plugins. - -This allows us to run with all of the plugins in non-blocking mode and -to simplify the trigger logic. Instead of waiting for the acquire bit to -change value, we use the a put-completion callback. - -To convert an existing area detector sub-class to support the new scheme you -must: - -1. Change the type of the came to sub-class :obj:`nslsii.ad33.CamV33Mixin` -2. Change the trigger mixin to be :obj:`nslsii.ad33.SingleTriggerV33` -3. Arrange for ``det.cam.ensure_nonblocking`` to be called after - initializing the ophyd object. - - - -Ports -===== - -Each plugin has a read-only out-put port name (``.port_name``) and a -settable in-put port name (``.nd_array_port``). To connect plugin -``downstream`` to plugin ``upstream`` set ``downstream.nd_array_port`` -to ``upstream.port_name``. - -The top-level `~base.ADBase` class has several helper methods for -walking and validating the plugin network. - -.. autosummary:: - :toctree: generated - - ~base.ADBase - ~base.ADBase.visualize_asyn_digraph - ~base.ADBase.get_plugin_by_asyn_port - ~base.ADBase.get_asyn_port_dictionary - ~base.ADBase.get_asyn_digraph - ~base.ADBase.validate_asyn_ports - ~base.ADBase.missing_plugins - - -Filestore Plugins -================= - -.. note:: - - The mixins in this section are to be mixed with the file plugin classes - and used as components on a larger device. The siblings of the resulting classes - are components representing the various plugins that make up an Area Detector. - -Integration of the file writing with filestore is done by mixing -sub-classes of :class:`FileStorePluginBase` into one of the file -plugin classes and using the resulting class as a component in your -detector. - - -The base classes (which may be merged in the future) - -.. autosummary:: - :toctree: generated - - ~filestore_mixins.FileStoreBase - ~filestore_mixins.FileStorePluginBase - - -provide the basic methods required for integrating AreaDetector file plugins with -:mod:`filestore` - -.. autosummary:: - :toctree: generated - - ~filestore_mixins.FileStoreBase.generate_datum - - ~filestore_mixins.FileStoreBase.write_path_template - ~filestore_mixins.FileStoreBase.reg_root - ~filestore_mixins.FileStoreBase.fs_root - ~filestore_mixins.FileStoreBase.read_path_template - - ~filestore_mixins.FileStorePluginBase.make_filename - -`~filestore_mixins.FileStorePluginBase` must be sub-classed to match -each file plugin and take care of inserting the correct meta-data into -`FileStore` and configuring the file plugin. - -.. autosummary:: - :toctree: generated - - ~filestore_mixins.FileStoreTIFF - ~filestore_mixins.FileStoreHDF5 - ~filestore_mixins.FileStoreTIFFSquashing - - -The :class:`~filestore_mixins.FileStoreTIFFSquashing` also makes use of the -processing plugin to 'squash' multiple frames together into a single -saved image. - -To create a functioning class you must also mixin - -.. autosummary:: - :toctree: generated - - ~filestore_mixins.FileStoreIterativeWrite - -which extends :meth:`~filestore_mixins.FileStoreBase.generate_datum` to -insert into the ``FileStore`` instance as data is taken. - -For convenience we provide - - -.. autosummary:: - :toctree: generated - - ~filestore_mixins.FileStoreHDF5IterativeWrite - ~filestore_mixins.FileStoreTIFFIterativeWrite - - -.. inheritance-diagram:: ophyd.areadetector.filestore_mixins.FileStoreBase ophyd.areadetector.filestore_mixins.FileStoreHDF5 ophyd.areadetector.filestore_mixins.FileStoreHDF5IterativeWrite ophyd.areadetector.filestore_mixins.FileStoreIterativeWrite ophyd.areadetector.filestore_mixins.FileStorePluginBase ophyd.areadetector.filestore_mixins.FileStoreTIFF ophyd.areadetector.filestore_mixins.FileStoreTIFFIterativeWrite ophyd.areadetector.filestore_mixins.FileStoreTIFFSquashing ophyd.device.GenerateDatumInterface ophyd.device.BlueskyInterface - :parts: 1 - - -Area Detector Trigger dispatching -================================= -.. note:: - - The mixins in this section are to be mixed with :class:`~ophyd.device.Device` to - represent the 'top level' area detector. The components of the resulting class are - the various plugins that make up a full Area Detector. - - -.. autosummary:: - :toctree: generated - - ~detectors.DetectorBase - ~detectors.DetectorBase.dispatch - ~detectors.DetectorBase.make_data_key - -The translation between the :meth:`~ophyd.device.BlueskyInterface.trigger` and triggering -the underlying camera is mediated by the trigger mix-ins. - -.. autosummary:: - :toctree: generated - - ~trigger_mixins.TriggerBase - ~trigger_mixins.SingleTrigger - ~trigger_mixins.MultiTrigger - -.. inheritance-diagram:: ophyd.areadetector.trigger_mixins.TriggerBase ophyd.areadetector.trigger_mixins.SingleTrigger ophyd.areadetector.trigger_mixins.MultiTrigger - :parts: 1 - -Plugins -======= - - -.. autosummary:: - :toctree: generated - - ~plugins.PluginBase - ~plugins.ColorConvPlugin - ~plugins.ImagePlugin - ~plugins.OverlayPlugin - ~plugins.ProcessPlugin - ~plugins.ROIPlugin - ~plugins.StatsPlugin - ~plugins.TransformPlugin - -.. inheritance-diagram:: ophyd.areadetector.plugins.PluginBase ophyd.areadetector.plugins.ColorConvPlugin ophyd.areadetector.plugins.ImagePlugin ophyd.areadetector.plugins.OverlayPlugin ophyd.areadetector.plugins.ProcessPlugin ophyd.areadetector.plugins.ROIPlugin ophyd.areadetector.plugins.StatsPlugin ophyd.areadetector.plugins.TransformPlugin - :parts: 1 - -File Plugins -============ -.. autosummary:: - :toctree: generated - - ~plugins.FilePlugin - ~plugins.HDF5Plugin - ~plugins.JPEGPlugin - ~plugins.MagickPlugin - ~plugins.NetCDFPlugin - ~plugins.NexusPlugin - ~plugins.TIFFPlugin - - -.. inheritance-diagram:: ophyd.areadetector.plugins.FilePlugin ophyd.areadetector.plugins.HDF5Plugin ophyd.areadetector.plugins.JPEGPlugin ophyd.areadetector.plugins.MagickPlugin ophyd.areadetector.plugins.NetCDFPlugin ophyd.areadetector.plugins.NexusPlugin ophyd.areadetector.plugins.TIFFPlugin - :parts: 1 - - -Specific Hardware -================= - -While the above example should work with any Area Detector, ophyd provides -specialized classes for specific detectors supported by EPICS Area Detector. -These specialized classes generally add components representing fields -particular to a given detector, along with device-specific documentation -for components. - -To use these model-specific classes, swap out ``AreaDetector`` like so: - -.. code-block:: python - - # before - class MyDetector(SingleTrigger, AreaDetector): - pass - - # after - class MyDetector(SingleTrigger, AndorDetector): - pass - -.. autosummary:: - :toctree: generated - - ~detectors.AreaDetector - ~detectors.AdscDetector - ~detectors.Andor3Detector - ~detectors.AndorDetector - ~detectors.BrukerDetector - ~detectors.FirewireLinDetector - ~detectors.FirewireWinDetector - ~detectors.LightFieldDetector - ~detectors.Mar345Detector - ~detectors.MarCCDDetector - ~detectors.PSLDetector - ~detectors.PerkinElmerDetector - ~detectors.PilatusDetector - ~detectors.PixiradDetector - ~detectors.PointGreyDetector - ~detectors.ProsilicaDetector - ~detectors.PvcamDetector - ~detectors.RoperDetector - ~detectors.SimDetector - ~detectors.URLDetector - -.. inheritance-diagram:: ophyd.areadetector.detectors.AreaDetector ophyd.areadetector.detectors.AdscDetector ophyd.areadetector.detectors.Andor3Detector ophyd.areadetector.detectors.AndorDetector ophyd.areadetector.detectors.BrukerDetector ophyd.areadetector.detectors.FirewireLinDetector ophyd.areadetector.detectors.FirewireWinDetector ophyd.areadetector.detectors.LightFieldDetector ophyd.areadetector.detectors.Mar345Detector ophyd.areadetector.detectors.MarCCDDetector ophyd.areadetector.detectors.PSLDetector ophyd.areadetector.detectors.PerkinElmerDetector ophyd.areadetector.detectors.PilatusDetector ophyd.areadetector.detectors.PixiradDetector ophyd.areadetector.detectors.PointGreyDetector ophyd.areadetector.detectors.ProsilicaDetector ophyd.areadetector.detectors.PvcamDetector ophyd.areadetector.detectors.RoperDetector ophyd.areadetector.detectors.SimDetector ophyd.areadetector.detectors.URLDetector - :parts: 1 - - -Cams ----- - -The vendor specific details are embedded in the cams - -.. autosummary:: - :toctree: generated - - ~cam.CamBase - ~cam.AdscDetectorCam - ~cam.Andor3DetectorCam - ~cam.AndorDetectorCam - ~cam.BrukerDetectorCam - ~cam.FirewireLinDetectorCam - ~cam.FirewireWinDetectorCam - ~cam.LightFieldDetectorCam - ~cam.Mar345DetectorCam - ~cam.MarCCDDetectorCam - ~cam.PSLDetectorCam - ~cam.PcoDetectorCam - ~cam.PcoDetectorIO - ~cam.PcoDetectorSimIO - ~cam.PerkinElmerDetectorCam - ~cam.PilatusDetectorCam - ~cam.PixiradDetectorCam - ~cam.PointGreyDetectorCam - ~cam.ProsilicaDetectorCam - ~cam.PvcamDetectorCam - ~cam.RoperDetectorCam - ~cam.SimDetectorCam - ~cam.URLDetectorCam - -.. inheritance-diagram:: ophyd.areadetector.cam.CamBase ophyd.areadetector.cam.AdscDetectorCam ophyd.areadetector.cam.Andor3DetectorCam ophyd.areadetector.cam.AndorDetectorCam ophyd.areadetector.cam.BrukerDetectorCam ophyd.areadetector.cam.FirewireLinDetectorCam ophyd.areadetector.cam.FirewireWinDetectorCam ophyd.areadetector.cam.LightFieldDetectorCam ophyd.areadetector.cam.Mar345DetectorCam ophyd.areadetector.cam.MarCCDDetectorCam ophyd.areadetector.cam.PSLDetectorCam ophyd.areadetector.cam.PcoDetectorCam ophyd.areadetector.cam.PcoDetectorIO ophyd.areadetector.cam.PcoDetectorSimIO ophyd.areadetector.cam.PerkinElmerDetectorCam ophyd.areadetector.cam.PilatusDetectorCam ophyd.areadetector.cam.PixiradDetectorCam ophyd.areadetector.cam.PointGreyDetectorCam ophyd.areadetector.cam.ProsilicaDetectorCam ophyd.areadetector.cam.PvcamDetectorCam ophyd.areadetector.cam.RoperDetectorCam ophyd.areadetector.cam.SimDetectorCam ophyd.areadetector.cam.URLDetectorCam - :parts: 1 - -Custom Devices -============== -For custom hardware based on area-detector it may be necesary to add a custom -device class (for custom plugins see section below). The new class should -inherit from :class:`ophyd.areadetector.base.ADbase` and should have the following -PV structure: - -.. code-block:: python - - PV = 'Areadetector_device_PV_prefix:(Plugin_suffix or attribute_suffix)' - -As an example, for the builtin areadetector 'stats' class this looks like: - -.. code-block:: python - - PV = 'Areadetector_device_PV_prefix:Stats' - -And for the builtin areadetector 'color mode' attribute it looks like: - -.. code-block:: python - - PV = 'Areadetector_device_PV_prefix:cam1:ColorMode_RBV' - -where ``'Areadetector_device_PV_prefix'`` is the base PV name for the -Area detector device, ``plugin_suffix = 'Stats'`` is the 'stats' Plugin -suffix and ``attribute_suffix = 'ColorMode_RBV'`` is the 'color mode' -attribute suffix of the ``'cam1'`` plugin. - -In order to create the class then the following code is required -(where ``XXX`` is the name of the device): - -.. code-block:: python - - from ophyd.areadetector.base import ad_group, EpicsSignalWithRBV - from ophyd.signal import EpicsSignal, EpicsSignalRO - from ophyd.device import DynamicDeviceComponent as DDCpt, Component as Cpt - from ophyd.detectors import DetectorBase - from ophyd.areadetector.trigger_mixins import SingleTrigger - - class XXX(SingleTrigger, DetectorBase): - '''An areadetector device class for ...''' - - # ADD ATTRIBUTES AS COMPONENTS HERE USING THE SYNTAX - # where 'Type' is EpicsSignal, EpicsSignalRO, EpicsSignalWithRBV,.. - attribute_name = Cpt(Type, attribute_suffix) - - # ADD ATTRIBUTE GROUPS AS COMPONENTS USING THE SYNTAX - group_name = DDCpt(ad_group(Type, - (attribute_1_name, attribute_1_suffix), - (attribute_2_name, attribute_2_suffix), - ..., - (attribute_n_name, attribute_n_suffix)) - - # ADD ATTRIBUTE PLUGINS AS COMPONENTS USING THE SYNTAX - plugin_name = Cpt(PluginClass, suffix=Plugin_suffix+':') - - -.. note:: - - 1. :class:`ophyd.areadetector.detectors.DetectorBase` can be - swapped out for any other Areadetector Device class that inherits - from :class:`ophyd.areadetector.detectors.DetectorBase`. - - 2. :class:`ophyd.areadetector.triggermixins.SingleTrigger` is an - optional trigger_mixin class and can be swapped out for any other - class that inherits from - :class:`ophyd.areadetector.trigger_mixins.TriggerBase`. These - classes provide the logic to 'trigger' the detector and actually - acquire the images. - - 3. PluginClass can be - :class:`ophyd.areadetector.plugins.PluginBase`, - :class:`ophyd.areadetector.cam.CamBase` or any plugin/cam class - that inherits from either of these. - - 4. In the ophyd source code, you may see - :class:`.ophyd.areadetector.base.ADComponent` - used. Functionally, this is interchangeable with an ordinary - :class:`.ophyd.device.Component` (imported as ``Cpt`` above); it - just adds extra machinery for generating a docstring based on a - scrape of the HTML of the official AreaDetector documentation. For - custom extensions such as we are addressing here, it is not - generally applicable. - - -The Areadetector device should then be instantiated using: - -.. code-block:: python - - ADdevice_name = Some_Areadetector_Device_Class(Areadetector_device_PV_suffix, - name = 'ADdevice_name') - - -Custom Plugins or Cameras -========================= - -For custom hardware based on area-detector it may be necesary to add a -custom plugin or camera class, this section will cover what is -required. Both 'plugins' and 'cameras' act in the same way, but have -slightly different 'base' attributes, hence they have different 'base -classes'. New Plugin classes should inherit from -:class:`ophyd.areadetector.base.PluginBase` while new Camera classes -should inherit from :class:`ophyd.areadetector.cam.CamBase`. Both -should have the following PV structure (replace 'plugin' with 'cam' -for cameras): - -.. code-block:: python - - PV = 'Areadetector_device_PV_prefix:Plugin_suffix:attribute_suffix' - -As an example, for the 'max value' component of the built-in areadetector -'stats' class this looks like: - -.. code-block:: python - - PV = 'Areadetector_device_PV_prefix:Stats:max_value' - -where ``Areadetector_device_PV_prefix`` is the PV name for the Area -detector device, ``plugin_suffix = Stats`` is the 'stats' Plugin -suffix and ``attribute_suffix = max_value`` is the 'max value' -attribute suffix. - - -In order to create the class then the following code is required -(where ``XXX`` is the name of the plugin): - -.. code-block:: python - - from ophyd.areadetector.base import ad_group, EpicsSignalWithRBV - from ophyd.signal import EpicsSignal, EpicsSignalRO - from ophyd.device import DynamicDeviceComponent as DDCpt, Component as Cpt - from ophyd.areadetector.plugins import PluginBase, register_plugin - from ophyd.areadetector.filestore_mixins import FileStoreHDF5 - - - class XXXplugin(PluginBase, FileStoreHDF5): - '''An areadetector plugin class that does ......''' - _suffix_re = 'Plugin_suffix\d:' - - # ADD ATTRIBUTES AS COMPONENTS HERE USING THE SYNTAX - attribute_name = Cpt(Type, attribute_suffix) - # where 'Type' is EpicsSignal, EpicsSignalRO, EpicsSignalWithRBV,.. - - # ADD ATTRIBUTE GROUPS AS COMPONENTS USING THE SYNTAX - group_name = DDCpt(ad_group(Type, - (attribute_1_name, attribute_1_suffix), - (attribute_2_name, attribute_2_suffix), - ..., - (attribute_n_name, attribute_n_suffix)) - - # this allows searching for a plugin class via matching _suffix_re for - # classes in the registry against the a PV name and is optional. - register_plugin(XXXplugin) - - -.. note:: - - 1. :class:`ophyd.areadetector.plugins.PluginBase` can be swapped - out for :class:`ophyd.areadetector.cam.CamBase`, - :class:`ophyd.areadetector.plugins.FilePlugin` or any other - Areadetector Plugin, cam or FilePlugin class that inherits from - these. - - 2. For FilePlugin plugins the optional filestore_mixin - :class:`ophyd.areadetector.filestore_mixins.FileStoreHDF5` should - also be defined. This can be replaced with any class that inherits - from - :class:`ophyd.areadetector.filestore_mixins.FileStorePluginBase`. - These mix-in classes provide the logic for generating Asset - Registry documents. - - -Once the class is defined above then it should be added to the Area -detector device class as a component using the code: - -.. code-block:: python - - class Some_Areadetector_Device_Class(Some_Area_Detector_Base_Class): - 'The ophyd class for the device that has the custom plugin' - - ... - - xxx = Cpt(XXXplugin, suffix=Plugin_suffix+':') - - ... - -The Areadetector device should then be instantiated using: - -.. code-block:: python - - ADdevice_name = Some_Areadetector_Device_Class(Areadetector_device_PV_suffix, - name = 'ADdevice_name') - - -Helpers -======= - -.. autosummary:: - :toctree: generated - - ~base.EpicsSignalWithRBV - ~base.ADComponent - ~base.ad_group - - -Full Inheritance -================ - -.. inheritance-diagram:: ophyd.areadetector.plugins.FilePlugin ophyd.areadetector.plugins.HDF5Plugin ophyd.areadetector.plugins.JPEGPlugin ophyd.areadetector.plugins.MagickPlugin ophyd.areadetector.plugins.NetCDFPlugin ophyd.areadetector.plugins.NexusPlugin ophyd.areadetector.plugins.TIFFPlugin ophyd.areadetector.plugins.PluginBase ophyd.areadetector.plugins.ColorConvPlugin ophyd.areadetector.plugins.ImagePlugin ophyd.areadetector.plugins.OverlayPlugin ophyd.areadetector.plugins.ProcessPlugin ophyd.areadetector.plugins.ROIPlugin ophyd.areadetector.plugins.StatsPlugin ophyd.areadetector.plugins.TransformPlugin ophyd.areadetector.filestore_mixins.FileStoreBase ophyd.areadetector.filestore_mixins.FileStoreHDF5 ophyd.areadetector.filestore_mixins.FileStoreHDF5IterativeWrite ophyd.areadetector.filestore_mixins.FileStoreIterativeWrite ophyd.areadetector.filestore_mixins.FileStorePluginBase ophyd.areadetector.filestore_mixins.FileStoreTIFF ophyd.areadetector.filestore_mixins.FileStoreTIFFIterativeWrite ophyd.areadetector.filestore_mixins.FileStoreTIFFSquashing ophyd.device.GenerateDatumInterface ophyd.device.BlueskyInterface ophyd.areadetector.trigger_mixins.TriggerBase ophyd.areadetector.trigger_mixins.SingleTrigger ophyd.areadetector.trigger_mixins.MultiTrigger ophyd.areadetector.cam.CamBase ophyd.areadetector.cam.AdscDetectorCam ophyd.areadetector.cam.Andor3DetectorCam ophyd.areadetector.cam.AndorDetectorCam ophyd.areadetector.cam.BrukerDetectorCam ophyd.areadetector.cam.FirewireLinDetectorCam ophyd.areadetector.cam.FirewireWinDetectorCam ophyd.areadetector.cam.LightFieldDetectorCam ophyd.areadetector.cam.Mar345DetectorCam ophyd.areadetector.cam.MarCCDDetectorCam ophyd.areadetector.cam.PSLDetectorCam ophyd.areadetector.cam.PcoDetectorCam ophyd.areadetector.cam.PcoDetectorIO ophyd.areadetector.cam.PcoDetectorSimIO ophyd.areadetector.cam.PerkinElmerDetectorCam ophyd.areadetector.cam.PilatusDetectorCam ophyd.areadetector.cam.PixiradDetectorCam ophyd.areadetector.cam.PointGreyDetectorCam ophyd.areadetector.cam.ProsilicaDetectorCam ophyd.areadetector.cam.PvcamDetectorCam ophyd.areadetector.cam.RoperDetectorCam ophyd.areadetector.cam.SimDetectorCam ophyd.areadetector.cam.URLDetectorCam ophyd.areadetector.detectors.AreaDetector ophyd.areadetector.detectors.AdscDetector ophyd.areadetector.detectors.Andor3Detector ophyd.areadetector.detectors.AndorDetector ophyd.areadetector.detectors.BrukerDetector ophyd.areadetector.detectors.FirewireLinDetector ophyd.areadetector.detectors.FirewireWinDetector ophyd.areadetector.detectors.LightFieldDetector ophyd.areadetector.detectors.Mar345Detector ophyd.areadetector.detectors.MarCCDDetector ophyd.areadetector.detectors.PSLDetector ophyd.areadetector.detectors.PerkinElmerDetector ophyd.areadetector.detectors.PilatusDetector ophyd.areadetector.detectors.PixiradDetector ophyd.areadetector.detectors.PointGreyDetector ophyd.areadetector.detectors.ProsilicaDetector ophyd.areadetector.detectors.PvcamDetector ophyd.areadetector.detectors.RoperDetector ophyd.areadetector.detectors.SimDetector ophyd.areadetector.detectors.URLDetector ophyd.areadetector.base.ADComponent ophyd.areadetector.base.EpicsSignalWithRBV - :parts: 1 - -.. [#] This came out of a conversation with Mark Rivers, Thomas Caswell, Stuart Campbell, and Stuart Wilkins and implemented by `Mark `_ diff --git a/ophyd/_sources/area-detector.txt b/ophyd/_sources/area-detector.txt deleted file mode 100644 index 754d10cdb3..0000000000 --- a/ophyd/_sources/area-detector.txt +++ /dev/null @@ -1,275 +0,0 @@ -Area Detectors -************** - -Area Detector devices require some customization to use. Here is the simplest -possible configuration. - -.. code-block:: python - - from ophyd import AreaDetector, SingleTrigger - - class MyDetector(SingleTrigger, AreaDetector): - pass - - prefix = 'XF:23ID1-ES{Tst-Cam:1}' - det = MyDetector(prefix) - -The above should work correctly with any EPICS `Area Detector `_. We test on -versions 1.9.1 and 2.2. - -Specific Hardware ------------------ - -While the above example should work with any Area Detector, ophyd provides -specialized classes for specific detectors supported by EPICS Area Detector. -These specialized classes generally add components representing fields -particular to a given detector, along with device-specific documentation -for components. - -To use these model-specific classes, swap out ``AreaDetector`` like so: - -.. code-block:: python - - # before - class MyDetector(SingleTrigger, AreaDetector): - pass - - # after - class MyDetector(SingleTrigger, AndorDetector): - pass - - -.. autoclass:: ophyd.areadetector.AreaDetector - :members: -.. autoclass:: ophyd.areadetector.CamBase - :members: - -ADSC -^^^^ - -.. autoclass:: ophyd.areadetector.AdscDetector -.. autoclass:: ophyd.areadetector.AdscDetectorCam - :members: - -Andor3 -^^^^^^ - -.. autoclass:: ophyd.areadetector.Andor3Detector -.. autoclass:: ophyd.areadetector.Andor3DetectorCam - :members: - -Andor -^^^^^ - -.. autoclass:: ophyd.areadetector.AndorDetector -.. autoclass:: ophyd.areadetector.AndorDetectorCam - :members: - - -Bruker -^^^^^^ - -.. autoclass:: ophyd.areadetector.BrukerDetector -.. autoclass:: ophyd.areadetector.BrukerDetectorCam - :members: - -Firewire on Linux -^^^^^^^^^^^^^^^^^ - -.. autoclass:: ophyd.areadetector.FirewireLinDetector -.. autoclass:: ophyd.areadetector.FirewireLinDetectorCam - :members: - - -Firewire on Windows -^^^^^^^^^^^^^^^^^^^ - -.. autoclass:: ophyd.areadetector.FirewireWinDetector -.. autoclass:: ophyd.areadetector.FirewireWinDetectorCam - :members: - -Lightfield -^^^^^^^^^^ - -.. autoclass:: ophyd.areadetector.LightFieldDetector -.. autoclass:: ophyd.areadetector.LightFieldDetectorCam - :members: - -Mar345 -^^^^^^ - -.. autoclass:: ophyd.areadetector.Mar345Detector -.. autoclass:: ophyd.areadetector.Mar345DetectorCam - :members: - -Mar CCD -^^^^^^^ - -.. autoclass:: ophyd.areadetector.MarCCDDetector -.. autoclass:: ophyd.areadetector.MarCCDDetectorCam - :members: - -PSL -^^^ - -.. autoclass:: ophyd.areadetector.PSLDetector -.. autoclass:: ophyd.areadetector.PSLDetectorCam - :members: - -Perkin-Elmer -^^^^^^^^^^^^ - -.. autoclass:: ophyd.areadetector.PerkinElmerDetector -.. autoclass:: ophyd.areadetector.PerkinElmerDetectorCam - :members: - - -Pilatus -^^^^^^^ - -.. autoclass:: ophyd.areadetector.PilatusDetector -.. autoclass:: ophyd.areadetector.PilatusDetectorCam - :members: - -Pixirad -^^^^^^^ - -.. autoclass:: ophyd.areadetector.PixiradDetector -.. autoclass:: ophyd.areadetector.PixiradDetectorCam - :members: - -Point Grey -^^^^^^^^^^ - -.. autoclass:: ophyd.areadetector.PointGreyDetector -.. autoclass:: ophyd.areadetector.PointGreyDetectorCam - :members: - -Prosilica -^^^^^^^^^ - -.. autoclass:: ophyd.areadetector.ProsilicaDetector -.. autoclass:: ophyd.areadetector.ProsilicaDetectorCam - :members: - -PV Cam -^^^^^^ - -.. autoclass:: ophyd.areadetector.PvcamDetector -.. autoclass:: ophyd.areadetector.PvcamDetectorCam - :members: - -Roper -^^^^^ - -.. autoclass:: ophyd.areadetector.RoperDetector -.. autoclass:: ophyd.areadetector.RoperDetectorCam - :members: - -Simulated -^^^^^^^^^ - -.. autoclass:: ophyd.areadetector.SimDetector -.. autoclass:: ophyd.areadetector.SimDetectorCam - :members: - - -URL -^^^ - -.. autoclass:: ophyd.areadetector.URLDetector -.. autoclass:: ophyd.areadetector.URLDetectorCam - :members: - - -Plugins -------- - - -.. autoclass:: ophyd.areadetector.plugins.PluginBase - :members: - -Color Converter Plugin -^^^^^^^^^^^^^^^^^^^^^^ - -.. autoclass:: ophyd.areadetector.plugins.ColorConvPlugin - :members: - -Image Plugin -^^^^^^^^^^^^ - -.. autoclass:: ophyd.areadetector.plugins.ImagePlugin - :members: - -Overlay Plugin -^^^^^^^^^^^^^^ - -.. autoclass:: ophyd.areadetector.plugins.OverlayPlugin - :members: - -Process Plugin -^^^^^^^^^^^^^^ - -.. autoclass:: ophyd.areadetector.plugins.ProcessPlugin - :members: - -ROI Plugin -^^^^^^^^^^ - -.. autoclass:: ophyd.areadetector.plugins.ROIPlugin - :members: - -Stats Plugin -^^^^^^^^^^^^ - -.. autoclass:: ophyd.areadetector.plugins.StatsPlugin - :members: - -Transform Plugin -^^^^^^^^^^^^^^^^ - -.. autoclass:: ophyd.areadetector.plugins.TransformPlugin - :members: - - -File Plugins ------------- - -.. autoclass:: ophyd.areadetector.plugins.FilePlugin - :members: - - -HDF5 Plugin -^^^^^^^^^^^ -.. autoclass:: ophyd.areadetector.plugins.HDF5Plugin - :members: - -JPEG Plugin -^^^^^^^^^^^ - -.. autoclass:: ophyd.areadetector.plugins.JPEGPlugin - :members: - -ImageMagick Plugin -^^^^^^^^^^^^^^^^^^ - -.. autoclass:: ophyd.areadetector.plugins.MagickPlugin - :members: - -NetCDF Plugin -^^^^^^^^^^^^^ - -.. autoclass:: ophyd.areadetector.plugins.NetCDFPlugin - :members: - -Nexus Plugin -^^^^^^^^^^^^ - -.. autoclass:: ophyd.areadetector.plugins.NexusPlugin - :members: - -TIFF Plugin -^^^^^^^^^^^ - -.. autoclass:: ophyd.areadetector.plugins.TIFFPlugin - :members: diff --git a/ophyd/_sources/builtin-devices.rst.txt b/ophyd/_sources/builtin-devices.rst.txt deleted file mode 100644 index 02affc4aff..0000000000 --- a/ophyd/_sources/builtin-devices.rst.txt +++ /dev/null @@ -1,76 +0,0 @@ -Ready-to-Use Devices -******************** - -These devices are have ready-made classes in Python. To configure them, the -user need only provide a PV prefix and a name. - -EpicsMotor ----------- - -Create an ``EpicsMotor`` to communicate with a single `EPICS motor record -`_: - -.. code-block:: python - - from ophyd import EpicsMotor - - # the two-theta motor - tth = EpicsMotor('XF:28IDC-ES:1{Dif:1-Ax:2ThI}Mtr', name='tth') - -.. autoclass:: ophyd.epics_motor.EpicsMotor - :members: - - -EpicsScaler ------------ - -Create an ``EpicsScaler`` to control an EPICS `scaler record -`_: - -.. code-block:: python - - from ophyd import EpicsScaler - scaler = EpicsScaler('XF:28IDC-ES:1{Sclr:1}', name='tth') - -.. autoclass:: ophyd.scaler.EpicsScaler - :members: - - -EpicsMCA and EpicsDXP ---------------------- - -`MCA records `_ and -DXP-based devices are also supported, through the ``EpicsMCA`` and ``EpicsDXP`` -devices. - -.. autoclass:: ophyd.mca.EpicsMCARecord - :members: -.. autoclass:: ophyd.mca.EpicsDXP - :members: - -.. index:: read_attrs -.. index:: configuration_attrs -.. index:: hints - -MotorBundle ------------ - -Creating 'bundles' of motors is very common so we also have a helper -class that tweaks the default behavior of :attr:`read_attrs`, -:attr:`configuration_attrs`, and :attr:`hints` - -.. autoclass:: ophyd.epics_motor.MotorBundle - :members: - -This must be sub-classed (like :class:`~ophyd.device.Device`) to be useful. - -.. code-block:: python - - from ophyd import MotorBundle, EpicsMotor - from ophyd import Component as Cpt - - class StageXY(MotorBundle): - x = Cpt(EpicsMotor, ':X') - y = Cpt(EpicsMotor, ':Y') - - stage = StageXY('STAGE_PV', name='stage') diff --git a/ophyd/_sources/builtin-devices.txt b/ophyd/_sources/builtin-devices.txt deleted file mode 100644 index d5849fa0f4..0000000000 --- a/ophyd/_sources/builtin-devices.txt +++ /dev/null @@ -1,49 +0,0 @@ -Ready-to-Use Devices -******************** - -These devices are have ready-made classes in Python. To configure them, the -user need only provide a PV prefix and a name. - -EpicsMotor ----------- - -Create an ``EpicsMotor`` to communicate with a single `EPICS motor record -`_: - -.. code-block:: python - - from ophyd import EpicsMotor - - # the two-theta motor - tth = EpicsMotor('XF:28IDC-ES:1{Dif:1-Ax:2ThI}Mtr', name='tth') - -.. autoclass:: ophyd.epics_motor.EpicsMotor - :members: - - -EpicsScaler ------------ - -Create an ``EpicsScaler`` to control an EPICS `scaler record -`_: - -.. code-block:: python - - from ophyd import EpicsScaler - scaler = EpicsScaler('XF:28IDC-ES:1{Sclr:1}', name='tth') - -.. autoclass:: ophyd.scaler.EpicsScaler - :members: - - -EpicsMCA and EpicsDXP ---------------------- - -`MCA records `_ and -DXP-based devices are also supported, through the ``EpicsMCA`` and ``EpicsDXP`` -devices. - -.. autoclass:: ophyd.mca.EpicsMCARecord - :members: -.. autoclass:: ophyd.mca.EpicsDXP - :members: diff --git a/ophyd/_sources/commands.rst.txt b/ophyd/_sources/commands.rst.txt deleted file mode 100644 index d7e6096af4..0000000000 --- a/ophyd/_sources/commands.rst.txt +++ /dev/null @@ -1,16 +0,0 @@ -Interactive Command Interface -***************************** - -These functions are intended for getting a snapshot of the beamline. - - - -.. currentmodule:: ophyd.commands -.. autosummary:: - :toctree: _as_gen - - wh_pos - log_pos - log_pos_diff - log_pos_mov - get_all_positioners diff --git a/ophyd/_sources/commands.txt b/ophyd/_sources/commands.txt deleted file mode 100644 index f0db4a3d4d..0000000000 --- a/ophyd/_sources/commands.txt +++ /dev/null @@ -1,22 +0,0 @@ -Interactive Command Interface -***************************** - -These functions are intended for interactive use. Users coming from SPEC will -find many of these commands familiar. - -.. currentmodule:: ophyd.commands -.. autosummary:: - :toctree: generated/ - - mov - movr - set_pos - wh_pos - set_lm - log_pos - log_pos_diff - log_pos_mov - get_all_positioners - get_logbook - -Click any command name to view its full docstring with example usage. diff --git a/ophyd/_sources/custom-devices.rst.txt b/ophyd/_sources/custom-devices.rst.txt deleted file mode 100644 index 97ca2c2898..0000000000 --- a/ophyd/_sources/custom-devices.rst.txt +++ /dev/null @@ -1,60 +0,0 @@ -Custom Devices -************** - -A Device is made from Components, which encapsulate other Devices or Signals. -See examples. - - -.. code-block:: python - - from ophyd import Device, EpicsSignal, EpicsSignalRO - from ophyd import Component as Cpt - from ophyd.utils import set_and_wait - - class Robot(Device): - sample_number = Cpt(EpicsSignal, 'ID:Tgt-SP') - load_cmd = Cpt(EpicsSignal, 'Cmd:Load-Cmd.PROC') - unload_cmd = Cpt(EpicsSignal, 'Cmd:Unload-Cmd.PROC') - execute_cmd = Cpt(EpicsSignal, 'Cmd:Exec-Cmd') - status = Cpt(EpicsSignal, 'Sts-Sts') - - my_robot = Robot('pv_prefix:', name='my_robot') - - -In this case, ``my_robot.load_cmd`` would be an ``EpicsSignal`` that points to -the PV ``pv_prefix:Cmd:Load-Cmd.PROC``. Each of the components can be used as -``stage_sigs``, added to the list of ``read_attrs`` or ``configuration_attrs``, -or simply as ``EpicsSignals`` on their own. - - -Devices and bluesky count_time -============================== - -When a ``Device`` is used as a bluesky detector in a scan, a ``count_time`` -component will be checked for prior to staging. For example: - - -.. code-block:: python - - from ophyd import (Device, Signal, Component as Cpt, EpicsSignal) - - class DetectorWithCountTime(Device): - count_time = Cpt(Signal) - exposure_time = Cpt(EpicsSignal, 'ExposureTime-SP') - - def stage(self): - if self.count_time.get() is not None: - actual_exposure_time = (self.count_time.get() - 0.1) - self.stage_sigs[self.exposure_time] = actual_exposure_time - super().stage() - - det = DetectorWithCountTime('prefix:', name='det') - gs.DETS.append(det) - RE(dscan(mtr, 0, 1, 5, time=5.0)) - # count_time would be set to 5.0 here, prior to the scan starting - - -Using the approach of a soft Signal on detectors allows ``stage`` to process -the value that comes directly from the user. A slightly less flexible -alternative would be to define ``count_time`` just as the ``EpicsSignal`` -``exposure_time`` below it, if those values should always be the same. diff --git a/ophyd/_sources/custom-devices.txt b/ophyd/_sources/custom-devices.txt deleted file mode 100644 index 97ca2c2898..0000000000 --- a/ophyd/_sources/custom-devices.txt +++ /dev/null @@ -1,60 +0,0 @@ -Custom Devices -************** - -A Device is made from Components, which encapsulate other Devices or Signals. -See examples. - - -.. code-block:: python - - from ophyd import Device, EpicsSignal, EpicsSignalRO - from ophyd import Component as Cpt - from ophyd.utils import set_and_wait - - class Robot(Device): - sample_number = Cpt(EpicsSignal, 'ID:Tgt-SP') - load_cmd = Cpt(EpicsSignal, 'Cmd:Load-Cmd.PROC') - unload_cmd = Cpt(EpicsSignal, 'Cmd:Unload-Cmd.PROC') - execute_cmd = Cpt(EpicsSignal, 'Cmd:Exec-Cmd') - status = Cpt(EpicsSignal, 'Sts-Sts') - - my_robot = Robot('pv_prefix:', name='my_robot') - - -In this case, ``my_robot.load_cmd`` would be an ``EpicsSignal`` that points to -the PV ``pv_prefix:Cmd:Load-Cmd.PROC``. Each of the components can be used as -``stage_sigs``, added to the list of ``read_attrs`` or ``configuration_attrs``, -or simply as ``EpicsSignals`` on their own. - - -Devices and bluesky count_time -============================== - -When a ``Device`` is used as a bluesky detector in a scan, a ``count_time`` -component will be checked for prior to staging. For example: - - -.. code-block:: python - - from ophyd import (Device, Signal, Component as Cpt, EpicsSignal) - - class DetectorWithCountTime(Device): - count_time = Cpt(Signal) - exposure_time = Cpt(EpicsSignal, 'ExposureTime-SP') - - def stage(self): - if self.count_time.get() is not None: - actual_exposure_time = (self.count_time.get() - 0.1) - self.stage_sigs[self.exposure_time] = actual_exposure_time - super().stage() - - det = DetectorWithCountTime('prefix:', name='det') - gs.DETS.append(det) - RE(dscan(mtr, 0, 1, 5, time=5.0)) - # count_time would be set to 5.0 here, prior to the scan starting - - -Using the approach of a soft Signal on detectors allows ``stage`` to process -the value that comes directly from the user. A slightly less flexible -alternative would be to define ``count_time`` just as the ``EpicsSignal`` -``exposure_time`` below it, if those values should always be the same. diff --git a/ophyd/_sources/debugging.rst.txt b/ophyd/_sources/debugging.rst.txt deleted file mode 100644 index a384afed04..0000000000 --- a/ophyd/_sources/debugging.rst.txt +++ /dev/null @@ -1,173 +0,0 @@ -********************* -Debugging and Logging -********************* - -.. versionchanged:: 1.4.0 - - Ophyd's use of Python's logging framework has been completely reworked to - follow Python's documented best practices for libraries. - -Ophyd uses Python's logging framework, which enables sophisticated log -management. For common simple cases, including viewing logs in the terminal or -writing them to a file, the next section illustrates streamlined, -copy/paste-able examples. Users who are familiar with that framework or who -need to route logs to multiple destinations may wish to skip ahead to -:ref:`logger_api`. - -Useful Snippets -=============== - -Log warnings ------------- - -This is the recommended standard setup. - -.. code-block:: python - - from ophyd.log import config_ophyd_logging - config_ophyd_logging() - -It will display ``'ophyd'`` log records of ``WARNING`` level or higher in the -terminal (standard out) with a format tailored to ophyd. - -Maximum verbosity ------------------ - -If operations are "hanging," running slowly, or repeatedly encountering an -error, increasing the logging verbosity can help identify the underlying issue. - -.. code-block:: python - - from ophyd.log import config_ophyd_logging - config_ophyd_logging(level='DEBUG') - -Log to a file -------------- - -This will direct all log messages to a file instead of the terminal (standard -out). - -.. code-block:: python - - from ophyd.log import config_ophyd_logging - config_ophyd_logging(file='/tmp/ophyd.log', level='DEBUG') - -.. _logger_api: - -Ophyd's Logging-Related API -============================= - -Logger Names ------------- - -Here are the primary loggers used by ophyd. - -* ``'ophyd'`` --- the logger to which all ophyd log records propagate -* ``'ophyd.objects'`` --- logs records from all devices and signals - (that is, :class:`~ophyd.OphydObject` subclasses) -* ``'ophyd.control_layer'`` --- logs requests issued to the underlying control - layer (e.g. pyepics, caproto) -* ``'ophyd.event_dispatcher'`` --- issues regular summaries of the backlog of - updates from the control layer that are being processed on background threads - -There are also many module-level loggers for specific features. - -Formatter ---------- - -.. autoclass:: ophyd.log.LogFormatter - -Global Handler ---------------- - -Following Python's recommendation, ophyd does not install any handlers at -import time, but it provides a function to set up a basic useful configuration -in one line, similar to Python's :py:func:`logging.basicConfig` but with some -additional options---and scoped to the ``'ophyd'`` logger with ophyd's -:class:`ophyd.log.LogFormatter`. It streamlines common use cases without -interfering with more sophisticated use cases. - -We recommend that facilities using ophyd leave this function for users and -configure any standardized, facility-managed logging handlers separately, as -described in the next section. - -.. autofunction:: ophyd.log.config_ophyd_logging -.. autofunction:: ophyd.log.get_handler - -Advanced Example -================ - -The flow of log event information in loggers and handlers is illustrated in the -following diagram: - -.. image:: https://docs.python.org/3/_images/logging_flow.png - -For further reference, see the Python 3 logging howto: -https://docs.python.org/3/howto/logging.html#logging-flow - -As an illustrative example, we will set up two handlers using the Python -logging framework directly, ignoring ophyd's convenience function. - -Suppose we set up a handler aimed at a file: - -.. code-block:: python - - import logging - file_handler = logging.FileHandler('ophyd.log') - -And another aimed at `Logstash `_: - -.. code-block:: python - - import logstash # requires python-logstash package - logstash_handler = logstash.TCPLogstashHandler(, , version=1) - -We can attach the handlers to the ophyd logger, to which all log records -created by ophyd propagate: - -.. code-block:: python - - logger = logging.getLogger('ophyd') - logger.addHandler(logstash_handler) - logger.addHandler(file_filter) - -We can set the verbosity of each handler. Suppose want maximum verbosity in the -file but only medium verbosity in logstash. - -.. code-block:: python - - logstash_handler.setLevel('INFO') - file_handler.setLevel('DEBUG') - -Finally, ensure that "effective level" of ``logger`` is at least as verbose as -the most verbose handler---in this case, ``'DEBUG'``. By default, at import, -its level is not set - -.. ipython:: python - :verbatim: - - logging.getLevelName(logger.level) - 'NOTSET' - -and so it inherits the level of Python's default -"handler of last resort," :py:obj:`logging.lastResort`, which is ``'WARNING'``. - -.. ipython:: python - :verbatim: - - logging.getLevelName(logger.getEffectiveLevel()) - 'WARNING' - -In this case we should set it to ``'DEBUG'``, to match the most verbose level -of the handler we have added. - -.. code-block:: python - - logger.setLevel('DEBUG') - -This makes DEBUG-level records *available* to all handlers. Our logstash -handler, set to ``'INFO'``, will filter out DEBUG-level records. - -To globally disable the generation of any log records at or below a certain -verbosity, which may be helpful for optimizing performance, Python provides -:py:func:`logging.disable`. diff --git a/ophyd/_sources/device-overview.rst.txt b/ophyd/_sources/device-overview.rst.txt deleted file mode 100644 index adc70f1470..0000000000 --- a/ophyd/_sources/device-overview.rst.txt +++ /dev/null @@ -1,425 +0,0 @@ -====================== - Device and Component -====================== - -.. automodule:: ophyd.device - :noindex: - - -Usage -===== - -The core class of :mod:`ophyd` is :class:`~device.Device` which encodes the -nodes of the hierarchical structure of the device and provides much of -core API. - - -.. autosummary:: - :toctree: generated - - Device - -The base :class:`~device.Device` is not particularly useful on it's own, it -must be sub-classed to provide it with components to do something -with. - -Creating a custom device is as simple as - -.. code-block:: python - - from ophyd import Device, EpicsMotor - from ophyd import Component as Cpt - - class StageXY(Device): - x = Cpt(EpicsMotor, ':X') - y = Cpt(EpicsMotor, ':Y') - - stage = StageXY('STAGE_PV', name='stage') - -You can then use ``stage`` as an input to any plan as a detector and -``stage.x`` and ``stage.y`` as independent motors. - - -A Robot -------- - -A slightly more complex example is to control a simple sample loading -robot. - -.. code-block:: python - - from ophyd import Device, EpicsSignal, EpicsSignalRO - from ophyd import Component as Cpt - from ophyd.utils import set_and_wait - - class Robot(Device): - sample_number = Cpt(EpicsSignal, 'ID:Tgt-SP') - load_cmd = Cpt(EpicsSignal, 'Cmd:Load-Cmd.PROC') - unload_cmd = Cpt(EpicsSignal, 'Cmd:Unload-Cmd.PROC') - execute_cmd = Cpt(EpicsSignal, 'Cmd:Exec-Cmd') - - status = Cpt(EpicsSignalRO, 'Sts-Sts') - - my_robot = Robot('PV_PREFIX:', name='my_robot', - read_attrs=['sample_number', 'status']) - -Which creates an instance ``my_robot`` with 5 children - - ====================== =============================== ===================== - python attribute PV name in ``read()`` - ====================== =============================== ===================== - my_robot.sample_number 'PV_PREFIX:ID:Tgt-SP' Y - my_robot.load_cmd 'PV_PREFIX:CMD:Load-Cmd.PROC' N - my_robot.unload_cmd 'PV_PREFIX:CMD:Unload-Cmd.PROC' N - my_robot.execute_cmd 'PV_PREFIX:CMD:Exec-Cmd' N - my_robot.status 'PV_PREFIX:Sts-Sts' Y - ====================== =============================== ===================== - -only 2 of which will be included when reading from the robot. - -You could now use this device in a scan like - -.. code-block:: python - - import bluesky.plans as bp - - def load_sample(robot, sample): - yield from bp.mv(robot.sample_number, sample) - yield from bp.mv(robot.load_cmd, 1) - yield from bp.mv(robot.execute_cmd, 1) - - def unload_sample(robot): - yield from bp.mv(robot.unload_cmd, 1) - yield from bp.mv(robot.execute_cmd, 1) - - def robot_plan(list_of_samples): - for sample in list_of_samples: - # load the sample - yield from load_sample(my_robot, sample) - # take a measurement - yield from bp.count([det], md={'sample': sample}) - # unload the sample - yield from unload_sample(my_robot) - -and from the command line :: - - RE(robot_plan([1, 2. 6])) - - -These classes were co-developed with :mod:`bluesky` and are the -reference implementation of a hardware abstraction layer for -:mod:`bluesky`. However, these are closely tied to EPICS and make -some assumptions about the PV naming based on NSLS-II's naming scheme. -Despite attempting generality, it is likely that as :mod:`ophyd` and -:mod:`bluesky` are used at other facilities (and when :mod:`ophyd` is -adapted for a different control system) we will discover some latent -NSLS-II-isms that should be corrected (or at least acknowledged and -documented). - - -:class:`~device.Device` -======================= - -:class:`~device.Device` adds a number of additional attributes beyond the -required :mod:`bluesky` API and what is inherited from :class:`~ohpyd.ophydobj.OphydObj` -for run-time configuration - - =========================== ======================================================== - Attribute Description - =========================== ======================================================== - :attr:`read_attrs` Names of components for ``read()`` See :ref:`trd` - --------------------------- -------------------------------------------------------- - :attr:`configuration_attrs` Names of components for ``read_configuration()``. - See :ref:`cfg_and_f` - --------------------------- -------------------------------------------------------- - :attr:`stage_sigs` Signals to be set during `Stage and Unstage`_ - --------------------------- -------------------------------------------------------- - :attr:`hints` Names of components as suggestions for handling in bluesky callbacks. - =========================== ======================================================== - -and static information about the object - - =========================== ======================================================== - Attribute Description - =========================== ======================================================== - :attr:`prefix` 'base' of PV name, used when building components - --------------------------- -------------------------------------------------------- - :attr:`component_names` List of the names components on this device. - Direct children only - --------------------------- -------------------------------------------------------- - :attr:`trigger_signals` Signals for use in `Implicit Triggering`_ - (provisional) - =========================== ======================================================== - -:class:`~device.Device` also has two class-level attributes to control the default contents of -:attr:`read_attrs` and :attr:`configuration_attrs`. - - ==================================== ======================================================== - Attribute Description - ==================================== ======================================================== - :attr:`_default_read_attrs` The default contents of :attr:`read_attrs` if a subset - of all available children. - - An iterable or `None`. If `None` defaults to - all children - - A :class:`tuple` is recommended. - - ------------------------------------ -------------------------------------------------------- - :attr:`_default_configuration_attrs` The default contents of :attr:`configuration_attrs` - - An iterable or `None`. If `None` defaults to ``[]`` - - A :class:`tuple` is recommended. - - ==================================== ======================================================== - -.. index:: hints attribute -.. _hints: - -:attr:`hints` -------------- - -The :attr:`hints` attribute is a dictionary that provides information about an -:mod:`ophyd` device to :mod:`bluesky` callbacks that advise how that device -should be handled by the callback. While it could be used for many purposes, -its first use has been to direct the selection of the relevant axes and signals -to use when plotting data from an event stream. - -There are two different locations where the ``hints`` dictionary is created. - -1. During the specification of an ophyd :class:`~device.Device` -1. Configuration of the ``start`` document by a :mod:`bluesky` plan - -The ``hints`` dictionary has well-known keys. - -=================== ======================================================== -Key Description of value -=================== ======================================================== -``fields`` signal names to be used for a plot as dependent axes -------------------- -------------------------------------------------------- -``dimensions`` signal names to be used for a plot as independent axes -------------------- -------------------------------------------------------- -``gridding`` advises when to prefer ``LiveGrid`` instead of ``LivePlot`` -=================== ======================================================== - -The ``hints`` dictionary may also have custom keys used by the custom support. - -* example using the *ad hoc* ``vis`` key in the creation of an :mod:`ophyd` - detector Device:: - - self.hints = {'vis': 'placeholder'} - -* then look for this key in the custom :mod:`bluesky` callback:: - - assert doc['hints']['det'] == {'vis': 'placeholder'} - - -.. _hints_fields: - -``hints["fields"]`` -^^^^^^^^^^^^^^^^^^^ - -``fields`` is a list of ophyd object name(s) to be used as dependent axes for -visualization callbacks. The object name(s) must appear in the dictionary -returned by the device's ``read()`` method. - -Examples: - -.. code-block:: python - - quadem.hints == {'fields': ['quadem_current1_mean_value']} - sca.hints == {'fields': [sca.channels.name]} - -To ensure internal consistency, the ``hints`` attribute of any -:class:`~signal.Signal` or :class:`~device.Device` cannot be set directly. -[#use_kind_not_fit]_ Instead of: - -.. code-block:: python - - camera.hints = {'fields': [camera.stats1.total.name, - camera.stats2.total.name]} - -use the :attr:`kind` :index:`kind` attribute. - -.. code-block:: python - - from ophyd import Kind - - camera.stats1.total.kind = Kind.hinted - camera.stats2.total.kind = Kind.hinted - -or, as a convenient shortcut - -.. code-block:: python - - camera.stats1.total.kind = 'hinted' - camera.stats2.total.kind = 'hinted' - -.. [#use_kind_not_fit] starting with ophyd v1.2.0 - - -.. _hints_dimensions: - -``hints["dimensions"]`` -^^^^^^^^^^^^^^^^^^^^^^^ - -Defines the ophyd signal names to be used as independent axes for visualization. -The syntax is (list of field names, stream name) where the list of field -names is as above and the stream name is usually ``primary``. -All the signals must be available in the named stream. - -``hints["dimensions"]`` is used by a :mod:`bluesky` plan -to prepare a :attr:`dimensions` attribute that is placed -in the `start` document. It is this :attr:`dimensions` attribute -that identifies the independent axes for visualization callbacks. -The plan can use or override what it finds in ``hints["dimensions"]``. - -Examples: - -.. code-block:: python - - dimensions = [(motor.hints['fields'], 'primary')] - dimensions = [(('time'), 'primary')] - -.. paraphrased from bluesky/bluesky/callbacks/best_effort.py - -For now, :mod:`bluesky` can only handle when all the dimensions belong -to the same stream. To generalize, we would need to resample -and we are not going to handle that yet. - - -.. _hints_gridding: - -``hints["gridding"]`` -^^^^^^^^^^^^^^^^^^^^^ - -This key is used for mesh and grid scans. When present, it can take these values: -``rectilinear`` or ``rectilinear_nonsequential``. - -In the *Best Effort Callback* from :mod:`bluesky`, if ``hints["gridding"]`` exists and -is ``"rectilinear"``, then use LiveGrid, otherwise use LivePlot. - - -:class:`~device.Component` --------------------------------- - -The :class:`~device.Component` class is a python descriptor_ which overrides -the behavior on attribute access. This allows us to use a declarative style to -define the software representation of the hardware. The best way to -understand is through an example:: - - class Foo(Device): - bar = Component(EpicsSignal, ':bar', string=True) - -which means "When a ``Foo`` instance is created give it a ``bar`` attribute -which is an instance of :class:`EpicsSignal` and use the extra args -and kwargs when creating it". It is a declaration of what you want -and it is the responsibility of :mod:`ophyd` to make it happen. - -There are three classes - -.. autosummary:: - :toctree: generated - - Component - FormattedComponent - DynamicDeviceComponent - - -.. _trd: - -Trigger, Read and Describe --------------------------- - -The :meth:`~ophyd.device.BlueskyInterface.trigger()` method is responsible for -implementing 'trigger' or 'acquire' functionality of the Device. - -The :meth:`~ophyd.device.BlueskyInterface.read()` method is responsible for -for returning the data from the Device. - -The :meth:`~ophyd.device.BlueskyInterface.describe()` method is responsible for -providing schema and meta-data for the `read()` method. - -.. _cfg_and_f: - - -Configuration and Friends -------------------------- - - -Stage and Unstage ------------------ - -When a Device ``d`` is used in scan, it is "staged" and "unstaged." Think of -this as "setup" and "cleanup". That is, before a device is triggered, read, or -moved, the scan is expected to call ``d.stage()``. And, at the end of scan, -``d.unstage()`` is called. (Whenever possible, unstaging is performed even if -the scan is aborted or fails due to an error.) - -The staging process is a "hook" for preparing a device for use. To add -custom staging logic to a Device, subclass it and override ``stage`` and/or -``unstage`` like so. - -.. code-block:: python - - class MyMotor(EpicsMotor): - - def stage(self): - print('I am staging.') - super().stage() - - def unstage(self): - print('I am unstaging.') - super().unstage() - -It is crucial to call ``super()``, as above, so that any built-in staging -behavior is not overridden. - -A common use for staging is to set certain signals to certain values for -a scan and then set them back at the end. For example, a detector device -might turn on "capture mode" at the beginning of the scan and then flip it -back off (or back to its original setting, whatever that was) at the end. -For this, ophyd provides a convenience, ``stage_sigs`` --- a dictionary -mapping signals to desired values. The device reads the initial values -of these signals, stashes them, changes them to the desired value, and then -restore the initial value when the device is unstaged. It is best to -customize ``stage_sigs`` in the device's ``__init__`` method, like so: - -.. code-block:: python - - class MyMotor(EpicsMotor): - def __init__(*args, **kwargs): - super().__init__(*args, **kwargs) - self.stage_sigs[self.user_offset] = 5 - -When a ``MyMotor`` device is staged, its ``user_offset`` value will be set -to 5. When it is unstaged, it will be set back to whatever value it had -right before it was staged. - - -Implicit Triggering -------------------- - -Count Time ----------- - -Low level API -============= - - -.. autosummary:: - :toctree: generated - :nosignatures: - - Device.connected - Device.wait_for_connection - Device.get_instantiated_signals - Device.get - Device.put - Device.get_device_tuple - -.. _descriptor: https://docs.python.org/3/reference/datamodel.html#implementing-descriptors - - -.. todo ['trigger_signals', ] diff --git a/ophyd/_sources/device-overview.txt b/ophyd/_sources/device-overview.txt deleted file mode 100644 index 30c7c582f6..0000000000 --- a/ophyd/_sources/device-overview.txt +++ /dev/null @@ -1,97 +0,0 @@ -Overview of a Device -******************** - -Signals and Devices -=================== - -* A **Signal** represents a single value. In EPICS, it corresponds to either - a single read-only PV or a pair of read and write PVs, grouped together. -* A **Device** is composed of Signals or of other Devices. Devices can be - nested. Some devices map to single pieces of hardware (like a motor). - Others group together many different pieces of hardware (like a - diffractometer). -* In one process, the same PVs might appear in multiple different Devices, - so organized for different uses. - -Staging -======= - -When a Device ``d`` is used in scan, it is "staged" and "unstaged." Think of -this as "setup" and "cleanup". That is, before a device is triggered, read, or -moved, the scan is expected to call ``d.stage()``. And, at the end of scan, -``d.unstage()`` is called. (Whenever possible, unstaging is performed even if -the scan is aborted or fails due to an error.) - -The staging process is a "hook" for preparing a device for use. To add -custom staging logic to a Device, subclass it and override ``stage`` and/or -``unstage`` like so. - -.. code-block:: python - - class MyMotor(EpicsMotor): - - def stage(self): - print('I am staging.') - super().stage() - - def unstage(self): - print('I am unstaging.') - super().unstage() - -It is crucial to call ``super()``, as above, so that any built-in staging -behavior is not overridden. - -A common use for staging is to set certain signals to certain values for -a scan and then set them back at the end. For example, a detector device -might turn on "capture mode" at the beginning of the scan and then flip it -back off (or back to its original setting, whatever that was) at the end. -For this, ophyd provides a convenience, ``stage_sigs`` --- a dictionary -mapping signals to desired values. The device reads the initial values -of these signals, stashes them, changes them to the desired value, and then -restore the initial value when the device is unstaged. It is best to -customize ``stage_sigs`` in the device's ``__init__`` method, like so: - -.. code-block:: python - - class MyMotor(EpicsMotor): - def __init__(*args, **kwargs): - super().__init__(*args, **kwargs) - self.stage_sigs[self.user_offset] = 5 - -When a ``MyMotor`` device is staged, its ``user_offset`` value will be set -to 5. When it is unstaged, it will be set back to whatever value it had -right before it was staged. - - -Device API -========== - - -All Devices have certain methods and attributes in common. - -.. autoclass:: ophyd.Device - -High-level Interface (used by bluesky) -====================================== - -.. automethod:: ophyd.Device.read -.. automethod:: ophyd.Device.describe -.. automethod:: ophyd.Device.set -.. automethod:: ophyd.Device.trigger -.. automethod:: ophyd.Device.stage -.. automethod:: ophyd.Device.unstage -.. automethod:: ophyd.Device.configure -.. automethod:: ophyd.Device.read_configuration -.. automethod:: ophyd.Device.describe_configuration - -Low-level Interface (for exploration, debugging) -================================================ - -.. autoattribute:: ophyd.Device.connected - - ``True`` is all components are connected, ``False`` if any are not - -.. automethod:: ophyd.Device.wait_for_connection -.. automethod:: ophyd.Device.get -.. automethod:: ophyd.Device.put -.. automethod:: ophyd.Device.get_device_tuple diff --git a/ophyd/_sources/docker.rst.txt b/ophyd/_sources/docker.rst.txt deleted file mode 100644 index 2c15b1e7ae..0000000000 --- a/ophyd/_sources/docker.rst.txt +++ /dev/null @@ -1,50 +0,0 @@ -Docker setup -============ - -.. highlight:: bash - - -You can use Docker to run test IOCs that are convenient for testing without -having to locally build and install EPICS IOCs. Please use the following -Docker links to install and configure Docker: - - - `Installing Docker on Ubuntu `_ - - `Configuring Docker `_ - (allowing to run as non-root, running at startup, etc.) - -To communicate with the Docker you have set up some environmental variables: - -.. literalinclude:: ../../scripts/epics_exports.sh - -and to run docker with the correct images (assuming the preceding code block is -saved in :file:`epics_exports.sh`): - -.. literalinclude:: ../../scripts/epics_docker.sh - -Running this multiple times will lead to multiple instances of the -images running. - -For EPICS to know where to search for the IOCs you will need to do :: - - source epics_exports.sh - - -to setup the EPICS environmental variables. To check that it is setup -correctly :: - - $ env | grep -i epics - EPICS_CA_ADDR_LIST=172.17.255.255 - EPICS_CA_AUTO_ADDR_LIST=no - EPICS_CA_MAX_ARRAY_BYTES=10000000 - -To check if it is working, try :: - - $ caget XF:31IDA-OP{Tbl-Ax:X1}Mtr - -.. note:: - - You may need to install ``pyepics``, which installs ``epics-base`` - and the corresponding ``caget`` executable: :: - - conda install -c lightsource2-tag pyepics - diff --git a/ophyd/_sources/generated/ophyd.areadetector.base.ADBase.get_asyn_digraph.rst.txt b/ophyd/_sources/generated/ophyd.areadetector.base.ADBase.get_asyn_digraph.rst.txt deleted file mode 100644 index 49b1446924..0000000000 --- a/ophyd/_sources/generated/ophyd.areadetector.base.ADBase.get_asyn_digraph.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -ophyd\.areadetector\.base\.ADBase\.get\_asyn\_digraph -===================================================== - -.. currentmodule:: ophyd.areadetector.base - -.. automethod:: ADBase.get_asyn_digraph \ No newline at end of file diff --git a/ophyd/_sources/generated/ophyd.areadetector.base.ADBase.get_asyn_port_dictionary.rst.txt b/ophyd/_sources/generated/ophyd.areadetector.base.ADBase.get_asyn_port_dictionary.rst.txt deleted file mode 100644 index 4e05314094..0000000000 --- a/ophyd/_sources/generated/ophyd.areadetector.base.ADBase.get_asyn_port_dictionary.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -ophyd\.areadetector\.base\.ADBase\.get\_asyn\_port\_dictionary -============================================================== - -.. currentmodule:: ophyd.areadetector.base - -.. automethod:: ADBase.get_asyn_port_dictionary \ No newline at end of file diff --git a/ophyd/_sources/generated/ophyd.areadetector.base.ADBase.get_plugin_by_asyn_port.rst.txt b/ophyd/_sources/generated/ophyd.areadetector.base.ADBase.get_plugin_by_asyn_port.rst.txt deleted file mode 100644 index 14640d712b..0000000000 --- a/ophyd/_sources/generated/ophyd.areadetector.base.ADBase.get_plugin_by_asyn_port.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -ophyd\.areadetector\.base\.ADBase\.get\_plugin\_by\_asyn\_port -============================================================== - -.. currentmodule:: ophyd.areadetector.base - -.. automethod:: ADBase.get_plugin_by_asyn_port \ No newline at end of file diff --git a/ophyd/_sources/generated/ophyd.areadetector.base.ADBase.missing_plugins.rst.txt b/ophyd/_sources/generated/ophyd.areadetector.base.ADBase.missing_plugins.rst.txt deleted file mode 100644 index 5c1179aa92..0000000000 --- a/ophyd/_sources/generated/ophyd.areadetector.base.ADBase.missing_plugins.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -ophyd\.areadetector\.base\.ADBase\.missing\_plugins -=================================================== - -.. currentmodule:: ophyd.areadetector.base - -.. automethod:: ADBase.missing_plugins \ No newline at end of file diff --git a/ophyd/_sources/generated/ophyd.areadetector.base.ADBase.rst.txt b/ophyd/_sources/generated/ophyd.areadetector.base.ADBase.rst.txt deleted file mode 100644 index 654ca2b282..0000000000 --- a/ophyd/_sources/generated/ophyd.areadetector.base.ADBase.rst.txt +++ /dev/null @@ -1,57 +0,0 @@ -ophyd\.areadetector\.base\.ADBase -================================= - -.. currentmodule:: ophyd.areadetector.base - -.. autoclass:: ADBase - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~ADBase.__init__ - ~ADBase.add_instantiation_callback - ~ADBase.check_value - ~ADBase.clear_sub - ~ADBase.configure - ~ADBase.describe - ~ADBase.describe_configuration - ~ADBase.destroy - ~ADBase.find_signal - ~ADBase.get - ~ADBase.get_asyn_digraph - ~ADBase.get_asyn_port_dictionary - ~ADBase.get_device_tuple - ~ADBase.get_instantiated_signals - ~ADBase.get_plugin_by_asyn_port - ~ADBase.missing_plugins - ~ADBase.pause - ~ADBase.put - ~ADBase.read - ~ADBase.read_configuration - ~ADBase.resume - ~ADBase.stage - ~ADBase.stop - ~ADBase.subscribe - ~ADBase.summary - ~ADBase.trigger - ~ADBase.unstage - ~ADBase.unsubscribe - ~ADBase.unsubscribe_all - ~ADBase.validate_asyn_ports - ~ADBase.visualize_asyn_digraph - ~ADBase.wait_for_connection - ~ADBase.walk_components - ~ADBase.walk_signals - ~ADBase.walk_subdevice_classes - ~ADBase.walk_subdevices - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/generated/ophyd.areadetector.base.ADBase.validate_asyn_ports.rst.txt b/ophyd/_sources/generated/ophyd.areadetector.base.ADBase.validate_asyn_ports.rst.txt deleted file mode 100644 index 704ed4180a..0000000000 --- a/ophyd/_sources/generated/ophyd.areadetector.base.ADBase.validate_asyn_ports.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -ophyd\.areadetector\.base\.ADBase\.validate\_asyn\_ports -======================================================== - -.. currentmodule:: ophyd.areadetector.base - -.. automethod:: ADBase.validate_asyn_ports \ No newline at end of file diff --git a/ophyd/_sources/generated/ophyd.areadetector.base.ADBase.visualize_asyn_digraph.rst.txt b/ophyd/_sources/generated/ophyd.areadetector.base.ADBase.visualize_asyn_digraph.rst.txt deleted file mode 100644 index 81df135643..0000000000 --- a/ophyd/_sources/generated/ophyd.areadetector.base.ADBase.visualize_asyn_digraph.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -ophyd\.areadetector\.base\.ADBase\.visualize\_asyn\_digraph -=========================================================== - -.. currentmodule:: ophyd.areadetector.base - -.. automethod:: ADBase.visualize_asyn_digraph \ No newline at end of file diff --git a/ophyd/_sources/generated/ophyd.areadetector.base.ADComponent.rst.txt b/ophyd/_sources/generated/ophyd.areadetector.base.ADComponent.rst.txt deleted file mode 100644 index bfac310e1e..0000000000 --- a/ophyd/_sources/generated/ophyd.areadetector.base.ADComponent.rst.txt +++ /dev/null @@ -1,30 +0,0 @@ -ophyd\.areadetector\.base\.ADComponent -====================================== - -.. currentmodule:: ophyd.areadetector.base - -.. autoclass:: ADComponent - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~ADComponent.__init__ - ~ADComponent.create_component - ~ADComponent.find_docs - ~ADComponent.make_docstring - ~ADComponent.maybe_add_prefix - ~ADComponent.sub_default - ~ADComponent.sub_meta - ~ADComponent.sub_value - ~ADComponent.subscriptions - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/generated/ophyd.areadetector.base.EpicsSignalWithRBV.rst.txt b/ophyd/_sources/generated/ophyd.areadetector.base.EpicsSignalWithRBV.rst.txt deleted file mode 100644 index a08e72ff48..0000000000 --- a/ophyd/_sources/generated/ophyd.areadetector.base.EpicsSignalWithRBV.rst.txt +++ /dev/null @@ -1,41 +0,0 @@ -ophyd\.areadetector\.base\.EpicsSignalWithRBV -============================================= - -.. currentmodule:: ophyd.areadetector.base - -.. autoclass:: EpicsSignalWithRBV - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~EpicsSignalWithRBV.__init__ - ~EpicsSignalWithRBV.add_instantiation_callback - ~EpicsSignalWithRBV.check_value - ~EpicsSignalWithRBV.clear_sub - ~EpicsSignalWithRBV.describe - ~EpicsSignalWithRBV.describe_configuration - ~EpicsSignalWithRBV.destroy - ~EpicsSignalWithRBV.get - ~EpicsSignalWithRBV.get_setpoint - ~EpicsSignalWithRBV.put - ~EpicsSignalWithRBV.read - ~EpicsSignalWithRBV.read_configuration - ~EpicsSignalWithRBV.set - ~EpicsSignalWithRBV.set_default_timeout - ~EpicsSignalWithRBV.set_defaults - ~EpicsSignalWithRBV.subscribe - ~EpicsSignalWithRBV.trigger - ~EpicsSignalWithRBV.unsubscribe - ~EpicsSignalWithRBV.unsubscribe_all - ~EpicsSignalWithRBV.wait_for_connection - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/generated/ophyd.areadetector.base.ad_group.rst.txt b/ophyd/_sources/generated/ophyd.areadetector.base.ad_group.rst.txt deleted file mode 100644 index 4d6d3c197d..0000000000 --- a/ophyd/_sources/generated/ophyd.areadetector.base.ad_group.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -ophyd\.areadetector\.base\.ad\_group -==================================== - -.. currentmodule:: ophyd.areadetector.base - -.. autofunction:: ad_group \ No newline at end of file diff --git a/ophyd/_sources/generated/ophyd.areadetector.base.rst.txt b/ophyd/_sources/generated/ophyd.areadetector.base.rst.txt deleted file mode 100644 index f53b37ec7c..0000000000 --- a/ophyd/_sources/generated/ophyd.areadetector.base.rst.txt +++ /dev/null @@ -1,31 +0,0 @@ -ophyd\.areadetector\.base -========================= - -.. automodule:: ophyd.areadetector.base - - - - .. rubric:: Functions - - .. autosummary:: - - ad_group - - - - - - .. rubric:: Classes - - .. autosummary:: - - ADBase - ADComponent - EpicsSignalWithRBV - NDDerivedSignal - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/generated/ophyd.areadetector.cam.AdscDetectorCam.rst.txt b/ophyd/_sources/generated/ophyd.areadetector.cam.AdscDetectorCam.rst.txt deleted file mode 100644 index d9ae12f821..0000000000 --- a/ophyd/_sources/generated/ophyd.areadetector.cam.AdscDetectorCam.rst.txt +++ /dev/null @@ -1,57 +0,0 @@ -ophyd\.areadetector\.cam\.AdscDetectorCam -========================================= - -.. currentmodule:: ophyd.areadetector.cam - -.. autoclass:: AdscDetectorCam - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~AdscDetectorCam.__init__ - ~AdscDetectorCam.add_instantiation_callback - ~AdscDetectorCam.check_value - ~AdscDetectorCam.clear_sub - ~AdscDetectorCam.configure - ~AdscDetectorCam.describe - ~AdscDetectorCam.describe_configuration - ~AdscDetectorCam.destroy - ~AdscDetectorCam.find_signal - ~AdscDetectorCam.get - ~AdscDetectorCam.get_asyn_digraph - ~AdscDetectorCam.get_asyn_port_dictionary - ~AdscDetectorCam.get_device_tuple - ~AdscDetectorCam.get_instantiated_signals - ~AdscDetectorCam.get_plugin_by_asyn_port - ~AdscDetectorCam.missing_plugins - ~AdscDetectorCam.pause - ~AdscDetectorCam.put - ~AdscDetectorCam.read - ~AdscDetectorCam.read_configuration - ~AdscDetectorCam.resume - ~AdscDetectorCam.stage - ~AdscDetectorCam.stop - ~AdscDetectorCam.subscribe - ~AdscDetectorCam.summary - ~AdscDetectorCam.trigger - ~AdscDetectorCam.unstage - ~AdscDetectorCam.unsubscribe - ~AdscDetectorCam.unsubscribe_all - ~AdscDetectorCam.validate_asyn_ports - ~AdscDetectorCam.visualize_asyn_digraph - ~AdscDetectorCam.wait_for_connection - ~AdscDetectorCam.walk_components - ~AdscDetectorCam.walk_signals - ~AdscDetectorCam.walk_subdevice_classes - ~AdscDetectorCam.walk_subdevices - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/generated/ophyd.areadetector.cam.Andor3DetectorCam.rst.txt b/ophyd/_sources/generated/ophyd.areadetector.cam.Andor3DetectorCam.rst.txt deleted file mode 100644 index efc693d257..0000000000 --- a/ophyd/_sources/generated/ophyd.areadetector.cam.Andor3DetectorCam.rst.txt +++ /dev/null @@ -1,57 +0,0 @@ -ophyd\.areadetector\.cam\.Andor3DetectorCam -=========================================== - -.. currentmodule:: ophyd.areadetector.cam - -.. autoclass:: Andor3DetectorCam - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~Andor3DetectorCam.__init__ - ~Andor3DetectorCam.add_instantiation_callback - ~Andor3DetectorCam.check_value - ~Andor3DetectorCam.clear_sub - ~Andor3DetectorCam.configure - ~Andor3DetectorCam.describe - ~Andor3DetectorCam.describe_configuration - ~Andor3DetectorCam.destroy - ~Andor3DetectorCam.find_signal - ~Andor3DetectorCam.get - ~Andor3DetectorCam.get_asyn_digraph - ~Andor3DetectorCam.get_asyn_port_dictionary - ~Andor3DetectorCam.get_device_tuple - ~Andor3DetectorCam.get_instantiated_signals - ~Andor3DetectorCam.get_plugin_by_asyn_port - ~Andor3DetectorCam.missing_plugins - ~Andor3DetectorCam.pause - ~Andor3DetectorCam.put - ~Andor3DetectorCam.read - ~Andor3DetectorCam.read_configuration - ~Andor3DetectorCam.resume - ~Andor3DetectorCam.stage - ~Andor3DetectorCam.stop - ~Andor3DetectorCam.subscribe - ~Andor3DetectorCam.summary - ~Andor3DetectorCam.trigger - ~Andor3DetectorCam.unstage - ~Andor3DetectorCam.unsubscribe - ~Andor3DetectorCam.unsubscribe_all - ~Andor3DetectorCam.validate_asyn_ports - ~Andor3DetectorCam.visualize_asyn_digraph - ~Andor3DetectorCam.wait_for_connection - ~Andor3DetectorCam.walk_components - ~Andor3DetectorCam.walk_signals - ~Andor3DetectorCam.walk_subdevice_classes - ~Andor3DetectorCam.walk_subdevices - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/generated/ophyd.areadetector.cam.AndorDetectorCam.rst.txt b/ophyd/_sources/generated/ophyd.areadetector.cam.AndorDetectorCam.rst.txt deleted file mode 100644 index bd5ffdc387..0000000000 --- a/ophyd/_sources/generated/ophyd.areadetector.cam.AndorDetectorCam.rst.txt +++ /dev/null @@ -1,57 +0,0 @@ -ophyd\.areadetector\.cam\.AndorDetectorCam -========================================== - -.. currentmodule:: ophyd.areadetector.cam - -.. autoclass:: AndorDetectorCam - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~AndorDetectorCam.__init__ - ~AndorDetectorCam.add_instantiation_callback - ~AndorDetectorCam.check_value - ~AndorDetectorCam.clear_sub - ~AndorDetectorCam.configure - ~AndorDetectorCam.describe - ~AndorDetectorCam.describe_configuration - ~AndorDetectorCam.destroy - ~AndorDetectorCam.find_signal - ~AndorDetectorCam.get - ~AndorDetectorCam.get_asyn_digraph - ~AndorDetectorCam.get_asyn_port_dictionary - ~AndorDetectorCam.get_device_tuple - ~AndorDetectorCam.get_instantiated_signals - ~AndorDetectorCam.get_plugin_by_asyn_port - ~AndorDetectorCam.missing_plugins - ~AndorDetectorCam.pause - ~AndorDetectorCam.put - ~AndorDetectorCam.read - ~AndorDetectorCam.read_configuration - ~AndorDetectorCam.resume - ~AndorDetectorCam.stage - ~AndorDetectorCam.stop - ~AndorDetectorCam.subscribe - ~AndorDetectorCam.summary - ~AndorDetectorCam.trigger - ~AndorDetectorCam.unstage - ~AndorDetectorCam.unsubscribe - ~AndorDetectorCam.unsubscribe_all - ~AndorDetectorCam.validate_asyn_ports - ~AndorDetectorCam.visualize_asyn_digraph - ~AndorDetectorCam.wait_for_connection - ~AndorDetectorCam.walk_components - ~AndorDetectorCam.walk_signals - ~AndorDetectorCam.walk_subdevice_classes - ~AndorDetectorCam.walk_subdevices - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/generated/ophyd.areadetector.cam.BrukerDetectorCam.rst.txt b/ophyd/_sources/generated/ophyd.areadetector.cam.BrukerDetectorCam.rst.txt deleted file mode 100644 index 9ef81211d8..0000000000 --- a/ophyd/_sources/generated/ophyd.areadetector.cam.BrukerDetectorCam.rst.txt +++ /dev/null @@ -1,57 +0,0 @@ -ophyd\.areadetector\.cam\.BrukerDetectorCam -=========================================== - -.. currentmodule:: ophyd.areadetector.cam - -.. autoclass:: BrukerDetectorCam - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~BrukerDetectorCam.__init__ - ~BrukerDetectorCam.add_instantiation_callback - ~BrukerDetectorCam.check_value - ~BrukerDetectorCam.clear_sub - ~BrukerDetectorCam.configure - ~BrukerDetectorCam.describe - ~BrukerDetectorCam.describe_configuration - ~BrukerDetectorCam.destroy - ~BrukerDetectorCam.find_signal - ~BrukerDetectorCam.get - ~BrukerDetectorCam.get_asyn_digraph - ~BrukerDetectorCam.get_asyn_port_dictionary - ~BrukerDetectorCam.get_device_tuple - ~BrukerDetectorCam.get_instantiated_signals - ~BrukerDetectorCam.get_plugin_by_asyn_port - ~BrukerDetectorCam.missing_plugins - ~BrukerDetectorCam.pause - ~BrukerDetectorCam.put - ~BrukerDetectorCam.read - ~BrukerDetectorCam.read_configuration - ~BrukerDetectorCam.resume - ~BrukerDetectorCam.stage - ~BrukerDetectorCam.stop - ~BrukerDetectorCam.subscribe - ~BrukerDetectorCam.summary - ~BrukerDetectorCam.trigger - ~BrukerDetectorCam.unstage - ~BrukerDetectorCam.unsubscribe - ~BrukerDetectorCam.unsubscribe_all - ~BrukerDetectorCam.validate_asyn_ports - ~BrukerDetectorCam.visualize_asyn_digraph - ~BrukerDetectorCam.wait_for_connection - ~BrukerDetectorCam.walk_components - ~BrukerDetectorCam.walk_signals - ~BrukerDetectorCam.walk_subdevice_classes - ~BrukerDetectorCam.walk_subdevices - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/generated/ophyd.areadetector.cam.CamBase.rst.txt b/ophyd/_sources/generated/ophyd.areadetector.cam.CamBase.rst.txt deleted file mode 100644 index d01f4f108d..0000000000 --- a/ophyd/_sources/generated/ophyd.areadetector.cam.CamBase.rst.txt +++ /dev/null @@ -1,57 +0,0 @@ -ophyd\.areadetector\.cam\.CamBase -================================= - -.. currentmodule:: ophyd.areadetector.cam - -.. autoclass:: CamBase - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~CamBase.__init__ - ~CamBase.add_instantiation_callback - ~CamBase.check_value - ~CamBase.clear_sub - ~CamBase.configure - ~CamBase.describe - ~CamBase.describe_configuration - ~CamBase.destroy - ~CamBase.find_signal - ~CamBase.get - ~CamBase.get_asyn_digraph - ~CamBase.get_asyn_port_dictionary - ~CamBase.get_device_tuple - ~CamBase.get_instantiated_signals - ~CamBase.get_plugin_by_asyn_port - ~CamBase.missing_plugins - ~CamBase.pause - ~CamBase.put - ~CamBase.read - ~CamBase.read_configuration - ~CamBase.resume - ~CamBase.stage - ~CamBase.stop - ~CamBase.subscribe - ~CamBase.summary - ~CamBase.trigger - ~CamBase.unstage - ~CamBase.unsubscribe - ~CamBase.unsubscribe_all - ~CamBase.validate_asyn_ports - ~CamBase.visualize_asyn_digraph - ~CamBase.wait_for_connection - ~CamBase.walk_components - ~CamBase.walk_signals - ~CamBase.walk_subdevice_classes - ~CamBase.walk_subdevices - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/generated/ophyd.areadetector.cam.FirewireLinDetectorCam.rst.txt b/ophyd/_sources/generated/ophyd.areadetector.cam.FirewireLinDetectorCam.rst.txt deleted file mode 100644 index 0527625e9a..0000000000 --- a/ophyd/_sources/generated/ophyd.areadetector.cam.FirewireLinDetectorCam.rst.txt +++ /dev/null @@ -1,57 +0,0 @@ -ophyd\.areadetector\.cam\.FirewireLinDetectorCam -================================================ - -.. currentmodule:: ophyd.areadetector.cam - -.. autoclass:: FirewireLinDetectorCam - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~FirewireLinDetectorCam.__init__ - ~FirewireLinDetectorCam.add_instantiation_callback - ~FirewireLinDetectorCam.check_value - ~FirewireLinDetectorCam.clear_sub - ~FirewireLinDetectorCam.configure - ~FirewireLinDetectorCam.describe - ~FirewireLinDetectorCam.describe_configuration - ~FirewireLinDetectorCam.destroy - ~FirewireLinDetectorCam.find_signal - ~FirewireLinDetectorCam.get - ~FirewireLinDetectorCam.get_asyn_digraph - ~FirewireLinDetectorCam.get_asyn_port_dictionary - ~FirewireLinDetectorCam.get_device_tuple - ~FirewireLinDetectorCam.get_instantiated_signals - ~FirewireLinDetectorCam.get_plugin_by_asyn_port - ~FirewireLinDetectorCam.missing_plugins - ~FirewireLinDetectorCam.pause - ~FirewireLinDetectorCam.put - ~FirewireLinDetectorCam.read - ~FirewireLinDetectorCam.read_configuration - ~FirewireLinDetectorCam.resume - ~FirewireLinDetectorCam.stage - ~FirewireLinDetectorCam.stop - ~FirewireLinDetectorCam.subscribe - ~FirewireLinDetectorCam.summary - ~FirewireLinDetectorCam.trigger - ~FirewireLinDetectorCam.unstage - ~FirewireLinDetectorCam.unsubscribe - ~FirewireLinDetectorCam.unsubscribe_all - ~FirewireLinDetectorCam.validate_asyn_ports - ~FirewireLinDetectorCam.visualize_asyn_digraph - ~FirewireLinDetectorCam.wait_for_connection - ~FirewireLinDetectorCam.walk_components - ~FirewireLinDetectorCam.walk_signals - ~FirewireLinDetectorCam.walk_subdevice_classes - ~FirewireLinDetectorCam.walk_subdevices - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/generated/ophyd.areadetector.cam.FirewireWinDetectorCam.rst.txt b/ophyd/_sources/generated/ophyd.areadetector.cam.FirewireWinDetectorCam.rst.txt deleted file mode 100644 index e945ee4367..0000000000 --- a/ophyd/_sources/generated/ophyd.areadetector.cam.FirewireWinDetectorCam.rst.txt +++ /dev/null @@ -1,57 +0,0 @@ -ophyd\.areadetector\.cam\.FirewireWinDetectorCam -================================================ - -.. currentmodule:: ophyd.areadetector.cam - -.. autoclass:: FirewireWinDetectorCam - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~FirewireWinDetectorCam.__init__ - ~FirewireWinDetectorCam.add_instantiation_callback - ~FirewireWinDetectorCam.check_value - ~FirewireWinDetectorCam.clear_sub - ~FirewireWinDetectorCam.configure - ~FirewireWinDetectorCam.describe - ~FirewireWinDetectorCam.describe_configuration - ~FirewireWinDetectorCam.destroy - ~FirewireWinDetectorCam.find_signal - ~FirewireWinDetectorCam.get - ~FirewireWinDetectorCam.get_asyn_digraph - ~FirewireWinDetectorCam.get_asyn_port_dictionary - ~FirewireWinDetectorCam.get_device_tuple - ~FirewireWinDetectorCam.get_instantiated_signals - ~FirewireWinDetectorCam.get_plugin_by_asyn_port - ~FirewireWinDetectorCam.missing_plugins - ~FirewireWinDetectorCam.pause - ~FirewireWinDetectorCam.put - ~FirewireWinDetectorCam.read - ~FirewireWinDetectorCam.read_configuration - ~FirewireWinDetectorCam.resume - ~FirewireWinDetectorCam.stage - ~FirewireWinDetectorCam.stop - ~FirewireWinDetectorCam.subscribe - ~FirewireWinDetectorCam.summary - ~FirewireWinDetectorCam.trigger - ~FirewireWinDetectorCam.unstage - ~FirewireWinDetectorCam.unsubscribe - ~FirewireWinDetectorCam.unsubscribe_all - ~FirewireWinDetectorCam.validate_asyn_ports - ~FirewireWinDetectorCam.visualize_asyn_digraph - ~FirewireWinDetectorCam.wait_for_connection - ~FirewireWinDetectorCam.walk_components - ~FirewireWinDetectorCam.walk_signals - ~FirewireWinDetectorCam.walk_subdevice_classes - ~FirewireWinDetectorCam.walk_subdevices - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/generated/ophyd.areadetector.cam.LightFieldDetectorCam.rst.txt b/ophyd/_sources/generated/ophyd.areadetector.cam.LightFieldDetectorCam.rst.txt deleted file mode 100644 index 8e5b08127f..0000000000 --- a/ophyd/_sources/generated/ophyd.areadetector.cam.LightFieldDetectorCam.rst.txt +++ /dev/null @@ -1,57 +0,0 @@ -ophyd\.areadetector\.cam\.LightFieldDetectorCam -=============================================== - -.. currentmodule:: ophyd.areadetector.cam - -.. autoclass:: LightFieldDetectorCam - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~LightFieldDetectorCam.__init__ - ~LightFieldDetectorCam.add_instantiation_callback - ~LightFieldDetectorCam.check_value - ~LightFieldDetectorCam.clear_sub - ~LightFieldDetectorCam.configure - ~LightFieldDetectorCam.describe - ~LightFieldDetectorCam.describe_configuration - ~LightFieldDetectorCam.destroy - ~LightFieldDetectorCam.find_signal - ~LightFieldDetectorCam.get - ~LightFieldDetectorCam.get_asyn_digraph - ~LightFieldDetectorCam.get_asyn_port_dictionary - ~LightFieldDetectorCam.get_device_tuple - ~LightFieldDetectorCam.get_instantiated_signals - ~LightFieldDetectorCam.get_plugin_by_asyn_port - ~LightFieldDetectorCam.missing_plugins - ~LightFieldDetectorCam.pause - ~LightFieldDetectorCam.put - ~LightFieldDetectorCam.read - ~LightFieldDetectorCam.read_configuration - ~LightFieldDetectorCam.resume - ~LightFieldDetectorCam.stage - ~LightFieldDetectorCam.stop - ~LightFieldDetectorCam.subscribe - ~LightFieldDetectorCam.summary - ~LightFieldDetectorCam.trigger - ~LightFieldDetectorCam.unstage - ~LightFieldDetectorCam.unsubscribe - ~LightFieldDetectorCam.unsubscribe_all - ~LightFieldDetectorCam.validate_asyn_ports - ~LightFieldDetectorCam.visualize_asyn_digraph - ~LightFieldDetectorCam.wait_for_connection - ~LightFieldDetectorCam.walk_components - ~LightFieldDetectorCam.walk_signals - ~LightFieldDetectorCam.walk_subdevice_classes - ~LightFieldDetectorCam.walk_subdevices - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/generated/ophyd.areadetector.cam.Mar345DetectorCam.rst.txt b/ophyd/_sources/generated/ophyd.areadetector.cam.Mar345DetectorCam.rst.txt deleted file mode 100644 index 5df93887ec..0000000000 --- a/ophyd/_sources/generated/ophyd.areadetector.cam.Mar345DetectorCam.rst.txt +++ /dev/null @@ -1,57 +0,0 @@ -ophyd\.areadetector\.cam\.Mar345DetectorCam -=========================================== - -.. currentmodule:: ophyd.areadetector.cam - -.. autoclass:: Mar345DetectorCam - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~Mar345DetectorCam.__init__ - ~Mar345DetectorCam.add_instantiation_callback - ~Mar345DetectorCam.check_value - ~Mar345DetectorCam.clear_sub - ~Mar345DetectorCam.configure - ~Mar345DetectorCam.describe - ~Mar345DetectorCam.describe_configuration - ~Mar345DetectorCam.destroy - ~Mar345DetectorCam.find_signal - ~Mar345DetectorCam.get - ~Mar345DetectorCam.get_asyn_digraph - ~Mar345DetectorCam.get_asyn_port_dictionary - ~Mar345DetectorCam.get_device_tuple - ~Mar345DetectorCam.get_instantiated_signals - ~Mar345DetectorCam.get_plugin_by_asyn_port - ~Mar345DetectorCam.missing_plugins - ~Mar345DetectorCam.pause - ~Mar345DetectorCam.put - ~Mar345DetectorCam.read - ~Mar345DetectorCam.read_configuration - ~Mar345DetectorCam.resume - ~Mar345DetectorCam.stage - ~Mar345DetectorCam.stop - ~Mar345DetectorCam.subscribe - ~Mar345DetectorCam.summary - ~Mar345DetectorCam.trigger - ~Mar345DetectorCam.unstage - ~Mar345DetectorCam.unsubscribe - ~Mar345DetectorCam.unsubscribe_all - ~Mar345DetectorCam.validate_asyn_ports - ~Mar345DetectorCam.visualize_asyn_digraph - ~Mar345DetectorCam.wait_for_connection - ~Mar345DetectorCam.walk_components - ~Mar345DetectorCam.walk_signals - ~Mar345DetectorCam.walk_subdevice_classes - ~Mar345DetectorCam.walk_subdevices - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/generated/ophyd.areadetector.cam.MarCCDDetectorCam.rst.txt b/ophyd/_sources/generated/ophyd.areadetector.cam.MarCCDDetectorCam.rst.txt deleted file mode 100644 index bc4f8204d3..0000000000 --- a/ophyd/_sources/generated/ophyd.areadetector.cam.MarCCDDetectorCam.rst.txt +++ /dev/null @@ -1,57 +0,0 @@ -ophyd\.areadetector\.cam\.MarCCDDetectorCam -=========================================== - -.. currentmodule:: ophyd.areadetector.cam - -.. autoclass:: MarCCDDetectorCam - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~MarCCDDetectorCam.__init__ - ~MarCCDDetectorCam.add_instantiation_callback - ~MarCCDDetectorCam.check_value - ~MarCCDDetectorCam.clear_sub - ~MarCCDDetectorCam.configure - ~MarCCDDetectorCam.describe - ~MarCCDDetectorCam.describe_configuration - ~MarCCDDetectorCam.destroy - ~MarCCDDetectorCam.find_signal - ~MarCCDDetectorCam.get - ~MarCCDDetectorCam.get_asyn_digraph - ~MarCCDDetectorCam.get_asyn_port_dictionary - ~MarCCDDetectorCam.get_device_tuple - ~MarCCDDetectorCam.get_instantiated_signals - ~MarCCDDetectorCam.get_plugin_by_asyn_port - ~MarCCDDetectorCam.missing_plugins - ~MarCCDDetectorCam.pause - ~MarCCDDetectorCam.put - ~MarCCDDetectorCam.read - ~MarCCDDetectorCam.read_configuration - ~MarCCDDetectorCam.resume - ~MarCCDDetectorCam.stage - ~MarCCDDetectorCam.stop - ~MarCCDDetectorCam.subscribe - ~MarCCDDetectorCam.summary - ~MarCCDDetectorCam.trigger - ~MarCCDDetectorCam.unstage - ~MarCCDDetectorCam.unsubscribe - ~MarCCDDetectorCam.unsubscribe_all - ~MarCCDDetectorCam.validate_asyn_ports - ~MarCCDDetectorCam.visualize_asyn_digraph - ~MarCCDDetectorCam.wait_for_connection - ~MarCCDDetectorCam.walk_components - ~MarCCDDetectorCam.walk_signals - ~MarCCDDetectorCam.walk_subdevice_classes - ~MarCCDDetectorCam.walk_subdevices - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/generated/ophyd.areadetector.cam.PSLDetectorCam.rst.txt b/ophyd/_sources/generated/ophyd.areadetector.cam.PSLDetectorCam.rst.txt deleted file mode 100644 index 5dad9a1d96..0000000000 --- a/ophyd/_sources/generated/ophyd.areadetector.cam.PSLDetectorCam.rst.txt +++ /dev/null @@ -1,57 +0,0 @@ -ophyd\.areadetector\.cam\.PSLDetectorCam -======================================== - -.. currentmodule:: ophyd.areadetector.cam - -.. autoclass:: PSLDetectorCam - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~PSLDetectorCam.__init__ - ~PSLDetectorCam.add_instantiation_callback - ~PSLDetectorCam.check_value - ~PSLDetectorCam.clear_sub - ~PSLDetectorCam.configure - ~PSLDetectorCam.describe - ~PSLDetectorCam.describe_configuration - ~PSLDetectorCam.destroy - ~PSLDetectorCam.find_signal - ~PSLDetectorCam.get - ~PSLDetectorCam.get_asyn_digraph - ~PSLDetectorCam.get_asyn_port_dictionary - ~PSLDetectorCam.get_device_tuple - ~PSLDetectorCam.get_instantiated_signals - ~PSLDetectorCam.get_plugin_by_asyn_port - ~PSLDetectorCam.missing_plugins - ~PSLDetectorCam.pause - ~PSLDetectorCam.put - ~PSLDetectorCam.read - ~PSLDetectorCam.read_configuration - ~PSLDetectorCam.resume - ~PSLDetectorCam.stage - ~PSLDetectorCam.stop - ~PSLDetectorCam.subscribe - ~PSLDetectorCam.summary - ~PSLDetectorCam.trigger - ~PSLDetectorCam.unstage - ~PSLDetectorCam.unsubscribe - ~PSLDetectorCam.unsubscribe_all - ~PSLDetectorCam.validate_asyn_ports - ~PSLDetectorCam.visualize_asyn_digraph - ~PSLDetectorCam.wait_for_connection - ~PSLDetectorCam.walk_components - ~PSLDetectorCam.walk_signals - ~PSLDetectorCam.walk_subdevice_classes - ~PSLDetectorCam.walk_subdevices - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/generated/ophyd.areadetector.cam.PcoDetectorCam.rst.txt b/ophyd/_sources/generated/ophyd.areadetector.cam.PcoDetectorCam.rst.txt deleted file mode 100644 index 438d755862..0000000000 --- a/ophyd/_sources/generated/ophyd.areadetector.cam.PcoDetectorCam.rst.txt +++ /dev/null @@ -1,57 +0,0 @@ -ophyd\.areadetector\.cam\.PcoDetectorCam -======================================== - -.. currentmodule:: ophyd.areadetector.cam - -.. autoclass:: PcoDetectorCam - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~PcoDetectorCam.__init__ - ~PcoDetectorCam.add_instantiation_callback - ~PcoDetectorCam.check_value - ~PcoDetectorCam.clear_sub - ~PcoDetectorCam.configure - ~PcoDetectorCam.describe - ~PcoDetectorCam.describe_configuration - ~PcoDetectorCam.destroy - ~PcoDetectorCam.find_signal - ~PcoDetectorCam.get - ~PcoDetectorCam.get_asyn_digraph - ~PcoDetectorCam.get_asyn_port_dictionary - ~PcoDetectorCam.get_device_tuple - ~PcoDetectorCam.get_instantiated_signals - ~PcoDetectorCam.get_plugin_by_asyn_port - ~PcoDetectorCam.missing_plugins - ~PcoDetectorCam.pause - ~PcoDetectorCam.put - ~PcoDetectorCam.read - ~PcoDetectorCam.read_configuration - ~PcoDetectorCam.resume - ~PcoDetectorCam.stage - ~PcoDetectorCam.stop - ~PcoDetectorCam.subscribe - ~PcoDetectorCam.summary - ~PcoDetectorCam.trigger - ~PcoDetectorCam.unstage - ~PcoDetectorCam.unsubscribe - ~PcoDetectorCam.unsubscribe_all - ~PcoDetectorCam.validate_asyn_ports - ~PcoDetectorCam.visualize_asyn_digraph - ~PcoDetectorCam.wait_for_connection - ~PcoDetectorCam.walk_components - ~PcoDetectorCam.walk_signals - ~PcoDetectorCam.walk_subdevice_classes - ~PcoDetectorCam.walk_subdevices - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/generated/ophyd.areadetector.cam.PcoDetectorIO.rst.txt b/ophyd/_sources/generated/ophyd.areadetector.cam.PcoDetectorIO.rst.txt deleted file mode 100644 index c4845e1fd9..0000000000 --- a/ophyd/_sources/generated/ophyd.areadetector.cam.PcoDetectorIO.rst.txt +++ /dev/null @@ -1,57 +0,0 @@ -ophyd\.areadetector\.cam\.PcoDetectorIO -======================================= - -.. currentmodule:: ophyd.areadetector.cam - -.. autoclass:: PcoDetectorIO - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~PcoDetectorIO.__init__ - ~PcoDetectorIO.add_instantiation_callback - ~PcoDetectorIO.check_value - ~PcoDetectorIO.clear_sub - ~PcoDetectorIO.configure - ~PcoDetectorIO.describe - ~PcoDetectorIO.describe_configuration - ~PcoDetectorIO.destroy - ~PcoDetectorIO.find_signal - ~PcoDetectorIO.get - ~PcoDetectorIO.get_asyn_digraph - ~PcoDetectorIO.get_asyn_port_dictionary - ~PcoDetectorIO.get_device_tuple - ~PcoDetectorIO.get_instantiated_signals - ~PcoDetectorIO.get_plugin_by_asyn_port - ~PcoDetectorIO.missing_plugins - ~PcoDetectorIO.pause - ~PcoDetectorIO.put - ~PcoDetectorIO.read - ~PcoDetectorIO.read_configuration - ~PcoDetectorIO.resume - ~PcoDetectorIO.stage - ~PcoDetectorIO.stop - ~PcoDetectorIO.subscribe - ~PcoDetectorIO.summary - ~PcoDetectorIO.trigger - ~PcoDetectorIO.unstage - ~PcoDetectorIO.unsubscribe - ~PcoDetectorIO.unsubscribe_all - ~PcoDetectorIO.validate_asyn_ports - ~PcoDetectorIO.visualize_asyn_digraph - ~PcoDetectorIO.wait_for_connection - ~PcoDetectorIO.walk_components - ~PcoDetectorIO.walk_signals - ~PcoDetectorIO.walk_subdevice_classes - ~PcoDetectorIO.walk_subdevices - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/generated/ophyd.areadetector.cam.PcoDetectorSimIO.rst.txt b/ophyd/_sources/generated/ophyd.areadetector.cam.PcoDetectorSimIO.rst.txt deleted file mode 100644 index 0394d02132..0000000000 --- a/ophyd/_sources/generated/ophyd.areadetector.cam.PcoDetectorSimIO.rst.txt +++ /dev/null @@ -1,57 +0,0 @@ -ophyd\.areadetector\.cam\.PcoDetectorSimIO -========================================== - -.. currentmodule:: ophyd.areadetector.cam - -.. autoclass:: PcoDetectorSimIO - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~PcoDetectorSimIO.__init__ - ~PcoDetectorSimIO.add_instantiation_callback - ~PcoDetectorSimIO.check_value - ~PcoDetectorSimIO.clear_sub - ~PcoDetectorSimIO.configure - ~PcoDetectorSimIO.describe - ~PcoDetectorSimIO.describe_configuration - ~PcoDetectorSimIO.destroy - ~PcoDetectorSimIO.find_signal - ~PcoDetectorSimIO.get - ~PcoDetectorSimIO.get_asyn_digraph - ~PcoDetectorSimIO.get_asyn_port_dictionary - ~PcoDetectorSimIO.get_device_tuple - ~PcoDetectorSimIO.get_instantiated_signals - ~PcoDetectorSimIO.get_plugin_by_asyn_port - ~PcoDetectorSimIO.missing_plugins - ~PcoDetectorSimIO.pause - ~PcoDetectorSimIO.put - ~PcoDetectorSimIO.read - ~PcoDetectorSimIO.read_configuration - ~PcoDetectorSimIO.resume - ~PcoDetectorSimIO.stage - ~PcoDetectorSimIO.stop - ~PcoDetectorSimIO.subscribe - ~PcoDetectorSimIO.summary - ~PcoDetectorSimIO.trigger - ~PcoDetectorSimIO.unstage - ~PcoDetectorSimIO.unsubscribe - ~PcoDetectorSimIO.unsubscribe_all - ~PcoDetectorSimIO.validate_asyn_ports - ~PcoDetectorSimIO.visualize_asyn_digraph - ~PcoDetectorSimIO.wait_for_connection - ~PcoDetectorSimIO.walk_components - ~PcoDetectorSimIO.walk_signals - ~PcoDetectorSimIO.walk_subdevice_classes - ~PcoDetectorSimIO.walk_subdevices - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/generated/ophyd.areadetector.cam.PerkinElmerDetectorCam.rst.txt b/ophyd/_sources/generated/ophyd.areadetector.cam.PerkinElmerDetectorCam.rst.txt deleted file mode 100644 index 96aabbafb9..0000000000 --- a/ophyd/_sources/generated/ophyd.areadetector.cam.PerkinElmerDetectorCam.rst.txt +++ /dev/null @@ -1,57 +0,0 @@ -ophyd\.areadetector\.cam\.PerkinElmerDetectorCam -================================================ - -.. currentmodule:: ophyd.areadetector.cam - -.. autoclass:: PerkinElmerDetectorCam - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~PerkinElmerDetectorCam.__init__ - ~PerkinElmerDetectorCam.add_instantiation_callback - ~PerkinElmerDetectorCam.check_value - ~PerkinElmerDetectorCam.clear_sub - ~PerkinElmerDetectorCam.configure - ~PerkinElmerDetectorCam.describe - ~PerkinElmerDetectorCam.describe_configuration - ~PerkinElmerDetectorCam.destroy - ~PerkinElmerDetectorCam.find_signal - ~PerkinElmerDetectorCam.get - ~PerkinElmerDetectorCam.get_asyn_digraph - ~PerkinElmerDetectorCam.get_asyn_port_dictionary - ~PerkinElmerDetectorCam.get_device_tuple - ~PerkinElmerDetectorCam.get_instantiated_signals - ~PerkinElmerDetectorCam.get_plugin_by_asyn_port - ~PerkinElmerDetectorCam.missing_plugins - ~PerkinElmerDetectorCam.pause - ~PerkinElmerDetectorCam.put - ~PerkinElmerDetectorCam.read - ~PerkinElmerDetectorCam.read_configuration - ~PerkinElmerDetectorCam.resume - ~PerkinElmerDetectorCam.stage - ~PerkinElmerDetectorCam.stop - ~PerkinElmerDetectorCam.subscribe - ~PerkinElmerDetectorCam.summary - ~PerkinElmerDetectorCam.trigger - ~PerkinElmerDetectorCam.unstage - ~PerkinElmerDetectorCam.unsubscribe - ~PerkinElmerDetectorCam.unsubscribe_all - ~PerkinElmerDetectorCam.validate_asyn_ports - ~PerkinElmerDetectorCam.visualize_asyn_digraph - ~PerkinElmerDetectorCam.wait_for_connection - ~PerkinElmerDetectorCam.walk_components - ~PerkinElmerDetectorCam.walk_signals - ~PerkinElmerDetectorCam.walk_subdevice_classes - ~PerkinElmerDetectorCam.walk_subdevices - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/generated/ophyd.areadetector.cam.PilatusDetectorCam.rst.txt b/ophyd/_sources/generated/ophyd.areadetector.cam.PilatusDetectorCam.rst.txt deleted file mode 100644 index 751d3d1c3b..0000000000 --- a/ophyd/_sources/generated/ophyd.areadetector.cam.PilatusDetectorCam.rst.txt +++ /dev/null @@ -1,57 +0,0 @@ -ophyd\.areadetector\.cam\.PilatusDetectorCam -============================================ - -.. currentmodule:: ophyd.areadetector.cam - -.. autoclass:: PilatusDetectorCam - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~PilatusDetectorCam.__init__ - ~PilatusDetectorCam.add_instantiation_callback - ~PilatusDetectorCam.check_value - ~PilatusDetectorCam.clear_sub - ~PilatusDetectorCam.configure - ~PilatusDetectorCam.describe - ~PilatusDetectorCam.describe_configuration - ~PilatusDetectorCam.destroy - ~PilatusDetectorCam.find_signal - ~PilatusDetectorCam.get - ~PilatusDetectorCam.get_asyn_digraph - ~PilatusDetectorCam.get_asyn_port_dictionary - ~PilatusDetectorCam.get_device_tuple - ~PilatusDetectorCam.get_instantiated_signals - ~PilatusDetectorCam.get_plugin_by_asyn_port - ~PilatusDetectorCam.missing_plugins - ~PilatusDetectorCam.pause - ~PilatusDetectorCam.put - ~PilatusDetectorCam.read - ~PilatusDetectorCam.read_configuration - ~PilatusDetectorCam.resume - ~PilatusDetectorCam.stage - ~PilatusDetectorCam.stop - ~PilatusDetectorCam.subscribe - ~PilatusDetectorCam.summary - ~PilatusDetectorCam.trigger - ~PilatusDetectorCam.unstage - ~PilatusDetectorCam.unsubscribe - ~PilatusDetectorCam.unsubscribe_all - ~PilatusDetectorCam.validate_asyn_ports - ~PilatusDetectorCam.visualize_asyn_digraph - ~PilatusDetectorCam.wait_for_connection - ~PilatusDetectorCam.walk_components - ~PilatusDetectorCam.walk_signals - ~PilatusDetectorCam.walk_subdevice_classes - ~PilatusDetectorCam.walk_subdevices - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/generated/ophyd.areadetector.cam.PixiradDetectorCam.rst.txt b/ophyd/_sources/generated/ophyd.areadetector.cam.PixiradDetectorCam.rst.txt deleted file mode 100644 index 9b2fa146ac..0000000000 --- a/ophyd/_sources/generated/ophyd.areadetector.cam.PixiradDetectorCam.rst.txt +++ /dev/null @@ -1,57 +0,0 @@ -ophyd\.areadetector\.cam\.PixiradDetectorCam -============================================ - -.. currentmodule:: ophyd.areadetector.cam - -.. autoclass:: PixiradDetectorCam - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~PixiradDetectorCam.__init__ - ~PixiradDetectorCam.add_instantiation_callback - ~PixiradDetectorCam.check_value - ~PixiradDetectorCam.clear_sub - ~PixiradDetectorCam.configure - ~PixiradDetectorCam.describe - ~PixiradDetectorCam.describe_configuration - ~PixiradDetectorCam.destroy - ~PixiradDetectorCam.find_signal - ~PixiradDetectorCam.get - ~PixiradDetectorCam.get_asyn_digraph - ~PixiradDetectorCam.get_asyn_port_dictionary - ~PixiradDetectorCam.get_device_tuple - ~PixiradDetectorCam.get_instantiated_signals - ~PixiradDetectorCam.get_plugin_by_asyn_port - ~PixiradDetectorCam.missing_plugins - ~PixiradDetectorCam.pause - ~PixiradDetectorCam.put - ~PixiradDetectorCam.read - ~PixiradDetectorCam.read_configuration - ~PixiradDetectorCam.resume - ~PixiradDetectorCam.stage - ~PixiradDetectorCam.stop - ~PixiradDetectorCam.subscribe - ~PixiradDetectorCam.summary - ~PixiradDetectorCam.trigger - ~PixiradDetectorCam.unstage - ~PixiradDetectorCam.unsubscribe - ~PixiradDetectorCam.unsubscribe_all - ~PixiradDetectorCam.validate_asyn_ports - ~PixiradDetectorCam.visualize_asyn_digraph - ~PixiradDetectorCam.wait_for_connection - ~PixiradDetectorCam.walk_components - ~PixiradDetectorCam.walk_signals - ~PixiradDetectorCam.walk_subdevice_classes - ~PixiradDetectorCam.walk_subdevices - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/generated/ophyd.areadetector.cam.PointGreyDetectorCam.rst.txt b/ophyd/_sources/generated/ophyd.areadetector.cam.PointGreyDetectorCam.rst.txt deleted file mode 100644 index 1abb1d0515..0000000000 --- a/ophyd/_sources/generated/ophyd.areadetector.cam.PointGreyDetectorCam.rst.txt +++ /dev/null @@ -1,57 +0,0 @@ -ophyd\.areadetector\.cam\.PointGreyDetectorCam -============================================== - -.. currentmodule:: ophyd.areadetector.cam - -.. autoclass:: PointGreyDetectorCam - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~PointGreyDetectorCam.__init__ - ~PointGreyDetectorCam.add_instantiation_callback - ~PointGreyDetectorCam.check_value - ~PointGreyDetectorCam.clear_sub - ~PointGreyDetectorCam.configure - ~PointGreyDetectorCam.describe - ~PointGreyDetectorCam.describe_configuration - ~PointGreyDetectorCam.destroy - ~PointGreyDetectorCam.find_signal - ~PointGreyDetectorCam.get - ~PointGreyDetectorCam.get_asyn_digraph - ~PointGreyDetectorCam.get_asyn_port_dictionary - ~PointGreyDetectorCam.get_device_tuple - ~PointGreyDetectorCam.get_instantiated_signals - ~PointGreyDetectorCam.get_plugin_by_asyn_port - ~PointGreyDetectorCam.missing_plugins - ~PointGreyDetectorCam.pause - ~PointGreyDetectorCam.put - ~PointGreyDetectorCam.read - ~PointGreyDetectorCam.read_configuration - ~PointGreyDetectorCam.resume - ~PointGreyDetectorCam.stage - ~PointGreyDetectorCam.stop - ~PointGreyDetectorCam.subscribe - ~PointGreyDetectorCam.summary - ~PointGreyDetectorCam.trigger - ~PointGreyDetectorCam.unstage - ~PointGreyDetectorCam.unsubscribe - ~PointGreyDetectorCam.unsubscribe_all - ~PointGreyDetectorCam.validate_asyn_ports - ~PointGreyDetectorCam.visualize_asyn_digraph - ~PointGreyDetectorCam.wait_for_connection - ~PointGreyDetectorCam.walk_components - ~PointGreyDetectorCam.walk_signals - ~PointGreyDetectorCam.walk_subdevice_classes - ~PointGreyDetectorCam.walk_subdevices - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/generated/ophyd.areadetector.cam.ProsilicaDetectorCam.rst.txt b/ophyd/_sources/generated/ophyd.areadetector.cam.ProsilicaDetectorCam.rst.txt deleted file mode 100644 index 0e3396fe56..0000000000 --- a/ophyd/_sources/generated/ophyd.areadetector.cam.ProsilicaDetectorCam.rst.txt +++ /dev/null @@ -1,57 +0,0 @@ -ophyd\.areadetector\.cam\.ProsilicaDetectorCam -============================================== - -.. currentmodule:: ophyd.areadetector.cam - -.. autoclass:: ProsilicaDetectorCam - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~ProsilicaDetectorCam.__init__ - ~ProsilicaDetectorCam.add_instantiation_callback - ~ProsilicaDetectorCam.check_value - ~ProsilicaDetectorCam.clear_sub - ~ProsilicaDetectorCam.configure - ~ProsilicaDetectorCam.describe - ~ProsilicaDetectorCam.describe_configuration - ~ProsilicaDetectorCam.destroy - ~ProsilicaDetectorCam.find_signal - ~ProsilicaDetectorCam.get - ~ProsilicaDetectorCam.get_asyn_digraph - ~ProsilicaDetectorCam.get_asyn_port_dictionary - ~ProsilicaDetectorCam.get_device_tuple - ~ProsilicaDetectorCam.get_instantiated_signals - ~ProsilicaDetectorCam.get_plugin_by_asyn_port - ~ProsilicaDetectorCam.missing_plugins - ~ProsilicaDetectorCam.pause - ~ProsilicaDetectorCam.put - ~ProsilicaDetectorCam.read - ~ProsilicaDetectorCam.read_configuration - ~ProsilicaDetectorCam.resume - ~ProsilicaDetectorCam.stage - ~ProsilicaDetectorCam.stop - ~ProsilicaDetectorCam.subscribe - ~ProsilicaDetectorCam.summary - ~ProsilicaDetectorCam.trigger - ~ProsilicaDetectorCam.unstage - ~ProsilicaDetectorCam.unsubscribe - ~ProsilicaDetectorCam.unsubscribe_all - ~ProsilicaDetectorCam.validate_asyn_ports - ~ProsilicaDetectorCam.visualize_asyn_digraph - ~ProsilicaDetectorCam.wait_for_connection - ~ProsilicaDetectorCam.walk_components - ~ProsilicaDetectorCam.walk_signals - ~ProsilicaDetectorCam.walk_subdevice_classes - ~ProsilicaDetectorCam.walk_subdevices - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/generated/ophyd.areadetector.cam.PvcamDetectorCam.rst.txt b/ophyd/_sources/generated/ophyd.areadetector.cam.PvcamDetectorCam.rst.txt deleted file mode 100644 index 9a52f527be..0000000000 --- a/ophyd/_sources/generated/ophyd.areadetector.cam.PvcamDetectorCam.rst.txt +++ /dev/null @@ -1,57 +0,0 @@ -ophyd\.areadetector\.cam\.PvcamDetectorCam -========================================== - -.. currentmodule:: ophyd.areadetector.cam - -.. autoclass:: PvcamDetectorCam - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~PvcamDetectorCam.__init__ - ~PvcamDetectorCam.add_instantiation_callback - ~PvcamDetectorCam.check_value - ~PvcamDetectorCam.clear_sub - ~PvcamDetectorCam.configure - ~PvcamDetectorCam.describe - ~PvcamDetectorCam.describe_configuration - ~PvcamDetectorCam.destroy - ~PvcamDetectorCam.find_signal - ~PvcamDetectorCam.get - ~PvcamDetectorCam.get_asyn_digraph - ~PvcamDetectorCam.get_asyn_port_dictionary - ~PvcamDetectorCam.get_device_tuple - ~PvcamDetectorCam.get_instantiated_signals - ~PvcamDetectorCam.get_plugin_by_asyn_port - ~PvcamDetectorCam.missing_plugins - ~PvcamDetectorCam.pause - ~PvcamDetectorCam.put - ~PvcamDetectorCam.read - ~PvcamDetectorCam.read_configuration - ~PvcamDetectorCam.resume - ~PvcamDetectorCam.stage - ~PvcamDetectorCam.stop - ~PvcamDetectorCam.subscribe - ~PvcamDetectorCam.summary - ~PvcamDetectorCam.trigger - ~PvcamDetectorCam.unstage - ~PvcamDetectorCam.unsubscribe - ~PvcamDetectorCam.unsubscribe_all - ~PvcamDetectorCam.validate_asyn_ports - ~PvcamDetectorCam.visualize_asyn_digraph - ~PvcamDetectorCam.wait_for_connection - ~PvcamDetectorCam.walk_components - ~PvcamDetectorCam.walk_signals - ~PvcamDetectorCam.walk_subdevice_classes - ~PvcamDetectorCam.walk_subdevices - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/generated/ophyd.areadetector.cam.RoperDetectorCam.rst.txt b/ophyd/_sources/generated/ophyd.areadetector.cam.RoperDetectorCam.rst.txt deleted file mode 100644 index 3c9fd7f280..0000000000 --- a/ophyd/_sources/generated/ophyd.areadetector.cam.RoperDetectorCam.rst.txt +++ /dev/null @@ -1,57 +0,0 @@ -ophyd\.areadetector\.cam\.RoperDetectorCam -========================================== - -.. currentmodule:: ophyd.areadetector.cam - -.. autoclass:: RoperDetectorCam - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~RoperDetectorCam.__init__ - ~RoperDetectorCam.add_instantiation_callback - ~RoperDetectorCam.check_value - ~RoperDetectorCam.clear_sub - ~RoperDetectorCam.configure - ~RoperDetectorCam.describe - ~RoperDetectorCam.describe_configuration - ~RoperDetectorCam.destroy - ~RoperDetectorCam.find_signal - ~RoperDetectorCam.get - ~RoperDetectorCam.get_asyn_digraph - ~RoperDetectorCam.get_asyn_port_dictionary - ~RoperDetectorCam.get_device_tuple - ~RoperDetectorCam.get_instantiated_signals - ~RoperDetectorCam.get_plugin_by_asyn_port - ~RoperDetectorCam.missing_plugins - ~RoperDetectorCam.pause - ~RoperDetectorCam.put - ~RoperDetectorCam.read - ~RoperDetectorCam.read_configuration - ~RoperDetectorCam.resume - ~RoperDetectorCam.stage - ~RoperDetectorCam.stop - ~RoperDetectorCam.subscribe - ~RoperDetectorCam.summary - ~RoperDetectorCam.trigger - ~RoperDetectorCam.unstage - ~RoperDetectorCam.unsubscribe - ~RoperDetectorCam.unsubscribe_all - ~RoperDetectorCam.validate_asyn_ports - ~RoperDetectorCam.visualize_asyn_digraph - ~RoperDetectorCam.wait_for_connection - ~RoperDetectorCam.walk_components - ~RoperDetectorCam.walk_signals - ~RoperDetectorCam.walk_subdevice_classes - ~RoperDetectorCam.walk_subdevices - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/generated/ophyd.areadetector.cam.SimDetectorCam.rst.txt b/ophyd/_sources/generated/ophyd.areadetector.cam.SimDetectorCam.rst.txt deleted file mode 100644 index 0b11d08825..0000000000 --- a/ophyd/_sources/generated/ophyd.areadetector.cam.SimDetectorCam.rst.txt +++ /dev/null @@ -1,57 +0,0 @@ -ophyd\.areadetector\.cam\.SimDetectorCam -======================================== - -.. currentmodule:: ophyd.areadetector.cam - -.. autoclass:: SimDetectorCam - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~SimDetectorCam.__init__ - ~SimDetectorCam.add_instantiation_callback - ~SimDetectorCam.check_value - ~SimDetectorCam.clear_sub - ~SimDetectorCam.configure - ~SimDetectorCam.describe - ~SimDetectorCam.describe_configuration - ~SimDetectorCam.destroy - ~SimDetectorCam.find_signal - ~SimDetectorCam.get - ~SimDetectorCam.get_asyn_digraph - ~SimDetectorCam.get_asyn_port_dictionary - ~SimDetectorCam.get_device_tuple - ~SimDetectorCam.get_instantiated_signals - ~SimDetectorCam.get_plugin_by_asyn_port - ~SimDetectorCam.missing_plugins - ~SimDetectorCam.pause - ~SimDetectorCam.put - ~SimDetectorCam.read - ~SimDetectorCam.read_configuration - ~SimDetectorCam.resume - ~SimDetectorCam.stage - ~SimDetectorCam.stop - ~SimDetectorCam.subscribe - ~SimDetectorCam.summary - ~SimDetectorCam.trigger - ~SimDetectorCam.unstage - ~SimDetectorCam.unsubscribe - ~SimDetectorCam.unsubscribe_all - ~SimDetectorCam.validate_asyn_ports - ~SimDetectorCam.visualize_asyn_digraph - ~SimDetectorCam.wait_for_connection - ~SimDetectorCam.walk_components - ~SimDetectorCam.walk_signals - ~SimDetectorCam.walk_subdevice_classes - ~SimDetectorCam.walk_subdevices - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/generated/ophyd.areadetector.cam.URLDetectorCam.rst.txt b/ophyd/_sources/generated/ophyd.areadetector.cam.URLDetectorCam.rst.txt deleted file mode 100644 index c8ede6e734..0000000000 --- a/ophyd/_sources/generated/ophyd.areadetector.cam.URLDetectorCam.rst.txt +++ /dev/null @@ -1,57 +0,0 @@ -ophyd\.areadetector\.cam\.URLDetectorCam -======================================== - -.. currentmodule:: ophyd.areadetector.cam - -.. autoclass:: URLDetectorCam - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~URLDetectorCam.__init__ - ~URLDetectorCam.add_instantiation_callback - ~URLDetectorCam.check_value - ~URLDetectorCam.clear_sub - ~URLDetectorCam.configure - ~URLDetectorCam.describe - ~URLDetectorCam.describe_configuration - ~URLDetectorCam.destroy - ~URLDetectorCam.find_signal - ~URLDetectorCam.get - ~URLDetectorCam.get_asyn_digraph - ~URLDetectorCam.get_asyn_port_dictionary - ~URLDetectorCam.get_device_tuple - ~URLDetectorCam.get_instantiated_signals - ~URLDetectorCam.get_plugin_by_asyn_port - ~URLDetectorCam.missing_plugins - ~URLDetectorCam.pause - ~URLDetectorCam.put - ~URLDetectorCam.read - ~URLDetectorCam.read_configuration - ~URLDetectorCam.resume - ~URLDetectorCam.stage - ~URLDetectorCam.stop - ~URLDetectorCam.subscribe - ~URLDetectorCam.summary - ~URLDetectorCam.trigger - ~URLDetectorCam.unstage - ~URLDetectorCam.unsubscribe - ~URLDetectorCam.unsubscribe_all - ~URLDetectorCam.validate_asyn_ports - ~URLDetectorCam.visualize_asyn_digraph - ~URLDetectorCam.wait_for_connection - ~URLDetectorCam.walk_components - ~URLDetectorCam.walk_signals - ~URLDetectorCam.walk_subdevice_classes - ~URLDetectorCam.walk_subdevices - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/generated/ophyd.areadetector.cam.rst.txt b/ophyd/_sources/generated/ophyd.areadetector.cam.rst.txt deleted file mode 100644 index e33a8ee5c0..0000000000 --- a/ophyd/_sources/generated/ophyd.areadetector.cam.rst.txt +++ /dev/null @@ -1,50 +0,0 @@ -ophyd\.areadetector\.cam -======================== - -.. automodule:: ophyd.areadetector.cam - - - - - - - - .. rubric:: Classes - - .. autosummary:: - - AdscDetectorCam - Andor3DetectorCam - AndorDetectorCam - AreaDetectorCam - BrukerDetectorCam - CamBase - DexelaDetectorCam - EigerDetectorCam - EmergentVisionDetectorCam - FirewireLinDetectorCam - FirewireWinDetectorCam - GreatEyesDetectorCam - Lambda750kCam - LightFieldDetectorCam - Mar345DetectorCam - MarCCDDetectorCam - PSLDetectorCam - PcoDetectorCam - PcoDetectorIO - PcoDetectorSimIO - PerkinElmerDetectorCam - PilatusDetectorCam - PixiradDetectorCam - PointGreyDetectorCam - ProsilicaDetectorCam - PvcamDetectorCam - RoperDetectorCam - SimDetectorCam - URLDetectorCam - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/generated/ophyd.areadetector.detectors.AdscDetector.rst.txt b/ophyd/_sources/generated/ophyd.areadetector.detectors.AdscDetector.rst.txt deleted file mode 100644 index 4988452e29..0000000000 --- a/ophyd/_sources/generated/ophyd.areadetector.detectors.AdscDetector.rst.txt +++ /dev/null @@ -1,60 +0,0 @@ -ophyd\.areadetector\.detectors\.AdscDetector -============================================ - -.. currentmodule:: ophyd.areadetector.detectors - -.. autoclass:: AdscDetector - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~AdscDetector.__init__ - ~AdscDetector.add_instantiation_callback - ~AdscDetector.check_value - ~AdscDetector.clear_sub - ~AdscDetector.collect_asset_docs - ~AdscDetector.configure - ~AdscDetector.describe - ~AdscDetector.describe_configuration - ~AdscDetector.destroy - ~AdscDetector.dispatch - ~AdscDetector.find_signal - ~AdscDetector.get - ~AdscDetector.get_asyn_digraph - ~AdscDetector.get_asyn_port_dictionary - ~AdscDetector.get_device_tuple - ~AdscDetector.get_instantiated_signals - ~AdscDetector.get_plugin_by_asyn_port - ~AdscDetector.make_data_key - ~AdscDetector.missing_plugins - ~AdscDetector.pause - ~AdscDetector.put - ~AdscDetector.read - ~AdscDetector.read_configuration - ~AdscDetector.resume - ~AdscDetector.stage - ~AdscDetector.stop - ~AdscDetector.subscribe - ~AdscDetector.summary - ~AdscDetector.trigger - ~AdscDetector.unstage - ~AdscDetector.unsubscribe - ~AdscDetector.unsubscribe_all - ~AdscDetector.validate_asyn_ports - ~AdscDetector.visualize_asyn_digraph - ~AdscDetector.wait_for_connection - ~AdscDetector.walk_components - ~AdscDetector.walk_signals - ~AdscDetector.walk_subdevice_classes - ~AdscDetector.walk_subdevices - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/generated/ophyd.areadetector.detectors.Andor3Detector.rst.txt b/ophyd/_sources/generated/ophyd.areadetector.detectors.Andor3Detector.rst.txt deleted file mode 100644 index 919eec2818..0000000000 --- a/ophyd/_sources/generated/ophyd.areadetector.detectors.Andor3Detector.rst.txt +++ /dev/null @@ -1,60 +0,0 @@ -ophyd\.areadetector\.detectors\.Andor3Detector -============================================== - -.. currentmodule:: ophyd.areadetector.detectors - -.. autoclass:: Andor3Detector - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~Andor3Detector.__init__ - ~Andor3Detector.add_instantiation_callback - ~Andor3Detector.check_value - ~Andor3Detector.clear_sub - ~Andor3Detector.collect_asset_docs - ~Andor3Detector.configure - ~Andor3Detector.describe - ~Andor3Detector.describe_configuration - ~Andor3Detector.destroy - ~Andor3Detector.dispatch - ~Andor3Detector.find_signal - ~Andor3Detector.get - ~Andor3Detector.get_asyn_digraph - ~Andor3Detector.get_asyn_port_dictionary - ~Andor3Detector.get_device_tuple - ~Andor3Detector.get_instantiated_signals - ~Andor3Detector.get_plugin_by_asyn_port - ~Andor3Detector.make_data_key - ~Andor3Detector.missing_plugins - ~Andor3Detector.pause - ~Andor3Detector.put - ~Andor3Detector.read - ~Andor3Detector.read_configuration - ~Andor3Detector.resume - ~Andor3Detector.stage - ~Andor3Detector.stop - ~Andor3Detector.subscribe - ~Andor3Detector.summary - ~Andor3Detector.trigger - ~Andor3Detector.unstage - ~Andor3Detector.unsubscribe - ~Andor3Detector.unsubscribe_all - ~Andor3Detector.validate_asyn_ports - ~Andor3Detector.visualize_asyn_digraph - ~Andor3Detector.wait_for_connection - ~Andor3Detector.walk_components - ~Andor3Detector.walk_signals - ~Andor3Detector.walk_subdevice_classes - ~Andor3Detector.walk_subdevices - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/generated/ophyd.areadetector.detectors.AndorDetector.rst.txt b/ophyd/_sources/generated/ophyd.areadetector.detectors.AndorDetector.rst.txt deleted file mode 100644 index 568ff781f4..0000000000 --- a/ophyd/_sources/generated/ophyd.areadetector.detectors.AndorDetector.rst.txt +++ /dev/null @@ -1,60 +0,0 @@ -ophyd\.areadetector\.detectors\.AndorDetector -============================================= - -.. currentmodule:: ophyd.areadetector.detectors - -.. autoclass:: AndorDetector - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~AndorDetector.__init__ - ~AndorDetector.add_instantiation_callback - ~AndorDetector.check_value - ~AndorDetector.clear_sub - ~AndorDetector.collect_asset_docs - ~AndorDetector.configure - ~AndorDetector.describe - ~AndorDetector.describe_configuration - ~AndorDetector.destroy - ~AndorDetector.dispatch - ~AndorDetector.find_signal - ~AndorDetector.get - ~AndorDetector.get_asyn_digraph - ~AndorDetector.get_asyn_port_dictionary - ~AndorDetector.get_device_tuple - ~AndorDetector.get_instantiated_signals - ~AndorDetector.get_plugin_by_asyn_port - ~AndorDetector.make_data_key - ~AndorDetector.missing_plugins - ~AndorDetector.pause - ~AndorDetector.put - ~AndorDetector.read - ~AndorDetector.read_configuration - ~AndorDetector.resume - ~AndorDetector.stage - ~AndorDetector.stop - ~AndorDetector.subscribe - ~AndorDetector.summary - ~AndorDetector.trigger - ~AndorDetector.unstage - ~AndorDetector.unsubscribe - ~AndorDetector.unsubscribe_all - ~AndorDetector.validate_asyn_ports - ~AndorDetector.visualize_asyn_digraph - ~AndorDetector.wait_for_connection - ~AndorDetector.walk_components - ~AndorDetector.walk_signals - ~AndorDetector.walk_subdevice_classes - ~AndorDetector.walk_subdevices - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/generated/ophyd.areadetector.detectors.AreaDetector.rst.txt b/ophyd/_sources/generated/ophyd.areadetector.detectors.AreaDetector.rst.txt deleted file mode 100644 index 9469e02efb..0000000000 --- a/ophyd/_sources/generated/ophyd.areadetector.detectors.AreaDetector.rst.txt +++ /dev/null @@ -1,60 +0,0 @@ -ophyd\.areadetector\.detectors\.AreaDetector -============================================ - -.. currentmodule:: ophyd.areadetector.detectors - -.. autoclass:: AreaDetector - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~AreaDetector.__init__ - ~AreaDetector.add_instantiation_callback - ~AreaDetector.check_value - ~AreaDetector.clear_sub - ~AreaDetector.collect_asset_docs - ~AreaDetector.configure - ~AreaDetector.describe - ~AreaDetector.describe_configuration - ~AreaDetector.destroy - ~AreaDetector.dispatch - ~AreaDetector.find_signal - ~AreaDetector.get - ~AreaDetector.get_asyn_digraph - ~AreaDetector.get_asyn_port_dictionary - ~AreaDetector.get_device_tuple - ~AreaDetector.get_instantiated_signals - ~AreaDetector.get_plugin_by_asyn_port - ~AreaDetector.make_data_key - ~AreaDetector.missing_plugins - ~AreaDetector.pause - ~AreaDetector.put - ~AreaDetector.read - ~AreaDetector.read_configuration - ~AreaDetector.resume - ~AreaDetector.stage - ~AreaDetector.stop - ~AreaDetector.subscribe - ~AreaDetector.summary - ~AreaDetector.trigger - ~AreaDetector.unstage - ~AreaDetector.unsubscribe - ~AreaDetector.unsubscribe_all - ~AreaDetector.validate_asyn_ports - ~AreaDetector.visualize_asyn_digraph - ~AreaDetector.wait_for_connection - ~AreaDetector.walk_components - ~AreaDetector.walk_signals - ~AreaDetector.walk_subdevice_classes - ~AreaDetector.walk_subdevices - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/generated/ophyd.areadetector.detectors.BrukerDetector.rst.txt b/ophyd/_sources/generated/ophyd.areadetector.detectors.BrukerDetector.rst.txt deleted file mode 100644 index 3a765a6609..0000000000 --- a/ophyd/_sources/generated/ophyd.areadetector.detectors.BrukerDetector.rst.txt +++ /dev/null @@ -1,60 +0,0 @@ -ophyd\.areadetector\.detectors\.BrukerDetector -============================================== - -.. currentmodule:: ophyd.areadetector.detectors - -.. autoclass:: BrukerDetector - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~BrukerDetector.__init__ - ~BrukerDetector.add_instantiation_callback - ~BrukerDetector.check_value - ~BrukerDetector.clear_sub - ~BrukerDetector.collect_asset_docs - ~BrukerDetector.configure - ~BrukerDetector.describe - ~BrukerDetector.describe_configuration - ~BrukerDetector.destroy - ~BrukerDetector.dispatch - ~BrukerDetector.find_signal - ~BrukerDetector.get - ~BrukerDetector.get_asyn_digraph - ~BrukerDetector.get_asyn_port_dictionary - ~BrukerDetector.get_device_tuple - ~BrukerDetector.get_instantiated_signals - ~BrukerDetector.get_plugin_by_asyn_port - ~BrukerDetector.make_data_key - ~BrukerDetector.missing_plugins - ~BrukerDetector.pause - ~BrukerDetector.put - ~BrukerDetector.read - ~BrukerDetector.read_configuration - ~BrukerDetector.resume - ~BrukerDetector.stage - ~BrukerDetector.stop - ~BrukerDetector.subscribe - ~BrukerDetector.summary - ~BrukerDetector.trigger - ~BrukerDetector.unstage - ~BrukerDetector.unsubscribe - ~BrukerDetector.unsubscribe_all - ~BrukerDetector.validate_asyn_ports - ~BrukerDetector.visualize_asyn_digraph - ~BrukerDetector.wait_for_connection - ~BrukerDetector.walk_components - ~BrukerDetector.walk_signals - ~BrukerDetector.walk_subdevice_classes - ~BrukerDetector.walk_subdevices - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/generated/ophyd.areadetector.detectors.DetectorBase.dispatch.rst.txt b/ophyd/_sources/generated/ophyd.areadetector.detectors.DetectorBase.dispatch.rst.txt deleted file mode 100644 index 94d5fbc971..0000000000 --- a/ophyd/_sources/generated/ophyd.areadetector.detectors.DetectorBase.dispatch.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -ophyd\.areadetector\.detectors\.DetectorBase\.dispatch -====================================================== - -.. currentmodule:: ophyd.areadetector.detectors - -.. automethod:: DetectorBase.dispatch \ No newline at end of file diff --git a/ophyd/_sources/generated/ophyd.areadetector.detectors.DetectorBase.make_data_key.rst.txt b/ophyd/_sources/generated/ophyd.areadetector.detectors.DetectorBase.make_data_key.rst.txt deleted file mode 100644 index e50c93f42a..0000000000 --- a/ophyd/_sources/generated/ophyd.areadetector.detectors.DetectorBase.make_data_key.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -ophyd\.areadetector\.detectors\.DetectorBase\.make\_data\_key -============================================================= - -.. currentmodule:: ophyd.areadetector.detectors - -.. automethod:: DetectorBase.make_data_key \ No newline at end of file diff --git a/ophyd/_sources/generated/ophyd.areadetector.detectors.DetectorBase.rst.txt b/ophyd/_sources/generated/ophyd.areadetector.detectors.DetectorBase.rst.txt deleted file mode 100644 index 2cc23e7f3b..0000000000 --- a/ophyd/_sources/generated/ophyd.areadetector.detectors.DetectorBase.rst.txt +++ /dev/null @@ -1,60 +0,0 @@ -ophyd\.areadetector\.detectors\.DetectorBase -============================================ - -.. currentmodule:: ophyd.areadetector.detectors - -.. autoclass:: DetectorBase - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~DetectorBase.__init__ - ~DetectorBase.add_instantiation_callback - ~DetectorBase.check_value - ~DetectorBase.clear_sub - ~DetectorBase.collect_asset_docs - ~DetectorBase.configure - ~DetectorBase.describe - ~DetectorBase.describe_configuration - ~DetectorBase.destroy - ~DetectorBase.dispatch - ~DetectorBase.find_signal - ~DetectorBase.get - ~DetectorBase.get_asyn_digraph - ~DetectorBase.get_asyn_port_dictionary - ~DetectorBase.get_device_tuple - ~DetectorBase.get_instantiated_signals - ~DetectorBase.get_plugin_by_asyn_port - ~DetectorBase.make_data_key - ~DetectorBase.missing_plugins - ~DetectorBase.pause - ~DetectorBase.put - ~DetectorBase.read - ~DetectorBase.read_configuration - ~DetectorBase.resume - ~DetectorBase.stage - ~DetectorBase.stop - ~DetectorBase.subscribe - ~DetectorBase.summary - ~DetectorBase.trigger - ~DetectorBase.unstage - ~DetectorBase.unsubscribe - ~DetectorBase.unsubscribe_all - ~DetectorBase.validate_asyn_ports - ~DetectorBase.visualize_asyn_digraph - ~DetectorBase.wait_for_connection - ~DetectorBase.walk_components - ~DetectorBase.walk_signals - ~DetectorBase.walk_subdevice_classes - ~DetectorBase.walk_subdevices - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/generated/ophyd.areadetector.detectors.FirewireLinDetector.rst.txt b/ophyd/_sources/generated/ophyd.areadetector.detectors.FirewireLinDetector.rst.txt deleted file mode 100644 index aa635fe088..0000000000 --- a/ophyd/_sources/generated/ophyd.areadetector.detectors.FirewireLinDetector.rst.txt +++ /dev/null @@ -1,60 +0,0 @@ -ophyd\.areadetector\.detectors\.FirewireLinDetector -=================================================== - -.. currentmodule:: ophyd.areadetector.detectors - -.. autoclass:: FirewireLinDetector - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~FirewireLinDetector.__init__ - ~FirewireLinDetector.add_instantiation_callback - ~FirewireLinDetector.check_value - ~FirewireLinDetector.clear_sub - ~FirewireLinDetector.collect_asset_docs - ~FirewireLinDetector.configure - ~FirewireLinDetector.describe - ~FirewireLinDetector.describe_configuration - ~FirewireLinDetector.destroy - ~FirewireLinDetector.dispatch - ~FirewireLinDetector.find_signal - ~FirewireLinDetector.get - ~FirewireLinDetector.get_asyn_digraph - ~FirewireLinDetector.get_asyn_port_dictionary - ~FirewireLinDetector.get_device_tuple - ~FirewireLinDetector.get_instantiated_signals - ~FirewireLinDetector.get_plugin_by_asyn_port - ~FirewireLinDetector.make_data_key - ~FirewireLinDetector.missing_plugins - ~FirewireLinDetector.pause - ~FirewireLinDetector.put - ~FirewireLinDetector.read - ~FirewireLinDetector.read_configuration - ~FirewireLinDetector.resume - ~FirewireLinDetector.stage - ~FirewireLinDetector.stop - ~FirewireLinDetector.subscribe - ~FirewireLinDetector.summary - ~FirewireLinDetector.trigger - ~FirewireLinDetector.unstage - ~FirewireLinDetector.unsubscribe - ~FirewireLinDetector.unsubscribe_all - ~FirewireLinDetector.validate_asyn_ports - ~FirewireLinDetector.visualize_asyn_digraph - ~FirewireLinDetector.wait_for_connection - ~FirewireLinDetector.walk_components - ~FirewireLinDetector.walk_signals - ~FirewireLinDetector.walk_subdevice_classes - ~FirewireLinDetector.walk_subdevices - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/generated/ophyd.areadetector.detectors.FirewireWinDetector.rst.txt b/ophyd/_sources/generated/ophyd.areadetector.detectors.FirewireWinDetector.rst.txt deleted file mode 100644 index 96c108ba2c..0000000000 --- a/ophyd/_sources/generated/ophyd.areadetector.detectors.FirewireWinDetector.rst.txt +++ /dev/null @@ -1,60 +0,0 @@ -ophyd\.areadetector\.detectors\.FirewireWinDetector -=================================================== - -.. currentmodule:: ophyd.areadetector.detectors - -.. autoclass:: FirewireWinDetector - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~FirewireWinDetector.__init__ - ~FirewireWinDetector.add_instantiation_callback - ~FirewireWinDetector.check_value - ~FirewireWinDetector.clear_sub - ~FirewireWinDetector.collect_asset_docs - ~FirewireWinDetector.configure - ~FirewireWinDetector.describe - ~FirewireWinDetector.describe_configuration - ~FirewireWinDetector.destroy - ~FirewireWinDetector.dispatch - ~FirewireWinDetector.find_signal - ~FirewireWinDetector.get - ~FirewireWinDetector.get_asyn_digraph - ~FirewireWinDetector.get_asyn_port_dictionary - ~FirewireWinDetector.get_device_tuple - ~FirewireWinDetector.get_instantiated_signals - ~FirewireWinDetector.get_plugin_by_asyn_port - ~FirewireWinDetector.make_data_key - ~FirewireWinDetector.missing_plugins - ~FirewireWinDetector.pause - ~FirewireWinDetector.put - ~FirewireWinDetector.read - ~FirewireWinDetector.read_configuration - ~FirewireWinDetector.resume - ~FirewireWinDetector.stage - ~FirewireWinDetector.stop - ~FirewireWinDetector.subscribe - ~FirewireWinDetector.summary - ~FirewireWinDetector.trigger - ~FirewireWinDetector.unstage - ~FirewireWinDetector.unsubscribe - ~FirewireWinDetector.unsubscribe_all - ~FirewireWinDetector.validate_asyn_ports - ~FirewireWinDetector.visualize_asyn_digraph - ~FirewireWinDetector.wait_for_connection - ~FirewireWinDetector.walk_components - ~FirewireWinDetector.walk_signals - ~FirewireWinDetector.walk_subdevice_classes - ~FirewireWinDetector.walk_subdevices - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/generated/ophyd.areadetector.detectors.LightFieldDetector.rst.txt b/ophyd/_sources/generated/ophyd.areadetector.detectors.LightFieldDetector.rst.txt deleted file mode 100644 index 91dd73d541..0000000000 --- a/ophyd/_sources/generated/ophyd.areadetector.detectors.LightFieldDetector.rst.txt +++ /dev/null @@ -1,60 +0,0 @@ -ophyd\.areadetector\.detectors\.LightFieldDetector -================================================== - -.. currentmodule:: ophyd.areadetector.detectors - -.. autoclass:: LightFieldDetector - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~LightFieldDetector.__init__ - ~LightFieldDetector.add_instantiation_callback - ~LightFieldDetector.check_value - ~LightFieldDetector.clear_sub - ~LightFieldDetector.collect_asset_docs - ~LightFieldDetector.configure - ~LightFieldDetector.describe - ~LightFieldDetector.describe_configuration - ~LightFieldDetector.destroy - ~LightFieldDetector.dispatch - ~LightFieldDetector.find_signal - ~LightFieldDetector.get - ~LightFieldDetector.get_asyn_digraph - ~LightFieldDetector.get_asyn_port_dictionary - ~LightFieldDetector.get_device_tuple - ~LightFieldDetector.get_instantiated_signals - ~LightFieldDetector.get_plugin_by_asyn_port - ~LightFieldDetector.make_data_key - ~LightFieldDetector.missing_plugins - ~LightFieldDetector.pause - ~LightFieldDetector.put - ~LightFieldDetector.read - ~LightFieldDetector.read_configuration - ~LightFieldDetector.resume - ~LightFieldDetector.stage - ~LightFieldDetector.stop - ~LightFieldDetector.subscribe - ~LightFieldDetector.summary - ~LightFieldDetector.trigger - ~LightFieldDetector.unstage - ~LightFieldDetector.unsubscribe - ~LightFieldDetector.unsubscribe_all - ~LightFieldDetector.validate_asyn_ports - ~LightFieldDetector.visualize_asyn_digraph - ~LightFieldDetector.wait_for_connection - ~LightFieldDetector.walk_components - ~LightFieldDetector.walk_signals - ~LightFieldDetector.walk_subdevice_classes - ~LightFieldDetector.walk_subdevices - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/generated/ophyd.areadetector.detectors.Mar345Detector.rst.txt b/ophyd/_sources/generated/ophyd.areadetector.detectors.Mar345Detector.rst.txt deleted file mode 100644 index 5034920e07..0000000000 --- a/ophyd/_sources/generated/ophyd.areadetector.detectors.Mar345Detector.rst.txt +++ /dev/null @@ -1,60 +0,0 @@ -ophyd\.areadetector\.detectors\.Mar345Detector -============================================== - -.. currentmodule:: ophyd.areadetector.detectors - -.. autoclass:: Mar345Detector - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~Mar345Detector.__init__ - ~Mar345Detector.add_instantiation_callback - ~Mar345Detector.check_value - ~Mar345Detector.clear_sub - ~Mar345Detector.collect_asset_docs - ~Mar345Detector.configure - ~Mar345Detector.describe - ~Mar345Detector.describe_configuration - ~Mar345Detector.destroy - ~Mar345Detector.dispatch - ~Mar345Detector.find_signal - ~Mar345Detector.get - ~Mar345Detector.get_asyn_digraph - ~Mar345Detector.get_asyn_port_dictionary - ~Mar345Detector.get_device_tuple - ~Mar345Detector.get_instantiated_signals - ~Mar345Detector.get_plugin_by_asyn_port - ~Mar345Detector.make_data_key - ~Mar345Detector.missing_plugins - ~Mar345Detector.pause - ~Mar345Detector.put - ~Mar345Detector.read - ~Mar345Detector.read_configuration - ~Mar345Detector.resume - ~Mar345Detector.stage - ~Mar345Detector.stop - ~Mar345Detector.subscribe - ~Mar345Detector.summary - ~Mar345Detector.trigger - ~Mar345Detector.unstage - ~Mar345Detector.unsubscribe - ~Mar345Detector.unsubscribe_all - ~Mar345Detector.validate_asyn_ports - ~Mar345Detector.visualize_asyn_digraph - ~Mar345Detector.wait_for_connection - ~Mar345Detector.walk_components - ~Mar345Detector.walk_signals - ~Mar345Detector.walk_subdevice_classes - ~Mar345Detector.walk_subdevices - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/generated/ophyd.areadetector.detectors.MarCCDDetector.rst.txt b/ophyd/_sources/generated/ophyd.areadetector.detectors.MarCCDDetector.rst.txt deleted file mode 100644 index 1cda05e5e5..0000000000 --- a/ophyd/_sources/generated/ophyd.areadetector.detectors.MarCCDDetector.rst.txt +++ /dev/null @@ -1,60 +0,0 @@ -ophyd\.areadetector\.detectors\.MarCCDDetector -============================================== - -.. currentmodule:: ophyd.areadetector.detectors - -.. autoclass:: MarCCDDetector - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~MarCCDDetector.__init__ - ~MarCCDDetector.add_instantiation_callback - ~MarCCDDetector.check_value - ~MarCCDDetector.clear_sub - ~MarCCDDetector.collect_asset_docs - ~MarCCDDetector.configure - ~MarCCDDetector.describe - ~MarCCDDetector.describe_configuration - ~MarCCDDetector.destroy - ~MarCCDDetector.dispatch - ~MarCCDDetector.find_signal - ~MarCCDDetector.get - ~MarCCDDetector.get_asyn_digraph - ~MarCCDDetector.get_asyn_port_dictionary - ~MarCCDDetector.get_device_tuple - ~MarCCDDetector.get_instantiated_signals - ~MarCCDDetector.get_plugin_by_asyn_port - ~MarCCDDetector.make_data_key - ~MarCCDDetector.missing_plugins - ~MarCCDDetector.pause - ~MarCCDDetector.put - ~MarCCDDetector.read - ~MarCCDDetector.read_configuration - ~MarCCDDetector.resume - ~MarCCDDetector.stage - ~MarCCDDetector.stop - ~MarCCDDetector.subscribe - ~MarCCDDetector.summary - ~MarCCDDetector.trigger - ~MarCCDDetector.unstage - ~MarCCDDetector.unsubscribe - ~MarCCDDetector.unsubscribe_all - ~MarCCDDetector.validate_asyn_ports - ~MarCCDDetector.visualize_asyn_digraph - ~MarCCDDetector.wait_for_connection - ~MarCCDDetector.walk_components - ~MarCCDDetector.walk_signals - ~MarCCDDetector.walk_subdevice_classes - ~MarCCDDetector.walk_subdevices - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/generated/ophyd.areadetector.detectors.PSLDetector.rst.txt b/ophyd/_sources/generated/ophyd.areadetector.detectors.PSLDetector.rst.txt deleted file mode 100644 index be5570b490..0000000000 --- a/ophyd/_sources/generated/ophyd.areadetector.detectors.PSLDetector.rst.txt +++ /dev/null @@ -1,60 +0,0 @@ -ophyd\.areadetector\.detectors\.PSLDetector -=========================================== - -.. currentmodule:: ophyd.areadetector.detectors - -.. autoclass:: PSLDetector - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~PSLDetector.__init__ - ~PSLDetector.add_instantiation_callback - ~PSLDetector.check_value - ~PSLDetector.clear_sub - ~PSLDetector.collect_asset_docs - ~PSLDetector.configure - ~PSLDetector.describe - ~PSLDetector.describe_configuration - ~PSLDetector.destroy - ~PSLDetector.dispatch - ~PSLDetector.find_signal - ~PSLDetector.get - ~PSLDetector.get_asyn_digraph - ~PSLDetector.get_asyn_port_dictionary - ~PSLDetector.get_device_tuple - ~PSLDetector.get_instantiated_signals - ~PSLDetector.get_plugin_by_asyn_port - ~PSLDetector.make_data_key - ~PSLDetector.missing_plugins - ~PSLDetector.pause - ~PSLDetector.put - ~PSLDetector.read - ~PSLDetector.read_configuration - ~PSLDetector.resume - ~PSLDetector.stage - ~PSLDetector.stop - ~PSLDetector.subscribe - ~PSLDetector.summary - ~PSLDetector.trigger - ~PSLDetector.unstage - ~PSLDetector.unsubscribe - ~PSLDetector.unsubscribe_all - ~PSLDetector.validate_asyn_ports - ~PSLDetector.visualize_asyn_digraph - ~PSLDetector.wait_for_connection - ~PSLDetector.walk_components - ~PSLDetector.walk_signals - ~PSLDetector.walk_subdevice_classes - ~PSLDetector.walk_subdevices - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/generated/ophyd.areadetector.detectors.PerkinElmerDetector.rst.txt b/ophyd/_sources/generated/ophyd.areadetector.detectors.PerkinElmerDetector.rst.txt deleted file mode 100644 index 73f1bb422c..0000000000 --- a/ophyd/_sources/generated/ophyd.areadetector.detectors.PerkinElmerDetector.rst.txt +++ /dev/null @@ -1,60 +0,0 @@ -ophyd\.areadetector\.detectors\.PerkinElmerDetector -=================================================== - -.. currentmodule:: ophyd.areadetector.detectors - -.. autoclass:: PerkinElmerDetector - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~PerkinElmerDetector.__init__ - ~PerkinElmerDetector.add_instantiation_callback - ~PerkinElmerDetector.check_value - ~PerkinElmerDetector.clear_sub - ~PerkinElmerDetector.collect_asset_docs - ~PerkinElmerDetector.configure - ~PerkinElmerDetector.describe - ~PerkinElmerDetector.describe_configuration - ~PerkinElmerDetector.destroy - ~PerkinElmerDetector.dispatch - ~PerkinElmerDetector.find_signal - ~PerkinElmerDetector.get - ~PerkinElmerDetector.get_asyn_digraph - ~PerkinElmerDetector.get_asyn_port_dictionary - ~PerkinElmerDetector.get_device_tuple - ~PerkinElmerDetector.get_instantiated_signals - ~PerkinElmerDetector.get_plugin_by_asyn_port - ~PerkinElmerDetector.make_data_key - ~PerkinElmerDetector.missing_plugins - ~PerkinElmerDetector.pause - ~PerkinElmerDetector.put - ~PerkinElmerDetector.read - ~PerkinElmerDetector.read_configuration - ~PerkinElmerDetector.resume - ~PerkinElmerDetector.stage - ~PerkinElmerDetector.stop - ~PerkinElmerDetector.subscribe - ~PerkinElmerDetector.summary - ~PerkinElmerDetector.trigger - ~PerkinElmerDetector.unstage - ~PerkinElmerDetector.unsubscribe - ~PerkinElmerDetector.unsubscribe_all - ~PerkinElmerDetector.validate_asyn_ports - ~PerkinElmerDetector.visualize_asyn_digraph - ~PerkinElmerDetector.wait_for_connection - ~PerkinElmerDetector.walk_components - ~PerkinElmerDetector.walk_signals - ~PerkinElmerDetector.walk_subdevice_classes - ~PerkinElmerDetector.walk_subdevices - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/generated/ophyd.areadetector.detectors.PilatusDetector.rst.txt b/ophyd/_sources/generated/ophyd.areadetector.detectors.PilatusDetector.rst.txt deleted file mode 100644 index 258167b5f5..0000000000 --- a/ophyd/_sources/generated/ophyd.areadetector.detectors.PilatusDetector.rst.txt +++ /dev/null @@ -1,60 +0,0 @@ -ophyd\.areadetector\.detectors\.PilatusDetector -=============================================== - -.. currentmodule:: ophyd.areadetector.detectors - -.. autoclass:: PilatusDetector - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~PilatusDetector.__init__ - ~PilatusDetector.add_instantiation_callback - ~PilatusDetector.check_value - ~PilatusDetector.clear_sub - ~PilatusDetector.collect_asset_docs - ~PilatusDetector.configure - ~PilatusDetector.describe - ~PilatusDetector.describe_configuration - ~PilatusDetector.destroy - ~PilatusDetector.dispatch - ~PilatusDetector.find_signal - ~PilatusDetector.get - ~PilatusDetector.get_asyn_digraph - ~PilatusDetector.get_asyn_port_dictionary - ~PilatusDetector.get_device_tuple - ~PilatusDetector.get_instantiated_signals - ~PilatusDetector.get_plugin_by_asyn_port - ~PilatusDetector.make_data_key - ~PilatusDetector.missing_plugins - ~PilatusDetector.pause - ~PilatusDetector.put - ~PilatusDetector.read - ~PilatusDetector.read_configuration - ~PilatusDetector.resume - ~PilatusDetector.stage - ~PilatusDetector.stop - ~PilatusDetector.subscribe - ~PilatusDetector.summary - ~PilatusDetector.trigger - ~PilatusDetector.unstage - ~PilatusDetector.unsubscribe - ~PilatusDetector.unsubscribe_all - ~PilatusDetector.validate_asyn_ports - ~PilatusDetector.visualize_asyn_digraph - ~PilatusDetector.wait_for_connection - ~PilatusDetector.walk_components - ~PilatusDetector.walk_signals - ~PilatusDetector.walk_subdevice_classes - ~PilatusDetector.walk_subdevices - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/generated/ophyd.areadetector.detectors.PixiradDetector.rst.txt b/ophyd/_sources/generated/ophyd.areadetector.detectors.PixiradDetector.rst.txt deleted file mode 100644 index f713a5f3b3..0000000000 --- a/ophyd/_sources/generated/ophyd.areadetector.detectors.PixiradDetector.rst.txt +++ /dev/null @@ -1,60 +0,0 @@ -ophyd\.areadetector\.detectors\.PixiradDetector -=============================================== - -.. currentmodule:: ophyd.areadetector.detectors - -.. autoclass:: PixiradDetector - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~PixiradDetector.__init__ - ~PixiradDetector.add_instantiation_callback - ~PixiradDetector.check_value - ~PixiradDetector.clear_sub - ~PixiradDetector.collect_asset_docs - ~PixiradDetector.configure - ~PixiradDetector.describe - ~PixiradDetector.describe_configuration - ~PixiradDetector.destroy - ~PixiradDetector.dispatch - ~PixiradDetector.find_signal - ~PixiradDetector.get - ~PixiradDetector.get_asyn_digraph - ~PixiradDetector.get_asyn_port_dictionary - ~PixiradDetector.get_device_tuple - ~PixiradDetector.get_instantiated_signals - ~PixiradDetector.get_plugin_by_asyn_port - ~PixiradDetector.make_data_key - ~PixiradDetector.missing_plugins - ~PixiradDetector.pause - ~PixiradDetector.put - ~PixiradDetector.read - ~PixiradDetector.read_configuration - ~PixiradDetector.resume - ~PixiradDetector.stage - ~PixiradDetector.stop - ~PixiradDetector.subscribe - ~PixiradDetector.summary - ~PixiradDetector.trigger - ~PixiradDetector.unstage - ~PixiradDetector.unsubscribe - ~PixiradDetector.unsubscribe_all - ~PixiradDetector.validate_asyn_ports - ~PixiradDetector.visualize_asyn_digraph - ~PixiradDetector.wait_for_connection - ~PixiradDetector.walk_components - ~PixiradDetector.walk_signals - ~PixiradDetector.walk_subdevice_classes - ~PixiradDetector.walk_subdevices - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/generated/ophyd.areadetector.detectors.PointGreyDetector.rst.txt b/ophyd/_sources/generated/ophyd.areadetector.detectors.PointGreyDetector.rst.txt deleted file mode 100644 index 8a3a887c20..0000000000 --- a/ophyd/_sources/generated/ophyd.areadetector.detectors.PointGreyDetector.rst.txt +++ /dev/null @@ -1,60 +0,0 @@ -ophyd\.areadetector\.detectors\.PointGreyDetector -================================================= - -.. currentmodule:: ophyd.areadetector.detectors - -.. autoclass:: PointGreyDetector - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~PointGreyDetector.__init__ - ~PointGreyDetector.add_instantiation_callback - ~PointGreyDetector.check_value - ~PointGreyDetector.clear_sub - ~PointGreyDetector.collect_asset_docs - ~PointGreyDetector.configure - ~PointGreyDetector.describe - ~PointGreyDetector.describe_configuration - ~PointGreyDetector.destroy - ~PointGreyDetector.dispatch - ~PointGreyDetector.find_signal - ~PointGreyDetector.get - ~PointGreyDetector.get_asyn_digraph - ~PointGreyDetector.get_asyn_port_dictionary - ~PointGreyDetector.get_device_tuple - ~PointGreyDetector.get_instantiated_signals - ~PointGreyDetector.get_plugin_by_asyn_port - ~PointGreyDetector.make_data_key - ~PointGreyDetector.missing_plugins - ~PointGreyDetector.pause - ~PointGreyDetector.put - ~PointGreyDetector.read - ~PointGreyDetector.read_configuration - ~PointGreyDetector.resume - ~PointGreyDetector.stage - ~PointGreyDetector.stop - ~PointGreyDetector.subscribe - ~PointGreyDetector.summary - ~PointGreyDetector.trigger - ~PointGreyDetector.unstage - ~PointGreyDetector.unsubscribe - ~PointGreyDetector.unsubscribe_all - ~PointGreyDetector.validate_asyn_ports - ~PointGreyDetector.visualize_asyn_digraph - ~PointGreyDetector.wait_for_connection - ~PointGreyDetector.walk_components - ~PointGreyDetector.walk_signals - ~PointGreyDetector.walk_subdevice_classes - ~PointGreyDetector.walk_subdevices - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/generated/ophyd.areadetector.detectors.ProsilicaDetector.rst.txt b/ophyd/_sources/generated/ophyd.areadetector.detectors.ProsilicaDetector.rst.txt deleted file mode 100644 index 84fe847b8f..0000000000 --- a/ophyd/_sources/generated/ophyd.areadetector.detectors.ProsilicaDetector.rst.txt +++ /dev/null @@ -1,60 +0,0 @@ -ophyd\.areadetector\.detectors\.ProsilicaDetector -================================================= - -.. currentmodule:: ophyd.areadetector.detectors - -.. autoclass:: ProsilicaDetector - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~ProsilicaDetector.__init__ - ~ProsilicaDetector.add_instantiation_callback - ~ProsilicaDetector.check_value - ~ProsilicaDetector.clear_sub - ~ProsilicaDetector.collect_asset_docs - ~ProsilicaDetector.configure - ~ProsilicaDetector.describe - ~ProsilicaDetector.describe_configuration - ~ProsilicaDetector.destroy - ~ProsilicaDetector.dispatch - ~ProsilicaDetector.find_signal - ~ProsilicaDetector.get - ~ProsilicaDetector.get_asyn_digraph - ~ProsilicaDetector.get_asyn_port_dictionary - ~ProsilicaDetector.get_device_tuple - ~ProsilicaDetector.get_instantiated_signals - ~ProsilicaDetector.get_plugin_by_asyn_port - ~ProsilicaDetector.make_data_key - ~ProsilicaDetector.missing_plugins - ~ProsilicaDetector.pause - ~ProsilicaDetector.put - ~ProsilicaDetector.read - ~ProsilicaDetector.read_configuration - ~ProsilicaDetector.resume - ~ProsilicaDetector.stage - ~ProsilicaDetector.stop - ~ProsilicaDetector.subscribe - ~ProsilicaDetector.summary - ~ProsilicaDetector.trigger - ~ProsilicaDetector.unstage - ~ProsilicaDetector.unsubscribe - ~ProsilicaDetector.unsubscribe_all - ~ProsilicaDetector.validate_asyn_ports - ~ProsilicaDetector.visualize_asyn_digraph - ~ProsilicaDetector.wait_for_connection - ~ProsilicaDetector.walk_components - ~ProsilicaDetector.walk_signals - ~ProsilicaDetector.walk_subdevice_classes - ~ProsilicaDetector.walk_subdevices - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/generated/ophyd.areadetector.detectors.PvcamDetector.rst.txt b/ophyd/_sources/generated/ophyd.areadetector.detectors.PvcamDetector.rst.txt deleted file mode 100644 index 1281af28b4..0000000000 --- a/ophyd/_sources/generated/ophyd.areadetector.detectors.PvcamDetector.rst.txt +++ /dev/null @@ -1,60 +0,0 @@ -ophyd\.areadetector\.detectors\.PvcamDetector -============================================= - -.. currentmodule:: ophyd.areadetector.detectors - -.. autoclass:: PvcamDetector - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~PvcamDetector.__init__ - ~PvcamDetector.add_instantiation_callback - ~PvcamDetector.check_value - ~PvcamDetector.clear_sub - ~PvcamDetector.collect_asset_docs - ~PvcamDetector.configure - ~PvcamDetector.describe - ~PvcamDetector.describe_configuration - ~PvcamDetector.destroy - ~PvcamDetector.dispatch - ~PvcamDetector.find_signal - ~PvcamDetector.get - ~PvcamDetector.get_asyn_digraph - ~PvcamDetector.get_asyn_port_dictionary - ~PvcamDetector.get_device_tuple - ~PvcamDetector.get_instantiated_signals - ~PvcamDetector.get_plugin_by_asyn_port - ~PvcamDetector.make_data_key - ~PvcamDetector.missing_plugins - ~PvcamDetector.pause - ~PvcamDetector.put - ~PvcamDetector.read - ~PvcamDetector.read_configuration - ~PvcamDetector.resume - ~PvcamDetector.stage - ~PvcamDetector.stop - ~PvcamDetector.subscribe - ~PvcamDetector.summary - ~PvcamDetector.trigger - ~PvcamDetector.unstage - ~PvcamDetector.unsubscribe - ~PvcamDetector.unsubscribe_all - ~PvcamDetector.validate_asyn_ports - ~PvcamDetector.visualize_asyn_digraph - ~PvcamDetector.wait_for_connection - ~PvcamDetector.walk_components - ~PvcamDetector.walk_signals - ~PvcamDetector.walk_subdevice_classes - ~PvcamDetector.walk_subdevices - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/generated/ophyd.areadetector.detectors.RoperDetector.rst.txt b/ophyd/_sources/generated/ophyd.areadetector.detectors.RoperDetector.rst.txt deleted file mode 100644 index 26e2910e7b..0000000000 --- a/ophyd/_sources/generated/ophyd.areadetector.detectors.RoperDetector.rst.txt +++ /dev/null @@ -1,60 +0,0 @@ -ophyd\.areadetector\.detectors\.RoperDetector -============================================= - -.. currentmodule:: ophyd.areadetector.detectors - -.. autoclass:: RoperDetector - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~RoperDetector.__init__ - ~RoperDetector.add_instantiation_callback - ~RoperDetector.check_value - ~RoperDetector.clear_sub - ~RoperDetector.collect_asset_docs - ~RoperDetector.configure - ~RoperDetector.describe - ~RoperDetector.describe_configuration - ~RoperDetector.destroy - ~RoperDetector.dispatch - ~RoperDetector.find_signal - ~RoperDetector.get - ~RoperDetector.get_asyn_digraph - ~RoperDetector.get_asyn_port_dictionary - ~RoperDetector.get_device_tuple - ~RoperDetector.get_instantiated_signals - ~RoperDetector.get_plugin_by_asyn_port - ~RoperDetector.make_data_key - ~RoperDetector.missing_plugins - ~RoperDetector.pause - ~RoperDetector.put - ~RoperDetector.read - ~RoperDetector.read_configuration - ~RoperDetector.resume - ~RoperDetector.stage - ~RoperDetector.stop - ~RoperDetector.subscribe - ~RoperDetector.summary - ~RoperDetector.trigger - ~RoperDetector.unstage - ~RoperDetector.unsubscribe - ~RoperDetector.unsubscribe_all - ~RoperDetector.validate_asyn_ports - ~RoperDetector.visualize_asyn_digraph - ~RoperDetector.wait_for_connection - ~RoperDetector.walk_components - ~RoperDetector.walk_signals - ~RoperDetector.walk_subdevice_classes - ~RoperDetector.walk_subdevices - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/generated/ophyd.areadetector.detectors.SimDetector.rst.txt b/ophyd/_sources/generated/ophyd.areadetector.detectors.SimDetector.rst.txt deleted file mode 100644 index bd52b720c0..0000000000 --- a/ophyd/_sources/generated/ophyd.areadetector.detectors.SimDetector.rst.txt +++ /dev/null @@ -1,60 +0,0 @@ -ophyd\.areadetector\.detectors\.SimDetector -=========================================== - -.. currentmodule:: ophyd.areadetector.detectors - -.. autoclass:: SimDetector - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~SimDetector.__init__ - ~SimDetector.add_instantiation_callback - ~SimDetector.check_value - ~SimDetector.clear_sub - ~SimDetector.collect_asset_docs - ~SimDetector.configure - ~SimDetector.describe - ~SimDetector.describe_configuration - ~SimDetector.destroy - ~SimDetector.dispatch - ~SimDetector.find_signal - ~SimDetector.get - ~SimDetector.get_asyn_digraph - ~SimDetector.get_asyn_port_dictionary - ~SimDetector.get_device_tuple - ~SimDetector.get_instantiated_signals - ~SimDetector.get_plugin_by_asyn_port - ~SimDetector.make_data_key - ~SimDetector.missing_plugins - ~SimDetector.pause - ~SimDetector.put - ~SimDetector.read - ~SimDetector.read_configuration - ~SimDetector.resume - ~SimDetector.stage - ~SimDetector.stop - ~SimDetector.subscribe - ~SimDetector.summary - ~SimDetector.trigger - ~SimDetector.unstage - ~SimDetector.unsubscribe - ~SimDetector.unsubscribe_all - ~SimDetector.validate_asyn_ports - ~SimDetector.visualize_asyn_digraph - ~SimDetector.wait_for_connection - ~SimDetector.walk_components - ~SimDetector.walk_signals - ~SimDetector.walk_subdevice_classes - ~SimDetector.walk_subdevices - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/generated/ophyd.areadetector.detectors.URLDetector.rst.txt b/ophyd/_sources/generated/ophyd.areadetector.detectors.URLDetector.rst.txt deleted file mode 100644 index 9cbbfea8c7..0000000000 --- a/ophyd/_sources/generated/ophyd.areadetector.detectors.URLDetector.rst.txt +++ /dev/null @@ -1,60 +0,0 @@ -ophyd\.areadetector\.detectors\.URLDetector -=========================================== - -.. currentmodule:: ophyd.areadetector.detectors - -.. autoclass:: URLDetector - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~URLDetector.__init__ - ~URLDetector.add_instantiation_callback - ~URLDetector.check_value - ~URLDetector.clear_sub - ~URLDetector.collect_asset_docs - ~URLDetector.configure - ~URLDetector.describe - ~URLDetector.describe_configuration - ~URLDetector.destroy - ~URLDetector.dispatch - ~URLDetector.find_signal - ~URLDetector.get - ~URLDetector.get_asyn_digraph - ~URLDetector.get_asyn_port_dictionary - ~URLDetector.get_device_tuple - ~URLDetector.get_instantiated_signals - ~URLDetector.get_plugin_by_asyn_port - ~URLDetector.make_data_key - ~URLDetector.missing_plugins - ~URLDetector.pause - ~URLDetector.put - ~URLDetector.read - ~URLDetector.read_configuration - ~URLDetector.resume - ~URLDetector.stage - ~URLDetector.stop - ~URLDetector.subscribe - ~URLDetector.summary - ~URLDetector.trigger - ~URLDetector.unstage - ~URLDetector.unsubscribe - ~URLDetector.unsubscribe_all - ~URLDetector.validate_asyn_ports - ~URLDetector.visualize_asyn_digraph - ~URLDetector.wait_for_connection - ~URLDetector.walk_components - ~URLDetector.walk_signals - ~URLDetector.walk_subdevice_classes - ~URLDetector.walk_subdevices - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/generated/ophyd.areadetector.detectors.rst.txt b/ophyd/_sources/generated/ophyd.areadetector.detectors.rst.txt deleted file mode 100644 index fc80d5ead2..0000000000 --- a/ophyd/_sources/generated/ophyd.areadetector.detectors.rst.txt +++ /dev/null @@ -1,46 +0,0 @@ -ophyd\.areadetector\.detectors -============================== - -.. automodule:: ophyd.areadetector.detectors - - - - - - - - .. rubric:: Classes - - .. autosummary:: - - AdscDetector - Andor3Detector - AndorDetector - AreaDetector - BrukerDetector - DetectorBase - DexelaDetector - EigerDetector - EmergentVisionDetector - FirewireLinDetector - FirewireWinDetector - GreatEyesDetector - LightFieldDetector - Mar345Detector - MarCCDDetector - PSLDetector - PerkinElmerDetector - PilatusDetector - PixiradDetector - PointGreyDetector - ProsilicaDetector - PvcamDetector - RoperDetector - SimDetector - URLDetector - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/generated/ophyd.areadetector.docs.rst.txt b/ophyd/_sources/generated/ophyd.areadetector.docs.rst.txt deleted file mode 100644 index fe390abc34..0000000000 --- a/ophyd/_sources/generated/ophyd.areadetector.docs.rst.txt +++ /dev/null @@ -1,16 +0,0 @@ -ophyd\.areadetector\.docs -========================= - -.. automodule:: ophyd.areadetector.docs - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/generated/ophyd.areadetector.filestore_mixins.FileStoreBase.fs_root.rst.txt b/ophyd/_sources/generated/ophyd.areadetector.filestore_mixins.FileStoreBase.fs_root.rst.txt deleted file mode 100644 index 904dae3636..0000000000 --- a/ophyd/_sources/generated/ophyd.areadetector.filestore_mixins.FileStoreBase.fs_root.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -ophyd\.areadetector\.filestore\_mixins\.FileStoreBase\.fs\_root -=============================================================== - -.. currentmodule:: ophyd.areadetector.filestore_mixins - -.. autoattribute:: FileStoreBase.fs_root \ No newline at end of file diff --git a/ophyd/_sources/generated/ophyd.areadetector.filestore_mixins.FileStoreBase.generate_datum.rst.txt b/ophyd/_sources/generated/ophyd.areadetector.filestore_mixins.FileStoreBase.generate_datum.rst.txt deleted file mode 100644 index e9f2f94056..0000000000 --- a/ophyd/_sources/generated/ophyd.areadetector.filestore_mixins.FileStoreBase.generate_datum.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -ophyd\.areadetector\.filestore\_mixins\.FileStoreBase\.generate\_datum -====================================================================== - -.. currentmodule:: ophyd.areadetector.filestore_mixins - -.. automethod:: FileStoreBase.generate_datum \ No newline at end of file diff --git a/ophyd/_sources/generated/ophyd.areadetector.filestore_mixins.FileStoreBase.read_path_template.rst.txt b/ophyd/_sources/generated/ophyd.areadetector.filestore_mixins.FileStoreBase.read_path_template.rst.txt deleted file mode 100644 index 10e25a5918..0000000000 --- a/ophyd/_sources/generated/ophyd.areadetector.filestore_mixins.FileStoreBase.read_path_template.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -ophyd\.areadetector\.filestore\_mixins\.FileStoreBase\.read\_path\_template -=========================================================================== - -.. currentmodule:: ophyd.areadetector.filestore_mixins - -.. autoattribute:: FileStoreBase.read_path_template \ No newline at end of file diff --git a/ophyd/_sources/generated/ophyd.areadetector.filestore_mixins.FileStoreBase.reg_root.rst.txt b/ophyd/_sources/generated/ophyd.areadetector.filestore_mixins.FileStoreBase.reg_root.rst.txt deleted file mode 100644 index 0f6f6742c5..0000000000 --- a/ophyd/_sources/generated/ophyd.areadetector.filestore_mixins.FileStoreBase.reg_root.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -ophyd\.areadetector\.filestore\_mixins\.FileStoreBase\.reg\_root -================================================================ - -.. currentmodule:: ophyd.areadetector.filestore_mixins - -.. autoattribute:: FileStoreBase.reg_root \ No newline at end of file diff --git a/ophyd/_sources/generated/ophyd.areadetector.filestore_mixins.FileStoreBase.rst.txt b/ophyd/_sources/generated/ophyd.areadetector.filestore_mixins.FileStoreBase.rst.txt deleted file mode 100644 index 12435c0313..0000000000 --- a/ophyd/_sources/generated/ophyd.areadetector.filestore_mixins.FileStoreBase.rst.txt +++ /dev/null @@ -1,31 +0,0 @@ -ophyd\.areadetector\.filestore\_mixins\.FileStoreBase -===================================================== - -.. currentmodule:: ophyd.areadetector.filestore_mixins - -.. autoclass:: FileStoreBase - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~FileStoreBase.__init__ - ~FileStoreBase.collect_asset_docs - ~FileStoreBase.describe - ~FileStoreBase.generate_datum - ~FileStoreBase.pause - ~FileStoreBase.read - ~FileStoreBase.resume - ~FileStoreBase.stage - ~FileStoreBase.trigger - ~FileStoreBase.unstage - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/generated/ophyd.areadetector.filestore_mixins.FileStoreBase.write_path_template.rst.txt b/ophyd/_sources/generated/ophyd.areadetector.filestore_mixins.FileStoreBase.write_path_template.rst.txt deleted file mode 100644 index 40809dd42a..0000000000 --- a/ophyd/_sources/generated/ophyd.areadetector.filestore_mixins.FileStoreBase.write_path_template.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -ophyd\.areadetector\.filestore\_mixins\.FileStoreBase\.write\_path\_template -============================================================================ - -.. currentmodule:: ophyd.areadetector.filestore_mixins - -.. autoattribute:: FileStoreBase.write_path_template \ No newline at end of file diff --git a/ophyd/_sources/generated/ophyd.areadetector.filestore_mixins.FileStoreHDF5.rst.txt b/ophyd/_sources/generated/ophyd.areadetector.filestore_mixins.FileStoreHDF5.rst.txt deleted file mode 100644 index 2ecb61dbf6..0000000000 --- a/ophyd/_sources/generated/ophyd.areadetector.filestore_mixins.FileStoreHDF5.rst.txt +++ /dev/null @@ -1,33 +0,0 @@ -ophyd\.areadetector\.filestore\_mixins\.FileStoreHDF5 -===================================================== - -.. currentmodule:: ophyd.areadetector.filestore_mixins - -.. autoclass:: FileStoreHDF5 - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~FileStoreHDF5.__init__ - ~FileStoreHDF5.collect_asset_docs - ~FileStoreHDF5.describe - ~FileStoreHDF5.generate_datum - ~FileStoreHDF5.get_frames_per_point - ~FileStoreHDF5.make_filename - ~FileStoreHDF5.pause - ~FileStoreHDF5.read - ~FileStoreHDF5.resume - ~FileStoreHDF5.stage - ~FileStoreHDF5.trigger - ~FileStoreHDF5.unstage - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/generated/ophyd.areadetector.filestore_mixins.FileStoreHDF5IterativeWrite.rst.txt b/ophyd/_sources/generated/ophyd.areadetector.filestore_mixins.FileStoreHDF5IterativeWrite.rst.txt deleted file mode 100644 index 4090d88b75..0000000000 --- a/ophyd/_sources/generated/ophyd.areadetector.filestore_mixins.FileStoreHDF5IterativeWrite.rst.txt +++ /dev/null @@ -1,33 +0,0 @@ -ophyd\.areadetector\.filestore\_mixins\.FileStoreHDF5IterativeWrite -=================================================================== - -.. currentmodule:: ophyd.areadetector.filestore_mixins - -.. autoclass:: FileStoreHDF5IterativeWrite - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~FileStoreHDF5IterativeWrite.__init__ - ~FileStoreHDF5IterativeWrite.collect_asset_docs - ~FileStoreHDF5IterativeWrite.describe - ~FileStoreHDF5IterativeWrite.generate_datum - ~FileStoreHDF5IterativeWrite.get_frames_per_point - ~FileStoreHDF5IterativeWrite.make_filename - ~FileStoreHDF5IterativeWrite.pause - ~FileStoreHDF5IterativeWrite.read - ~FileStoreHDF5IterativeWrite.resume - ~FileStoreHDF5IterativeWrite.stage - ~FileStoreHDF5IterativeWrite.trigger - ~FileStoreHDF5IterativeWrite.unstage - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/generated/ophyd.areadetector.filestore_mixins.FileStoreIterativeWrite.rst.txt b/ophyd/_sources/generated/ophyd.areadetector.filestore_mixins.FileStoreIterativeWrite.rst.txt deleted file mode 100644 index 927ca12b6f..0000000000 --- a/ophyd/_sources/generated/ophyd.areadetector.filestore_mixins.FileStoreIterativeWrite.rst.txt +++ /dev/null @@ -1,31 +0,0 @@ -ophyd\.areadetector\.filestore\_mixins\.FileStoreIterativeWrite -=============================================================== - -.. currentmodule:: ophyd.areadetector.filestore_mixins - -.. autoclass:: FileStoreIterativeWrite - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~FileStoreIterativeWrite.__init__ - ~FileStoreIterativeWrite.collect_asset_docs - ~FileStoreIterativeWrite.describe - ~FileStoreIterativeWrite.generate_datum - ~FileStoreIterativeWrite.pause - ~FileStoreIterativeWrite.read - ~FileStoreIterativeWrite.resume - ~FileStoreIterativeWrite.stage - ~FileStoreIterativeWrite.trigger - ~FileStoreIterativeWrite.unstage - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/generated/ophyd.areadetector.filestore_mixins.FileStorePluginBase.make_filename.rst.txt b/ophyd/_sources/generated/ophyd.areadetector.filestore_mixins.FileStorePluginBase.make_filename.rst.txt deleted file mode 100644 index b57e08df54..0000000000 --- a/ophyd/_sources/generated/ophyd.areadetector.filestore_mixins.FileStorePluginBase.make_filename.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -ophyd\.areadetector\.filestore\_mixins\.FileStorePluginBase\.make\_filename -=========================================================================== - -.. currentmodule:: ophyd.areadetector.filestore_mixins - -.. automethod:: FileStorePluginBase.make_filename \ No newline at end of file diff --git a/ophyd/_sources/generated/ophyd.areadetector.filestore_mixins.FileStorePluginBase.rst.txt b/ophyd/_sources/generated/ophyd.areadetector.filestore_mixins.FileStorePluginBase.rst.txt deleted file mode 100644 index 75dca87e33..0000000000 --- a/ophyd/_sources/generated/ophyd.areadetector.filestore_mixins.FileStorePluginBase.rst.txt +++ /dev/null @@ -1,32 +0,0 @@ -ophyd\.areadetector\.filestore\_mixins\.FileStorePluginBase -=========================================================== - -.. currentmodule:: ophyd.areadetector.filestore_mixins - -.. autoclass:: FileStorePluginBase - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~FileStorePluginBase.__init__ - ~FileStorePluginBase.collect_asset_docs - ~FileStorePluginBase.describe - ~FileStorePluginBase.generate_datum - ~FileStorePluginBase.make_filename - ~FileStorePluginBase.pause - ~FileStorePluginBase.read - ~FileStorePluginBase.resume - ~FileStorePluginBase.stage - ~FileStorePluginBase.trigger - ~FileStorePluginBase.unstage - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/generated/ophyd.areadetector.filestore_mixins.FileStoreTIFF.rst.txt b/ophyd/_sources/generated/ophyd.areadetector.filestore_mixins.FileStoreTIFF.rst.txt deleted file mode 100644 index cf05499195..0000000000 --- a/ophyd/_sources/generated/ophyd.areadetector.filestore_mixins.FileStoreTIFF.rst.txt +++ /dev/null @@ -1,33 +0,0 @@ -ophyd\.areadetector\.filestore\_mixins\.FileStoreTIFF -===================================================== - -.. currentmodule:: ophyd.areadetector.filestore_mixins - -.. autoclass:: FileStoreTIFF - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~FileStoreTIFF.__init__ - ~FileStoreTIFF.collect_asset_docs - ~FileStoreTIFF.describe - ~FileStoreTIFF.generate_datum - ~FileStoreTIFF.get_frames_per_point - ~FileStoreTIFF.make_filename - ~FileStoreTIFF.pause - ~FileStoreTIFF.read - ~FileStoreTIFF.resume - ~FileStoreTIFF.stage - ~FileStoreTIFF.trigger - ~FileStoreTIFF.unstage - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/generated/ophyd.areadetector.filestore_mixins.FileStoreTIFFIterativeWrite.rst.txt b/ophyd/_sources/generated/ophyd.areadetector.filestore_mixins.FileStoreTIFFIterativeWrite.rst.txt deleted file mode 100644 index fa130b2608..0000000000 --- a/ophyd/_sources/generated/ophyd.areadetector.filestore_mixins.FileStoreTIFFIterativeWrite.rst.txt +++ /dev/null @@ -1,33 +0,0 @@ -ophyd\.areadetector\.filestore\_mixins\.FileStoreTIFFIterativeWrite -=================================================================== - -.. currentmodule:: ophyd.areadetector.filestore_mixins - -.. autoclass:: FileStoreTIFFIterativeWrite - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~FileStoreTIFFIterativeWrite.__init__ - ~FileStoreTIFFIterativeWrite.collect_asset_docs - ~FileStoreTIFFIterativeWrite.describe - ~FileStoreTIFFIterativeWrite.generate_datum - ~FileStoreTIFFIterativeWrite.get_frames_per_point - ~FileStoreTIFFIterativeWrite.make_filename - ~FileStoreTIFFIterativeWrite.pause - ~FileStoreTIFFIterativeWrite.read - ~FileStoreTIFFIterativeWrite.resume - ~FileStoreTIFFIterativeWrite.stage - ~FileStoreTIFFIterativeWrite.trigger - ~FileStoreTIFFIterativeWrite.unstage - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/generated/ophyd.areadetector.filestore_mixins.FileStoreTIFFSquashing.rst.txt b/ophyd/_sources/generated/ophyd.areadetector.filestore_mixins.FileStoreTIFFSquashing.rst.txt deleted file mode 100644 index 94e9f64a4c..0000000000 --- a/ophyd/_sources/generated/ophyd.areadetector.filestore_mixins.FileStoreTIFFSquashing.rst.txt +++ /dev/null @@ -1,33 +0,0 @@ -ophyd\.areadetector\.filestore\_mixins\.FileStoreTIFFSquashing -============================================================== - -.. currentmodule:: ophyd.areadetector.filestore_mixins - -.. autoclass:: FileStoreTIFFSquashing - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~FileStoreTIFFSquashing.__init__ - ~FileStoreTIFFSquashing.collect_asset_docs - ~FileStoreTIFFSquashing.describe - ~FileStoreTIFFSquashing.generate_datum - ~FileStoreTIFFSquashing.get_frames_per_point - ~FileStoreTIFFSquashing.make_filename - ~FileStoreTIFFSquashing.pause - ~FileStoreTIFFSquashing.read - ~FileStoreTIFFSquashing.resume - ~FileStoreTIFFSquashing.stage - ~FileStoreTIFFSquashing.trigger - ~FileStoreTIFFSquashing.unstage - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/generated/ophyd.areadetector.filestore_mixins.rst.txt b/ophyd/_sources/generated/ophyd.areadetector.filestore_mixins.rst.txt deleted file mode 100644 index 03b17f329e..0000000000 --- a/ophyd/_sources/generated/ophyd.areadetector.filestore_mixins.rst.txt +++ /dev/null @@ -1,39 +0,0 @@ -ophyd\.areadetector\.filestore\_mixins -====================================== - -.. automodule:: ophyd.areadetector.filestore_mixins - - - - .. rubric:: Functions - - .. autosummary:: - - new_short_uid - new_uid - resource_factory - - - - - - .. rubric:: Classes - - .. autosummary:: - - FileStoreBase - FileStoreHDF5 - FileStoreHDF5IterativeWrite - FileStoreHDF5Single - FileStoreHDF5SingleIterativeWrite - FileStoreIterativeWrite - FileStorePluginBase - FileStoreTIFF - FileStoreTIFFIterativeWrite - FileStoreTIFFSquashing - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/generated/ophyd.areadetector.plugins.ColorConvPlugin.rst.txt b/ophyd/_sources/generated/ophyd.areadetector.plugins.ColorConvPlugin.rst.txt deleted file mode 100644 index 25c106f78b..0000000000 --- a/ophyd/_sources/generated/ophyd.areadetector.plugins.ColorConvPlugin.rst.txt +++ /dev/null @@ -1,61 +0,0 @@ -ophyd\.areadetector\.plugins\.ColorConvPlugin -============================================= - -.. currentmodule:: ophyd.areadetector.plugins - -.. autoclass:: ColorConvPlugin - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~ColorConvPlugin.__init__ - ~ColorConvPlugin.add_instantiation_callback - ~ColorConvPlugin.check_value - ~ColorConvPlugin.clear_sub - ~ColorConvPlugin.configure - ~ColorConvPlugin.describe - ~ColorConvPlugin.describe_configuration - ~ColorConvPlugin.destroy - ~ColorConvPlugin.disable_on_stage - ~ColorConvPlugin.enable_on_stage - ~ColorConvPlugin.ensure_blocking - ~ColorConvPlugin.ensure_nonblocking - ~ColorConvPlugin.find_signal - ~ColorConvPlugin.get - ~ColorConvPlugin.get_asyn_digraph - ~ColorConvPlugin.get_asyn_port_dictionary - ~ColorConvPlugin.get_device_tuple - ~ColorConvPlugin.get_instantiated_signals - ~ColorConvPlugin.get_plugin_by_asyn_port - ~ColorConvPlugin.missing_plugins - ~ColorConvPlugin.pause - ~ColorConvPlugin.put - ~ColorConvPlugin.read - ~ColorConvPlugin.read_configuration - ~ColorConvPlugin.resume - ~ColorConvPlugin.stage - ~ColorConvPlugin.stop - ~ColorConvPlugin.subscribe - ~ColorConvPlugin.summary - ~ColorConvPlugin.trigger - ~ColorConvPlugin.unstage - ~ColorConvPlugin.unsubscribe - ~ColorConvPlugin.unsubscribe_all - ~ColorConvPlugin.validate_asyn_ports - ~ColorConvPlugin.visualize_asyn_digraph - ~ColorConvPlugin.wait_for_connection - ~ColorConvPlugin.walk_components - ~ColorConvPlugin.walk_signals - ~ColorConvPlugin.walk_subdevice_classes - ~ColorConvPlugin.walk_subdevices - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/generated/ophyd.areadetector.plugins.FilePlugin.rst.txt b/ophyd/_sources/generated/ophyd.areadetector.plugins.FilePlugin.rst.txt deleted file mode 100644 index 8f8fa43b16..0000000000 --- a/ophyd/_sources/generated/ophyd.areadetector.plugins.FilePlugin.rst.txt +++ /dev/null @@ -1,62 +0,0 @@ -ophyd\.areadetector\.plugins\.FilePlugin -======================================== - -.. currentmodule:: ophyd.areadetector.plugins - -.. autoclass:: FilePlugin - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~FilePlugin.__init__ - ~FilePlugin.add_instantiation_callback - ~FilePlugin.check_value - ~FilePlugin.clear_sub - ~FilePlugin.configure - ~FilePlugin.describe - ~FilePlugin.describe_configuration - ~FilePlugin.destroy - ~FilePlugin.disable_on_stage - ~FilePlugin.enable_on_stage - ~FilePlugin.ensure_blocking - ~FilePlugin.ensure_nonblocking - ~FilePlugin.find_signal - ~FilePlugin.generate_datum - ~FilePlugin.get - ~FilePlugin.get_asyn_digraph - ~FilePlugin.get_asyn_port_dictionary - ~FilePlugin.get_device_tuple - ~FilePlugin.get_instantiated_signals - ~FilePlugin.get_plugin_by_asyn_port - ~FilePlugin.missing_plugins - ~FilePlugin.pause - ~FilePlugin.put - ~FilePlugin.read - ~FilePlugin.read_configuration - ~FilePlugin.resume - ~FilePlugin.stage - ~FilePlugin.stop - ~FilePlugin.subscribe - ~FilePlugin.summary - ~FilePlugin.trigger - ~FilePlugin.unstage - ~FilePlugin.unsubscribe - ~FilePlugin.unsubscribe_all - ~FilePlugin.validate_asyn_ports - ~FilePlugin.visualize_asyn_digraph - ~FilePlugin.wait_for_connection - ~FilePlugin.walk_components - ~FilePlugin.walk_signals - ~FilePlugin.walk_subdevice_classes - ~FilePlugin.walk_subdevices - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/generated/ophyd.areadetector.plugins.HDF5Plugin.rst.txt b/ophyd/_sources/generated/ophyd.areadetector.plugins.HDF5Plugin.rst.txt deleted file mode 100644 index 029e00d52e..0000000000 --- a/ophyd/_sources/generated/ophyd.areadetector.plugins.HDF5Plugin.rst.txt +++ /dev/null @@ -1,63 +0,0 @@ -ophyd\.areadetector\.plugins\.HDF5Plugin -======================================== - -.. currentmodule:: ophyd.areadetector.plugins - -.. autoclass:: HDF5Plugin - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~HDF5Plugin.__init__ - ~HDF5Plugin.add_instantiation_callback - ~HDF5Plugin.check_value - ~HDF5Plugin.clear_sub - ~HDF5Plugin.configure - ~HDF5Plugin.describe - ~HDF5Plugin.describe_configuration - ~HDF5Plugin.destroy - ~HDF5Plugin.disable_on_stage - ~HDF5Plugin.enable_on_stage - ~HDF5Plugin.ensure_blocking - ~HDF5Plugin.ensure_nonblocking - ~HDF5Plugin.find_signal - ~HDF5Plugin.generate_datum - ~HDF5Plugin.get - ~HDF5Plugin.get_asyn_digraph - ~HDF5Plugin.get_asyn_port_dictionary - ~HDF5Plugin.get_device_tuple - ~HDF5Plugin.get_instantiated_signals - ~HDF5Plugin.get_plugin_by_asyn_port - ~HDF5Plugin.missing_plugins - ~HDF5Plugin.pause - ~HDF5Plugin.put - ~HDF5Plugin.read - ~HDF5Plugin.read_configuration - ~HDF5Plugin.resume - ~HDF5Plugin.stage - ~HDF5Plugin.stop - ~HDF5Plugin.subscribe - ~HDF5Plugin.summary - ~HDF5Plugin.trigger - ~HDF5Plugin.unstage - ~HDF5Plugin.unsubscribe - ~HDF5Plugin.unsubscribe_all - ~HDF5Plugin.validate_asyn_ports - ~HDF5Plugin.visualize_asyn_digraph - ~HDF5Plugin.wait_for_connection - ~HDF5Plugin.walk_components - ~HDF5Plugin.walk_signals - ~HDF5Plugin.walk_subdevice_classes - ~HDF5Plugin.walk_subdevices - ~HDF5Plugin.warmup - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/generated/ophyd.areadetector.plugins.ImagePlugin.rst.txt b/ophyd/_sources/generated/ophyd.areadetector.plugins.ImagePlugin.rst.txt deleted file mode 100644 index 713e32c4bf..0000000000 --- a/ophyd/_sources/generated/ophyd.areadetector.plugins.ImagePlugin.rst.txt +++ /dev/null @@ -1,61 +0,0 @@ -ophyd\.areadetector\.plugins\.ImagePlugin -========================================= - -.. currentmodule:: ophyd.areadetector.plugins - -.. autoclass:: ImagePlugin - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~ImagePlugin.__init__ - ~ImagePlugin.add_instantiation_callback - ~ImagePlugin.check_value - ~ImagePlugin.clear_sub - ~ImagePlugin.configure - ~ImagePlugin.describe - ~ImagePlugin.describe_configuration - ~ImagePlugin.destroy - ~ImagePlugin.disable_on_stage - ~ImagePlugin.enable_on_stage - ~ImagePlugin.ensure_blocking - ~ImagePlugin.ensure_nonblocking - ~ImagePlugin.find_signal - ~ImagePlugin.get - ~ImagePlugin.get_asyn_digraph - ~ImagePlugin.get_asyn_port_dictionary - ~ImagePlugin.get_device_tuple - ~ImagePlugin.get_instantiated_signals - ~ImagePlugin.get_plugin_by_asyn_port - ~ImagePlugin.missing_plugins - ~ImagePlugin.pause - ~ImagePlugin.put - ~ImagePlugin.read - ~ImagePlugin.read_configuration - ~ImagePlugin.resume - ~ImagePlugin.stage - ~ImagePlugin.stop - ~ImagePlugin.subscribe - ~ImagePlugin.summary - ~ImagePlugin.trigger - ~ImagePlugin.unstage - ~ImagePlugin.unsubscribe - ~ImagePlugin.unsubscribe_all - ~ImagePlugin.validate_asyn_ports - ~ImagePlugin.visualize_asyn_digraph - ~ImagePlugin.wait_for_connection - ~ImagePlugin.walk_components - ~ImagePlugin.walk_signals - ~ImagePlugin.walk_subdevice_classes - ~ImagePlugin.walk_subdevices - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/generated/ophyd.areadetector.plugins.JPEGPlugin.rst.txt b/ophyd/_sources/generated/ophyd.areadetector.plugins.JPEGPlugin.rst.txt deleted file mode 100644 index 4877093e84..0000000000 --- a/ophyd/_sources/generated/ophyd.areadetector.plugins.JPEGPlugin.rst.txt +++ /dev/null @@ -1,62 +0,0 @@ -ophyd\.areadetector\.plugins\.JPEGPlugin -======================================== - -.. currentmodule:: ophyd.areadetector.plugins - -.. autoclass:: JPEGPlugin - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~JPEGPlugin.__init__ - ~JPEGPlugin.add_instantiation_callback - ~JPEGPlugin.check_value - ~JPEGPlugin.clear_sub - ~JPEGPlugin.configure - ~JPEGPlugin.describe - ~JPEGPlugin.describe_configuration - ~JPEGPlugin.destroy - ~JPEGPlugin.disable_on_stage - ~JPEGPlugin.enable_on_stage - ~JPEGPlugin.ensure_blocking - ~JPEGPlugin.ensure_nonblocking - ~JPEGPlugin.find_signal - ~JPEGPlugin.generate_datum - ~JPEGPlugin.get - ~JPEGPlugin.get_asyn_digraph - ~JPEGPlugin.get_asyn_port_dictionary - ~JPEGPlugin.get_device_tuple - ~JPEGPlugin.get_instantiated_signals - ~JPEGPlugin.get_plugin_by_asyn_port - ~JPEGPlugin.missing_plugins - ~JPEGPlugin.pause - ~JPEGPlugin.put - ~JPEGPlugin.read - ~JPEGPlugin.read_configuration - ~JPEGPlugin.resume - ~JPEGPlugin.stage - ~JPEGPlugin.stop - ~JPEGPlugin.subscribe - ~JPEGPlugin.summary - ~JPEGPlugin.trigger - ~JPEGPlugin.unstage - ~JPEGPlugin.unsubscribe - ~JPEGPlugin.unsubscribe_all - ~JPEGPlugin.validate_asyn_ports - ~JPEGPlugin.visualize_asyn_digraph - ~JPEGPlugin.wait_for_connection - ~JPEGPlugin.walk_components - ~JPEGPlugin.walk_signals - ~JPEGPlugin.walk_subdevice_classes - ~JPEGPlugin.walk_subdevices - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/generated/ophyd.areadetector.plugins.MagickPlugin.rst.txt b/ophyd/_sources/generated/ophyd.areadetector.plugins.MagickPlugin.rst.txt deleted file mode 100644 index 5b77c4c4be..0000000000 --- a/ophyd/_sources/generated/ophyd.areadetector.plugins.MagickPlugin.rst.txt +++ /dev/null @@ -1,62 +0,0 @@ -ophyd\.areadetector\.plugins\.MagickPlugin -========================================== - -.. currentmodule:: ophyd.areadetector.plugins - -.. autoclass:: MagickPlugin - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~MagickPlugin.__init__ - ~MagickPlugin.add_instantiation_callback - ~MagickPlugin.check_value - ~MagickPlugin.clear_sub - ~MagickPlugin.configure - ~MagickPlugin.describe - ~MagickPlugin.describe_configuration - ~MagickPlugin.destroy - ~MagickPlugin.disable_on_stage - ~MagickPlugin.enable_on_stage - ~MagickPlugin.ensure_blocking - ~MagickPlugin.ensure_nonblocking - ~MagickPlugin.find_signal - ~MagickPlugin.generate_datum - ~MagickPlugin.get - ~MagickPlugin.get_asyn_digraph - ~MagickPlugin.get_asyn_port_dictionary - ~MagickPlugin.get_device_tuple - ~MagickPlugin.get_instantiated_signals - ~MagickPlugin.get_plugin_by_asyn_port - ~MagickPlugin.missing_plugins - ~MagickPlugin.pause - ~MagickPlugin.put - ~MagickPlugin.read - ~MagickPlugin.read_configuration - ~MagickPlugin.resume - ~MagickPlugin.stage - ~MagickPlugin.stop - ~MagickPlugin.subscribe - ~MagickPlugin.summary - ~MagickPlugin.trigger - ~MagickPlugin.unstage - ~MagickPlugin.unsubscribe - ~MagickPlugin.unsubscribe_all - ~MagickPlugin.validate_asyn_ports - ~MagickPlugin.visualize_asyn_digraph - ~MagickPlugin.wait_for_connection - ~MagickPlugin.walk_components - ~MagickPlugin.walk_signals - ~MagickPlugin.walk_subdevice_classes - ~MagickPlugin.walk_subdevices - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/generated/ophyd.areadetector.plugins.NetCDFPlugin.rst.txt b/ophyd/_sources/generated/ophyd.areadetector.plugins.NetCDFPlugin.rst.txt deleted file mode 100644 index 2e89689580..0000000000 --- a/ophyd/_sources/generated/ophyd.areadetector.plugins.NetCDFPlugin.rst.txt +++ /dev/null @@ -1,62 +0,0 @@ -ophyd\.areadetector\.plugins\.NetCDFPlugin -========================================== - -.. currentmodule:: ophyd.areadetector.plugins - -.. autoclass:: NetCDFPlugin - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~NetCDFPlugin.__init__ - ~NetCDFPlugin.add_instantiation_callback - ~NetCDFPlugin.check_value - ~NetCDFPlugin.clear_sub - ~NetCDFPlugin.configure - ~NetCDFPlugin.describe - ~NetCDFPlugin.describe_configuration - ~NetCDFPlugin.destroy - ~NetCDFPlugin.disable_on_stage - ~NetCDFPlugin.enable_on_stage - ~NetCDFPlugin.ensure_blocking - ~NetCDFPlugin.ensure_nonblocking - ~NetCDFPlugin.find_signal - ~NetCDFPlugin.generate_datum - ~NetCDFPlugin.get - ~NetCDFPlugin.get_asyn_digraph - ~NetCDFPlugin.get_asyn_port_dictionary - ~NetCDFPlugin.get_device_tuple - ~NetCDFPlugin.get_instantiated_signals - ~NetCDFPlugin.get_plugin_by_asyn_port - ~NetCDFPlugin.missing_plugins - ~NetCDFPlugin.pause - ~NetCDFPlugin.put - ~NetCDFPlugin.read - ~NetCDFPlugin.read_configuration - ~NetCDFPlugin.resume - ~NetCDFPlugin.stage - ~NetCDFPlugin.stop - ~NetCDFPlugin.subscribe - ~NetCDFPlugin.summary - ~NetCDFPlugin.trigger - ~NetCDFPlugin.unstage - ~NetCDFPlugin.unsubscribe - ~NetCDFPlugin.unsubscribe_all - ~NetCDFPlugin.validate_asyn_ports - ~NetCDFPlugin.visualize_asyn_digraph - ~NetCDFPlugin.wait_for_connection - ~NetCDFPlugin.walk_components - ~NetCDFPlugin.walk_signals - ~NetCDFPlugin.walk_subdevice_classes - ~NetCDFPlugin.walk_subdevices - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/generated/ophyd.areadetector.plugins.NexusPlugin.rst.txt b/ophyd/_sources/generated/ophyd.areadetector.plugins.NexusPlugin.rst.txt deleted file mode 100644 index 353f3e7541..0000000000 --- a/ophyd/_sources/generated/ophyd.areadetector.plugins.NexusPlugin.rst.txt +++ /dev/null @@ -1,62 +0,0 @@ -ophyd\.areadetector\.plugins\.NexusPlugin -========================================= - -.. currentmodule:: ophyd.areadetector.plugins - -.. autoclass:: NexusPlugin - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~NexusPlugin.__init__ - ~NexusPlugin.add_instantiation_callback - ~NexusPlugin.check_value - ~NexusPlugin.clear_sub - ~NexusPlugin.configure - ~NexusPlugin.describe - ~NexusPlugin.describe_configuration - ~NexusPlugin.destroy - ~NexusPlugin.disable_on_stage - ~NexusPlugin.enable_on_stage - ~NexusPlugin.ensure_blocking - ~NexusPlugin.ensure_nonblocking - ~NexusPlugin.find_signal - ~NexusPlugin.generate_datum - ~NexusPlugin.get - ~NexusPlugin.get_asyn_digraph - ~NexusPlugin.get_asyn_port_dictionary - ~NexusPlugin.get_device_tuple - ~NexusPlugin.get_instantiated_signals - ~NexusPlugin.get_plugin_by_asyn_port - ~NexusPlugin.missing_plugins - ~NexusPlugin.pause - ~NexusPlugin.put - ~NexusPlugin.read - ~NexusPlugin.read_configuration - ~NexusPlugin.resume - ~NexusPlugin.stage - ~NexusPlugin.stop - ~NexusPlugin.subscribe - ~NexusPlugin.summary - ~NexusPlugin.trigger - ~NexusPlugin.unstage - ~NexusPlugin.unsubscribe - ~NexusPlugin.unsubscribe_all - ~NexusPlugin.validate_asyn_ports - ~NexusPlugin.visualize_asyn_digraph - ~NexusPlugin.wait_for_connection - ~NexusPlugin.walk_components - ~NexusPlugin.walk_signals - ~NexusPlugin.walk_subdevice_classes - ~NexusPlugin.walk_subdevices - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/generated/ophyd.areadetector.plugins.OverlayPlugin.rst.txt b/ophyd/_sources/generated/ophyd.areadetector.plugins.OverlayPlugin.rst.txt deleted file mode 100644 index 2b72620c01..0000000000 --- a/ophyd/_sources/generated/ophyd.areadetector.plugins.OverlayPlugin.rst.txt +++ /dev/null @@ -1,61 +0,0 @@ -ophyd\.areadetector\.plugins\.OverlayPlugin -=========================================== - -.. currentmodule:: ophyd.areadetector.plugins - -.. autoclass:: OverlayPlugin - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~OverlayPlugin.__init__ - ~OverlayPlugin.add_instantiation_callback - ~OverlayPlugin.check_value - ~OverlayPlugin.clear_sub - ~OverlayPlugin.configure - ~OverlayPlugin.describe - ~OverlayPlugin.describe_configuration - ~OverlayPlugin.destroy - ~OverlayPlugin.disable_on_stage - ~OverlayPlugin.enable_on_stage - ~OverlayPlugin.ensure_blocking - ~OverlayPlugin.ensure_nonblocking - ~OverlayPlugin.find_signal - ~OverlayPlugin.get - ~OverlayPlugin.get_asyn_digraph - ~OverlayPlugin.get_asyn_port_dictionary - ~OverlayPlugin.get_device_tuple - ~OverlayPlugin.get_instantiated_signals - ~OverlayPlugin.get_plugin_by_asyn_port - ~OverlayPlugin.missing_plugins - ~OverlayPlugin.pause - ~OverlayPlugin.put - ~OverlayPlugin.read - ~OverlayPlugin.read_configuration - ~OverlayPlugin.resume - ~OverlayPlugin.stage - ~OverlayPlugin.stop - ~OverlayPlugin.subscribe - ~OverlayPlugin.summary - ~OverlayPlugin.trigger - ~OverlayPlugin.unstage - ~OverlayPlugin.unsubscribe - ~OverlayPlugin.unsubscribe_all - ~OverlayPlugin.validate_asyn_ports - ~OverlayPlugin.visualize_asyn_digraph - ~OverlayPlugin.wait_for_connection - ~OverlayPlugin.walk_components - ~OverlayPlugin.walk_signals - ~OverlayPlugin.walk_subdevice_classes - ~OverlayPlugin.walk_subdevices - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/generated/ophyd.areadetector.plugins.PluginBase.rst.txt b/ophyd/_sources/generated/ophyd.areadetector.plugins.PluginBase.rst.txt deleted file mode 100644 index 8c3955489d..0000000000 --- a/ophyd/_sources/generated/ophyd.areadetector.plugins.PluginBase.rst.txt +++ /dev/null @@ -1,61 +0,0 @@ -ophyd\.areadetector\.plugins\.PluginBase -======================================== - -.. currentmodule:: ophyd.areadetector.plugins - -.. autoclass:: PluginBase - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~PluginBase.__init__ - ~PluginBase.add_instantiation_callback - ~PluginBase.check_value - ~PluginBase.clear_sub - ~PluginBase.configure - ~PluginBase.describe - ~PluginBase.describe_configuration - ~PluginBase.destroy - ~PluginBase.disable_on_stage - ~PluginBase.enable_on_stage - ~PluginBase.ensure_blocking - ~PluginBase.ensure_nonblocking - ~PluginBase.find_signal - ~PluginBase.get - ~PluginBase.get_asyn_digraph - ~PluginBase.get_asyn_port_dictionary - ~PluginBase.get_device_tuple - ~PluginBase.get_instantiated_signals - ~PluginBase.get_plugin_by_asyn_port - ~PluginBase.missing_plugins - ~PluginBase.pause - ~PluginBase.put - ~PluginBase.read - ~PluginBase.read_configuration - ~PluginBase.resume - ~PluginBase.stage - ~PluginBase.stop - ~PluginBase.subscribe - ~PluginBase.summary - ~PluginBase.trigger - ~PluginBase.unstage - ~PluginBase.unsubscribe - ~PluginBase.unsubscribe_all - ~PluginBase.validate_asyn_ports - ~PluginBase.visualize_asyn_digraph - ~PluginBase.wait_for_connection - ~PluginBase.walk_components - ~PluginBase.walk_signals - ~PluginBase.walk_subdevice_classes - ~PluginBase.walk_subdevices - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/generated/ophyd.areadetector.plugins.ProcessPlugin.rst.txt b/ophyd/_sources/generated/ophyd.areadetector.plugins.ProcessPlugin.rst.txt deleted file mode 100644 index eae3372933..0000000000 --- a/ophyd/_sources/generated/ophyd.areadetector.plugins.ProcessPlugin.rst.txt +++ /dev/null @@ -1,61 +0,0 @@ -ophyd\.areadetector\.plugins\.ProcessPlugin -=========================================== - -.. currentmodule:: ophyd.areadetector.plugins - -.. autoclass:: ProcessPlugin - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~ProcessPlugin.__init__ - ~ProcessPlugin.add_instantiation_callback - ~ProcessPlugin.check_value - ~ProcessPlugin.clear_sub - ~ProcessPlugin.configure - ~ProcessPlugin.describe - ~ProcessPlugin.describe_configuration - ~ProcessPlugin.destroy - ~ProcessPlugin.disable_on_stage - ~ProcessPlugin.enable_on_stage - ~ProcessPlugin.ensure_blocking - ~ProcessPlugin.ensure_nonblocking - ~ProcessPlugin.find_signal - ~ProcessPlugin.get - ~ProcessPlugin.get_asyn_digraph - ~ProcessPlugin.get_asyn_port_dictionary - ~ProcessPlugin.get_device_tuple - ~ProcessPlugin.get_instantiated_signals - ~ProcessPlugin.get_plugin_by_asyn_port - ~ProcessPlugin.missing_plugins - ~ProcessPlugin.pause - ~ProcessPlugin.put - ~ProcessPlugin.read - ~ProcessPlugin.read_configuration - ~ProcessPlugin.resume - ~ProcessPlugin.stage - ~ProcessPlugin.stop - ~ProcessPlugin.subscribe - ~ProcessPlugin.summary - ~ProcessPlugin.trigger - ~ProcessPlugin.unstage - ~ProcessPlugin.unsubscribe - ~ProcessPlugin.unsubscribe_all - ~ProcessPlugin.validate_asyn_ports - ~ProcessPlugin.visualize_asyn_digraph - ~ProcessPlugin.wait_for_connection - ~ProcessPlugin.walk_components - ~ProcessPlugin.walk_signals - ~ProcessPlugin.walk_subdevice_classes - ~ProcessPlugin.walk_subdevices - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/generated/ophyd.areadetector.plugins.ROIPlugin.rst.txt b/ophyd/_sources/generated/ophyd.areadetector.plugins.ROIPlugin.rst.txt deleted file mode 100644 index a258227921..0000000000 --- a/ophyd/_sources/generated/ophyd.areadetector.plugins.ROIPlugin.rst.txt +++ /dev/null @@ -1,62 +0,0 @@ -ophyd\.areadetector\.plugins\.ROIPlugin -======================================= - -.. currentmodule:: ophyd.areadetector.plugins - -.. autoclass:: ROIPlugin - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~ROIPlugin.__init__ - ~ROIPlugin.add_instantiation_callback - ~ROIPlugin.check_value - ~ROIPlugin.clear_sub - ~ROIPlugin.configure - ~ROIPlugin.describe - ~ROIPlugin.describe_configuration - ~ROIPlugin.destroy - ~ROIPlugin.disable_on_stage - ~ROIPlugin.enable_on_stage - ~ROIPlugin.ensure_blocking - ~ROIPlugin.ensure_nonblocking - ~ROIPlugin.find_signal - ~ROIPlugin.get - ~ROIPlugin.get_asyn_digraph - ~ROIPlugin.get_asyn_port_dictionary - ~ROIPlugin.get_device_tuple - ~ROIPlugin.get_instantiated_signals - ~ROIPlugin.get_plugin_by_asyn_port - ~ROIPlugin.missing_plugins - ~ROIPlugin.pause - ~ROIPlugin.put - ~ROIPlugin.read - ~ROIPlugin.read_configuration - ~ROIPlugin.resume - ~ROIPlugin.set - ~ROIPlugin.stage - ~ROIPlugin.stop - ~ROIPlugin.subscribe - ~ROIPlugin.summary - ~ROIPlugin.trigger - ~ROIPlugin.unstage - ~ROIPlugin.unsubscribe - ~ROIPlugin.unsubscribe_all - ~ROIPlugin.validate_asyn_ports - ~ROIPlugin.visualize_asyn_digraph - ~ROIPlugin.wait_for_connection - ~ROIPlugin.walk_components - ~ROIPlugin.walk_signals - ~ROIPlugin.walk_subdevice_classes - ~ROIPlugin.walk_subdevices - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/generated/ophyd.areadetector.plugins.StatsPlugin.rst.txt b/ophyd/_sources/generated/ophyd.areadetector.plugins.StatsPlugin.rst.txt deleted file mode 100644 index 9533d56e8d..0000000000 --- a/ophyd/_sources/generated/ophyd.areadetector.plugins.StatsPlugin.rst.txt +++ /dev/null @@ -1,61 +0,0 @@ -ophyd\.areadetector\.plugins\.StatsPlugin -========================================= - -.. currentmodule:: ophyd.areadetector.plugins - -.. autoclass:: StatsPlugin - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~StatsPlugin.__init__ - ~StatsPlugin.add_instantiation_callback - ~StatsPlugin.check_value - ~StatsPlugin.clear_sub - ~StatsPlugin.configure - ~StatsPlugin.describe - ~StatsPlugin.describe_configuration - ~StatsPlugin.destroy - ~StatsPlugin.disable_on_stage - ~StatsPlugin.enable_on_stage - ~StatsPlugin.ensure_blocking - ~StatsPlugin.ensure_nonblocking - ~StatsPlugin.find_signal - ~StatsPlugin.get - ~StatsPlugin.get_asyn_digraph - ~StatsPlugin.get_asyn_port_dictionary - ~StatsPlugin.get_device_tuple - ~StatsPlugin.get_instantiated_signals - ~StatsPlugin.get_plugin_by_asyn_port - ~StatsPlugin.missing_plugins - ~StatsPlugin.pause - ~StatsPlugin.put - ~StatsPlugin.read - ~StatsPlugin.read_configuration - ~StatsPlugin.resume - ~StatsPlugin.stage - ~StatsPlugin.stop - ~StatsPlugin.subscribe - ~StatsPlugin.summary - ~StatsPlugin.trigger - ~StatsPlugin.unstage - ~StatsPlugin.unsubscribe - ~StatsPlugin.unsubscribe_all - ~StatsPlugin.validate_asyn_ports - ~StatsPlugin.visualize_asyn_digraph - ~StatsPlugin.wait_for_connection - ~StatsPlugin.walk_components - ~StatsPlugin.walk_signals - ~StatsPlugin.walk_subdevice_classes - ~StatsPlugin.walk_subdevices - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/generated/ophyd.areadetector.plugins.TIFFPlugin.rst.txt b/ophyd/_sources/generated/ophyd.areadetector.plugins.TIFFPlugin.rst.txt deleted file mode 100644 index 96995b11f6..0000000000 --- a/ophyd/_sources/generated/ophyd.areadetector.plugins.TIFFPlugin.rst.txt +++ /dev/null @@ -1,62 +0,0 @@ -ophyd\.areadetector\.plugins\.TIFFPlugin -======================================== - -.. currentmodule:: ophyd.areadetector.plugins - -.. autoclass:: TIFFPlugin - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~TIFFPlugin.__init__ - ~TIFFPlugin.add_instantiation_callback - ~TIFFPlugin.check_value - ~TIFFPlugin.clear_sub - ~TIFFPlugin.configure - ~TIFFPlugin.describe - ~TIFFPlugin.describe_configuration - ~TIFFPlugin.destroy - ~TIFFPlugin.disable_on_stage - ~TIFFPlugin.enable_on_stage - ~TIFFPlugin.ensure_blocking - ~TIFFPlugin.ensure_nonblocking - ~TIFFPlugin.find_signal - ~TIFFPlugin.generate_datum - ~TIFFPlugin.get - ~TIFFPlugin.get_asyn_digraph - ~TIFFPlugin.get_asyn_port_dictionary - ~TIFFPlugin.get_device_tuple - ~TIFFPlugin.get_instantiated_signals - ~TIFFPlugin.get_plugin_by_asyn_port - ~TIFFPlugin.missing_plugins - ~TIFFPlugin.pause - ~TIFFPlugin.put - ~TIFFPlugin.read - ~TIFFPlugin.read_configuration - ~TIFFPlugin.resume - ~TIFFPlugin.stage - ~TIFFPlugin.stop - ~TIFFPlugin.subscribe - ~TIFFPlugin.summary - ~TIFFPlugin.trigger - ~TIFFPlugin.unstage - ~TIFFPlugin.unsubscribe - ~TIFFPlugin.unsubscribe_all - ~TIFFPlugin.validate_asyn_ports - ~TIFFPlugin.visualize_asyn_digraph - ~TIFFPlugin.wait_for_connection - ~TIFFPlugin.walk_components - ~TIFFPlugin.walk_signals - ~TIFFPlugin.walk_subdevice_classes - ~TIFFPlugin.walk_subdevices - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/generated/ophyd.areadetector.plugins.TransformPlugin.rst.txt b/ophyd/_sources/generated/ophyd.areadetector.plugins.TransformPlugin.rst.txt deleted file mode 100644 index d1704b4be5..0000000000 --- a/ophyd/_sources/generated/ophyd.areadetector.plugins.TransformPlugin.rst.txt +++ /dev/null @@ -1,61 +0,0 @@ -ophyd\.areadetector\.plugins\.TransformPlugin -============================================= - -.. currentmodule:: ophyd.areadetector.plugins - -.. autoclass:: TransformPlugin - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~TransformPlugin.__init__ - ~TransformPlugin.add_instantiation_callback - ~TransformPlugin.check_value - ~TransformPlugin.clear_sub - ~TransformPlugin.configure - ~TransformPlugin.describe - ~TransformPlugin.describe_configuration - ~TransformPlugin.destroy - ~TransformPlugin.disable_on_stage - ~TransformPlugin.enable_on_stage - ~TransformPlugin.ensure_blocking - ~TransformPlugin.ensure_nonblocking - ~TransformPlugin.find_signal - ~TransformPlugin.get - ~TransformPlugin.get_asyn_digraph - ~TransformPlugin.get_asyn_port_dictionary - ~TransformPlugin.get_device_tuple - ~TransformPlugin.get_instantiated_signals - ~TransformPlugin.get_plugin_by_asyn_port - ~TransformPlugin.missing_plugins - ~TransformPlugin.pause - ~TransformPlugin.put - ~TransformPlugin.read - ~TransformPlugin.read_configuration - ~TransformPlugin.resume - ~TransformPlugin.stage - ~TransformPlugin.stop - ~TransformPlugin.subscribe - ~TransformPlugin.summary - ~TransformPlugin.trigger - ~TransformPlugin.unstage - ~TransformPlugin.unsubscribe - ~TransformPlugin.unsubscribe_all - ~TransformPlugin.validate_asyn_ports - ~TransformPlugin.visualize_asyn_digraph - ~TransformPlugin.wait_for_connection - ~TransformPlugin.walk_components - ~TransformPlugin.walk_signals - ~TransformPlugin.walk_subdevice_classes - ~TransformPlugin.walk_subdevices - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/generated/ophyd.areadetector.plugins.rst.txt b/ophyd/_sources/generated/ophyd.areadetector.plugins.rst.txt deleted file mode 100644 index baa75f7ce2..0000000000 --- a/ophyd/_sources/generated/ophyd.areadetector.plugins.rst.txt +++ /dev/null @@ -1,235 +0,0 @@ -ophyd\.areadetector\.plugins -============================ - -.. automodule:: ophyd.areadetector.plugins - - - - .. rubric:: Functions - - .. autosummary:: - - get_areadetector_plugin - get_areadetector_plugin_class - plugin_from_pvname - register_plugin - - - - - - .. rubric:: Classes - - .. autosummary:: - - AttrPlotPlugin - AttrPlotPlugin_V31 - AttrPlotPlugin_V33 - AttrPlotPlugin_V34 - AttributeNPlugin - AttributeNPlugin_V22 - AttributeNPlugin_V26 - AttributePlugin - AttributePlugin_V20 - AttributePlugin_V22 - AttributePlugin_V25 - AttributePlugin_V26 - AttributePlugin_V31 - AttributePlugin_V33 - AttributePlugin_V34 - CircularBuffPlugin - CircularBuffPlugin_V22 - CircularBuffPlugin_V25 - CircularBuffPlugin_V26 - CircularBuffPlugin_V31 - CircularBuffPlugin_V33 - CircularBuffPlugin_V34 - CodecPlugin - CodecPlugin_V34 - ColorConvPlugin - ColorConvPlugin_V20 - ColorConvPlugin_V22 - ColorConvPlugin_V25 - ColorConvPlugin_V26 - ColorConvPlugin_V31 - ColorConvPlugin_V33 - ColorConvPlugin_V34 - FFTPlugin - FFTPlugin_V25 - FFTPlugin_V26 - FFTPlugin_V31 - FFTPlugin_V33 - FFTPlugin_V34 - FileBase - FilePlugin - FilePlugin_V20 - FilePlugin_V21 - FilePlugin_V22 - FilePlugin_V25 - FilePlugin_V26 - FilePlugin_V31 - FilePlugin_V33 - FilePlugin_V34 - GatherNPlugin - GatherNPlugin_V31 - GatherPlugin - HDF5Plugin - HDF5Plugin_V20 - HDF5Plugin_V21 - HDF5Plugin_V22 - HDF5Plugin_V25 - HDF5Plugin_V26 - HDF5Plugin_V31 - HDF5Plugin_V32 - HDF5Plugin_V33 - HDF5Plugin_V34 - ImagePlugin - ImagePlugin_V20 - ImagePlugin_V22 - ImagePlugin_V25 - ImagePlugin_V26 - ImagePlugin_V31 - ImagePlugin_V33 - ImagePlugin_V34 - JPEGPlugin - JPEGPlugin_V20 - JPEGPlugin_V21 - JPEGPlugin_V22 - JPEGPlugin_V25 - JPEGPlugin_V26 - JPEGPlugin_V31 - JPEGPlugin_V33 - JPEGPlugin_V34 - MagickPlugin - MagickPlugin_V20 - MagickPlugin_V21 - MagickPlugin_V22 - MagickPlugin_V25 - MagickPlugin_V26 - MagickPlugin_V31 - MagickPlugin_V33 - MagickPlugin_V34 - NetCDFPlugin - NetCDFPlugin_V20 - NetCDFPlugin_V21 - NetCDFPlugin_V22 - NetCDFPlugin_V25 - NetCDFPlugin_V26 - NetCDFPlugin_V31 - NetCDFPlugin_V33 - NetCDFPlugin_V34 - NexusPlugin - NexusPlugin_V20 - NexusPlugin_V21 - NexusPlugin_V22 - NexusPlugin_V25 - NexusPlugin_V26 - NexusPlugin_V31 - NexusPlugin_V33 - NexusPlugin_V34 - Overlay - OverlayPlugin - OverlayPlugin_V20 - OverlayPlugin_V22 - OverlayPlugin_V25 - OverlayPlugin_V26 - OverlayPlugin_V31 - OverlayPlugin_V33 - OverlayPlugin_V34 - Overlay_V21 - Overlay_V26 - Overlay_V31 - PluginBase - PluginBase_V20 - PluginBase_V22 - PluginBase_V25 - PluginBase_V26 - PluginBase_V31 - PluginBase_V33 - PluginBase_V34 - PosPlugin - PosPluginPlugin_V25 - PosPluginPlugin_V26 - PosPluginPlugin_V31 - PosPluginPlugin_V33 - PosPluginPlugin_V34 - ProcessPlugin - ProcessPlugin_V20 - ProcessPlugin_V22 - ProcessPlugin_V25 - ProcessPlugin_V26 - ProcessPlugin_V31 - ProcessPlugin_V33 - ProcessPlugin_V34 - PvaPlugin - PvaPlugin_V25 - PvaPlugin_V26 - PvaPlugin_V31 - PvaPlugin_V33 - PvaPlugin_V34 - ROIPlugin - ROIPlugin_V20 - ROIPlugin_V22 - ROIPlugin_V25 - ROIPlugin_V26 - ROIPlugin_V31 - ROIPlugin_V33 - ROIPlugin_V34 - ROIStatNPlugin - ROIStatNPlugin_V22 - ROIStatNPlugin_V23 - ROIStatNPlugin_V25 - ROIStatPlugin - ROIStatPlugin_V22 - ROIStatPlugin_V23 - ROIStatPlugin_V25 - ROIStatPlugin_V26 - ROIStatPlugin_V31 - ROIStatPlugin_V33 - ROIStatPlugin_V34 - ScatterPlugin - ScatterPlugin_V31 - ScatterPlugin_V32 - ScatterPlugin_V33 - ScatterPlugin_V34 - StatsPlugin - StatsPlugin_V20 - StatsPlugin_V22 - StatsPlugin_V25 - StatsPlugin_V26 - StatsPlugin_V31 - StatsPlugin_V32 - StatsPlugin_V33 - StatsPlugin_V34 - TIFFPlugin - TIFFPlugin_V20 - TIFFPlugin_V21 - TIFFPlugin_V22 - TIFFPlugin_V25 - TIFFPlugin_V26 - TIFFPlugin_V31 - TIFFPlugin_V33 - TIFFPlugin_V34 - TimeSeriesNPlugin - TimeSeriesNPlugin_V25 - TimeSeriesPlugin - TimeSeriesPlugin_V25 - TimeSeriesPlugin_V26 - TimeSeriesPlugin_V31 - TimeSeriesPlugin_V33 - TimeSeriesPlugin_V34 - TransformPlugin - TransformPlugin_V20 - TransformPlugin_V21 - TransformPlugin_V22 - TransformPlugin_V25 - TransformPlugin_V26 - TransformPlugin_V31 - TransformPlugin_V33 - TransformPlugin_V34 - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/generated/ophyd.areadetector.rst.txt b/ophyd/_sources/generated/ophyd.areadetector.rst.txt deleted file mode 100644 index da097ef50e..0000000000 --- a/ophyd/_sources/generated/ophyd.areadetector.rst.txt +++ /dev/null @@ -1,16 +0,0 @@ -ophyd\.areadetector -=================== - -.. automodule:: ophyd.areadetector - - - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/generated/ophyd.areadetector.trigger_mixins.MultiTrigger.rst.txt b/ophyd/_sources/generated/ophyd.areadetector.trigger_mixins.MultiTrigger.rst.txt deleted file mode 100644 index 2d55b421b8..0000000000 --- a/ophyd/_sources/generated/ophyd.areadetector.trigger_mixins.MultiTrigger.rst.txt +++ /dev/null @@ -1,29 +0,0 @@ -ophyd\.areadetector\.trigger\_mixins\.MultiTrigger -================================================== - -.. currentmodule:: ophyd.areadetector.trigger_mixins - -.. autoclass:: MultiTrigger - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~MultiTrigger.__init__ - ~MultiTrigger.describe - ~MultiTrigger.pause - ~MultiTrigger.read - ~MultiTrigger.resume - ~MultiTrigger.stage - ~MultiTrigger.trigger - ~MultiTrigger.unstage - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/generated/ophyd.areadetector.trigger_mixins.SingleTrigger.rst.txt b/ophyd/_sources/generated/ophyd.areadetector.trigger_mixins.SingleTrigger.rst.txt deleted file mode 100644 index 1ef26c6fca..0000000000 --- a/ophyd/_sources/generated/ophyd.areadetector.trigger_mixins.SingleTrigger.rst.txt +++ /dev/null @@ -1,29 +0,0 @@ -ophyd\.areadetector\.trigger\_mixins\.SingleTrigger -=================================================== - -.. currentmodule:: ophyd.areadetector.trigger_mixins - -.. autoclass:: SingleTrigger - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~SingleTrigger.__init__ - ~SingleTrigger.describe - ~SingleTrigger.pause - ~SingleTrigger.read - ~SingleTrigger.resume - ~SingleTrigger.stage - ~SingleTrigger.trigger - ~SingleTrigger.unstage - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/generated/ophyd.areadetector.trigger_mixins.TriggerBase.rst.txt b/ophyd/_sources/generated/ophyd.areadetector.trigger_mixins.TriggerBase.rst.txt deleted file mode 100644 index ad45104a5b..0000000000 --- a/ophyd/_sources/generated/ophyd.areadetector.trigger_mixins.TriggerBase.rst.txt +++ /dev/null @@ -1,29 +0,0 @@ -ophyd\.areadetector\.trigger\_mixins\.TriggerBase -================================================= - -.. currentmodule:: ophyd.areadetector.trigger_mixins - -.. autoclass:: TriggerBase - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~TriggerBase.__init__ - ~TriggerBase.describe - ~TriggerBase.pause - ~TriggerBase.read - ~TriggerBase.resume - ~TriggerBase.stage - ~TriggerBase.trigger - ~TriggerBase.unstage - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/generated/ophyd.areadetector.trigger_mixins.rst.txt b/ophyd/_sources/generated/ophyd.areadetector.trigger_mixins.rst.txt deleted file mode 100644 index edce5232e9..0000000000 --- a/ophyd/_sources/generated/ophyd.areadetector.trigger_mixins.rst.txt +++ /dev/null @@ -1,25 +0,0 @@ -ophyd\.areadetector\.trigger\_mixins -==================================== - -.. automodule:: ophyd.areadetector.trigger_mixins - - - - - - - - .. rubric:: Classes - - .. autosummary:: - - ADTriggerStatus - MultiTrigger - SingleTrigger - TriggerBase - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/generated/ophyd.areadetector.util.rst.txt b/ophyd/_sources/generated/ophyd.areadetector.util.rst.txt deleted file mode 100644 index 3009114c2f..0000000000 --- a/ophyd/_sources/generated/ophyd.areadetector.util.rst.txt +++ /dev/null @@ -1,31 +0,0 @@ -ophyd\.areadetector\.util -========================= - -.. automodule:: ophyd.areadetector.util - - - - .. rubric:: Functions - - .. autosummary:: - - create_detector_stub - get_prop_name - get_stub_info - stub_templates - - - - - - .. rubric:: Classes - - .. autosummary:: - - StubInfo - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/generated/ophyd.callbacks.rst.txt b/ophyd/_sources/generated/ophyd.callbacks.rst.txt deleted file mode 100644 index 08faa9b427..0000000000 --- a/ophyd/_sources/generated/ophyd.callbacks.rst.txt +++ /dev/null @@ -1,23 +0,0 @@ -ophyd\.callbacks -================ - -.. automodule:: ophyd.callbacks - - - - - - - - .. rubric:: Classes - - .. autosummary:: - - LastUidPublish - UidPublish - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/generated/ophyd.commands.get_all_positioners.rst.txt b/ophyd/_sources/generated/ophyd.commands.get_all_positioners.rst.txt deleted file mode 100644 index 0eb0ee7936..0000000000 --- a/ophyd/_sources/generated/ophyd.commands.get_all_positioners.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -ophyd.commands.get_all_positioners -================================== - -.. currentmodule:: ophyd.commands - -.. autofunction:: get_all_positioners \ No newline at end of file diff --git a/ophyd/_sources/generated/ophyd.commands.get_all_positioners.txt b/ophyd/_sources/generated/ophyd.commands.get_all_positioners.txt deleted file mode 100644 index 0eb0ee7936..0000000000 --- a/ophyd/_sources/generated/ophyd.commands.get_all_positioners.txt +++ /dev/null @@ -1,6 +0,0 @@ -ophyd.commands.get_all_positioners -================================== - -.. currentmodule:: ophyd.commands - -.. autofunction:: get_all_positioners \ No newline at end of file diff --git a/ophyd/_sources/generated/ophyd.commands.get_logbook.rst.txt b/ophyd/_sources/generated/ophyd.commands.get_logbook.rst.txt deleted file mode 100644 index 777674a21e..0000000000 --- a/ophyd/_sources/generated/ophyd.commands.get_logbook.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -ophyd.commands.get_logbook -========================== - -.. currentmodule:: ophyd.commands - -.. autofunction:: get_logbook \ No newline at end of file diff --git a/ophyd/_sources/generated/ophyd.commands.get_logbook.txt b/ophyd/_sources/generated/ophyd.commands.get_logbook.txt deleted file mode 100644 index 777674a21e..0000000000 --- a/ophyd/_sources/generated/ophyd.commands.get_logbook.txt +++ /dev/null @@ -1,6 +0,0 @@ -ophyd.commands.get_logbook -========================== - -.. currentmodule:: ophyd.commands - -.. autofunction:: get_logbook \ No newline at end of file diff --git a/ophyd/_sources/generated/ophyd.commands.log_pos.rst.txt b/ophyd/_sources/generated/ophyd.commands.log_pos.rst.txt deleted file mode 100644 index 55e4922a7e..0000000000 --- a/ophyd/_sources/generated/ophyd.commands.log_pos.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -ophyd.commands.log_pos -====================== - -.. currentmodule:: ophyd.commands - -.. autofunction:: log_pos \ No newline at end of file diff --git a/ophyd/_sources/generated/ophyd.commands.log_pos.txt b/ophyd/_sources/generated/ophyd.commands.log_pos.txt deleted file mode 100644 index 55e4922a7e..0000000000 --- a/ophyd/_sources/generated/ophyd.commands.log_pos.txt +++ /dev/null @@ -1,6 +0,0 @@ -ophyd.commands.log_pos -====================== - -.. currentmodule:: ophyd.commands - -.. autofunction:: log_pos \ No newline at end of file diff --git a/ophyd/_sources/generated/ophyd.commands.log_pos_diff.rst.txt b/ophyd/_sources/generated/ophyd.commands.log_pos_diff.rst.txt deleted file mode 100644 index 301cf6199e..0000000000 --- a/ophyd/_sources/generated/ophyd.commands.log_pos_diff.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -ophyd.commands.log_pos_diff -=========================== - -.. currentmodule:: ophyd.commands - -.. autofunction:: log_pos_diff \ No newline at end of file diff --git a/ophyd/_sources/generated/ophyd.commands.log_pos_diff.txt b/ophyd/_sources/generated/ophyd.commands.log_pos_diff.txt deleted file mode 100644 index 301cf6199e..0000000000 --- a/ophyd/_sources/generated/ophyd.commands.log_pos_diff.txt +++ /dev/null @@ -1,6 +0,0 @@ -ophyd.commands.log_pos_diff -=========================== - -.. currentmodule:: ophyd.commands - -.. autofunction:: log_pos_diff \ No newline at end of file diff --git a/ophyd/_sources/generated/ophyd.commands.log_pos_mov.rst.txt b/ophyd/_sources/generated/ophyd.commands.log_pos_mov.rst.txt deleted file mode 100644 index 5a66b9e8b6..0000000000 --- a/ophyd/_sources/generated/ophyd.commands.log_pos_mov.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -ophyd.commands.log_pos_mov -========================== - -.. currentmodule:: ophyd.commands - -.. autofunction:: log_pos_mov \ No newline at end of file diff --git a/ophyd/_sources/generated/ophyd.commands.log_pos_mov.txt b/ophyd/_sources/generated/ophyd.commands.log_pos_mov.txt deleted file mode 100644 index 5a66b9e8b6..0000000000 --- a/ophyd/_sources/generated/ophyd.commands.log_pos_mov.txt +++ /dev/null @@ -1,6 +0,0 @@ -ophyd.commands.log_pos_mov -========================== - -.. currentmodule:: ophyd.commands - -.. autofunction:: log_pos_mov \ No newline at end of file diff --git a/ophyd/_sources/generated/ophyd.commands.mov.rst.txt b/ophyd/_sources/generated/ophyd.commands.mov.rst.txt deleted file mode 100644 index 9b993fecc7..0000000000 --- a/ophyd/_sources/generated/ophyd.commands.mov.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -ophyd.commands.mov -================== - -.. currentmodule:: ophyd.commands - -.. autofunction:: mov \ No newline at end of file diff --git a/ophyd/_sources/generated/ophyd.commands.mov.txt b/ophyd/_sources/generated/ophyd.commands.mov.txt deleted file mode 100644 index 9b993fecc7..0000000000 --- a/ophyd/_sources/generated/ophyd.commands.mov.txt +++ /dev/null @@ -1,6 +0,0 @@ -ophyd.commands.mov -================== - -.. currentmodule:: ophyd.commands - -.. autofunction:: mov \ No newline at end of file diff --git a/ophyd/_sources/generated/ophyd.commands.movr.rst.txt b/ophyd/_sources/generated/ophyd.commands.movr.rst.txt deleted file mode 100644 index c733e844d9..0000000000 --- a/ophyd/_sources/generated/ophyd.commands.movr.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -ophyd.commands.movr -=================== - -.. currentmodule:: ophyd.commands - -.. autofunction:: movr \ No newline at end of file diff --git a/ophyd/_sources/generated/ophyd.commands.movr.txt b/ophyd/_sources/generated/ophyd.commands.movr.txt deleted file mode 100644 index c733e844d9..0000000000 --- a/ophyd/_sources/generated/ophyd.commands.movr.txt +++ /dev/null @@ -1,6 +0,0 @@ -ophyd.commands.movr -=================== - -.. currentmodule:: ophyd.commands - -.. autofunction:: movr \ No newline at end of file diff --git a/ophyd/_sources/generated/ophyd.commands.set_lm.rst.txt b/ophyd/_sources/generated/ophyd.commands.set_lm.rst.txt deleted file mode 100644 index b447817526..0000000000 --- a/ophyd/_sources/generated/ophyd.commands.set_lm.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -ophyd.commands.set_lm -===================== - -.. currentmodule:: ophyd.commands - -.. autofunction:: set_lm \ No newline at end of file diff --git a/ophyd/_sources/generated/ophyd.commands.set_lm.txt b/ophyd/_sources/generated/ophyd.commands.set_lm.txt deleted file mode 100644 index b447817526..0000000000 --- a/ophyd/_sources/generated/ophyd.commands.set_lm.txt +++ /dev/null @@ -1,6 +0,0 @@ -ophyd.commands.set_lm -===================== - -.. currentmodule:: ophyd.commands - -.. autofunction:: set_lm \ No newline at end of file diff --git a/ophyd/_sources/generated/ophyd.commands.set_pos.rst.txt b/ophyd/_sources/generated/ophyd.commands.set_pos.rst.txt deleted file mode 100644 index 1853d5e10d..0000000000 --- a/ophyd/_sources/generated/ophyd.commands.set_pos.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -ophyd.commands.set_pos -====================== - -.. currentmodule:: ophyd.commands - -.. autofunction:: set_pos \ No newline at end of file diff --git a/ophyd/_sources/generated/ophyd.commands.set_pos.txt b/ophyd/_sources/generated/ophyd.commands.set_pos.txt deleted file mode 100644 index 1853d5e10d..0000000000 --- a/ophyd/_sources/generated/ophyd.commands.set_pos.txt +++ /dev/null @@ -1,6 +0,0 @@ -ophyd.commands.set_pos -====================== - -.. currentmodule:: ophyd.commands - -.. autofunction:: set_pos \ No newline at end of file diff --git a/ophyd/_sources/generated/ophyd.commands.wh_pos.rst.txt b/ophyd/_sources/generated/ophyd.commands.wh_pos.rst.txt deleted file mode 100644 index 99b8b2f365..0000000000 --- a/ophyd/_sources/generated/ophyd.commands.wh_pos.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -ophyd.commands.wh_pos -===================== - -.. currentmodule:: ophyd.commands - -.. autofunction:: wh_pos \ No newline at end of file diff --git a/ophyd/_sources/generated/ophyd.commands.wh_pos.txt b/ophyd/_sources/generated/ophyd.commands.wh_pos.txt deleted file mode 100644 index 99b8b2f365..0000000000 --- a/ophyd/_sources/generated/ophyd.commands.wh_pos.txt +++ /dev/null @@ -1,6 +0,0 @@ -ophyd.commands.wh_pos -===================== - -.. currentmodule:: ophyd.commands - -.. autofunction:: wh_pos \ No newline at end of file diff --git a/ophyd/_sources/generated/ophyd.device.BlueskyInterface.describe.rst.txt b/ophyd/_sources/generated/ophyd.device.BlueskyInterface.describe.rst.txt deleted file mode 100644 index 7fa40f90ba..0000000000 --- a/ophyd/_sources/generated/ophyd.device.BlueskyInterface.describe.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -ophyd\.device\.BlueskyInterface\.describe -========================================= - -.. currentmodule:: ophyd.device - -.. automethod:: BlueskyInterface.describe \ No newline at end of file diff --git a/ophyd/_sources/generated/ophyd.device.BlueskyInterface.pause.rst.txt b/ophyd/_sources/generated/ophyd.device.BlueskyInterface.pause.rst.txt deleted file mode 100644 index 080a91dbbe..0000000000 --- a/ophyd/_sources/generated/ophyd.device.BlueskyInterface.pause.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -ophyd\.device\.BlueskyInterface\.pause -====================================== - -.. currentmodule:: ophyd.device - -.. automethod:: BlueskyInterface.pause \ No newline at end of file diff --git a/ophyd/_sources/generated/ophyd.device.BlueskyInterface.read.rst.txt b/ophyd/_sources/generated/ophyd.device.BlueskyInterface.read.rst.txt deleted file mode 100644 index 111739b74e..0000000000 --- a/ophyd/_sources/generated/ophyd.device.BlueskyInterface.read.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -ophyd\.device\.BlueskyInterface\.read -===================================== - -.. currentmodule:: ophyd.device - -.. automethod:: BlueskyInterface.read \ No newline at end of file diff --git a/ophyd/_sources/generated/ophyd.device.BlueskyInterface.resume.rst.txt b/ophyd/_sources/generated/ophyd.device.BlueskyInterface.resume.rst.txt deleted file mode 100644 index 3493a0f105..0000000000 --- a/ophyd/_sources/generated/ophyd.device.BlueskyInterface.resume.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -ophyd\.device\.BlueskyInterface\.resume -======================================= - -.. currentmodule:: ophyd.device - -.. automethod:: BlueskyInterface.resume \ No newline at end of file diff --git a/ophyd/_sources/generated/ophyd.device.BlueskyInterface.stage.rst.txt b/ophyd/_sources/generated/ophyd.device.BlueskyInterface.stage.rst.txt deleted file mode 100644 index ca86cc2cdb..0000000000 --- a/ophyd/_sources/generated/ophyd.device.BlueskyInterface.stage.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -ophyd\.device\.BlueskyInterface\.stage -====================================== - -.. currentmodule:: ophyd.device - -.. automethod:: BlueskyInterface.stage \ No newline at end of file diff --git a/ophyd/_sources/generated/ophyd.device.BlueskyInterface.trigger.rst.txt b/ophyd/_sources/generated/ophyd.device.BlueskyInterface.trigger.rst.txt deleted file mode 100644 index 9fbb0658e3..0000000000 --- a/ophyd/_sources/generated/ophyd.device.BlueskyInterface.trigger.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -ophyd\.device\.BlueskyInterface\.trigger -======================================== - -.. currentmodule:: ophyd.device - -.. automethod:: BlueskyInterface.trigger \ No newline at end of file diff --git a/ophyd/_sources/generated/ophyd.device.BlueskyInterface.unstage.rst.txt b/ophyd/_sources/generated/ophyd.device.BlueskyInterface.unstage.rst.txt deleted file mode 100644 index e0b05b2818..0000000000 --- a/ophyd/_sources/generated/ophyd.device.BlueskyInterface.unstage.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -ophyd\.device\.BlueskyInterface\.unstage -======================================== - -.. currentmodule:: ophyd.device - -.. automethod:: BlueskyInterface.unstage \ No newline at end of file diff --git a/ophyd/_sources/generated/ophyd.device.Component.rst.txt b/ophyd/_sources/generated/ophyd.device.Component.rst.txt deleted file mode 100644 index ca71f79e43..0000000000 --- a/ophyd/_sources/generated/ophyd.device.Component.rst.txt +++ /dev/null @@ -1,29 +0,0 @@ -ophyd\.device\.Component -======================== - -.. currentmodule:: ophyd.device - -.. autoclass:: Component - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~Component.__init__ - ~Component.create_component - ~Component.make_docstring - ~Component.maybe_add_prefix - ~Component.sub_default - ~Component.sub_meta - ~Component.sub_value - ~Component.subscriptions - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/generated/ophyd.device.Device.configure.rst.txt b/ophyd/_sources/generated/ophyd.device.Device.configure.rst.txt deleted file mode 100644 index b0ba0cee0a..0000000000 --- a/ophyd/_sources/generated/ophyd.device.Device.configure.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -ophyd\.device\.Device\.configure -================================ - -.. currentmodule:: ophyd.device - -.. automethod:: Device.configure \ No newline at end of file diff --git a/ophyd/_sources/generated/ophyd.device.Device.connected.rst.txt b/ophyd/_sources/generated/ophyd.device.Device.connected.rst.txt deleted file mode 100644 index ec490c28ea..0000000000 --- a/ophyd/_sources/generated/ophyd.device.Device.connected.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -ophyd\.device\.Device\.connected -================================ - -.. currentmodule:: ophyd.device - -.. autoattribute:: Device.connected \ No newline at end of file diff --git a/ophyd/_sources/generated/ophyd.device.Device.describe_configuration.rst.txt b/ophyd/_sources/generated/ophyd.device.Device.describe_configuration.rst.txt deleted file mode 100644 index 8756224724..0000000000 --- a/ophyd/_sources/generated/ophyd.device.Device.describe_configuration.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -ophyd\.device\.Device\.describe\_configuration -============================================== - -.. currentmodule:: ophyd.device - -.. automethod:: Device.describe_configuration \ No newline at end of file diff --git a/ophyd/_sources/generated/ophyd.device.Device.get.rst.txt b/ophyd/_sources/generated/ophyd.device.Device.get.rst.txt deleted file mode 100644 index d5715b1c5d..0000000000 --- a/ophyd/_sources/generated/ophyd.device.Device.get.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -ophyd\.device\.Device\.get -========================== - -.. currentmodule:: ophyd.device - -.. automethod:: Device.get \ No newline at end of file diff --git a/ophyd/_sources/generated/ophyd.device.Device.get_device_tuple.rst.txt b/ophyd/_sources/generated/ophyd.device.Device.get_device_tuple.rst.txt deleted file mode 100644 index 99f426235d..0000000000 --- a/ophyd/_sources/generated/ophyd.device.Device.get_device_tuple.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -ophyd\.device\.Device\.get\_device\_tuple -========================================= - -.. currentmodule:: ophyd.device - -.. automethod:: Device.get_device_tuple \ No newline at end of file diff --git a/ophyd/_sources/generated/ophyd.device.Device.get_instantiated_signals.rst.txt b/ophyd/_sources/generated/ophyd.device.Device.get_instantiated_signals.rst.txt deleted file mode 100644 index 0a3bc41252..0000000000 --- a/ophyd/_sources/generated/ophyd.device.Device.get_instantiated_signals.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -ophyd\.device\.Device\.get\_instantiated\_signals -================================================= - -.. currentmodule:: ophyd.device - -.. automethod:: Device.get_instantiated_signals \ No newline at end of file diff --git a/ophyd/_sources/generated/ophyd.device.Device.put.rst.txt b/ophyd/_sources/generated/ophyd.device.Device.put.rst.txt deleted file mode 100644 index 2540341a43..0000000000 --- a/ophyd/_sources/generated/ophyd.device.Device.put.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -ophyd\.device\.Device\.put -========================== - -.. currentmodule:: ophyd.device - -.. automethod:: Device.put \ No newline at end of file diff --git a/ophyd/_sources/generated/ophyd.device.Device.read_configuration.rst.txt b/ophyd/_sources/generated/ophyd.device.Device.read_configuration.rst.txt deleted file mode 100644 index f476dcfb02..0000000000 --- a/ophyd/_sources/generated/ophyd.device.Device.read_configuration.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -ophyd\.device\.Device\.read\_configuration -========================================== - -.. currentmodule:: ophyd.device - -.. automethod:: Device.read_configuration \ No newline at end of file diff --git a/ophyd/_sources/generated/ophyd.device.Device.rst.txt b/ophyd/_sources/generated/ophyd.device.Device.rst.txt deleted file mode 100644 index cb865601c9..0000000000 --- a/ophyd/_sources/generated/ophyd.device.Device.rst.txt +++ /dev/null @@ -1,50 +0,0 @@ -ophyd\.device\.Device -===================== - -.. currentmodule:: ophyd.device - -.. autoclass:: Device - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~Device.__init__ - ~Device.add_instantiation_callback - ~Device.check_value - ~Device.clear_sub - ~Device.configure - ~Device.describe - ~Device.describe_configuration - ~Device.destroy - ~Device.get - ~Device.get_device_tuple - ~Device.get_instantiated_signals - ~Device.pause - ~Device.put - ~Device.read - ~Device.read_configuration - ~Device.resume - ~Device.stage - ~Device.stop - ~Device.subscribe - ~Device.summary - ~Device.trigger - ~Device.unstage - ~Device.unsubscribe - ~Device.unsubscribe_all - ~Device.wait_for_connection - ~Device.walk_components - ~Device.walk_signals - ~Device.walk_subdevice_classes - ~Device.walk_subdevices - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/generated/ophyd.device.Device.wait_for_connection.rst.txt b/ophyd/_sources/generated/ophyd.device.Device.wait_for_connection.rst.txt deleted file mode 100644 index ed71c55383..0000000000 --- a/ophyd/_sources/generated/ophyd.device.Device.wait_for_connection.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -ophyd\.device\.Device\.wait\_for\_connection -============================================ - -.. currentmodule:: ophyd.device - -.. automethod:: Device.wait_for_connection \ No newline at end of file diff --git a/ophyd/_sources/generated/ophyd.device.DynamicDeviceComponent.rst.txt b/ophyd/_sources/generated/ophyd.device.DynamicDeviceComponent.rst.txt deleted file mode 100644 index 00545cc61b..0000000000 --- a/ophyd/_sources/generated/ophyd.device.DynamicDeviceComponent.rst.txt +++ /dev/null @@ -1,29 +0,0 @@ -ophyd\.device\.DynamicDeviceComponent -===================================== - -.. currentmodule:: ophyd.device - -.. autoclass:: DynamicDeviceComponent - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~DynamicDeviceComponent.__init__ - ~DynamicDeviceComponent.create_component - ~DynamicDeviceComponent.make_docstring - ~DynamicDeviceComponent.maybe_add_prefix - ~DynamicDeviceComponent.sub_default - ~DynamicDeviceComponent.sub_meta - ~DynamicDeviceComponent.sub_value - ~DynamicDeviceComponent.subscriptions - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/generated/ophyd.device.FormattedComponent.rst.txt b/ophyd/_sources/generated/ophyd.device.FormattedComponent.rst.txt deleted file mode 100644 index 41645f51ed..0000000000 --- a/ophyd/_sources/generated/ophyd.device.FormattedComponent.rst.txt +++ /dev/null @@ -1,29 +0,0 @@ -ophyd\.device\.FormattedComponent -================================= - -.. currentmodule:: ophyd.device - -.. autoclass:: FormattedComponent - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~FormattedComponent.__init__ - ~FormattedComponent.create_component - ~FormattedComponent.make_docstring - ~FormattedComponent.maybe_add_prefix - ~FormattedComponent.sub_default - ~FormattedComponent.sub_meta - ~FormattedComponent.sub_value - ~FormattedComponent.subscriptions - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/generated/ophyd.device.rst.txt b/ophyd/_sources/generated/ophyd.device.rst.txt deleted file mode 100644 index ee3ac59847..0000000000 --- a/ophyd/_sources/generated/ophyd.device.rst.txt +++ /dev/null @@ -1,40 +0,0 @@ -ophyd\.device -============= - -.. automodule:: ophyd.device - - - - .. rubric:: Functions - - .. autosummary:: - - create_device_from_components - do_not_wait_for_lazy_connection - kind_context - required_for_connection - wait_for_lazy_connection - - - - - - .. rubric:: Classes - - .. autosummary:: - - BlueskyInterface - Component - ComponentWalk - Device - DynamicDeviceComponent - FormattedComponent - GenerateDatumInterface - OrderedDictType - Staged - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/generated/ophyd.epics_motor.rst.txt b/ophyd/_sources/generated/ophyd.epics_motor.rst.txt deleted file mode 100644 index 93cb90d1c8..0000000000 --- a/ophyd/_sources/generated/ophyd.epics_motor.rst.txt +++ /dev/null @@ -1,24 +0,0 @@ -ophyd\.epics\_motor -=================== - -.. automodule:: ophyd.epics_motor - - - - - - - - .. rubric:: Classes - - .. autosummary:: - - EpicsMotor - HomeEnum - MotorBundle - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/generated/ophyd.flyers.FlyerInterface.collect.rst.txt b/ophyd/_sources/generated/ophyd.flyers.FlyerInterface.collect.rst.txt deleted file mode 100644 index 2cbcf87806..0000000000 --- a/ophyd/_sources/generated/ophyd.flyers.FlyerInterface.collect.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -ophyd\.flyers\.FlyerInterface\.collect -====================================== - -.. currentmodule:: ophyd.flyers - -.. automethod:: FlyerInterface.collect \ No newline at end of file diff --git a/ophyd/_sources/generated/ophyd.flyers.FlyerInterface.complete.rst.txt b/ophyd/_sources/generated/ophyd.flyers.FlyerInterface.complete.rst.txt deleted file mode 100644 index 155f40014c..0000000000 --- a/ophyd/_sources/generated/ophyd.flyers.FlyerInterface.complete.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -ophyd\.flyers\.FlyerInterface\.complete -======================================= - -.. currentmodule:: ophyd.flyers - -.. automethod:: FlyerInterface.complete \ No newline at end of file diff --git a/ophyd/_sources/generated/ophyd.flyers.FlyerInterface.describe_collect.rst.txt b/ophyd/_sources/generated/ophyd.flyers.FlyerInterface.describe_collect.rst.txt deleted file mode 100644 index ac453de038..0000000000 --- a/ophyd/_sources/generated/ophyd.flyers.FlyerInterface.describe_collect.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -ophyd\.flyers\.FlyerInterface\.describe\_collect -================================================ - -.. currentmodule:: ophyd.flyers - -.. automethod:: FlyerInterface.describe_collect \ No newline at end of file diff --git a/ophyd/_sources/generated/ophyd.flyers.FlyerInterface.kickoff.rst.txt b/ophyd/_sources/generated/ophyd.flyers.FlyerInterface.kickoff.rst.txt deleted file mode 100644 index e9dfcbedea..0000000000 --- a/ophyd/_sources/generated/ophyd.flyers.FlyerInterface.kickoff.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -ophyd\.flyers\.FlyerInterface\.kickoff -====================================== - -.. currentmodule:: ophyd.flyers - -.. automethod:: FlyerInterface.kickoff \ No newline at end of file diff --git a/ophyd/_sources/generated/ophyd.flyers.rst.txt b/ophyd/_sources/generated/ophyd.flyers.rst.txt deleted file mode 100644 index f61e1e4b2f..0000000000 --- a/ophyd/_sources/generated/ophyd.flyers.rst.txt +++ /dev/null @@ -1,25 +0,0 @@ -ophyd\.flyers -============= - -.. automodule:: ophyd.flyers - - - - - - - - .. rubric:: Classes - - .. autosummary:: - - AreaDetectorTimeseriesCollector - FlyerInterface - MonitorFlyerMixin - WaveformCollector - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/generated/ophyd.mca.rst.txt b/ophyd/_sources/generated/ophyd.mca.rst.txt deleted file mode 100644 index ebd2e74ce8..0000000000 --- a/ophyd/_sources/generated/ophyd.mca.rst.txt +++ /dev/null @@ -1,44 +0,0 @@ -ophyd\.mca -========== - -.. automodule:: ophyd.mca - - - - .. rubric:: Functions - - .. autosummary:: - - add_rois - - - - - - .. rubric:: Classes - - .. autosummary:: - - EpicsDXP - EpicsDXPBaseSystem - EpicsDXPLowLevel - EpicsDXPLowLevelParameter - EpicsDXPMapping - EpicsDXPMultiElementSystem - EpicsMCA - EpicsMCACallback - EpicsMCAReadNotify - EpicsMCARecord - Mercury1 - MercuryDXP - ROI - Saturn - SaturnDXP - SaturnMCA - SoftDXPTrigger - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/generated/ophyd.mixins.rst.txt b/ophyd/_sources/generated/ophyd.mixins.rst.txt deleted file mode 100644 index 321aa17d78..0000000000 --- a/ophyd/_sources/generated/ophyd.mixins.rst.txt +++ /dev/null @@ -1,23 +0,0 @@ -ophyd\.mixins -============= - -.. automodule:: ophyd.mixins - - - - - - - - .. rubric:: Classes - - .. autosummary:: - - EpicsSignalPositioner - SignalPositionerMixin - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/generated/ophyd.ophydobj.OphydObject._reset_sub.rst.txt b/ophyd/_sources/generated/ophyd.ophydobj.OphydObject._reset_sub.rst.txt deleted file mode 100644 index d8842e85bb..0000000000 --- a/ophyd/_sources/generated/ophyd.ophydobj.OphydObject._reset_sub.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -ophyd\.ophydobj\.OphydObject\.\_reset\_sub -========================================== - -.. currentmodule:: ophyd.ophydobj - -.. automethod:: OphydObject._reset_sub \ No newline at end of file diff --git a/ophyd/_sources/generated/ophyd.ophydobj.OphydObject._run_subs.rst.txt b/ophyd/_sources/generated/ophyd.ophydobj.OphydObject._run_subs.rst.txt deleted file mode 100644 index 00369ee6d6..0000000000 --- a/ophyd/_sources/generated/ophyd.ophydobj.OphydObject._run_subs.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -ophyd\.ophydobj\.OphydObject\.\_run\_subs -========================================= - -.. currentmodule:: ophyd.ophydobj - -.. automethod:: OphydObject._run_subs \ No newline at end of file diff --git a/ophyd/_sources/generated/ophyd.ophydobj.OphydObject.clear_sub.rst.txt b/ophyd/_sources/generated/ophyd.ophydobj.OphydObject.clear_sub.rst.txt deleted file mode 100644 index a87ae0e1e1..0000000000 --- a/ophyd/_sources/generated/ophyd.ophydobj.OphydObject.clear_sub.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -ophyd\.ophydobj\.OphydObject\.clear\_sub -======================================== - -.. currentmodule:: ophyd.ophydobj - -.. automethod:: OphydObject.clear_sub \ No newline at end of file diff --git a/ophyd/_sources/generated/ophyd.ophydobj.OphydObject.event_types.rst.txt b/ophyd/_sources/generated/ophyd.ophydobj.OphydObject.event_types.rst.txt deleted file mode 100644 index 51eb5c44d6..0000000000 --- a/ophyd/_sources/generated/ophyd.ophydobj.OphydObject.event_types.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -ophyd\.ophydobj\.OphydObject\.event\_types -========================================== - -.. currentmodule:: ophyd.ophydobj - -.. autoattribute:: OphydObject.event_types \ No newline at end of file diff --git a/ophyd/_sources/generated/ophyd.ophydobj.OphydObject.name.rst.txt b/ophyd/_sources/generated/ophyd.ophydobj.OphydObject.name.rst.txt deleted file mode 100644 index 4d05c3e77b..0000000000 --- a/ophyd/_sources/generated/ophyd.ophydobj.OphydObject.name.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -ophyd\.ophydobj\.OphydObject\.name -================================== - -.. currentmodule:: ophyd.ophydobj - -.. autoattribute:: OphydObject.name \ No newline at end of file diff --git a/ophyd/_sources/generated/ophyd.ophydobj.OphydObject.parent.rst.txt b/ophyd/_sources/generated/ophyd.ophydobj.OphydObject.parent.rst.txt deleted file mode 100644 index 1c6129ef7a..0000000000 --- a/ophyd/_sources/generated/ophyd.ophydobj.OphydObject.parent.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -ophyd\.ophydobj\.OphydObject\.parent -==================================== - -.. currentmodule:: ophyd.ophydobj - -.. autoattribute:: OphydObject.parent \ No newline at end of file diff --git a/ophyd/_sources/generated/ophyd.ophydobj.OphydObject.root.rst.txt b/ophyd/_sources/generated/ophyd.ophydobj.OphydObject.root.rst.txt deleted file mode 100644 index ac1981d7df..0000000000 --- a/ophyd/_sources/generated/ophyd.ophydobj.OphydObject.root.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -ophyd\.ophydobj\.OphydObject\.root -================================== - -.. currentmodule:: ophyd.ophydobj - -.. autoattribute:: OphydObject.root \ No newline at end of file diff --git a/ophyd/_sources/generated/ophyd.ophydobj.OphydObject.rst.txt b/ophyd/_sources/generated/ophyd.ophydobj.OphydObject.rst.txt deleted file mode 100644 index 45fa869ff0..0000000000 --- a/ophyd/_sources/generated/ophyd.ophydobj.OphydObject.rst.txt +++ /dev/null @@ -1,29 +0,0 @@ -ophyd\.ophydobj\.OphydObject -============================ - -.. currentmodule:: ophyd.ophydobj - -.. autoclass:: OphydObject - - - .. automethod:: __init__ - - - .. rubric:: Methods - - .. autosummary:: - - ~OphydObject.__init__ - ~OphydObject.add_instantiation_callback - ~OphydObject.check_value - ~OphydObject.clear_sub - ~OphydObject.destroy - ~OphydObject.subscribe - ~OphydObject.unsubscribe - ~OphydObject.unsubscribe_all - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/generated/ophyd.ophydobj.OphydObject.subscribe.rst.txt b/ophyd/_sources/generated/ophyd.ophydobj.OphydObject.subscribe.rst.txt deleted file mode 100644 index 562db4e4fc..0000000000 --- a/ophyd/_sources/generated/ophyd.ophydobj.OphydObject.subscribe.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -ophyd\.ophydobj\.OphydObject\.subscribe -======================================= - -.. currentmodule:: ophyd.ophydobj - -.. automethod:: OphydObject.subscribe \ No newline at end of file diff --git a/ophyd/_sources/generated/ophyd.ophydobj.OphydObject.unsubscribe.rst.txt b/ophyd/_sources/generated/ophyd.ophydobj.OphydObject.unsubscribe.rst.txt deleted file mode 100644 index 1d4329ec67..0000000000 --- a/ophyd/_sources/generated/ophyd.ophydobj.OphydObject.unsubscribe.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -ophyd\.ophydobj\.OphydObject\.unsubscribe -========================================= - -.. currentmodule:: ophyd.ophydobj - -.. automethod:: OphydObject.unsubscribe \ No newline at end of file diff --git a/ophyd/_sources/generated/ophyd.ophydobj.rst.txt b/ophyd/_sources/generated/ophyd.ophydobj.rst.txt deleted file mode 100644 index 4a003d7168..0000000000 --- a/ophyd/_sources/generated/ophyd.ophydobj.rst.txt +++ /dev/null @@ -1,37 +0,0 @@ -ophyd\.ophydobj -=============== - -.. automodule:: ophyd.ophydobj - - - - .. rubric:: Functions - - .. autosummary:: - - register_instances_in_weakset - register_instances_keyed_on_name - select_version - - - - - - .. rubric:: Classes - - .. autosummary:: - - Kind - OphydObject - - - - - - .. rubric:: Exceptions - - .. autosummary:: - - UnknownSubscription - - \ No newline at end of file diff --git a/ophyd/_sources/generated/ophyd.positioner.PositionerBase.set.rst.txt b/ophyd/_sources/generated/ophyd.positioner.PositionerBase.set.rst.txt deleted file mode 100644 index 39facc6164..0000000000 --- a/ophyd/_sources/generated/ophyd.positioner.PositionerBase.set.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -ophyd\.positioner\.PositionerBase\.set -====================================== - -.. currentmodule:: ophyd.positioner - -.. automethod:: PositionerBase.set \ No newline at end of file diff --git a/ophyd/_sources/generated/ophyd.positioner.PositionerBase.stop.rst.txt b/ophyd/_sources/generated/ophyd.positioner.PositionerBase.stop.rst.txt deleted file mode 100644 index 5629983535..0000000000 --- a/ophyd/_sources/generated/ophyd.positioner.PositionerBase.stop.rst.txt +++ /dev/null @@ -1,6 +0,0 @@ -ophyd\.positioner\.PositionerBase\.stop -======================================= - -.. currentmodule:: ophyd.positioner - -.. automethod:: PositionerBase.stop \ No newline at end of file diff --git a/ophyd/_sources/generated/ophyd.positioner.rst.txt b/ophyd/_sources/generated/ophyd.positioner.rst.txt deleted file mode 100644 index 3cf8fda3e1..0000000000 --- a/ophyd/_sources/generated/ophyd.positioner.rst.txt +++ /dev/null @@ -1,23 +0,0 @@ -ophyd\.positioner -================= - -.. automodule:: ophyd.positioner - - - - - - - - .. rubric:: Classes - - .. autosummary:: - - PositionerBase - SoftPositioner - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/generated/ophyd.pseudopos.rst.txt b/ophyd/_sources/generated/ophyd.pseudopos.rst.txt deleted file mode 100644 index 40760582a2..0000000000 --- a/ophyd/_sources/generated/ophyd.pseudopos.rst.txt +++ /dev/null @@ -1,30 +0,0 @@ -ophyd\.pseudopos -================ - -.. automodule:: ophyd.pseudopos - - - - .. rubric:: Functions - - .. autosummary:: - - pseudo_position_argument - real_position_argument - - - - - - .. rubric:: Classes - - .. autosummary:: - - PseudoPositioner - PseudoSingle - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/generated/ophyd.pv_positioner.rst.txt b/ophyd/_sources/generated/ophyd.pv_positioner.rst.txt deleted file mode 100644 index fa6adc56f9..0000000000 --- a/ophyd/_sources/generated/ophyd.pv_positioner.rst.txt +++ /dev/null @@ -1,23 +0,0 @@ -ophyd\.pv\_positioner -===================== - -.. automodule:: ophyd.pv_positioner - - - - - - - - .. rubric:: Classes - - .. autosummary:: - - PVPositioner - PVPositionerPC - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/generated/ophyd.quadem.rst.txt b/ophyd/_sources/generated/ophyd.quadem.rst.txt deleted file mode 100644 index 81bdad5349..0000000000 --- a/ophyd/_sources/generated/ophyd.quadem.rst.txt +++ /dev/null @@ -1,26 +0,0 @@ -ophyd\.quadem -============= - -.. automodule:: ophyd.quadem - - - - - - - - .. rubric:: Classes - - .. autosummary:: - - APS_EM - NSLS_EM - QuadEM - QuadEMPort - TetrAMM - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/generated/ophyd.rst.txt b/ophyd/_sources/generated/ophyd.rst.txt deleted file mode 100644 index 685e9c2a0d..0000000000 --- a/ophyd/_sources/generated/ophyd.rst.txt +++ /dev/null @@ -1,23 +0,0 @@ -ophyd -===== - -.. automodule:: ophyd - - - - .. rubric:: Functions - - .. autosummary:: - - get_cl - set_cl - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/generated/ophyd.scaler.rst.txt b/ophyd/_sources/generated/ophyd.scaler.rst.txt deleted file mode 100644 index 89ea86b7e8..0000000000 --- a/ophyd/_sources/generated/ophyd.scaler.rst.txt +++ /dev/null @@ -1,24 +0,0 @@ -ophyd\.scaler -============= - -.. automodule:: ophyd.scaler - - - - - - - - .. rubric:: Classes - - .. autosummary:: - - EpicsScaler - ScalerCH - ScalerChannel - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/generated/ophyd.signal.rst.txt b/ophyd/_sources/generated/ophyd.signal.rst.txt deleted file mode 100644 index 5c9c61f5eb..0000000000 --- a/ophyd/_sources/generated/ophyd.signal.rst.txt +++ /dev/null @@ -1,36 +0,0 @@ -ophyd\.signal -============= - -.. automodule:: ophyd.signal - - - - - - - - .. rubric:: Classes - - .. autosummary:: - - ArrayAttributeSignal - AttributeSignal - DerivedSignal - EpicsSignal - EpicsSignalBase - EpicsSignalRO - Signal - SignalRO - - - - - - .. rubric:: Exceptions - - .. autosummary:: - - ConnectionTimeoutError - ReadTimeoutError - - \ No newline at end of file diff --git a/ophyd/_sources/generated/ophyd.status.rst.txt b/ophyd/_sources/generated/ophyd.status.rst.txt deleted file mode 100644 index 19d69c1466..0000000000 --- a/ophyd/_sources/generated/ophyd.status.rst.txt +++ /dev/null @@ -1,39 +0,0 @@ -ophyd\.status -============= - -.. automodule:: ophyd.status - - - - .. rubric:: Functions - - .. autosummary:: - - wait - - - - - - .. rubric:: Classes - - .. autosummary:: - - AndStatus - DeviceStatus - MoveStatus - Status - StatusBase - SubscriptionStatus - - - - - - .. rubric:: Exceptions - - .. autosummary:: - - UseNewProperty - - \ No newline at end of file diff --git a/ophyd/_sources/generated/ophyd.utils.epics_pvs.rst.txt b/ophyd/_sources/generated/ophyd.utils.epics_pvs.rst.txt deleted file mode 100644 index 60b1377bf9..0000000000 --- a/ophyd/_sources/generated/ophyd.utils.epics_pvs.rst.txt +++ /dev/null @@ -1,45 +0,0 @@ -ophyd\.utils\.epics\_pvs -======================== - -.. automodule:: ophyd.utils.epics_pvs - - - - .. rubric:: Functions - - .. autosummary:: - - data_shape - data_type - fmt_time - raise_if_disconnected - record_field - records_from_db - set_and_wait - split_record_field - strip_field - validate_pv_name - waveform_to_string - - - - - - .. rubric:: Classes - - .. autosummary:: - - AlarmSeverity - AlarmStatus - - - - - - .. rubric:: Exceptions - - .. autosummary:: - - BadPVName - - \ No newline at end of file diff --git a/ophyd/_sources/generated/ophyd.utils.errors.rst.txt b/ophyd/_sources/generated/ophyd.utils.errors.rst.txt deleted file mode 100644 index 22d04753ad..0000000000 --- a/ophyd/_sources/generated/ophyd.utils.errors.rst.txt +++ /dev/null @@ -1,34 +0,0 @@ -ophyd\.utils\.errors -==================== - -.. automodule:: ophyd.utils.errors - - - - - - - - - - - - .. rubric:: Exceptions - - .. autosummary:: - - DestroyedError - DisconnectedError - ExceptionBundle - InvalidState - LimitError - OpException - PluginMisconfigurationError - ReadOnlyError - RedundantStaging - StatusTimeoutError - UnknownStatusFailure - UnprimedPlugin - WaitTimeoutError - - \ No newline at end of file diff --git a/ophyd/_sources/generated/ophyd.utils.paths.rst.txt b/ophyd/_sources/generated/ophyd.utils.paths.rst.txt deleted file mode 100644 index 0ef88dfddc..0000000000 --- a/ophyd/_sources/generated/ophyd.utils.paths.rst.txt +++ /dev/null @@ -1,23 +0,0 @@ -ophyd\.utils\.paths -=================== - -.. automodule:: ophyd.utils.paths - - - - .. rubric:: Functions - - .. autosummary:: - - make_dir_tree - makedirs - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/generated/ophyd.utils.rst.txt b/ophyd/_sources/generated/ophyd.utils.rst.txt deleted file mode 100644 index ca71fd4586..0000000000 --- a/ophyd/_sources/generated/ophyd.utils.rst.txt +++ /dev/null @@ -1,35 +0,0 @@ -ophyd\.utils -============ - -.. automodule:: ophyd.utils - - - - .. rubric:: Functions - - .. autosummary:: - - adapt_old_callback_signature - doc_annotation_forwarder - ducks_from_namespace - enum - getattrs - instances_from_namespace - underscores_to_camel_case - - - - - - .. rubric:: Classes - - .. autosummary:: - - DO_NOT_USE - OrderedDefaultDict - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/generated/ophyd.utils.startup.rst.txt b/ophyd/_sources/generated/ophyd.utils.startup.rst.txt deleted file mode 100644 index 2085e463b6..0000000000 --- a/ophyd/_sources/generated/ophyd.utils.startup.rst.txt +++ /dev/null @@ -1,22 +0,0 @@ -ophyd\.utils\.startup -===================== - -.. automodule:: ophyd.utils.startup - - - - .. rubric:: Functions - - .. autosummary:: - - setup - - - - - - - - - - \ No newline at end of file diff --git a/ophyd/_sources/index.rst.txt b/ophyd/_sources/index.rst.txt deleted file mode 100644 index 706828d676..0000000000 --- a/ophyd/_sources/index.rst.txt +++ /dev/null @@ -1,67 +0,0 @@ -.. ophyd documentation master file, created by - sphinx-quickstart on Fri Nov 7 11:18:58 2014. - You can adapt this file completely to your liking, but it should at least - contain the root `toctree` directive. - -Ophyd -===== - -Ophyd represents hardware in Python as hierarchical objects grouping -together related values from the underlying control system. This -structure allows :mod:`ophyd` to provide - -* A consistent high-level interface across a wide-range of devices ( - which is used by :mod:`bluesky`). -* Direct low-level access to the underlying controls system for - debugging and development. - - -By presenting a uniform interface experimental plans can be agnostic -to the details of the underlying hardware which simplifies writing -experimental plans. For example, every device has a ``read`` method -which, somewhat tautologically, reads the device. It is up to the -object to have an understanding of which of its signals are -interesting and should be included in the reading, to reach out and -fetch those values, and then to format them into a consistent format. -Similarly, if a device can be 'moved' (in the most general sense) then -it must provide a ``set`` method which is responsible for knowing how -to translate the user input into values that the control system -understands, setting those values, and then returning to the caller an -object which will signal when the requested move is complete. This -provides a direct way to implement software pseudo motors. - -:mod:`ophyd` contains a number of pre-built devices for common -hardware (and IOCs) as well as the tools to build custom devices. - -Currently ophyd only support ``EPICS`` via :mod:`pyepics` (because it -is what we use at NSLS-II), however the library is designed to be -control-system agnostic and we are looking for a partner to port it to -other control systems. - - -.. toctree:: - :maxdepth: 1 - :caption: Ophyd's Core Functionality - - architecture - device-overview - signals - status - positioners - debugging - -.. toctree:: - :maxdepth: 2 - :caption: Built-in Device Support - - area-detector - builtin-devices - -.. toctree:: - :maxdepth: 1 - :caption: Developer notes - - api - release_notes - OEP/index - docker diff --git a/ophyd/_sources/index.txt b/ophyd/_sources/index.txt deleted file mode 100644 index f23f24a001..0000000000 --- a/ophyd/_sources/index.txt +++ /dev/null @@ -1,69 +0,0 @@ -.. ophyd documentation master file, created by - sphinx-quickstart on Fri Nov 7 11:18:58 2014. - You can adapt this file completely to your liking, but it should at least - contain the root `toctree` directive. - -Ophyd -===== - -Ophyd represents hardware in Python, providing a consistent interface for -reading values from and sending values to any device. - -To represent a complex device with many components, it employs a hierarchical -structure wherein a device is a composition of subdevices, all sharing the -common interface. - -Why not just use pyepics? -------------------------- - -Ophyd builds on pyepics, Python bindings to EPICS. It provides full access to -the underlying pyepics PV objects, but it also provides some higher-level -abstractions. - -The purpose of these abstractions is make all hardware look the same as much as -possible, enabling the same experimental control logic to apply to different -hardware. For example, from this point of view performing a temperature sweep -is no different that scanning a motor. The abstractions in ophyd present a -standard interface for maximum generality. But they do not preclude direct -access to the individual PVs, which can be important for debugging or -interactive exploration. - -* A **Signal** represents a single value. In EPICS, it corresponds to either - a single read-only PV or a pair of read and write PVs, grouped together. It - assigns a human-readable name (e.g., 'temperature') which is more natural in - the analysis phase than the raw PV names. -* A **Device** is composed of Signals or of other Devices. Devices can be - nested. Some devices map to single pieces of hardware (like a motor). - Others group together many different pieces of hardware (like a - diffractometer). In one process, the same PVs might appear in multiple - different Devices, so organized for different uses. - -Signals and devices have: -* a ``connected`` attribute, to quickly check whether *all* the involved PVs - are responding -* a ``name`` attribute, assigning a human-friendly alias (e.g., "temperature") - which is often more natural than the raw PV name in the analysis phase -* a means of designating signals that should included in a typical reading - (``read_attrs`` for "read attriubtes"), signals that change rarely - (``configuration_attrs`` for "configuration attributes") and should be read - only when known to change, and signals that should be not read at all (a - common example: the hundreds of rarely-touched PVs in the area detector - plugin). -* a single ``read`` method which reads the values of all a device's designated - components and collates them into a single, labeled result -* a single ``describe`` method which extrats the metadata (PV, units, - precision, data type, etc.) of all a device's designated components - -Contents: - -.. toctree:: - :maxdepth: 1 - - device-overview - commands - builtin-devices - positioners - custom-devices - signals - area-detector - architecture diff --git a/ophyd/_sources/positioners.rst.txt b/ophyd/_sources/positioners.rst.txt deleted file mode 100644 index 50802b09b6..0000000000 --- a/ophyd/_sources/positioners.rst.txt +++ /dev/null @@ -1,149 +0,0 @@ -.. _positioners: - -Positioners -*********** - -Positioners other than ``EpicsMotor`` and ``SoftPositioner`` are not -"ready-to-use". They require some customization. - -PVPositioner ------------- - -For example, this code defines a CS700 temperature controller. A temperature -controller is a kind of positioner, from ophyd's point of view, where the -"position" is the temperature. - -.. code-block:: python - - from ophyd import PVPositioner, EpicsSignal, EpicsSignalRO - from ophyd import Component as Cpt - - # Define a new kind of device. - - class CS700TemperatureController(PVPositioner): - setpoint = Cpt(EpicsSignal, 'T-SP') - readback = Cpt(EpicsSignalRO, 'T-I') - done = Cpt(EpicsSignalRO, 'Cmd-Busy') - stop_signal = Cpt(EpicsSignal, 'Cmd-Cmd') - - # Create an instance of this new kind of device. - - prefix = 'XF:28IDC-ES:1{Env:01}' - cs700 = CS700TemperatureController(prefix, name='cs700') - - # When the cs700 has reached the set-point temperature, the 'done' signal - # flips to 0. - cs700.done_value = 0 - - -.. autoclass:: ophyd.pv_positioner.PVPositioner - -PseudoPositioner ----------------- - -An ophyd ``PseudoPositioner`` relates one or more pseudo (virtual) axes to one -or more real (physical) axes via forward and inverse calculations. To define -such a PseudoPositioner, one must subclass from PseudoPositioner: - -.. code-block:: python - - from ophyd import (PseudoPositioner, PseudoSingle, EpicsMotor) - from ophyd import (Component as Cpt) - from ophyd.pseudopos import (pseudo_position_argument, - real_position_argument) - - - class Pseudo3x3(PseudoPositioner): - # The pseudo positioner axes: - px = Cpt(PseudoSingle, limits=(-10, 10)) - py = Cpt(PseudoSingle, limits=(-10, 10)) - pz = Cpt(PseudoSingle) - - # The real (or physical) positioners: - rx = Cpt(EpicsMotor, 'XF:31IDA-OP{Tbl-Ax:X1}Mtr') - ry = Cpt(EpicsMotor, 'XF:31IDA-OP{Tbl-Ax:X2}Mtr') - rz = Cpt(EpicsMotor, 'XF:31IDA-OP{Tbl-Ax:X3}Mtr') - - @pseudo_position_argument - def forward(self, pseudo_pos): - '''Run a forward (pseudo -> real) calculation''' - return self.RealPosition(rx=-pseudo_pos.px, - ry=-pseudo_pos.py, - rz=-pseudo_pos.pz) - - @real_position_argument - def inverse(self, real_pos): - '''Run an inverse (real -> pseudo) calculation''' - return self.PseudoPosition(px=-real_pos.rx, - py=-real_pos.ry, - pz=-real_pos.rz) - -``Pseudo3x3`` above is a pseudo positioner with 3 pseudo axes and 3 real axes. -The pseudo axes are defined in order as (px, py, pz). Similarly, the real -positioners are (rx, ry, rz). - -There is no restriction that the real axes must be tied to physical hardware. -A physical axis could just as well be a ``SoftPositioner``, or any subclass of -``PositionerBase`` (with the sole exception of ``PseudoSingle``). - -The forward calculation says that, for any given pseudo position, the real -motors should move to the opposite position. For example, for a pseudo position -of (px=1, py=2, pz=3), the corresponding real position would be (rx=-1, ry=-2, -rz=-3). The inverse calculation is similar, in going from a real position to a -pseudo position. - -The two decorators ``@real_position_argument`` and -``@pseudo_position_argument`` are used here for convenience so that one can -call these functions in a variety of ways, all of which generate a correct -PseudoPosition tuple as the first argument to your calculation method. -Positions can be specified in the following ways: - -* As positional arguments: - -.. code-block:: python - - pseudo.forward(px, py, pz) - - -* As a sequence or PseudoPosition/RealPosition: - -.. code-block:: python - - pseudo.forward((px, py, pz)) - pseudo.forward(pseudo.PseudoPosition(px, py, pz)) - - -* As kwargs: - -.. code-block:: python - - pseudo.forward(px=1, py=2, pz=3) - - -``move`` is decorated like this on PseudoPositioner, meaning you can also call -it with this syntax. - -.. autoclass:: ophyd.pseudopos.PseudoSingle -.. autoclass:: ophyd.pseudopos.PseudoPositioner - - -SoftPositioner --------------- - -A ``SoftPositioner`` is a positioner which has no corresponding physical motor. -On its own, it is most useful for debugging scanning logic when moving physical -motors is either undesirable or not possible. - -Used as-is, a ``SoftPositioner`` will "move" to the requested position -immediately. - -``PseudoSingle`` and ``PseudoPositioner``, for example, are implemented as -heavily customized ``SoftPositioner`` subclasses. - -.. autoclass:: ophyd.positioner.PositionerBase -.. autoclass:: ophyd.positioner.SoftPositioner - -.. code-block:: python - - from ophyd import SoftPositioner - my_positioner = SoftPositioner(name='my_positioner') diff --git a/ophyd/_sources/positioners.txt b/ophyd/_sources/positioners.txt deleted file mode 100644 index fa245aa96b..0000000000 --- a/ophyd/_sources/positioners.txt +++ /dev/null @@ -1,147 +0,0 @@ -Positioners -*********** - -Positioners other than ``EpicsMotor`` and ``SoftPositioner`` are not -"ready-to-use". They require some customization. - -PVPositioner ------------- - -For example, this code defines a CS700 temperature controller. A temperature -controller is a kind of positioner, from ophyd's point of view, where the -"position" is the temperature. - -.. code-block:: python - - from ophyd import PVPositioner, EpicsSignal, EpicsSignalRO - from ophyd import Component as Cpt - - # Define a new kind of device. - - class CS700TemperatureController(PVPositioner): - setpoint = Cpt(EpicsSignal, 'T-SP') - readback = Cpt(EpicsSignalRO, 'T-I') - done = Cpt(EpicsSignalRO, 'Cmd-Busy') - stop_signal = Cpt(EpicsSignal, 'Cmd-Cmd') - - # Create an instance of this new kind of device. - - prefix = 'XF:28IDC-ES:1{Env:01}' - cs700 = CS700TemperatureController(prefix, name='cs700') - - # When the cs700 has reached the set-point temperature, the 'done' signal - # flips to 0. - cs700.done_value = 0 - - -.. autoclass:: ophyd.pv_positioner.PVPositioner - -PseudoPositioner ----------------- - -An ophyd ``PseudoPositioner`` relates one or more pseudo (virtual) axes to one -or more real (physical) axes via forward and inverse calculations. To define -such a PseudoPositioner, one must subclass from PseudoPositioner: - -.. code-block:: python - - from ophyd import (PseudoPositioner, PseudoSingle, EpicsMotor) - from ophyd import (Component as Cpt) - from ophyd.pseudopos import (pseudo_position_argument, - real_position_argument) - - - class Pseudo3x3(PseudoPositioner): - # The pseudo positioner axes: - px = Cpt(PseudoSingle, limits=(-10, 10)) - py = Cpt(PseudoSingle, limits=(-10, 10)) - pz = Cpt(PseudoSingle) - - # The real (or physical) positioners: - rx = Cpt(EpicsMotor, 'XF:31IDA-OP{Tbl-Ax:X1}Mtr') - ry = Cpt(EpicsMotor, 'XF:31IDA-OP{Tbl-Ax:X2}Mtr') - rz = Cpt(EpicsMotor, 'XF:31IDA-OP{Tbl-Ax:X3}Mtr') - - @pseudo_position_argument - def forward(self, pseudo_pos): - '''Run a forward (pseudo -> real) calculation''' - return self.RealPosition(rx=-pseudo_pos.px, - ry=-pseudo_pos.py, - rz=-pseudo_pos.pz) - - @real_position_argument - def inverse(self, real_pos): - '''Run an inverse (real -> pseudo) calculation''' - return self.PseudoPosition(px=-real_pos.rx, - py=-real_pos.ry, - pz=-real_pos.rz) - -``Pseudo3x3`` above is a pseudo positioner with 3 pseudo axes and 3 real axes. -The pseudo axes are defined in order as (px, py, pz). Similarly, the real -positioners are (rx, ry, rz). - -There is no restriction that the real axes must be tied to physical hardware. -A physical axis could just as well be a ``SoftPositioner``, or any subclass of -``PositionerBase`` (with the sole exception of ``PseudoSingle``). - -The forward calculation says that, for any given pseudo position, the real -motors should move to the opposite position. For example, for a pseudo position -of (px=1, py=2, pz=3), the corresponding real position would be (rx=-1, ry=-2, -rz=-3). The inverse calculation is similar, in going from a real position to a -pseudo position. - -The two decorators ``@real_position_argument`` and -``@pseudo_position_argument`` are used here for convenience so that one can -call these functions in a variety of ways, all of which generate a correct -PseudoPosition tuple as the first argument to your calculation method. -Positions can be specified in the following ways: - -* As positional arguments: - -.. code-block:: python - - pseudo.forward(px, py, pz) - - -* As a sequence or PseudoPosition/RealPosition: - -.. code-block:: python - - pseudo.forward((px, py, pz)) - pseudo.forward(pseudo.PseudoPosition(px, py, pz)) - - -* As kwargs: - -.. code-block:: python - - pseudo.forward(px=1, py=2, pz=3) - - -``move`` is decorated like this on PseudoPositioner, meaning you can also call -it with this syntax. - -.. autoclass:: ophyd.pseudopos.PseudoSingle -.. autoclass:: ophyd.pseudopos.PseudoPositioner - - -SoftPositioner --------------- - -A ``SoftPositioner`` is a positioner which has no corresponding physical motor. -On its own, it is most useful for debugging scanning logic when moving physical -motors is either undesirable or not possible. - -Used as-is, a ``SoftPositioner`` will "move" to the requested position -immediately. - -``PseudoSingle`` and ``PseudoPositioner``, for example, are implemented as -heavily customized ``SoftPositioner`` subclasses. - -.. autoclass:: ophyd.positioner.PositionerBase -.. autoclass:: ophyd.positioner.SoftPositioner - -.. code-block:: python - - from ophyd import SoftPositioner - my_positioner = SoftPositioner(name='my_positioner') diff --git a/ophyd/_sources/release_notes.rst.txt b/ophyd/_sources/release_notes.rst.txt deleted file mode 100644 index 1c35fce6f3..0000000000 --- a/ophyd/_sources/release_notes.rst.txt +++ /dev/null @@ -1,891 +0,0 @@ -================= - Release History -================= - -v1.6.0 (2020-XX-XX) -=================== - -Added ------ - -* Support for Emergent Vision detectors. - -1.5.4 (2020-10-19) -================== - -Changes -------- - -* NDFile PVs implemented in FileBase instead of FilePlugin. - - -Fixes ------ - -* Various doc fixes and improvements. - - -Added ------ - -* ``OPHYD_SILENCE_VALUE_WARNING`` environment variable to silence ``.value`` warning. - - - -1.5.3 (2020-08-26) -================== - -Changes -------- - -* Add a default value for ``ScalerCH.select_channels`` such that calling it - without arguments selects all named channels. -* Change a particularly verbose ophyd logger from INFO-level to DEBUG-level. - - -Fixes ------ - -* Critical bug in EpicsMotor limits set low to high and high to low. -* For area detector cameras, add ``num_images`` to the set of components - recorded as configuration by default. - -1.5.2 (2020-07-07) -================== - -Changes -------- - -* Default logging behavior will now be to print all log messages with level - ``warning`` and higher. -* ``ophyd.mca.SoftDXPTrigger`` now inherits from ``Device`` instead of - ``BlueskyInterface``. This is to satisfy the requirement that classes which - have Components must also inherit Device. -* It was formerly the case that :meth:`~ophyd.signal.Signal.destroy` was always - called at teardown---either manually by the user or automatically using one - of Python mechanisms for running cleanup during garbage collection or process - teardown. Now, *automatic* teardown only involves internal weakref - finalizers and it does not call ``destroy``. The method is now only a - user-facing hook for manually invoking those finalizers. It should not be - used as an extension point for adding more code to be run at teardown; - rather, additional finalizers should be set up in ``__init__`` and invoked in - ``destroy``. See https://github.com/bluesky/ophyd/pull/865 for an example. - This changed is in accordance with best practices recommended by the Python - weakref documentation. - -Internals ---------- - -* Fixed logging imports in debugging documentation. -* Reset the internal ``_status`` in ``SingleTrigger`` to ``None`` when the - trigger is completed. - -1.5.1 (2020-06-12) -================== - -Fixes ------ - -* Updated required version of ``pyepics`` to ``3.4.2``, to ensure the included - fix to libca shutdown is available, preventing crashes on Python shutdown. -* The objects in ``ophyd.sim`` use threads to simulate delays due to movement, - instead of conditionally attempting to integrate with the asyncio event loop. -* Set attributes before invoking super in - :class:`~ophyd.areadetector.base.NDDerivedSignal` to ensure describe method - returns correct results. -* Improved documentation of :class:`~ophyd.device.BlueskyInterface`. -* Fixed intended ordering of areadetector plugins provided by - ``component_names``. - -Internals ---------- - -* Formatting fixes in Sphinx documentation. -* Added epics-pypdb to test requirements. -* Added Python 3.8 builds to continuous integration. -* Added log message when an exception occurs in status callback threads. - -1.5.0 (2020-05-01) -================== - -The API for Status objects has been reworked to be closer to its generic analog -in the standard library, :class:`concurrent.futures.Future`. Most of the -changes are extenions, but there are some deprecations and some minor -backward-incompatible changes. - -Added ------ - -* Status objects can store an exception giving information about why the - underlying action failed. This is set by - :meth:`~ophyd.StatusBase.set_exception` and can be retrieved by - :meth:`~ophyd.StatusBase.exception`. The method - :meth:`~ophyd.StatusBase.set_finished` may be used to mark successful - completion, in which case :meth:`~ophyd.StatusBase.exception` returns - ``None``. -* Status objects have a new :meth:`~ophyd.StatusBase.wait` method, which blocks - until the Status finishes (in success or failure) or until an optional - timeout is reached, whichever happens first. If it finishes in success, the - method returns ``None``; if failure, the exception captured by - :meth:`~ophyd.StatusBase.set_exception` is raised. - -Deprecated ----------- - -* Status objects take the parameters ``done`` and ``success``. These are - deprecated and, if set to anything but ``None`` (the default) issue a - warning suggesting a better approach. -* The method :meth:`~ophyd.StatusBase._finished` is deprecated in favor of - :meth:`~ophyd.StatusBase.set_finished` (for success) and - :meth:`~ophyd.StatusBase.set_exception` (for failure). There are no plans to - *remove* :meth:`~ophyd.StatusBase._finished`, given its wide use, but it may - begin to issue warnings in future releases. - -Backward-incompatible Changes ------------------------------ - -* The function :func:`ophyd.status.wait` formerly raised on ``TimeoutError`` or - ``RuntimeError``. It can now raise any ``Exception``. -* The attributes :obj:`~ophyd.StatusBase.timeout` and - :obj:`~ophyd.StatusBase.settle_time` have become read-only properties. - -Additionally, some unrelated bug fixes are included in this release. - -Fixed ------ - -* Fix a regression that broke ``describe()`` on some simulated hardware in - ``ophyd.sim`` in certain circumstances. -* Handle teardown more gracefully, avoiding error messages at shutdown time - that arose in certain installations. - -v1.4.1 (2020-04-07) -=================== - -Features --------- - -* Update HLM and LLM limits automatically on :class:`ophyd.EpicsMotor` when - they are changed externally. -* Added more descriptive error message when attempting to run setup under - unsupported Python versions. - -API Changes ------------ - -* Added methods :func:`ophyd.EpicsMotor.set_lim` and - :func:`ophyd.EpicsMotor.get_lim` to set and get limits on motors. -* Added documentation for logging API. - -Fixes ------ - -* Improved documentation of :class:`ophyd.PVPositioner`. -* Corrected path semantics behavior when interacting with an areadetector - running on a different OS. - -Internals ---------- - -* Refactored code to satisfy Flake8 requirements. Maximum line length set to - 115 characters. -* Improved scope of log messages emitted by ``OphydObj``. - -v1.4.0 (2020-03-13) -=================== - -Features --------- - -* Version ophyd classes to support IOCs changing over time. This is currently - implemented for AreaDetector plugins (releases 1-9 to 3-4). -* Added :class:`ophyd.NDDerivedSignal`, which supplies a reshaped version of an - input array signal. -* Added :func:`ophyd.Component.subscriptions` decorator to set up default - subscriptions on a component. -* Added :func:`ophyd.device.create_device_from_components` to aid dynamic - device generation. -* Added :func:`ophyd.device.required_for_connection` decorator to mark the - Components that must be connected for the overall Device to be considered - connected. -* Added a hook to be called on all ophyd object creation via the - :func:`OphydObj.add_instantiation_callback` class method along with the - :func:`.register_instances_keyed_on_name` and - :func:`.register_instance_in_weakset` helper functions. -* Added :attr:`OphydObj.dotted_name` property to get the full attribute name of a - child component. -* Added the properties `read_access`, `write_access`, `metadata` to the base - signal class :class:`ophyd.Signal`. -* Added metadata subscriptions for :class:`ophyd.Signal`. -* Added :func:`OphydObj.destroy` method to all ophyd objects. -* Added support for ADLambda X-Spectrum Lambda 750K camera. -* Improved error message "Another set() call is still in progress" to include - the name of the device that raised the error. -* Allowed `ophyd.FormattedComponent` strings to be written like - ``{prefix}{_ch_name}`` as well as the previously-supported and more verbose - ``{self.prefix}{self._ch_name}``. -* Made timeouts more configurable, including separately configurable connection - timeout, write timeout, and read timeout. New method - `ophyd.EpicsSignal.set_default_timeout` sets class-wide defaults. Timeouts - can also be specified per-instance and in a specific action. - -API Changes ------------ - -* Dropped support for Python 3.5. -* The optional dependency pyepics, if installed, must be above version 3.4.0 to - be used. -* If you are holding a reference to a pyepics.pv.PV that is shared with ophyd - and all ophyd objects that use that PV are torn down, all callbacks on the PV - will be cleared and the channel will be torn down. If this is a problem for - you, please create a bug report. -* Removed :mod:`ophyd.control_layer`. The "control layer" used to access EPICS - can be controlled via :func:`ophyd.set_cl`. -* :class:`ophyd.DynamicDeviceComponent` is now an :class:`ophyd.Component` - sub-class -* Changed argument name in :meth:`OphydObj.subscribe` from ``cb`` to - ``callback``. -* Removed :class:`ophyd.tests.conftest.FakeEpicsPV`, - :class:`ophyd.tests.conftest.FakeEpicsWaveForm`, and associated helper - functions. If you need this class, please vendor it from a previous version - of ophyd - or please consider moving to `make_fake_device` or `caproto`-based - simulation IOCs. -* Removed ``ophyd.tests.AssertTools`` and use standard pytest idioms throughout - the test suite. -* Overhauled objects in `ophyd.sim` to inherit from `ophyd.Signal` and - `ophyd.Device` and thus behave more like true hardware-connected devices. -* The `ophyd.StatusBase.done` attribute was formerly settable, but never - intended to be. It should only be set by calling - `ophyd.StatusBase._finished()`. Now, if it is set from ``False`` to ``True`` - is warns, and if it is set from ``True`` to ``False`` (which does not make - sense) it raises. - -Fixes ------ - -* Skip erroneous limits check on ``EpicsMotor.set_current_position``. -* Handle bug in dispatcher to allow ``functools.partial`` objects to be - registered as callbacks. -* Before shaping area detector image data, truncate any extra elements that - exceed the declares waveform length. -* Fix clipping in status progress updates. -* Address numpy pickle CVE. - -Internals ---------- - -* Switch from :class:`ophyd.Device` using meta-classes to using - ``__init__subclass__``. There are now no meta-classes used in ophyd! -* Completely overhauled how we connect to PVs at initialization and tear them - down on destruction of the ophyd objects. -* Completely overhauled how PV meta-data is handled. -* Completely overhauled the dispatcher thread mechanism. -* Removed our backport of ``enum``, as it is available on the minimum Python - 3.6. -* Refactor simulated text object ``SynAxisNoHints`` to be more realistic. - -v1.3.3 (2019-05-02) -=================== - -Features --------- -* Provide way to select all channels of ScalarCH. - -Bug Fixes ---------- -* Ensure that ScalarCH channels with empty names are not selected. - -v1.3.2 (2019-03-11) -=================== - -Bug Fixes ---------- - -* Update usage of ``collections`` module for Python 3.7. -* Improve documentation of "hints". -* Fix ``ophyd.log.logger`` which had erroneous name ``'bluesky'`` instead of - ``'ophyd'``. -* Fix typos in definition of area detector devices wherein ``BrukerDetector`` - and ``PerkinElmerDetector`` had ``cam`` components from cameras of different - brands than their own. -* In area detector file plugins, do not touch 'Capture' PV if image mode is - 'Single'. Doing so has no effect, and it generates an error (that should be a - warning) from area detector noting that it has no effect. -* Fix a typo in ``ScalerCH`` definition of its ``name_map``. - -v1.3.1 (2019-01-03) -=================== - -Features --------- - -* Add :class:`~ophyd.FakeEpicsSignalWithRBV`, which is to - :class:`~ophyd.FakeEpicsSignal` as :class:`~ophyd.EpicsSignalWithRBV` is to - :class:`~ophyd.EpicsSignal`. -* Add enum-spoofing to :class:`~ophyd.FakeEpicsSignal`. -* A default handler is added to the ``'ophyd'`` logger at import time. A new - convenience function, :func:`~ophyd.set_handler`, addresses common cases - such as directing the log output to a file. - -Bug Fixes ---------- - -* Always interpret simulated motor positions as floats, even if set to an - integer position. -* Accept numpy arrays in ``set_and_wait``. -* Log errors with ``set_and_wait`` at the ERROR level rather than the (often - silenced) DEBUG level. -* Check limits on :class:`~ophyd.SoftPositioner`. -* Produce consistent Datum documents in the old and new asset registry code - paths in :class:`~ophyd.sim.SynSignalWithRegistry`. -* Fix some missing imports in :mod:`ophyd.areadetector.plugins`. -* The verification that the image plugin has received an array of nonzero size - was implemented in a way that it would never be tripped. -* Accept any tuple of the right length in :meth:`~ophyd.Device.put`. -* :class:`~ophyd.AttributeSignal` now runs subscriptions when it processes an - update. -* Fix some bugs in :class:`~ophyd.FakeEpicsSignal`. - -v1.3.0 (2018-09-05) -=================== - -Features --------- - -* Teach Area Detector classes how to display the DAG of their pipelines - via :func:`~ophyd.areadetector.base.ADBase.visualize_asyn_digraph`. - - -Bug Fixes ---------- - -* :class:`~ophyd.signal.Signal.describe` correctly reports the type - and shape of the data. -* make :obj:`Device.component_names` an :class:`tuple` (instead of a - :class:`list`) as it should not be mutable. -* Fix issue with grand-children not correctly reporting as being in - ``read_attrs`` or ``configuration_attrs``. - -v1.2.0 (2018-06-06) -=================== - -Features --------- - -* On each Signal or Device, attach a Python logger attribute named ``log`` - with a logger name scoped by module name and the ophyd ``name`` of the - parent Device. -* Signals and Devices now accept ``labels`` argument, a set of labels - --- presumed but not (yet) forced to be strings --- which the user can use - for grouping and displaying available hardware. The labels are accessible via - a new attribute ``_ophyd_labels_``, so name to facilitate duck-typing across - libraries. For example, the bluesky IPython "magics" use this to identify - objects for the purpose of displaying them in labeled groups. -* Added ``tolerated_alarm`` attribute to ``EpicsMotors``, a hook to increase - alarm tolerance for mis-configured motors. -* Ophyd is now fully tested to work against the experimental control layer, - caproto, in addition to pyepics. The control layer can also be set to 'dummy' - for testing without EPICS. This is configurable via the - ``OPHYD_CONTROL_LAYER`` environment variable. -* Added a ``kind`` attribute to each Signal and Device, settable interactively - or via an argument at initiation time, which controls whether its parent - Device will include it in ``read()``, ``read_configuration()``, and/or - ``hints.fields``. This behavior was previously controlled by ``read_attrs``, - ``configuration_attrs``, ``_default_read_attrs``, and - ``_default_configuration_attrs`` on parent Devices. Those can still be used - for *setting* the desired state, but the source of truth is now stored - locally on each child Signal/Device, and - ``read_attrs``/``configuration_attrs`` has been re-implemented as a - convenience API. Documentation is forthcoming; until then we refer to you the - `narrative-style tests of this feature `_. Also see three breaking changes, listed in a subsequent - section of these release notes. The existing implementation contained buggy - and surprising behavior, and addressing that made breaking *something* - unavoidable. -* Added ``make_fake_device`` factory function that makes a Device out of - ``FakeEpicsSignal`` based on a Device that has real signals. -* Add ``sum_all`` component to QuadEM. -* Add a ``set`` method to the ROI plugin. -* Validate that a Device or Signal's ``name`` is a string, and raise helpfully - if it is not. - -Bug Fixes ---------- - -* Allow ``DerivedSignal`` to accept a string name as its target component so - that it can be used inside Device, where it must defer grabbing its target to - initialization time. -* Signals that start with underscores are now not renamed by ``namedtuple``. - This causes issues when the ``.get`` method tries to fill the ``DeviceTuple``. -* Add new ``ad_root`` ("area detector root") to remove the accidental - assumption that ``ADBase`` is the root ancestor Device of all its subclasses. -* ``ad_group`` generates Components that are lazy by default. -* Catch various edge cases related to the data fed to progress bars from status - objects. - -Deprecations ------------- - -* This release simplifies the flow of information out of ophyd. Fortunately, - this major change can be made smoothly. In this transitional release, both - old and new modes of operation are supported. Old configurations should - continue to work, unchanged. Nonetheless, users are encouraged to update - their configurations promptly to take advantage of the better design. The - old mode of operation will cease to be supported in a future release. - - **How to upgrade your configuration:** Simply remove the ``reg=...`` - parameter everywhere it occurs in area-detector-related configuration. - - **Background:** In the original design, bluesky's RunEngine collected *some* - information (readings for Event and EventDescriptor documents) and dispatched - it out to consumers, while ophyd itself pushed other information (Datum and - Resource documents) directly into a database. There are two problems with - this design. - - 1. Consumers subscribed to bluesky only see partial information. For example, - to access the filepaths to externally-stored data, they have to perform a - separate database lookup. There are no guarantees about synchronization: - the consumer may receive references to objects that do not exist in the - database yet. - 2. Ophyd is responsible inserting information into a database, which means - connection information needs to be associated with a Device. This seems - misplaced. - - In the new design, ophyd merely *caches* Datum and Resource documents and - leaves it up to bluesky's RunEngine to ask for them and dispatch them out to - any consumers (such as that database that ophyd used to push to directly). - Thus, all information flows through bluesky and to consumers in a guaranteed - order. Ophyd does not need to know about database configuration. - - Ophyd's area detector "filestore" integration classes in - ``ophyd.areadetector.filestore_mixins`` and ``ophyd.sim`` still *accept* - a ``Registry`` via their optional ``reg`` parameter. If they receive one, - they will assume that they are supposed to operate the old way: inserting - documents directly into the ``Registry``. If the user is running bluesky - v1.3.0, bluesky will collect these same documents and dispatch them out to - consumers also. -* The module ``ophyd.control_layer`` has been deprecated in favor of a - top-level ``cl`` object. - -Breaking Changes ----------------- - -* The 'hints' feature was an experimental feature in previous releases of - ophyd and is now being incorporated in a first-class way. To ensure - internal consistency, the ``hints`` attribute of any ``Signal`` or ``Device`` - is no longer directly settable. Instead of - - .. code-block:: python - - camera.hints = {'fields': [camera.stats1.total.name, - camera.stats2.total.name]} - - do - - .. code-block:: python - - from ophyd import Kind - - camera.stats1.total.kind = Kind.hinted - camera.stats2.total.kind = Kind.hinted - - or, as a convenient shortcut - - .. code-block:: python - - camera.stats1.total.kind = 'hinted' - camera.stats2.total.kind = 'hinted' -* The ``read_attrs`` / ``configuration_attrs`` lists will now contain all of - the components touched when walking the Device tree. This also means that - setting these lists may not always round trip: they may contain extra - elements in addition to those explicitly set. -* When adding "grandchildren" via ``read_attrs`` / ``configuration_attrs``, we - no longer allow generation skipping and forcibly set up the state of all of - the devices along the way to be consistent. Inconsistency arguably should - never have been possible in the first place. -* A Device's ``__repr__`` no longer includes ``read_attrs`` and - ``configuration_attrs`` (because they are now so lengthy). This means that - passing a Device's ``__repr__`` to ``eval()`` does not necessarily - reconstruct a Device in exactly the same state. - -v1.1.0 (2017-02-20) -=================== - -Features --------- - -* Add a new ``run`` keyword, which defaults to ``True``, which can be used to - keep :class:`.SubscriptionStatus` objects from running callbacks immediately. -* Add an :meth:`unsuscribe_all` method to OphydObj. -* Support timestamps and subscriptions in the simulated motor - :class:`.SynAxis` and related classes. -* Extend :class:`.DynamicDeviceComponent` to accept optional - ``default_read_attrs`` and ``default_configuration_attrs`` arguments, which - it will assign as class attributes on the class it dynamically creates. -* Systematically add ``default_read_attrs=(...)`` to every DDC on every - Area Detector plugin. Now, for example, adding ``'centroid'`` to the read - attributes of a :class:`.StatsPlugin` instance also effectively adds - ``'centroid_x'`` and ``'centroid_y'``, which is presumably the desired - result. -* On :class:`.ScalerCH`, omit any channels whose name is ``''`` from - the read attributes by default. -* Add new ``random_state`` keyword to relevant simulated devices so that their - randomness can be made deterministic for testing purposes. -* Restore namespace-scraping utilities :func:`.instances_from_namespace` and - :func:`.ducks_from_namespace` which had been moved in pyolog during previous - refactor. - -Bug Fixes ---------- - -* Fix race condition in :func:`.set_and_wait`. -* Fix a bug in aforementioned namespace-scraping utilities. -* Do not use deprecated API (``signal_names``, now called ``component_names``) - internally. - -v1.0.0 (2017-11-17) -=================== - -This tag marks an important release for ophyd, signifying the conclusion of -the early development phase. From this point on, we intend that this project -will be co-developed between multiple facilities. The 1.x series is planned to -be a long-term-support release. - -Breaking Changes ----------------- - -* To access the human-friendly summary of a Device's layout, use - ``device.summary()`` instead of ``print(device)``. The verbosity of the - summary was overwhelming when it appeared in error messages and logs, so it - was moved from ``Device.__str__`` this new method. Now ``Device.__str__`` - gives the same result as ``Device.__repr__``, as it did before v0.7.0. -* Add (empty) hints to `~ophyd.sim.SynSignalWithRegistry`. - -Bug Fixes ---------- - -* Initiate :class:`~ophyd.sim.SynSignal` with a function that returns ``None`` - if no ``func`` parameter is provided. -* Make ophyd importable without pyepics and libca. - -v0.8.0 (2017-11-01) -=================== - -Breaking Changes ----------------- - -* Make the ``name`` keyword to Device a required, keyword-only argument. This - ensures that the names that appear in the read dictionary are always - human-readable. -* When a ``PseudoPositioner`` is set with only a subset of its parameters - specified, fill in the unspecified values with the current *target* position, - not the current *actual* position. - -Deprecations ------------- - -* The ``signal_names`` attribute of devices has been renamed - ``component_names`` for clarity because it may include a mixture of Signals - and Devices -- any Components. The old name now issues a warning when - accessed, and it may be removed in a future release of ophyd. -* Status objects' new ``add_callback`` method and ``callbacks`` attribute - should be preferred over the ``finished_cb`` property, which only supports - one callback and now warns if set or accessed. - -Features --------- - -* Add ``ophyd.sim`` module with various synthetic 'hardware' for testing and - teaching. -* The 'children' of a ``PseudoPositioner`` can now be simultaneously used as - independent axes in a bluesky plan. -* Add ``SubscriptionStatus``, which reports done when a Python function of the - subscription returns ``True``. -* It is possible to register more than one callback function to be called on - completion of a Status object (i.e. when a Device is finished triggering or - moving). -* Status objects support ``__and__``, such that ``status1 & status2`` return a - new status object that completes when both ``status1`` and ``status2`` are - complete. -* Do not require a ``prefix`` argument to ``Device``. It is not applicable in - cases of synthetic 'hardware'. -* Add ``MotorBundle`` for bundling ``EpicsMotors`` and automatically composing - a useful combined hint. -* Add hints to ``PseudoSingle``, ``PseudoPositioner``, and ``SoftPositioner``. -* Make it possible to plug in a different "control layer" --- i.e. an interface - to EPICS other than pyepics. This is experimental and may be changed in the - future in a way that is not backward-compatible. - -Bug Fixes ---------- - -* Avoid a race condition when timing out during a settle time. - -Internal Changes ----------------- - -* Reduce set_and_wait log messages to DEBUG level. -* Refactor OphydObj callbacks to make the logic easier to follow. This change - is fully backward-compatible. - -v0.7.0 (2017-09-06) -=================== - -Breaking Changes ----------------- - -* The module :mod:`ophyd.commands`, a grab bag of convenient tools, has been - entirely removed. The functionality is available in other ways: - - * The functions :func:`mov` and :func:`movr` ("move" and "move relative") - have been replaced by IPython magics, provided in bluesky v0.10.0: - - .. code-block:: python - - %mov eta 3 temp 273 - %movr eta 1 temp -5 - - * The function :func:`wh_pos` for surveying current positioners has also - been supplanted by an IPython magic packaged with bluesky: ``%wa`` (short - for "where all", an abbreviation borrowed from SPEC). - - .. code-block:: python - - %wa - - * The fucntionality of :func:`set_pos`---setting zero---is available via a - device method :meth:`set_current_pos`, if applicable. - - * The functionality of :func:`set_lm` for altering limits has been removed. - It is not something users should generally change, and now must be done - directly via EPICS or pyepics. - - * The logging-related functionality, including all functions named - ``log_*`` and also :func:`get_all_positioners` have been moved to - `pyOlog `_. - - * The function ``setup_ophyd`` was merely a shim to - :func:`ophyd.setup_ophyd`, which is still available as a top-level - import. - -* When recursing through complex devices, ``read()`` in no longer called as - part of ``read_configuration()``. - For complex devices, the same child device may be used in both ``read_attrs`` - and ``read_configuration``. Putting the read values into the configuration - is generically not correct. For example, the mean_value of a stats plugin for - Area Detector should be in the ``read()`` but not in the result of - ``read_configuration()``. At the bottom, Signals fall back to ``read()`` for - their read_configuration implementation. -* The area detector 'EnableCallbacks' signal is set using its integer - representation instead of its enum string. The string representation was - changed on the NDPluginBase.template file in upstream Area Detector. The int - value is stable (we hope). -* Low-level changes related to integration between ophyd's area detector code - and databroker/filestore: - - * Ophyd's optional dependency on filestore, which is now a deprecated - package, has been replaced by an optional dependency on databroker. In - area detector classes, the keyword argument and attribute ``fs`` has been - changed to ``reg``, short for "registry". - * The ``FileStoreBulkWrite`` mixin classes have been removed. Now that the - Registry is generating the datum UIDs the 'stash, emit on read, and then - insert on unstage' is no longer possible. This means we will never let a - datum_id which is not in a Registry out into the EventSources. This - change is driven by the need to support column based backends from Assets. - * The method ``generate_datum`` on area detector file plugins requires an - additional argument, ``datum_kwargs``. - -Features --------- - -* Many devices picked up a new ``hints`` property. Its goal is to highlight the - most interesting or important fields---often a small subset of all the fields - that are read---in support of automated visualization and processing. It does - not affect what is read or recorded; nothing is permanently altered or lost - if the hints are incorrect. The content of hints may be changed in future - releases, as this feature is experimental. For now, ``hints`` is a dictionary - with the key ``fields`` mapped to a list of field names. For movable - devices, these fields are expected to represent the the independent axes of - the device. For devices that are only readable, these fields represent the - most interesting fields, i.e. the fields most likely to be desired in a table - or plot. -* The string representation of a device, accessible via ``str(...)`` or - ``print(...)``, provides a human-readable summary of its attributes and - fields. Example: - - .. code-block:: none - - In [5]: motor = EpicsMotor('XF:31IDA-OP{Tbl-Ax:X1}Mtr', name='motor') - - In [6]: print(motor) - data keys (* hints) - ------------------- - *motor - motor_user_setpoint - - read attrs - ---------- - user_readback EpicsSignalRO ('motor') - user_setpoint EpicsSignal ('motor_user_setpoint') - - config keys - ----------- - motor_acceleration - motor_motor_egu - motor_user_offset - motor_user_offset_dir - motor_velocity - - configuration attrs - ---------- - motor_egu EpicsSignal ('motor_motor_egu') - velocity EpicsSignal ('motor_velocity') - acceleration EpicsSignal ('motor_acceleration') - user_offset EpicsSignal ('motor_user_offset') - user_offset_dir EpicsSignal ('motor_user_offset_dir') - - Unused attrs - ------------ - offset_freeze_switch EpicsSignal ('motor_offset_freeze_switch') - set_use_switch EpicsSignal ('motor_set_use_switch') - motor_is_moving EpicsSignalRO ('motor_motor_is_moving') - motor_done_move EpicsSignalRO ('motor_motor_done_move') - high_limit_switch EpicsSignal ('motor_high_limit_switch') - low_limit_switch EpicsSignal ('motor_low_limit_switch') - direction_of_travel EpicsSignal ('motor_direction_of_travel') - motor_stop EpicsSignal ('motor_motor_stop') - home_forward EpicsSignal ('motor_home_forward') - home_reverse EpicsSignal ('motor_home_reverse') - -* The Area Detector plugins formerly always enabled themselves during staging. - Now, this behavior is configurable using new methods, ``enable_on_stage()`` - and ``disable_on_stage()``. After unstaging, devices are put into their - original state, whether enabled or disabled. Additionally, there are methods - to control blocking callbacks, ``ensure_blocking()`` and - ``ensure_nonblocking()``. We recommend using blocking callbacks always to - ensure that file names do not get out of sync with acquisitions. -* A device's default read_attrs and configuration_attrs can be more succinctly - specified via the class attributes ``_default_read_attrs`` and - ``_default_configuration_attrs``. -* Some status objects add a new method named ``watch`` which support bluesky's - new progress bar feature. -* The ``ScalerCH`` class has a new method, ``select_channels`` that - coordinates several necessary steps of configuration in one convenient - method. - -Bug Fixes ---------- - -* The area detector plugin ports are validated after staging, giving the - staging process the opportunity to put them into a valid state. - -Maintenance ------------ - -* Ophyd's automated tests are now included inside the Python package in the - package ``ophyd.tests``. -* Ophyd has many fewer dependencies. It no longer requires: - - * ``boltons`` - * ``doct`` - * ``ipython`` - * ``prettytable`` - * ``pyOlog`` (This was previous optional; now it is not used at all.) -* :attr:`ophyd.AreaDetector.filestore_mixin.fs_root` has been deprecated in - favor of :attr:`ophyd.AreaDetector.filestore_mixin.reg_root`. - -v0.6.1 (2017-05-22) -=================== - -(TO DO) - -v0.6.0 (2017-05-05) -=================== - -(TO DO) - -v0.5.0 (2017-01-27) -=================== - -(TO DO) - -v0.4.0 (2016-11-01) -=================== - -Enhancements ------------- - -* Allow ``set_and_wait`` to have a timeout. -* Allow a plugin to have no port name. -* Ensure trailing slashes are included in file plugin filepaths to avoid common - user mistake. - -Breaking Changes ----------------- - -* The bluesky interface now expects the ``stop`` method to accept an optional - ``success`` argument. - -v0.3.1 (2016-09-23) -=================== - -Enhancements ------------- - -* Check alarm status of EpicsMotor to decide success/failure -* Allow ``stage_sigs`` to be attribute *names* to enable lazy-loading. -* Add ``target_initial_position`` parameter to ``PseudoSingle``. - -Fixes ------ - -* Add size-link to ROI plugin. -* Fix QuadEM port name uniqueness. -* Rename ``read`` attribute on MCA, which was shadowing ``read`` method, to - ``force_read``. Add check to ``Device`` to avoid repeating this mistake in - the future. - -v0.3.0 (2016-07-25) -=================== - -Breaking Changes ----------------- - -* Area detector now checks that all plugins in the pipeline of - anything that will be collected as part of ``read``. The - configuration of all of the plugins in the processing chain will now - be included in descriptor document. Tooling to inspect the asyn pipelines - is now part of `ADBase` and `PluginBase`. - -New Features ------------- - -* Add ``pivot`` kwarg to `MonitorFlyierMixin` to optionally provide a - single event as a time series rather than a time series of many - events. -* Add `SignalPositionerMixin` to turn a `Signal` into a positioner. -* Add classes for PCO edge - -Bug Fixes ---------- - -* Be more careful about thread safety around ``pyepics`` - -v0.2.3 (2016-05-05) -=================== - -(TO DO) - -v0.2.2 (2016-03-14) -=================== - -(TO DO) - -v0.2.1 (2016-02-23) -=================== - -(TO DO) - -v0.2.0 (2016-02-10) -=================== - -(TO DO) diff --git a/ophyd/_sources/release_notes.txt b/ophyd/_sources/release_notes.txt deleted file mode 100644 index 2605cd86ee..0000000000 --- a/ophyd/_sources/release_notes.txt +++ /dev/null @@ -1,64 +0,0 @@ -Release Notes -------------- - -0.4.0 -===== - -Enhancements -************ - -* Allow ``set_and_wait`` to have a timeout. -* Allow a plugin to have no port name. -* Ensure trailing slashes are included in file plugin filepaths to avoid common - user mistake. - -API Changes -*********** - -* The bluesky interface now expects the ``stop`` method to accept an optional - ``success`` argument. - -0.3.1 -===== - -Enhancements -************ - -* Check alarm status of EpicsMotor to decide success/failure -* Allow ``stage_sigs`` to be attribute *names* to enable lazy-loading. -* Add ``target_initial_position`` parameter to ``PseudoSingle``. - -Fixes -***** - -* Add size-link to ROI plugin. -* Fix QuadEM port name uniqueness. -* Rename ``read`` attribute on MCA, which was shadowing ``read`` method, to - ``force_read``. Add check to ``Device`` to avoid repeating this mistake in - the future. - -0.3.0 -===== - -API Changes -*********** - -* Area detector now checks that all plugins in the pipeline of - anything that will be collected as part of ``read``. The - configuration of all of the plugins in the processing chain will now - be included in descriptor document. Tooling to inspect the asyn pipelines - is now part of `ADBase` and `PluginBase`. - -New Features -************ - -* Add ``pivot`` kwarg to `MonitorFlyierMixin` to optionally provide a - single event as a time series rather than a time series of many - events. -* Add `SignalPositionerMixin` to turn a `Signal` into a positioner. -* Add classes for PCO edge - -Bug Fixes -********* - -* Be more careful about thread safety around ``pyepics`` diff --git a/ophyd/_sources/signals.rst.txt b/ophyd/_sources/signals.rst.txt deleted file mode 100644 index bfff114d0c..0000000000 --- a/ophyd/_sources/signals.rst.txt +++ /dev/null @@ -1,131 +0,0 @@ -.. _signal_indx: - -Signals -******* - -In EPICS, **Signal** maybe backed by a read-only PV, a single -read-write PV, or a pair of read and write PVs, grouped together. In -any of those cases, a single value is exposed to `bluesky -`_. For more complex hardware, for -example a `motor record -`_, the relationships -between the individual process variables needs to be encoded in a -:class:`~device.Device` (a :class:`~epics_motor.EpicsMotor` class -ships with ophyd for this case). This includes both what **Signals** -are grouped together, but also how to manipulate them a coordinated -fashion to achieve the high-level action (moving a motor, changing a -temperature, opening a valve, or taking data). More complex devices, -like a diffractometer or a Area Detector, can be assembled out of -simpler component devices. - - -A ``Signal`` is much like a ``Device`` -- they share almost the same -interface -- but a ``Signal`` has no sub-components. In ophyd's hierarchical, -tree-like representation of a complex piece of hardware, the signals are -the leaves. Each one represents a single PV or a read--write pair of PVs. - -.. index:: kind attribute -.. _kind: - -:attr:`kind` -------------- - -The :attr:`kind` attribute is the means to identify a signal that is -relevant for handling by a callback. -:attr:`kind` controls whether the signal's parent -Device will include it in ``read()``, ``read_configuration()``, and/or -``hints.fields``. -The first use of :attr:`kind` is to inform -visualization callbacks about the independent and dependent display -axes for plotting. -A Component marked as hinted will return a dictionary with that component's fields list. - -The :attr:`kind` attribute takes string values of: ``config``, -``hinted``, ``normal``, and ``omitted``. -These values are like bit flags, a signal could have multiple values. - -The value may be set either when the :class:`~signal.Signal` is created or -programmatically. -Use the :attr:`kind` attribute when creating a :class:`~signal.Signal` -or :class:`Component`, such as: - -.. code-block:: python - - from ophyd import Kind - - camera.stats1.total.kind = Kind.hinted - camera.stats2.total.kind = Kind.hinted - -or, as a convenient shortcut (eliminates the import) - -.. code-block:: python - - camera.stats1.total.kind = 'hinted' - camera.stats2.total.kind = 'hinted' - -With ophyd v1.2.0 or higher, use :attr:`kind` instead of setting -the :attr:`hints` attribute of the :class:`~device.Device`. See -:ref:`hints_fields` for more details. - -.. index:: labels attribute -.. _labels: - -:attr:`labels` --------------- - -:class:`~signal.Signal` and :class:`~device.Device` now accept -a :attr:`labels` attribute. The value is a list of text strings ---- presumed but not (yet) forced to be strings --- which the user can use -for grouping and displaying available hardware or other ophyd constructs. -The labels are accessible via -an attribute ``_ophyd_labels_``, so named to facilitate duck-typing across -libraries. For example, the bluesky IPython "magics" use this to identify -objects for the purpose of displaying them in labeled groups. - -The IPython magic command ``wa`` (available if bluesky is installed as well -as ophyd) groups items by labels. Here is an example: - -.. code-block:: python - - m1 = EpicsMotor('prj:m1', name='m1', labels=("general",)) - m2 = EpicsMotor('prj:m2', name='m2', labels=("general",)) - - class MyRig(Device): - t = Component(EpicsMotor, "m5", labels=("rig",),) - l = Component(EpicsMotor, "m6", labels=("rig",)) - b = Component(EpicsMotor, "m7", labels=("rig",)) - r = Component(EpicsMotor, "m8", labels=("rig",)) - - - rig = MyRig("prj:", name="rig") - -Then in an ipython session: - -.. code-block:: python - - In [1]: wa - general - Positioner Value Low Limit High Limit Offset - m1 1.0 -100.0 100.0 0.0 - m2 0.0 -100.0 100.0 0.0 - - Local variable name Ophyd name (to be recorded as metadata) - m1 m1 - m2 m2 - - rig - Positioner Value Low Limit High Limit Offset - rig_b 0.0 -100.0 100.0 0.0 - rig_l 0.0 -100.0 100.0 0.0 - rig_r 0.0 -100.0 100.0 0.0 - rig_t 0.0 -100.0 100.0 0.0 - - Local variable name Ophyd name (to be recorded as metadata) - rig.b rig_b - rig.l rig_l - rig.r rig_r - rig.t rig_t - - -.. automodule:: ophyd.signal - :noindex: diff --git a/ophyd/_sources/signals.txt b/ophyd/_sources/signals.txt deleted file mode 100644 index 4262a916ea..0000000000 --- a/ophyd/_sources/signals.txt +++ /dev/null @@ -1,10 +0,0 @@ -Signals -******* - -A ``Signal`` is much like a ``Device`` -- they share almost the same -interface -- but a ``Signal`` has no sub-components. In ophyd's hierarchical, -tree-like representation of a complex piece of hardware, the signals are -the leaves. Each one represents a single PV or a read--write pair of PVs. - -.. automodule:: ophyd.signal - :members: diff --git a/ophyd/_sources/status.rst.txt b/ophyd/_sources/status.rst.txt deleted file mode 100644 index a8586bdba4..0000000000 --- a/ophyd/_sources/status.rst.txt +++ /dev/null @@ -1,244 +0,0 @@ -Status objects (Futures) -======================== - -Ophyd Status objects signal when some potentially-lengthy action is complete. -The action may be moving a motor, acquiring an image, or waiting for a -temperature controller to reach a setpoint. From a general software engineering -point of view, they are like :obj:`concurrent.futures.Future` objects in the -Python standard library but with some semantics specific to controlling -physical hardware. - -The lifecycle of a Status object is: - -#. A Status object is created with an associated timeout. The timeout clock - starts. -#. The recipient of the Status object may add callbacks that will be notified - when the Status object completes. -#. The Status object is marked as completed successfully, or marked as - completed with an error, or the timeout is reached, whichever happens first. - The callbacks are called in any case. - -Creation and Marking Completion -------------------------------- - -A *timeout*, given in seconds, is optional but strongly recommended. (The -default, ``None`` means it will wait forever to be marked completed.) - -.. code:: python - - from ophyd import Status - - status = Status(timeout=60) - -Additionally, it accepts a *settle_time*, an extra delay which will be added -between the control system reporting successful completion and the Status being -marked as finished. This is also given in seconds. It is ``0`` by default. - -.. code:: python - - status = Status(timeout=60, settle_time=10) - -The status should be notified by the control system, typically from another -thread or task, when some action is complete. To mark success, call -:obj:`~ophyd.StatusBase.set_finished`. To mark failure, call -:obj:`~ophyd.StatusBase.set_exception`, passing it an Exception giving -information about the cause of failure. - -As a toy example, we could hook it up to a :obj:`threading.Timer` that marks it -as succeeded or failed based on a coin flip. - -.. code:: python - - import random - import threading - - def mark_done(): - if random.random() > 0.5: # coin flip - status.set_finished() # success - else: - error = Exception("Bad luck") - status.set_exception(error) # failure - - # Run mark_done 5 seconds from now in a thread. - threading.Timer(5, mark_done).start() - -See the tutorials for more realistic examples involving integration with an -actual control system. - -.. versionchanged:: v1.5.0 - - In previous versions of ophyd, the Status objects were marked as completed - by calling ``status._finished(success=True)`` or - ``status._finished(success=False)``. This is still supported but the new - methods ``status.set_finished()`` and ``status.set_exception(...)`` are - recommended because they can provide more information about the *cause* of - failure, and they match the Python standard library's - :obj:`concurrent.futures.Future` interface. - -Notification of Completion --------------------------- - -The recipient of the Status object can request synchronous or asynchronous -notification of completion. To wait synchronously, the :obj:`~ophyd.StatusBase.wait` -will block until the Status is marked as complete or a timeout has expired. - -.. code:: python - - status.wait() # Wait forever for the Status to finish or time out. - status.wait(10) # Wait for at most 10 seconds. - -If and when the Status completes successfully, this will return ``None``. If -the Status is marked as failed, the exception (e.g. ``Exception("Bad luck")`` -in our example above) will be raised. If the Status' own timeout has expired, -:obj:`~ophyd.utils.StatusTimeoutError` will be raised. If a timeout given to -:obj:`~ophyd.StatusBase.wait` expires before any of these things happen, -:obj:`~ophyd.utils.WaitTimeoutError` will be raised. - -The method :obj:`~ophyd.StatusBase.exception` behaves similarly to -:obj:`~ophyd.StatusBase.wait`; the only difference is that if the Status is marked as -failed or the Status' own timeout expires it *returns* the exception rather -than *raising* it. Both return ``None`` if the Status finishes successfully, -and both raise :obj:`~ophyd.utils.WaitTimeoutError` if the given timeout expires -before the Status completes or times out. - -Alternatively, the recipient of the Status object can ask to be notified of -completion asynchronously by adding a callback. The callback will be called -when the Status is marked as complete or its timeout has expired. (If no -timeout was given, the callback might never be called. This is why providing a -timeout is strongly recommended.) - -.. code:: python - - def callback(status): - print(f"{status} is done") - - status.add_callback(callback) - -Callbacks may be added at any time. Until the Status completes, it holds a hard -reference to each callback in a list, ``status.callbacks``. The list is cleared -when the callback completes. Any callbacks added to a Status object *after* -completion will be called immediately, and no reference will be held. - -Each callback is passed to the Status object as an argument, and it can use -this to distinguish success from failure. - -.. code:: python - - def callback(status): - error = status.exception() - if error is None: - print(f"{status} has completed successfully.") - else: - print(f"{status} has failed with error {error}.") - -SubscriptionStatus ------------------- - -The :class:`~ophyd.status.SubscriptionStatus` is a special Status object that -correctly and succinctly handles a common use case, wherein the Status object -is marked finished based on some ophyd event. It reduces this: - -.. code:: python - - from ophyd import Device, Component, DeviceStatus - - class MyToyDetector(Device): - ... - # When set to 1, acquires, and then goes back to 0. - acquire = Component(...) - - def trigger(self): - def check_value(*, old_value, value, **kwargs): - "Mark status as finished when the acquisition is complete." - if old_value == 1 and value == 0: - status.set_finished() - # Clear the subscription. - sself.acquire.clear_sub(check_value) - - status = DeviceStatus(self.acquire) - self.acquire.subscribe(check_value) - self.acquire.set(1) - return status - -to this: - -.. code:: python - - from ophyd import Device, Component, SubscriptionStatus - - class MyToyDetector(Device): - ... - # When set to 1, acquires, and then goes back to 0. - acquire = Component(...) - - def trigger(self): - def check_value(*, old_value, value, **kwargs): - "Return True when the acquisition is complete, False otherwise." - return (old_value == 1 and value == 0) - - status = SubscriptionStatus(self.acquire, check_value) - self.acquire.set(1) - return status - -Note that ``set_finished``, ``subscribe`` and ``clear_sub`` are gone; they are -handled automatically, internally. See -:class:`~ophyd.status.SubscriptionStatus` for additional options. - -Partial Progress Updates ------------------------- - -Some Status objects provide an additional method named ``watch``, as in -:meth:`~ophyd.status.MoveStatus.watch`, which can be used to subscribe to -*incremental* progress updates suitable for building progress bars. See -:doc:`bluesky:progress-bar` for one application of this feature. - -The ``watch`` method accepts a callback which must accept the following -parameters as optional keyword arguments: - -* ``name`` -* ``current`` -* ``initial`` -* ``target`` -* ``unit`` -* ``precision`` -* ``fraction`` -* ``time_elapsed`` -* ``time_remaining`` - -The callback may receive a subset of these depending on how much we can know -about the progress of a particular action. In the case of -:obj:`ophyd.status.MoveStatus` and -:obj:`ophyd.areadetector.trigger_mixins.ADTriggerStatus`, we know a lot, from -which one can build a frequently-updating progress bar with a realistic -estimated time of completion. In the case of a generic -:obj:`ophyd.status.DeviceStatus`, we only know the name of the assocated -Device, when the action starts, and when the action ends. - -Status API details ------------------- - -.. autoclass:: ophyd.status.StatusBase - :members: - -In addition we provide specialized subclasses that know more about the object -they are tied to. - -.. inheritance-diagram:: ophyd.status.StatusBase ophyd.status.MoveStatus ophyd.status.DeviceStatus ophyd.status.Status ophyd.status.SubscriptionStatus - :parts: 2 - -.. autoclass:: ophyd.status.Status - :members: - -.. autoclass:: ophyd.status.DeviceStatus - :members: - -.. autoclass:: ophyd.status.MoveStatus - :members: - -.. autoclass:: ophyd.areadetector.trigger_mixins.ADTriggerStatus - :members: - -.. autoclass:: ophyd.status.SubscriptionStatus - :members: - -.. autofunction:: ophyd.status.wait diff --git a/ophyd/_static/ajax-loader.gif b/ophyd/_static/ajax-loader.gif deleted file mode 100644 index 61faf8cab2..0000000000 Binary files a/ophyd/_static/ajax-loader.gif and /dev/null differ diff --git a/ophyd/_static/basic.css b/ophyd/_static/basic.css deleted file mode 100644 index 607b5f5582..0000000000 --- a/ophyd/_static/basic.css +++ /dev/null @@ -1,648 +0,0 @@ -/* - * basic.css - * ~~~~~~~~~ - * - * Sphinx stylesheet -- basic theme. - * - * :copyright: Copyright 2007-2018 by the Sphinx team, see AUTHORS. - * :license: BSD, see LICENSE for details. - * - */ - -/* -- main layout ----------------------------------------------------------- */ - -div.clearer { - clear: both; -} - -/* -- relbar ---------------------------------------------------------------- */ - -div.related { - width: 100%; - font-size: 90%; -} - -div.related h3 { - display: none; -} - -div.related ul { - margin: 0; - padding: 0 0 0 10px; - list-style: none; -} - -div.related li { - display: inline; -} - -div.related li.right { - float: right; - margin-right: 5px; -} - -/* -- sidebar --------------------------------------------------------------- */ - -div.sphinxsidebarwrapper { - padding: 10px 5px 0 10px; -} - -div.sphinxsidebar { - float: left; - width: 230px; - margin-left: -100%; - font-size: 90%; - word-wrap: break-word; - overflow-wrap : break-word; -} - -div.sphinxsidebar ul { - list-style: none; -} - -div.sphinxsidebar ul ul, -div.sphinxsidebar ul.want-points { - margin-left: 20px; - list-style: square; -} - -div.sphinxsidebar ul ul { - margin-top: 0; - margin-bottom: 0; -} - -div.sphinxsidebar form { - margin-top: 10px; -} - -div.sphinxsidebar input { - border: 1px solid #98dbcc; - font-family: sans-serif; - font-size: 1em; -} - -div.sphinxsidebar #searchbox input[type="text"] { - width: 170px; -} - -img { - border: 0; - max-width: 100%; -} - -/* -- search page ----------------------------------------------------------- */ - -ul.search { - margin: 10px 0 0 20px; - padding: 0; -} - -ul.search li { - padding: 5px 0 5px 20px; - background-image: url(file.png); - background-repeat: no-repeat; - background-position: 0 7px; -} - -ul.search li a { - font-weight: bold; -} - -ul.search li div.context { - color: #888; - margin: 2px 0 0 30px; - text-align: left; -} - -ul.keywordmatches li.goodmatch a { - font-weight: bold; -} - -/* -- index page ------------------------------------------------------------ */ - -table.contentstable { - width: 90%; - margin-left: auto; - margin-right: auto; -} - -table.contentstable p.biglink { - line-height: 150%; -} - -a.biglink { - font-size: 1.3em; -} - -span.linkdescr { - font-style: italic; - padding-top: 5px; - font-size: 90%; -} - -/* -- general index --------------------------------------------------------- */ - -table.indextable { - width: 100%; -} - -table.indextable td { - text-align: left; - vertical-align: top; -} - -table.indextable ul { - margin-top: 0; - margin-bottom: 0; - list-style-type: none; -} - -table.indextable > tbody > tr > td > ul { - padding-left: 0em; -} - -table.indextable tr.pcap { - height: 10px; -} - -table.indextable tr.cap { - margin-top: 10px; - background-color: #f2f2f2; -} - -img.toggler { - margin-right: 3px; - margin-top: 3px; - cursor: pointer; -} - -div.modindex-jumpbox { - border-top: 1px solid #ddd; - border-bottom: 1px solid #ddd; - margin: 1em 0 1em 0; - padding: 0.4em; -} - -div.genindex-jumpbox { - border-top: 1px solid #ddd; - border-bottom: 1px solid #ddd; - margin: 1em 0 1em 0; - padding: 0.4em; -} - -/* -- domain module index --------------------------------------------------- */ - -table.modindextable td { - padding: 2px; - border-collapse: collapse; -} - -/* -- general body styles --------------------------------------------------- */ - -div.body p, div.body dd, div.body li, div.body blockquote { - -moz-hyphens: auto; - -ms-hyphens: auto; - -webkit-hyphens: auto; - hyphens: auto; -} - -a.headerlink { - visibility: hidden; -} - -h1:hover > a.headerlink, -h2:hover > a.headerlink, -h3:hover > a.headerlink, -h4:hover > a.headerlink, -h5:hover > a.headerlink, -h6:hover > a.headerlink, -dt:hover > a.headerlink, -caption:hover > a.headerlink, -p.caption:hover > a.headerlink, -div.code-block-caption:hover > a.headerlink { - visibility: visible; -} - -div.body p.caption { - text-align: inherit; -} - -div.body td { - text-align: left; -} - -.first { - margin-top: 0 !important; -} - -p.rubric { - margin-top: 30px; - font-weight: bold; -} - -img.align-left, .figure.align-left, object.align-left { - clear: left; - float: left; - margin-right: 1em; -} - -img.align-right, .figure.align-right, object.align-right { - clear: right; - float: right; - margin-left: 1em; -} - -img.align-center, .figure.align-center, object.align-center { - display: block; - margin-left: auto; - margin-right: auto; -} - -.align-left { - text-align: left; -} - -.align-center { - text-align: center; -} - -.align-right { - text-align: right; -} - -/* -- sidebars -------------------------------------------------------------- */ - -div.sidebar { - margin: 0 0 0.5em 1em; - border: 1px solid #ddb; - padding: 7px 7px 0 7px; - background-color: #ffe; - width: 40%; - float: right; -} - -p.sidebar-title { - font-weight: bold; -} - -/* -- topics ---------------------------------------------------------------- */ - -div.topic { - border: 1px solid #ccc; - padding: 7px 7px 0 7px; - margin: 10px 0 10px 0; -} - -p.topic-title { - font-size: 1.1em; - font-weight: bold; - margin-top: 10px; -} - -/* -- admonitions ----------------------------------------------------------- */ - -div.admonition { - margin-top: 10px; - margin-bottom: 10px; - padding: 7px; -} - -div.admonition dt { - font-weight: bold; -} - -div.admonition dl { - margin-bottom: 0; -} - -p.admonition-title { - margin: 0px 10px 5px 0px; - font-weight: bold; -} - -div.body p.centered { - text-align: center; - margin-top: 25px; -} - -/* -- tables ---------------------------------------------------------------- */ - -table.docutils { - border: 0; - border-collapse: collapse; -} - -table.align-center { - margin-left: auto; - margin-right: auto; -} - -table caption span.caption-number { - font-style: italic; -} - -table caption span.caption-text { -} - -table.docutils td, table.docutils th { - padding: 1px 8px 1px 5px; - border-top: 0; - border-left: 0; - border-right: 0; - border-bottom: 1px solid #aaa; -} - -table.footnote td, table.footnote th { - border: 0 !important; -} - -th { - text-align: left; - padding-right: 5px; -} - -table.citation { - border-left: solid 1px gray; - margin-left: 1px; -} - -table.citation td { - border-bottom: none; -} - -/* -- figures --------------------------------------------------------------- */ - -div.figure { - margin: 0.5em; - padding: 0.5em; -} - -div.figure p.caption { - padding: 0.3em; -} - -div.figure p.caption span.caption-number { - font-style: italic; -} - -div.figure p.caption span.caption-text { -} - -/* -- field list styles ----------------------------------------------------- */ - -table.field-list td, table.field-list th { - border: 0 !important; -} - -.field-list ul { - margin: 0; - padding-left: 1em; -} - -.field-list p { - margin: 0; -} - -.field-name { - -moz-hyphens: manual; - -ms-hyphens: manual; - -webkit-hyphens: manual; - hyphens: manual; -} - -/* -- other body styles ----------------------------------------------------- */ - -ol.arabic { - list-style: decimal; -} - -ol.loweralpha { - list-style: lower-alpha; -} - -ol.upperalpha { - list-style: upper-alpha; -} - -ol.lowerroman { - list-style: lower-roman; -} - -ol.upperroman { - list-style: upper-roman; -} - -dl { - margin-bottom: 15px; -} - -dd p { - margin-top: 0px; -} - -dd ul, dd table { - margin-bottom: 10px; -} - -dd { - margin-top: 3px; - margin-bottom: 10px; - margin-left: 30px; -} - -dt:target, span.highlighted { - background-color: #fbe54e; -} - -rect.highlighted { - fill: #fbe54e; -} - -dl.glossary dt { - font-weight: bold; - font-size: 1.1em; -} - -.optional { - font-size: 1.3em; -} - -.sig-paren { - font-size: larger; -} - -.versionmodified { - font-style: italic; -} - -.system-message { - background-color: #fda; - padding: 5px; - border: 3px solid red; -} - -.footnote:target { - background-color: #ffa; -} - -.line-block { - display: block; - margin-top: 1em; - margin-bottom: 1em; -} - -.line-block .line-block { - margin-top: 0; - margin-bottom: 0; - margin-left: 1.5em; -} - -.guilabel, .menuselection { - font-family: sans-serif; -} - -.accelerator { - text-decoration: underline; -} - -.classifier { - font-style: oblique; -} - -abbr, acronym { - border-bottom: dotted 1px; - cursor: help; -} - -/* -- code displays --------------------------------------------------------- */ - -pre { - overflow: auto; - overflow-y: hidden; /* fixes display issues on Chrome browsers */ -} - -span.pre { - -moz-hyphens: none; - -ms-hyphens: none; - -webkit-hyphens: none; - hyphens: none; -} - -td.linenos pre { - padding: 5px 0px; - border: 0; - background-color: transparent; - color: #aaa; -} - -table.highlighttable { - margin-left: 0.5em; -} - -table.highlighttable td { - padding: 0 0.5em 0 0.5em; -} - -div.code-block-caption { - padding: 2px 5px; - font-size: small; -} - -div.code-block-caption code { - background-color: transparent; -} - -div.code-block-caption + div > div.highlight > pre { - margin-top: 0; -} - -div.code-block-caption span.caption-number { - padding: 0.1em 0.3em; - font-style: italic; -} - -div.code-block-caption span.caption-text { -} - -div.literal-block-wrapper { - padding: 1em 1em 0; -} - -div.literal-block-wrapper div.highlight { - margin: 0; -} - -code.descname { - background-color: transparent; - font-weight: bold; - font-size: 1.2em; -} - -code.descclassname { - background-color: transparent; -} - -code.xref, a code { - background-color: transparent; - font-weight: bold; -} - -h1 code, h2 code, h3 code, h4 code, h5 code, h6 code { - background-color: transparent; -} - -.viewcode-link { - float: right; -} - -.viewcode-back { - float: right; - font-family: sans-serif; -} - -div.viewcode-block:target { - margin: -1px -10px; - padding: 0 10px; -} - -/* -- math display ---------------------------------------------------------- */ - -img.math { - vertical-align: middle; -} - -div.body div.math p { - text-align: center; -} - -span.eqno { - float: right; -} - -span.eqno a.headerlink { - position: relative; - left: 0px; - z-index: 1; -} - -div.math:hover a.headerlink { - visibility: visible; -} - -/* -- printout stylesheet --------------------------------------------------- */ - -@media print { - div.document, - div.documentwrapper, - div.bodywrapper { - margin: 0 !important; - width: 100%; - } - - div.sphinxsidebar, - div.related, - div.footer, - #top-link { - display: none; - } -} \ No newline at end of file diff --git a/ophyd/_static/comment-bright.png b/ophyd/_static/comment-bright.png deleted file mode 100644 index 15e27edb12..0000000000 Binary files a/ophyd/_static/comment-bright.png and /dev/null differ diff --git a/ophyd/_static/comment-close.png b/ophyd/_static/comment-close.png deleted file mode 100644 index 4d91bcf57d..0000000000 Binary files a/ophyd/_static/comment-close.png and /dev/null differ diff --git a/ophyd/_static/comment.png b/ophyd/_static/comment.png deleted file mode 100644 index dfbc0cbd51..0000000000 Binary files a/ophyd/_static/comment.png and /dev/null differ diff --git a/ophyd/_static/css/badge_only.css b/ophyd/_static/css/badge_only.css deleted file mode 100644 index e380325bc6..0000000000 --- a/ophyd/_static/css/badge_only.css +++ /dev/null @@ -1 +0,0 @@ -.fa:before{-webkit-font-smoothing:antialiased}.clearfix{*zoom:1}.clearfix:after,.clearfix:before{display:table;content:""}.clearfix:after{clear:both}@font-face{font-family:FontAwesome;font-style:normal;font-weight:400;src:url(fonts/fontawesome-webfont.eot?674f50d287a8c48dc19ba404d20fe713?#iefix) format("embedded-opentype"),url(fonts/fontawesome-webfont.woff2?af7ae505a9eed503f8b8e6982036873e) format("woff2"),url(fonts/fontawesome-webfont.woff?fee66e712a8a08eef5805a46892932ad) format("woff"),url(fonts/fontawesome-webfont.ttf?b06871f281fee6b241d60582ae9369b9) format("truetype"),url(fonts/fontawesome-webfont.svg?912ec66d7572ff821749319396470bde#FontAwesome) format("svg")}.fa:before{font-family:FontAwesome;font-style:normal;font-weight:400;line-height:1}.fa:before,a .fa{text-decoration:inherit}.fa:before,a .fa,li .fa{display:inline-block}li .fa-large:before{width:1.875em}ul.fas{list-style-type:none;margin-left:2em;text-indent:-.8em}ul.fas li .fa{width:.8em}ul.fas li .fa-large:before{vertical-align:baseline}.fa-book:before,.icon-book:before{content:"\f02d"}.fa-caret-down:before,.icon-caret-down:before{content:"\f0d7"}.fa-caret-up:before,.icon-caret-up:before{content:"\f0d8"}.fa-caret-left:before,.icon-caret-left:before{content:"\f0d9"}.fa-caret-right:before,.icon-caret-right:before{content:"\f0da"}.rst-versions{position:fixed;bottom:0;left:0;width:300px;color:#fcfcfc;background:#1f1d1d;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;z-index:400}.rst-versions a{color:#2980b9;text-decoration:none}.rst-versions .rst-badge-small{display:none}.rst-versions .rst-current-version{padding:12px;background-color:#272525;display:block;text-align:right;font-size:90%;cursor:pointer;color:#27ae60}.rst-versions .rst-current-version:after{clear:both;content:"";display:block}.rst-versions .rst-current-version .fa{color:#fcfcfc}.rst-versions .rst-current-version .fa-book,.rst-versions .rst-current-version .icon-book{float:left}.rst-versions .rst-current-version.rst-out-of-date{background-color:#e74c3c;color:#fff}.rst-versions .rst-current-version.rst-active-old-version{background-color:#f1c40f;color:#000}.rst-versions.shift-up{height:auto;max-height:100%;overflow-y:scroll}.rst-versions.shift-up .rst-other-versions{display:block}.rst-versions .rst-other-versions{font-size:90%;padding:12px;color:grey;display:none}.rst-versions .rst-other-versions hr{display:block;height:1px;border:0;margin:20px 0;padding:0;border-top:1px solid #413d3d}.rst-versions .rst-other-versions dd{display:inline-block;margin:0}.rst-versions .rst-other-versions dd a{display:inline-block;padding:6px;color:#fcfcfc}.rst-versions.rst-badge{width:auto;bottom:20px;right:20px;left:auto;border:none;max-width:300px;max-height:90%}.rst-versions.rst-badge .fa-book,.rst-versions.rst-badge .icon-book{float:none;line-height:30px}.rst-versions.rst-badge.shift-up .rst-current-version{text-align:right}.rst-versions.rst-badge.shift-up .rst-current-version .fa-book,.rst-versions.rst-badge.shift-up .rst-current-version .icon-book{float:left}.rst-versions.rst-badge>.rst-current-version{width:auto;height:30px;line-height:30px;padding:0 6px;display:block;text-align:center}@media screen and (max-width:768px){.rst-versions{width:85%;display:none}.rst-versions.shift{display:block}} \ No newline at end of file diff --git a/ophyd/_static/css/fonts/Roboto-Slab-Bold.woff b/ophyd/_static/css/fonts/Roboto-Slab-Bold.woff deleted file mode 100644 index 6cb6000018..0000000000 Binary files a/ophyd/_static/css/fonts/Roboto-Slab-Bold.woff and /dev/null differ diff --git a/ophyd/_static/css/fonts/Roboto-Slab-Bold.woff2 b/ophyd/_static/css/fonts/Roboto-Slab-Bold.woff2 deleted file mode 100644 index 7059e23142..0000000000 Binary files a/ophyd/_static/css/fonts/Roboto-Slab-Bold.woff2 and /dev/null differ diff --git a/ophyd/_static/css/fonts/Roboto-Slab-Regular.woff b/ophyd/_static/css/fonts/Roboto-Slab-Regular.woff deleted file mode 100644 index f815f63f99..0000000000 Binary files a/ophyd/_static/css/fonts/Roboto-Slab-Regular.woff and /dev/null differ diff --git a/ophyd/_static/css/fonts/Roboto-Slab-Regular.woff2 b/ophyd/_static/css/fonts/Roboto-Slab-Regular.woff2 deleted file mode 100644 index f2c76e5bda..0000000000 Binary files a/ophyd/_static/css/fonts/Roboto-Slab-Regular.woff2 and /dev/null differ diff --git a/ophyd/_static/css/fonts/fontawesome-webfont.eot b/ophyd/_static/css/fonts/fontawesome-webfont.eot deleted file mode 100644 index e9f60ca953..0000000000 Binary files a/ophyd/_static/css/fonts/fontawesome-webfont.eot and /dev/null differ diff --git a/ophyd/_static/css/fonts/fontawesome-webfont.svg b/ophyd/_static/css/fonts/fontawesome-webfont.svg deleted file mode 100644 index 855c845e53..0000000000 --- a/ophyd/_static/css/fonts/fontawesome-webfont.svg +++ /dev/null @@ -1,2671 +0,0 @@ - - - - -Created by FontForge 20120731 at Mon Oct 24 17:37:40 2016 - By ,,, -Copyright Dave Gandy 2016. All rights reserved. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/ophyd/_static/css/fonts/fontawesome-webfont.ttf b/ophyd/_static/css/fonts/fontawesome-webfont.ttf deleted file mode 100644 index 35acda2fa1..0000000000 Binary files a/ophyd/_static/css/fonts/fontawesome-webfont.ttf and /dev/null differ diff --git a/ophyd/_static/css/fonts/fontawesome-webfont.woff b/ophyd/_static/css/fonts/fontawesome-webfont.woff deleted file mode 100644 index 400014a4b0..0000000000 Binary files a/ophyd/_static/css/fonts/fontawesome-webfont.woff and /dev/null differ diff --git a/ophyd/_static/css/fonts/fontawesome-webfont.woff2 b/ophyd/_static/css/fonts/fontawesome-webfont.woff2 deleted file mode 100644 index 4d13fc6040..0000000000 Binary files a/ophyd/_static/css/fonts/fontawesome-webfont.woff2 and /dev/null differ diff --git a/ophyd/_static/css/fonts/lato-bold-italic.woff b/ophyd/_static/css/fonts/lato-bold-italic.woff deleted file mode 100644 index 88ad05b9ff..0000000000 Binary files a/ophyd/_static/css/fonts/lato-bold-italic.woff and /dev/null differ diff --git a/ophyd/_static/css/fonts/lato-bold-italic.woff2 b/ophyd/_static/css/fonts/lato-bold-italic.woff2 deleted file mode 100644 index c4e3d804b5..0000000000 Binary files a/ophyd/_static/css/fonts/lato-bold-italic.woff2 and /dev/null differ diff --git a/ophyd/_static/css/fonts/lato-bold.woff b/ophyd/_static/css/fonts/lato-bold.woff deleted file mode 100644 index c6dff51f06..0000000000 Binary files a/ophyd/_static/css/fonts/lato-bold.woff and /dev/null differ diff --git a/ophyd/_static/css/fonts/lato-bold.woff2 b/ophyd/_static/css/fonts/lato-bold.woff2 deleted file mode 100644 index bb195043cf..0000000000 Binary files a/ophyd/_static/css/fonts/lato-bold.woff2 and /dev/null differ diff --git a/ophyd/_static/css/fonts/lato-normal-italic.woff b/ophyd/_static/css/fonts/lato-normal-italic.woff deleted file mode 100644 index 76114bc033..0000000000 Binary files a/ophyd/_static/css/fonts/lato-normal-italic.woff and /dev/null differ diff --git a/ophyd/_static/css/fonts/lato-normal-italic.woff2 b/ophyd/_static/css/fonts/lato-normal-italic.woff2 deleted file mode 100644 index 3404f37e2e..0000000000 Binary files a/ophyd/_static/css/fonts/lato-normal-italic.woff2 and /dev/null differ diff --git a/ophyd/_static/css/fonts/lato-normal.woff b/ophyd/_static/css/fonts/lato-normal.woff deleted file mode 100644 index ae1307ff5f..0000000000 Binary files a/ophyd/_static/css/fonts/lato-normal.woff and /dev/null differ diff --git a/ophyd/_static/css/fonts/lato-normal.woff2 b/ophyd/_static/css/fonts/lato-normal.woff2 deleted file mode 100644 index 3bf9843328..0000000000 Binary files a/ophyd/_static/css/fonts/lato-normal.woff2 and /dev/null differ diff --git a/ophyd/_static/css/theme.css b/ophyd/_static/css/theme.css deleted file mode 100644 index 8cd4f101a9..0000000000 --- a/ophyd/_static/css/theme.css +++ /dev/null @@ -1,4 +0,0 @@ -html{box-sizing:border-box}*,:after,:before{box-sizing:inherit}article,aside,details,figcaption,figure,footer,header,hgroup,nav,section{display:block}audio,canvas,video{display:inline-block;*display:inline;*zoom:1}[hidden],audio:not([controls]){display:none}*{-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box}html{font-size:100%;-webkit-text-size-adjust:100%;-ms-text-size-adjust:100%}body{margin:0}a:active,a:hover{outline:0}abbr[title]{border-bottom:1px dotted}b,strong{font-weight:700}blockquote{margin:0}dfn{font-style:italic}ins{background:#ff9;text-decoration:none}ins,mark{color:#000}mark{background:#ff0;font-style:italic;font-weight:700}.rst-content code,.rst-content tt,code,kbd,pre,samp{font-family:monospace,serif;_font-family:courier new,monospace;font-size:1em}pre{white-space:pre}q{quotes:none}q:after,q:before{content:"";content:none}small{font-size:85%}sub,sup{font-size:75%;line-height:0;position:relative;vertical-align:baseline}sup{top:-.5em}sub{bottom:-.25em}dl,ol,ul{margin:0;padding:0;list-style:none;list-style-image:none}li{list-style:none}dd{margin:0}img{border:0;-ms-interpolation-mode:bicubic;vertical-align:middle;max-width:100%}svg:not(:root){overflow:hidden}figure,form{margin:0}label{cursor:pointer}button,input,select,textarea{font-size:100%;margin:0;vertical-align:baseline;*vertical-align:middle}button,input{line-height:normal}button,input[type=button],input[type=reset],input[type=submit]{cursor:pointer;-webkit-appearance:button;*overflow:visible}button[disabled],input[disabled]{cursor:default}input[type=search]{-webkit-appearance:textfield;-moz-box-sizing:content-box;-webkit-box-sizing:content-box;box-sizing:content-box}textarea{resize:vertical}table{border-collapse:collapse;border-spacing:0}td{vertical-align:top}.chromeframe{margin:.2em 0;background:#ccc;color:#000;padding:.2em 0}.ir{display:block;border:0;text-indent:-999em;overflow:hidden;background-color:transparent;background-repeat:no-repeat;text-align:left;direction:ltr;*line-height:0}.ir br{display:none}.hidden{display:none!important;visibility:hidden}.visuallyhidden{border:0;clip:rect(0 0 0 0);height:1px;margin:-1px;overflow:hidden;padding:0;position:absolute;width:1px}.visuallyhidden.focusable:active,.visuallyhidden.focusable:focus{clip:auto;height:auto;margin:0;overflow:visible;position:static;width:auto}.invisible{visibility:hidden}.relative{position:relative}big,small{font-size:100%}@media print{body,html,section{background:none!important}*{box-shadow:none!important;text-shadow:none!important;filter:none!important;-ms-filter:none!important}a,a:visited{text-decoration:underline}.ir a:after,a[href^="#"]:after,a[href^="javascript:"]:after{content:""}blockquote,pre{page-break-inside:avoid}thead{display:table-header-group}img,tr{page-break-inside:avoid}img{max-width:100%!important}@page{margin:.5cm}.rst-content .toctree-wrapper>p.caption,h2,h3,p{orphans:3;widows:3}.rst-content .toctree-wrapper>p.caption,h2,h3{page-break-after:avoid}}.btn,.fa:before,.icon:before,.rst-content .admonition,.rst-content .admonition-title:before,.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .code-block-caption .headerlink:before,.rst-content .danger,.rst-content .error,.rst-content .hint,.rst-content .important,.rst-content .note,.rst-content .seealso,.rst-content .tip,.rst-content .warning,.rst-content code.download span:first-child:before,.rst-content dl dt .headerlink:before,.rst-content h1 .headerlink:before,.rst-content h2 .headerlink:before,.rst-content h3 .headerlink:before,.rst-content h4 .headerlink:before,.rst-content h5 .headerlink:before,.rst-content h6 .headerlink:before,.rst-content p.caption .headerlink:before,.rst-content table>caption .headerlink:before,.rst-content tt.download span:first-child:before,.wy-alert,.wy-dropdown .caret:before,.wy-inline-validate.wy-inline-validate-danger .wy-input-context:before,.wy-inline-validate.wy-inline-validate-info .wy-input-context:before,.wy-inline-validate.wy-inline-validate-success .wy-input-context:before,.wy-inline-validate.wy-inline-validate-warning .wy-input-context:before,.wy-menu-vertical li.current>a,.wy-menu-vertical li.current>a span.toctree-expand:before,.wy-menu-vertical li.on a,.wy-menu-vertical li.on a span.toctree-expand:before,.wy-menu-vertical li span.toctree-expand:before,.wy-nav-top a,.wy-side-nav-search .wy-dropdown>a,.wy-side-nav-search>a,input[type=color],input[type=date],input[type=datetime-local],input[type=datetime],input[type=email],input[type=month],input[type=number],input[type=password],input[type=search],input[type=tel],input[type=text],input[type=time],input[type=url],input[type=week],select,textarea{-webkit-font-smoothing:antialiased}.clearfix{*zoom:1}.clearfix:after,.clearfix:before{display:table;content:""}.clearfix:after{clear:both}/*! - * Font Awesome 4.7.0 by @davegandy - http://fontawesome.io - @fontawesome - * License - http://fontawesome.io/license (Font: SIL OFL 1.1, CSS: MIT License) - */@font-face{font-family:FontAwesome;src:url(fonts/fontawesome-webfont.eot?674f50d287a8c48dc19ba404d20fe713);src:url(fonts/fontawesome-webfont.eot?674f50d287a8c48dc19ba404d20fe713?#iefix&v=4.7.0) format("embedded-opentype"),url(fonts/fontawesome-webfont.woff2?af7ae505a9eed503f8b8e6982036873e) format("woff2"),url(fonts/fontawesome-webfont.woff?fee66e712a8a08eef5805a46892932ad) format("woff"),url(fonts/fontawesome-webfont.ttf?b06871f281fee6b241d60582ae9369b9) format("truetype"),url(fonts/fontawesome-webfont.svg?912ec66d7572ff821749319396470bde#fontawesomeregular) format("svg");font-weight:400;font-style:normal}.fa,.icon,.rst-content .admonition-title,.rst-content .code-block-caption .headerlink,.rst-content code.download span:first-child,.rst-content dl dt .headerlink,.rst-content h1 .headerlink,.rst-content h2 .headerlink,.rst-content h3 .headerlink,.rst-content h4 .headerlink,.rst-content h5 .headerlink,.rst-content h6 .headerlink,.rst-content p.caption .headerlink,.rst-content table>caption .headerlink,.rst-content tt.download span:first-child,.wy-menu-vertical li.current>a span.toctree-expand,.wy-menu-vertical li.on a span.toctree-expand,.wy-menu-vertical li span.toctree-expand{display:inline-block;font:normal normal normal 14px/1 FontAwesome;font-size:inherit;text-rendering:auto;-webkit-font-smoothing:antialiased;-moz-osx-font-smoothing:grayscale}.fa-lg{font-size:1.33333em;line-height:.75em;vertical-align:-15%}.fa-2x{font-size:2em}.fa-3x{font-size:3em}.fa-4x{font-size:4em}.fa-5x{font-size:5em}.fa-fw{width:1.28571em;text-align:center}.fa-ul{padding-left:0;margin-left:2.14286em;list-style-type:none}.fa-ul>li{position:relative}.fa-li{position:absolute;left:-2.14286em;width:2.14286em;top:.14286em;text-align:center}.fa-li.fa-lg{left:-1.85714em}.fa-border{padding:.2em .25em .15em;border:.08em solid #eee;border-radius:.1em}.fa-pull-left{float:left}.fa-pull-right{float:right}.fa-pull-left.icon,.fa.fa-pull-left,.rst-content .code-block-caption .fa-pull-left.headerlink,.rst-content .fa-pull-left.admonition-title,.rst-content code.download span.fa-pull-left:first-child,.rst-content dl dt .fa-pull-left.headerlink,.rst-content h1 .fa-pull-left.headerlink,.rst-content h2 .fa-pull-left.headerlink,.rst-content h3 .fa-pull-left.headerlink,.rst-content h4 .fa-pull-left.headerlink,.rst-content h5 .fa-pull-left.headerlink,.rst-content h6 .fa-pull-left.headerlink,.rst-content p.caption .fa-pull-left.headerlink,.rst-content table>caption .fa-pull-left.headerlink,.rst-content tt.download span.fa-pull-left:first-child,.wy-menu-vertical li.current>a span.fa-pull-left.toctree-expand,.wy-menu-vertical li.on a span.fa-pull-left.toctree-expand,.wy-menu-vertical li span.fa-pull-left.toctree-expand{margin-right:.3em}.fa-pull-right.icon,.fa.fa-pull-right,.rst-content .code-block-caption .fa-pull-right.headerlink,.rst-content .fa-pull-right.admonition-title,.rst-content code.download span.fa-pull-right:first-child,.rst-content dl dt .fa-pull-right.headerlink,.rst-content h1 .fa-pull-right.headerlink,.rst-content h2 .fa-pull-right.headerlink,.rst-content h3 .fa-pull-right.headerlink,.rst-content h4 .fa-pull-right.headerlink,.rst-content h5 .fa-pull-right.headerlink,.rst-content h6 .fa-pull-right.headerlink,.rst-content p.caption .fa-pull-right.headerlink,.rst-content table>caption .fa-pull-right.headerlink,.rst-content tt.download span.fa-pull-right:first-child,.wy-menu-vertical li.current>a span.fa-pull-right.toctree-expand,.wy-menu-vertical li.on a span.fa-pull-right.toctree-expand,.wy-menu-vertical li span.fa-pull-right.toctree-expand{margin-left:.3em}.pull-right{float:right}.pull-left{float:left}.fa.pull-left,.pull-left.icon,.rst-content .code-block-caption .pull-left.headerlink,.rst-content .pull-left.admonition-title,.rst-content code.download span.pull-left:first-child,.rst-content dl dt .pull-left.headerlink,.rst-content h1 .pull-left.headerlink,.rst-content h2 .pull-left.headerlink,.rst-content h3 .pull-left.headerlink,.rst-content h4 .pull-left.headerlink,.rst-content h5 .pull-left.headerlink,.rst-content h6 .pull-left.headerlink,.rst-content p.caption .pull-left.headerlink,.rst-content table>caption .pull-left.headerlink,.rst-content tt.download span.pull-left:first-child,.wy-menu-vertical li.current>a span.pull-left.toctree-expand,.wy-menu-vertical li.on a span.pull-left.toctree-expand,.wy-menu-vertical li span.pull-left.toctree-expand{margin-right:.3em}.fa.pull-right,.pull-right.icon,.rst-content .code-block-caption .pull-right.headerlink,.rst-content .pull-right.admonition-title,.rst-content code.download span.pull-right:first-child,.rst-content dl dt .pull-right.headerlink,.rst-content h1 .pull-right.headerlink,.rst-content h2 .pull-right.headerlink,.rst-content h3 .pull-right.headerlink,.rst-content h4 .pull-right.headerlink,.rst-content h5 .pull-right.headerlink,.rst-content h6 .pull-right.headerlink,.rst-content p.caption .pull-right.headerlink,.rst-content table>caption .pull-right.headerlink,.rst-content tt.download span.pull-right:first-child,.wy-menu-vertical li.current>a span.pull-right.toctree-expand,.wy-menu-vertical li.on a span.pull-right.toctree-expand,.wy-menu-vertical li span.pull-right.toctree-expand{margin-left:.3em}.fa-spin{-webkit-animation:fa-spin 2s linear infinite;animation:fa-spin 2s linear infinite}.fa-pulse{-webkit-animation:fa-spin 1s steps(8) infinite;animation:fa-spin 1s steps(8) infinite}@-webkit-keyframes fa-spin{0%{-webkit-transform:rotate(0deg);transform:rotate(0deg)}to{-webkit-transform:rotate(359deg);transform:rotate(359deg)}}@keyframes fa-spin{0%{-webkit-transform:rotate(0deg);transform:rotate(0deg)}to{-webkit-transform:rotate(359deg);transform:rotate(359deg)}}.fa-rotate-90{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=1)";-webkit-transform:rotate(90deg);-ms-transform:rotate(90deg);transform:rotate(90deg)}.fa-rotate-180{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=2)";-webkit-transform:rotate(180deg);-ms-transform:rotate(180deg);transform:rotate(180deg)}.fa-rotate-270{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=3)";-webkit-transform:rotate(270deg);-ms-transform:rotate(270deg);transform:rotate(270deg)}.fa-flip-horizontal{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=0, mirror=1)";-webkit-transform:scaleX(-1);-ms-transform:scaleX(-1);transform:scaleX(-1)}.fa-flip-vertical{-ms-filter:"progid:DXImageTransform.Microsoft.BasicImage(rotation=2, mirror=1)";-webkit-transform:scaleY(-1);-ms-transform:scaleY(-1);transform:scaleY(-1)}:root .fa-flip-horizontal,:root .fa-flip-vertical,:root .fa-rotate-90,:root .fa-rotate-180,:root .fa-rotate-270{filter:none}.fa-stack{position:relative;display:inline-block;width:2em;height:2em;line-height:2em;vertical-align:middle}.fa-stack-1x,.fa-stack-2x{position:absolute;left:0;width:100%;text-align:center}.fa-stack-1x{line-height:inherit}.fa-stack-2x{font-size:2em}.fa-inverse{color:#fff}.fa-glass:before{content:""}.fa-music:before{content:""}.fa-search:before,.icon-search:before{content:""}.fa-envelope-o:before{content:""}.fa-heart:before{content:""}.fa-star:before{content:""}.fa-star-o:before{content:""}.fa-user:before{content:""}.fa-film:before{content:""}.fa-th-large:before{content:""}.fa-th:before{content:""}.fa-th-list:before{content:""}.fa-check:before{content:""}.fa-close:before,.fa-remove:before,.fa-times:before{content:""}.fa-search-plus:before{content:""}.fa-search-minus:before{content:""}.fa-power-off:before{content:""}.fa-signal:before{content:""}.fa-cog:before,.fa-gear:before{content:""}.fa-trash-o:before{content:""}.fa-home:before,.icon-home:before{content:""}.fa-file-o:before{content:""}.fa-clock-o:before{content:""}.fa-road:before{content:""}.fa-download:before,.rst-content code.download span:first-child:before,.rst-content tt.download span:first-child:before{content:""}.fa-arrow-circle-o-down:before{content:""}.fa-arrow-circle-o-up:before{content:""}.fa-inbox:before{content:""}.fa-play-circle-o:before{content:""}.fa-repeat:before,.fa-rotate-right:before{content:""}.fa-refresh:before{content:""}.fa-list-alt:before{content:""}.fa-lock:before{content:""}.fa-flag:before{content:""}.fa-headphones:before{content:""}.fa-volume-off:before{content:""}.fa-volume-down:before{content:""}.fa-volume-up:before{content:""}.fa-qrcode:before{content:""}.fa-barcode:before{content:""}.fa-tag:before{content:""}.fa-tags:before{content:""}.fa-book:before,.icon-book:before{content:""}.fa-bookmark:before{content:""}.fa-print:before{content:""}.fa-camera:before{content:""}.fa-font:before{content:""}.fa-bold:before{content:""}.fa-italic:before{content:""}.fa-text-height:before{content:""}.fa-text-width:before{content:""}.fa-align-left:before{content:""}.fa-align-center:before{content:""}.fa-align-right:before{content:""}.fa-align-justify:before{content:""}.fa-list:before{content:""}.fa-dedent:before,.fa-outdent:before{content:""}.fa-indent:before{content:""}.fa-video-camera:before{content:""}.fa-image:before,.fa-photo:before,.fa-picture-o:before{content:""}.fa-pencil:before{content:""}.fa-map-marker:before{content:""}.fa-adjust:before{content:""}.fa-tint:before{content:""}.fa-edit:before,.fa-pencil-square-o:before{content:""}.fa-share-square-o:before{content:""}.fa-check-square-o:before{content:""}.fa-arrows:before{content:""}.fa-step-backward:before{content:""}.fa-fast-backward:before{content:""}.fa-backward:before{content:""}.fa-play:before{content:""}.fa-pause:before{content:""}.fa-stop:before{content:""}.fa-forward:before{content:""}.fa-fast-forward:before{content:""}.fa-step-forward:before{content:""}.fa-eject:before{content:""}.fa-chevron-left:before{content:""}.fa-chevron-right:before{content:""}.fa-plus-circle:before{content:""}.fa-minus-circle:before{content:""}.fa-times-circle:before,.wy-inline-validate.wy-inline-validate-danger .wy-input-context:before{content:""}.fa-check-circle:before,.wy-inline-validate.wy-inline-validate-success .wy-input-context:before{content:""}.fa-question-circle:before{content:""}.fa-info-circle:before{content:""}.fa-crosshairs:before{content:""}.fa-times-circle-o:before{content:""}.fa-check-circle-o:before{content:""}.fa-ban:before{content:""}.fa-arrow-left:before{content:""}.fa-arrow-right:before{content:""}.fa-arrow-up:before{content:""}.fa-arrow-down:before{content:""}.fa-mail-forward:before,.fa-share:before{content:""}.fa-expand:before{content:""}.fa-compress:before{content:""}.fa-plus:before{content:""}.fa-minus:before{content:""}.fa-asterisk:before{content:""}.fa-exclamation-circle:before,.rst-content .admonition-title:before,.wy-inline-validate.wy-inline-validate-info .wy-input-context:before,.wy-inline-validate.wy-inline-validate-warning .wy-input-context:before{content:""}.fa-gift:before{content:""}.fa-leaf:before{content:""}.fa-fire:before,.icon-fire:before{content:""}.fa-eye:before{content:""}.fa-eye-slash:before{content:""}.fa-exclamation-triangle:before,.fa-warning:before{content:""}.fa-plane:before{content:""}.fa-calendar:before{content:""}.fa-random:before{content:""}.fa-comment:before{content:""}.fa-magnet:before{content:""}.fa-chevron-up:before{content:""}.fa-chevron-down:before{content:""}.fa-retweet:before{content:""}.fa-shopping-cart:before{content:""}.fa-folder:before{content:""}.fa-folder-open:before{content:""}.fa-arrows-v:before{content:""}.fa-arrows-h:before{content:""}.fa-bar-chart-o:before,.fa-bar-chart:before{content:""}.fa-twitter-square:before{content:""}.fa-facebook-square:before{content:""}.fa-camera-retro:before{content:""}.fa-key:before{content:""}.fa-cogs:before,.fa-gears:before{content:""}.fa-comments:before{content:""}.fa-thumbs-o-up:before{content:""}.fa-thumbs-o-down:before{content:""}.fa-star-half:before{content:""}.fa-heart-o:before{content:""}.fa-sign-out:before{content:""}.fa-linkedin-square:before{content:""}.fa-thumb-tack:before{content:""}.fa-external-link:before{content:""}.fa-sign-in:before{content:""}.fa-trophy:before{content:""}.fa-github-square:before{content:""}.fa-upload:before{content:""}.fa-lemon-o:before{content:""}.fa-phone:before{content:""}.fa-square-o:before{content:""}.fa-bookmark-o:before{content:""}.fa-phone-square:before{content:""}.fa-twitter:before{content:""}.fa-facebook-f:before,.fa-facebook:before{content:""}.fa-github:before,.icon-github:before{content:""}.fa-unlock:before{content:""}.fa-credit-card:before{content:""}.fa-feed:before,.fa-rss:before{content:""}.fa-hdd-o:before{content:""}.fa-bullhorn:before{content:""}.fa-bell:before{content:""}.fa-certificate:before{content:""}.fa-hand-o-right:before{content:""}.fa-hand-o-left:before{content:""}.fa-hand-o-up:before{content:""}.fa-hand-o-down:before{content:""}.fa-arrow-circle-left:before,.icon-circle-arrow-left:before{content:""}.fa-arrow-circle-right:before,.icon-circle-arrow-right:before{content:""}.fa-arrow-circle-up:before{content:""}.fa-arrow-circle-down:before{content:""}.fa-globe:before{content:""}.fa-wrench:before{content:""}.fa-tasks:before{content:""}.fa-filter:before{content:""}.fa-briefcase:before{content:""}.fa-arrows-alt:before{content:""}.fa-group:before,.fa-users:before{content:""}.fa-chain:before,.fa-link:before,.icon-link:before{content:""}.fa-cloud:before{content:""}.fa-flask:before{content:""}.fa-cut:before,.fa-scissors:before{content:""}.fa-copy:before,.fa-files-o:before{content:""}.fa-paperclip:before{content:""}.fa-floppy-o:before,.fa-save:before{content:""}.fa-square:before{content:""}.fa-bars:before,.fa-navicon:before,.fa-reorder:before{content:""}.fa-list-ul:before{content:""}.fa-list-ol:before{content:""}.fa-strikethrough:before{content:""}.fa-underline:before{content:""}.fa-table:before{content:""}.fa-magic:before{content:""}.fa-truck:before{content:""}.fa-pinterest:before{content:""}.fa-pinterest-square:before{content:""}.fa-google-plus-square:before{content:""}.fa-google-plus:before{content:""}.fa-money:before{content:""}.fa-caret-down:before,.icon-caret-down:before,.wy-dropdown .caret:before{content:""}.fa-caret-up:before{content:""}.fa-caret-left:before{content:""}.fa-caret-right:before{content:""}.fa-columns:before{content:""}.fa-sort:before,.fa-unsorted:before{content:""}.fa-sort-desc:before,.fa-sort-down:before{content:""}.fa-sort-asc:before,.fa-sort-up:before{content:""}.fa-envelope:before{content:""}.fa-linkedin:before{content:""}.fa-rotate-left:before,.fa-undo:before{content:""}.fa-gavel:before,.fa-legal:before{content:""}.fa-dashboard:before,.fa-tachometer:before{content:""}.fa-comment-o:before{content:""}.fa-comments-o:before{content:""}.fa-bolt:before,.fa-flash:before{content:""}.fa-sitemap:before{content:""}.fa-umbrella:before{content:""}.fa-clipboard:before,.fa-paste:before{content:""}.fa-lightbulb-o:before{content:""}.fa-exchange:before{content:""}.fa-cloud-download:before{content:""}.fa-cloud-upload:before{content:""}.fa-user-md:before{content:""}.fa-stethoscope:before{content:""}.fa-suitcase:before{content:""}.fa-bell-o:before{content:""}.fa-coffee:before{content:""}.fa-cutlery:before{content:""}.fa-file-text-o:before{content:""}.fa-building-o:before{content:""}.fa-hospital-o:before{content:""}.fa-ambulance:before{content:""}.fa-medkit:before{content:""}.fa-fighter-jet:before{content:""}.fa-beer:before{content:""}.fa-h-square:before{content:""}.fa-plus-square:before{content:""}.fa-angle-double-left:before{content:""}.fa-angle-double-right:before{content:""}.fa-angle-double-up:before{content:""}.fa-angle-double-down:before{content:""}.fa-angle-left:before{content:""}.fa-angle-right:before{content:""}.fa-angle-up:before{content:""}.fa-angle-down:before{content:""}.fa-desktop:before{content:""}.fa-laptop:before{content:""}.fa-tablet:before{content:""}.fa-mobile-phone:before,.fa-mobile:before{content:""}.fa-circle-o:before{content:""}.fa-quote-left:before{content:""}.fa-quote-right:before{content:""}.fa-spinner:before{content:""}.fa-circle:before{content:""}.fa-mail-reply:before,.fa-reply:before{content:""}.fa-github-alt:before{content:""}.fa-folder-o:before{content:""}.fa-folder-open-o:before{content:""}.fa-smile-o:before{content:""}.fa-frown-o:before{content:""}.fa-meh-o:before{content:""}.fa-gamepad:before{content:""}.fa-keyboard-o:before{content:""}.fa-flag-o:before{content:""}.fa-flag-checkered:before{content:""}.fa-terminal:before{content:""}.fa-code:before{content:""}.fa-mail-reply-all:before,.fa-reply-all:before{content:""}.fa-star-half-empty:before,.fa-star-half-full:before,.fa-star-half-o:before{content:""}.fa-location-arrow:before{content:""}.fa-crop:before{content:""}.fa-code-fork:before{content:""}.fa-chain-broken:before,.fa-unlink:before{content:""}.fa-question:before{content:""}.fa-info:before{content:""}.fa-exclamation:before{content:""}.fa-superscript:before{content:""}.fa-subscript:before{content:""}.fa-eraser:before{content:""}.fa-puzzle-piece:before{content:""}.fa-microphone:before{content:""}.fa-microphone-slash:before{content:""}.fa-shield:before{content:""}.fa-calendar-o:before{content:""}.fa-fire-extinguisher:before{content:""}.fa-rocket:before{content:""}.fa-maxcdn:before{content:""}.fa-chevron-circle-left:before{content:""}.fa-chevron-circle-right:before{content:""}.fa-chevron-circle-up:before{content:""}.fa-chevron-circle-down:before{content:""}.fa-html5:before{content:""}.fa-css3:before{content:""}.fa-anchor:before{content:""}.fa-unlock-alt:before{content:""}.fa-bullseye:before{content:""}.fa-ellipsis-h:before{content:""}.fa-ellipsis-v:before{content:""}.fa-rss-square:before{content:""}.fa-play-circle:before{content:""}.fa-ticket:before{content:""}.fa-minus-square:before{content:""}.fa-minus-square-o:before,.wy-menu-vertical li.current>a span.toctree-expand:before,.wy-menu-vertical li.on a span.toctree-expand:before{content:""}.fa-level-up:before{content:""}.fa-level-down:before{content:""}.fa-check-square:before{content:""}.fa-pencil-square:before{content:""}.fa-external-link-square:before{content:""}.fa-share-square:before{content:""}.fa-compass:before{content:""}.fa-caret-square-o-down:before,.fa-toggle-down:before{content:""}.fa-caret-square-o-up:before,.fa-toggle-up:before{content:""}.fa-caret-square-o-right:before,.fa-toggle-right:before{content:""}.fa-eur:before,.fa-euro:before{content:""}.fa-gbp:before{content:""}.fa-dollar:before,.fa-usd:before{content:""}.fa-inr:before,.fa-rupee:before{content:""}.fa-cny:before,.fa-jpy:before,.fa-rmb:before,.fa-yen:before{content:""}.fa-rouble:before,.fa-rub:before,.fa-ruble:before{content:""}.fa-krw:before,.fa-won:before{content:""}.fa-bitcoin:before,.fa-btc:before{content:""}.fa-file:before{content:""}.fa-file-text:before{content:""}.fa-sort-alpha-asc:before{content:""}.fa-sort-alpha-desc:before{content:""}.fa-sort-amount-asc:before{content:""}.fa-sort-amount-desc:before{content:""}.fa-sort-numeric-asc:before{content:""}.fa-sort-numeric-desc:before{content:""}.fa-thumbs-up:before{content:""}.fa-thumbs-down:before{content:""}.fa-youtube-square:before{content:""}.fa-youtube:before{content:""}.fa-xing:before{content:""}.fa-xing-square:before{content:""}.fa-youtube-play:before{content:""}.fa-dropbox:before{content:""}.fa-stack-overflow:before{content:""}.fa-instagram:before{content:""}.fa-flickr:before{content:""}.fa-adn:before{content:""}.fa-bitbucket:before,.icon-bitbucket:before{content:""}.fa-bitbucket-square:before{content:""}.fa-tumblr:before{content:""}.fa-tumblr-square:before{content:""}.fa-long-arrow-down:before{content:""}.fa-long-arrow-up:before{content:""}.fa-long-arrow-left:before{content:""}.fa-long-arrow-right:before{content:""}.fa-apple:before{content:""}.fa-windows:before{content:""}.fa-android:before{content:""}.fa-linux:before{content:""}.fa-dribbble:before{content:""}.fa-skype:before{content:""}.fa-foursquare:before{content:""}.fa-trello:before{content:""}.fa-female:before{content:""}.fa-male:before{content:""}.fa-gittip:before,.fa-gratipay:before{content:""}.fa-sun-o:before{content:""}.fa-moon-o:before{content:""}.fa-archive:before{content:""}.fa-bug:before{content:""}.fa-vk:before{content:""}.fa-weibo:before{content:""}.fa-renren:before{content:""}.fa-pagelines:before{content:""}.fa-stack-exchange:before{content:""}.fa-arrow-circle-o-right:before{content:""}.fa-arrow-circle-o-left:before{content:""}.fa-caret-square-o-left:before,.fa-toggle-left:before{content:""}.fa-dot-circle-o:before{content:""}.fa-wheelchair:before{content:""}.fa-vimeo-square:before{content:""}.fa-try:before,.fa-turkish-lira:before{content:""}.fa-plus-square-o:before,.wy-menu-vertical li span.toctree-expand:before{content:""}.fa-space-shuttle:before{content:""}.fa-slack:before{content:""}.fa-envelope-square:before{content:""}.fa-wordpress:before{content:""}.fa-openid:before{content:""}.fa-bank:before,.fa-institution:before,.fa-university:before{content:""}.fa-graduation-cap:before,.fa-mortar-board:before{content:""}.fa-yahoo:before{content:""}.fa-google:before{content:""}.fa-reddit:before{content:""}.fa-reddit-square:before{content:""}.fa-stumbleupon-circle:before{content:""}.fa-stumbleupon:before{content:""}.fa-delicious:before{content:""}.fa-digg:before{content:""}.fa-pied-piper-pp:before{content:""}.fa-pied-piper-alt:before{content:""}.fa-drupal:before{content:""}.fa-joomla:before{content:""}.fa-language:before{content:""}.fa-fax:before{content:""}.fa-building:before{content:""}.fa-child:before{content:""}.fa-paw:before{content:""}.fa-spoon:before{content:""}.fa-cube:before{content:""}.fa-cubes:before{content:""}.fa-behance:before{content:""}.fa-behance-square:before{content:""}.fa-steam:before{content:""}.fa-steam-square:before{content:""}.fa-recycle:before{content:""}.fa-automobile:before,.fa-car:before{content:""}.fa-cab:before,.fa-taxi:before{content:""}.fa-tree:before{content:""}.fa-spotify:before{content:""}.fa-deviantart:before{content:""}.fa-soundcloud:before{content:""}.fa-database:before{content:""}.fa-file-pdf-o:before{content:""}.fa-file-word-o:before{content:""}.fa-file-excel-o:before{content:""}.fa-file-powerpoint-o:before{content:""}.fa-file-image-o:before,.fa-file-photo-o:before,.fa-file-picture-o:before{content:""}.fa-file-archive-o:before,.fa-file-zip-o:before{content:""}.fa-file-audio-o:before,.fa-file-sound-o:before{content:""}.fa-file-movie-o:before,.fa-file-video-o:before{content:""}.fa-file-code-o:before{content:""}.fa-vine:before{content:""}.fa-codepen:before{content:""}.fa-jsfiddle:before{content:""}.fa-life-bouy:before,.fa-life-buoy:before,.fa-life-ring:before,.fa-life-saver:before,.fa-support:before{content:""}.fa-circle-o-notch:before{content:""}.fa-ra:before,.fa-rebel:before,.fa-resistance:before{content:""}.fa-empire:before,.fa-ge:before{content:""}.fa-git-square:before{content:""}.fa-git:before{content:""}.fa-hacker-news:before,.fa-y-combinator-square:before,.fa-yc-square:before{content:""}.fa-tencent-weibo:before{content:""}.fa-qq:before{content:""}.fa-wechat:before,.fa-weixin:before{content:""}.fa-paper-plane:before,.fa-send:before{content:""}.fa-paper-plane-o:before,.fa-send-o:before{content:""}.fa-history:before{content:""}.fa-circle-thin:before{content:""}.fa-header:before{content:""}.fa-paragraph:before{content:""}.fa-sliders:before{content:""}.fa-share-alt:before{content:""}.fa-share-alt-square:before{content:""}.fa-bomb:before{content:""}.fa-futbol-o:before,.fa-soccer-ball-o:before{content:""}.fa-tty:before{content:""}.fa-binoculars:before{content:""}.fa-plug:before{content:""}.fa-slideshare:before{content:""}.fa-twitch:before{content:""}.fa-yelp:before{content:""}.fa-newspaper-o:before{content:""}.fa-wifi:before{content:""}.fa-calculator:before{content:""}.fa-paypal:before{content:""}.fa-google-wallet:before{content:""}.fa-cc-visa:before{content:""}.fa-cc-mastercard:before{content:""}.fa-cc-discover:before{content:""}.fa-cc-amex:before{content:""}.fa-cc-paypal:before{content:""}.fa-cc-stripe:before{content:""}.fa-bell-slash:before{content:""}.fa-bell-slash-o:before{content:""}.fa-trash:before{content:""}.fa-copyright:before{content:""}.fa-at:before{content:""}.fa-eyedropper:before{content:""}.fa-paint-brush:before{content:""}.fa-birthday-cake:before{content:""}.fa-area-chart:before{content:""}.fa-pie-chart:before{content:""}.fa-line-chart:before{content:""}.fa-lastfm:before{content:""}.fa-lastfm-square:before{content:""}.fa-toggle-off:before{content:""}.fa-toggle-on:before{content:""}.fa-bicycle:before{content:""}.fa-bus:before{content:""}.fa-ioxhost:before{content:""}.fa-angellist:before{content:""}.fa-cc:before{content:""}.fa-ils:before,.fa-shekel:before,.fa-sheqel:before{content:""}.fa-meanpath:before{content:""}.fa-buysellads:before{content:""}.fa-connectdevelop:before{content:""}.fa-dashcube:before{content:""}.fa-forumbee:before{content:""}.fa-leanpub:before{content:""}.fa-sellsy:before{content:""}.fa-shirtsinbulk:before{content:""}.fa-simplybuilt:before{content:""}.fa-skyatlas:before{content:""}.fa-cart-plus:before{content:""}.fa-cart-arrow-down:before{content:""}.fa-diamond:before{content:""}.fa-ship:before{content:""}.fa-user-secret:before{content:""}.fa-motorcycle:before{content:""}.fa-street-view:before{content:""}.fa-heartbeat:before{content:""}.fa-venus:before{content:""}.fa-mars:before{content:""}.fa-mercury:before{content:""}.fa-intersex:before,.fa-transgender:before{content:""}.fa-transgender-alt:before{content:""}.fa-venus-double:before{content:""}.fa-mars-double:before{content:""}.fa-venus-mars:before{content:""}.fa-mars-stroke:before{content:""}.fa-mars-stroke-v:before{content:""}.fa-mars-stroke-h:before{content:""}.fa-neuter:before{content:""}.fa-genderless:before{content:""}.fa-facebook-official:before{content:""}.fa-pinterest-p:before{content:""}.fa-whatsapp:before{content:""}.fa-server:before{content:""}.fa-user-plus:before{content:""}.fa-user-times:before{content:""}.fa-bed:before,.fa-hotel:before{content:""}.fa-viacoin:before{content:""}.fa-train:before{content:""}.fa-subway:before{content:""}.fa-medium:before{content:""}.fa-y-combinator:before,.fa-yc:before{content:""}.fa-optin-monster:before{content:""}.fa-opencart:before{content:""}.fa-expeditedssl:before{content:""}.fa-battery-4:before,.fa-battery-full:before,.fa-battery:before{content:""}.fa-battery-3:before,.fa-battery-three-quarters:before{content:""}.fa-battery-2:before,.fa-battery-half:before{content:""}.fa-battery-1:before,.fa-battery-quarter:before{content:""}.fa-battery-0:before,.fa-battery-empty:before{content:""}.fa-mouse-pointer:before{content:""}.fa-i-cursor:before{content:""}.fa-object-group:before{content:""}.fa-object-ungroup:before{content:""}.fa-sticky-note:before{content:""}.fa-sticky-note-o:before{content:""}.fa-cc-jcb:before{content:""}.fa-cc-diners-club:before{content:""}.fa-clone:before{content:""}.fa-balance-scale:before{content:""}.fa-hourglass-o:before{content:""}.fa-hourglass-1:before,.fa-hourglass-start:before{content:""}.fa-hourglass-2:before,.fa-hourglass-half:before{content:""}.fa-hourglass-3:before,.fa-hourglass-end:before{content:""}.fa-hourglass:before{content:""}.fa-hand-grab-o:before,.fa-hand-rock-o:before{content:""}.fa-hand-paper-o:before,.fa-hand-stop-o:before{content:""}.fa-hand-scissors-o:before{content:""}.fa-hand-lizard-o:before{content:""}.fa-hand-spock-o:before{content:""}.fa-hand-pointer-o:before{content:""}.fa-hand-peace-o:before{content:""}.fa-trademark:before{content:""}.fa-registered:before{content:""}.fa-creative-commons:before{content:""}.fa-gg:before{content:""}.fa-gg-circle:before{content:""}.fa-tripadvisor:before{content:""}.fa-odnoklassniki:before{content:""}.fa-odnoklassniki-square:before{content:""}.fa-get-pocket:before{content:""}.fa-wikipedia-w:before{content:""}.fa-safari:before{content:""}.fa-chrome:before{content:""}.fa-firefox:before{content:""}.fa-opera:before{content:""}.fa-internet-explorer:before{content:""}.fa-television:before,.fa-tv:before{content:""}.fa-contao:before{content:""}.fa-500px:before{content:""}.fa-amazon:before{content:""}.fa-calendar-plus-o:before{content:""}.fa-calendar-minus-o:before{content:""}.fa-calendar-times-o:before{content:""}.fa-calendar-check-o:before{content:""}.fa-industry:before{content:""}.fa-map-pin:before{content:""}.fa-map-signs:before{content:""}.fa-map-o:before{content:""}.fa-map:before{content:""}.fa-commenting:before{content:""}.fa-commenting-o:before{content:""}.fa-houzz:before{content:""}.fa-vimeo:before{content:""}.fa-black-tie:before{content:""}.fa-fonticons:before{content:""}.fa-reddit-alien:before{content:""}.fa-edge:before{content:""}.fa-credit-card-alt:before{content:""}.fa-codiepie:before{content:""}.fa-modx:before{content:""}.fa-fort-awesome:before{content:""}.fa-usb:before{content:""}.fa-product-hunt:before{content:""}.fa-mixcloud:before{content:""}.fa-scribd:before{content:""}.fa-pause-circle:before{content:""}.fa-pause-circle-o:before{content:""}.fa-stop-circle:before{content:""}.fa-stop-circle-o:before{content:""}.fa-shopping-bag:before{content:""}.fa-shopping-basket:before{content:""}.fa-hashtag:before{content:""}.fa-bluetooth:before{content:""}.fa-bluetooth-b:before{content:""}.fa-percent:before{content:""}.fa-gitlab:before,.icon-gitlab:before{content:""}.fa-wpbeginner:before{content:""}.fa-wpforms:before{content:""}.fa-envira:before{content:""}.fa-universal-access:before{content:""}.fa-wheelchair-alt:before{content:""}.fa-question-circle-o:before{content:""}.fa-blind:before{content:""}.fa-audio-description:before{content:""}.fa-volume-control-phone:before{content:""}.fa-braille:before{content:""}.fa-assistive-listening-systems:before{content:""}.fa-american-sign-language-interpreting:before,.fa-asl-interpreting:before{content:""}.fa-deaf:before,.fa-deafness:before,.fa-hard-of-hearing:before{content:""}.fa-glide:before{content:""}.fa-glide-g:before{content:""}.fa-sign-language:before,.fa-signing:before{content:""}.fa-low-vision:before{content:""}.fa-viadeo:before{content:""}.fa-viadeo-square:before{content:""}.fa-snapchat:before{content:""}.fa-snapchat-ghost:before{content:""}.fa-snapchat-square:before{content:""}.fa-pied-piper:before{content:""}.fa-first-order:before{content:""}.fa-yoast:before{content:""}.fa-themeisle:before{content:""}.fa-google-plus-circle:before,.fa-google-plus-official:before{content:""}.fa-fa:before,.fa-font-awesome:before{content:""}.fa-handshake-o:before{content:""}.fa-envelope-open:before{content:""}.fa-envelope-open-o:before{content:""}.fa-linode:before{content:""}.fa-address-book:before{content:""}.fa-address-book-o:before{content:""}.fa-address-card:before,.fa-vcard:before{content:""}.fa-address-card-o:before,.fa-vcard-o:before{content:""}.fa-user-circle:before{content:""}.fa-user-circle-o:before{content:""}.fa-user-o:before{content:""}.fa-id-badge:before{content:""}.fa-drivers-license:before,.fa-id-card:before{content:""}.fa-drivers-license-o:before,.fa-id-card-o:before{content:""}.fa-quora:before{content:""}.fa-free-code-camp:before{content:""}.fa-telegram:before{content:""}.fa-thermometer-4:before,.fa-thermometer-full:before,.fa-thermometer:before{content:""}.fa-thermometer-3:before,.fa-thermometer-three-quarters:before{content:""}.fa-thermometer-2:before,.fa-thermometer-half:before{content:""}.fa-thermometer-1:before,.fa-thermometer-quarter:before{content:""}.fa-thermometer-0:before,.fa-thermometer-empty:before{content:""}.fa-shower:before{content:""}.fa-bath:before,.fa-bathtub:before,.fa-s15:before{content:""}.fa-podcast:before{content:""}.fa-window-maximize:before{content:""}.fa-window-minimize:before{content:""}.fa-window-restore:before{content:""}.fa-times-rectangle:before,.fa-window-close:before{content:""}.fa-times-rectangle-o:before,.fa-window-close-o:before{content:""}.fa-bandcamp:before{content:""}.fa-grav:before{content:""}.fa-etsy:before{content:""}.fa-imdb:before{content:""}.fa-ravelry:before{content:""}.fa-eercast:before{content:""}.fa-microchip:before{content:""}.fa-snowflake-o:before{content:""}.fa-superpowers:before{content:""}.fa-wpexplorer:before{content:""}.fa-meetup:before{content:""}.sr-only{position:absolute;width:1px;height:1px;padding:0;margin:-1px;overflow:hidden;clip:rect(0,0,0,0);border:0}.sr-only-focusable:active,.sr-only-focusable:focus{position:static;width:auto;height:auto;margin:0;overflow:visible;clip:auto}.fa,.icon,.rst-content .admonition-title,.rst-content .code-block-caption .headerlink,.rst-content code.download span:first-child,.rst-content dl dt .headerlink,.rst-content h1 .headerlink,.rst-content h2 .headerlink,.rst-content h3 .headerlink,.rst-content h4 .headerlink,.rst-content h5 .headerlink,.rst-content h6 .headerlink,.rst-content p.caption .headerlink,.rst-content table>caption .headerlink,.rst-content tt.download span:first-child,.wy-dropdown .caret,.wy-inline-validate.wy-inline-validate-danger .wy-input-context,.wy-inline-validate.wy-inline-validate-info .wy-input-context,.wy-inline-validate.wy-inline-validate-success .wy-input-context,.wy-inline-validate.wy-inline-validate-warning .wy-input-context,.wy-menu-vertical li.current>a span.toctree-expand,.wy-menu-vertical li.on a span.toctree-expand,.wy-menu-vertical li span.toctree-expand{font-family:inherit}.fa:before,.icon:before,.rst-content .admonition-title:before,.rst-content .code-block-caption .headerlink:before,.rst-content code.download span:first-child:before,.rst-content dl dt .headerlink:before,.rst-content h1 .headerlink:before,.rst-content h2 .headerlink:before,.rst-content h3 .headerlink:before,.rst-content h4 .headerlink:before,.rst-content h5 .headerlink:before,.rst-content h6 .headerlink:before,.rst-content p.caption .headerlink:before,.rst-content table>caption .headerlink:before,.rst-content tt.download span:first-child:before,.wy-dropdown .caret:before,.wy-inline-validate.wy-inline-validate-danger .wy-input-context:before,.wy-inline-validate.wy-inline-validate-info .wy-input-context:before,.wy-inline-validate.wy-inline-validate-success .wy-input-context:before,.wy-inline-validate.wy-inline-validate-warning .wy-input-context:before,.wy-menu-vertical li.current>a span.toctree-expand:before,.wy-menu-vertical li.on a span.toctree-expand:before,.wy-menu-vertical li span.toctree-expand:before{font-family:FontAwesome;display:inline-block;font-style:normal;font-weight:400;line-height:1;text-decoration:inherit}.rst-content .code-block-caption a .headerlink,.rst-content a .admonition-title,.rst-content code.download a span:first-child,.rst-content dl dt a .headerlink,.rst-content h1 a .headerlink,.rst-content h2 a .headerlink,.rst-content h3 a .headerlink,.rst-content h4 a .headerlink,.rst-content h5 a .headerlink,.rst-content h6 a .headerlink,.rst-content p.caption a .headerlink,.rst-content table>caption a .headerlink,.rst-content tt.download a span:first-child,.wy-menu-vertical li.current>a span.toctree-expand,.wy-menu-vertical li.on a span.toctree-expand,.wy-menu-vertical li a span.toctree-expand,a .fa,a .icon,a .rst-content .admonition-title,a .rst-content .code-block-caption .headerlink,a .rst-content code.download span:first-child,a .rst-content dl dt .headerlink,a .rst-content h1 .headerlink,a .rst-content h2 .headerlink,a .rst-content h3 .headerlink,a .rst-content h4 .headerlink,a .rst-content h5 .headerlink,a .rst-content h6 .headerlink,a .rst-content p.caption .headerlink,a .rst-content table>caption .headerlink,a .rst-content tt.download span:first-child,a .wy-menu-vertical li span.toctree-expand{display:inline-block;text-decoration:inherit}.btn .fa,.btn .icon,.btn .rst-content .admonition-title,.btn .rst-content .code-block-caption .headerlink,.btn .rst-content code.download span:first-child,.btn .rst-content dl dt .headerlink,.btn .rst-content h1 .headerlink,.btn .rst-content h2 .headerlink,.btn .rst-content h3 .headerlink,.btn .rst-content h4 .headerlink,.btn .rst-content h5 .headerlink,.btn .rst-content h6 .headerlink,.btn .rst-content p.caption .headerlink,.btn .rst-content table>caption .headerlink,.btn .rst-content tt.download span:first-child,.btn .wy-menu-vertical li.current>a span.toctree-expand,.btn .wy-menu-vertical li.on a span.toctree-expand,.btn .wy-menu-vertical li span.toctree-expand,.nav .fa,.nav .icon,.nav .rst-content .admonition-title,.nav .rst-content .code-block-caption .headerlink,.nav .rst-content code.download span:first-child,.nav .rst-content dl dt .headerlink,.nav .rst-content h1 .headerlink,.nav .rst-content h2 .headerlink,.nav .rst-content h3 .headerlink,.nav .rst-content h4 .headerlink,.nav .rst-content h5 .headerlink,.nav .rst-content h6 .headerlink,.nav .rst-content p.caption .headerlink,.nav .rst-content table>caption .headerlink,.nav .rst-content tt.download span:first-child,.nav .wy-menu-vertical li.current>a span.toctree-expand,.nav .wy-menu-vertical li.on a span.toctree-expand,.nav .wy-menu-vertical li span.toctree-expand,.rst-content .btn .admonition-title,.rst-content .code-block-caption .btn .headerlink,.rst-content .code-block-caption .nav .headerlink,.rst-content .nav .admonition-title,.rst-content code.download .btn span:first-child,.rst-content code.download .nav span:first-child,.rst-content dl dt .btn .headerlink,.rst-content dl dt .nav .headerlink,.rst-content h1 .btn .headerlink,.rst-content h1 .nav .headerlink,.rst-content h2 .btn .headerlink,.rst-content h2 .nav .headerlink,.rst-content h3 .btn .headerlink,.rst-content h3 .nav .headerlink,.rst-content h4 .btn .headerlink,.rst-content h4 .nav .headerlink,.rst-content h5 .btn .headerlink,.rst-content h5 .nav .headerlink,.rst-content h6 .btn .headerlink,.rst-content h6 .nav .headerlink,.rst-content p.caption .btn .headerlink,.rst-content p.caption .nav .headerlink,.rst-content table>caption .btn .headerlink,.rst-content table>caption .nav .headerlink,.rst-content tt.download .btn span:first-child,.rst-content tt.download .nav span:first-child,.wy-menu-vertical li .btn span.toctree-expand,.wy-menu-vertical li.current>a .btn span.toctree-expand,.wy-menu-vertical li.current>a .nav span.toctree-expand,.wy-menu-vertical li .nav span.toctree-expand,.wy-menu-vertical li.on a .btn span.toctree-expand,.wy-menu-vertical li.on a .nav span.toctree-expand{display:inline}.btn .fa-large.icon,.btn .fa.fa-large,.btn .rst-content .code-block-caption .fa-large.headerlink,.btn .rst-content .fa-large.admonition-title,.btn .rst-content code.download span.fa-large:first-child,.btn .rst-content dl dt .fa-large.headerlink,.btn .rst-content h1 .fa-large.headerlink,.btn .rst-content h2 .fa-large.headerlink,.btn .rst-content h3 .fa-large.headerlink,.btn .rst-content h4 .fa-large.headerlink,.btn .rst-content h5 .fa-large.headerlink,.btn .rst-content h6 .fa-large.headerlink,.btn .rst-content p.caption .fa-large.headerlink,.btn .rst-content table>caption .fa-large.headerlink,.btn .rst-content tt.download span.fa-large:first-child,.btn .wy-menu-vertical li span.fa-large.toctree-expand,.nav .fa-large.icon,.nav .fa.fa-large,.nav .rst-content .code-block-caption .fa-large.headerlink,.nav .rst-content .fa-large.admonition-title,.nav .rst-content code.download span.fa-large:first-child,.nav .rst-content dl dt .fa-large.headerlink,.nav .rst-content h1 .fa-large.headerlink,.nav .rst-content h2 .fa-large.headerlink,.nav .rst-content h3 .fa-large.headerlink,.nav .rst-content h4 .fa-large.headerlink,.nav .rst-content h5 .fa-large.headerlink,.nav .rst-content h6 .fa-large.headerlink,.nav .rst-content p.caption .fa-large.headerlink,.nav .rst-content table>caption .fa-large.headerlink,.nav .rst-content tt.download span.fa-large:first-child,.nav .wy-menu-vertical li span.fa-large.toctree-expand,.rst-content .btn .fa-large.admonition-title,.rst-content .code-block-caption .btn .fa-large.headerlink,.rst-content .code-block-caption .nav .fa-large.headerlink,.rst-content .nav .fa-large.admonition-title,.rst-content code.download .btn span.fa-large:first-child,.rst-content code.download .nav span.fa-large:first-child,.rst-content dl dt .btn .fa-large.headerlink,.rst-content dl dt .nav .fa-large.headerlink,.rst-content h1 .btn .fa-large.headerlink,.rst-content h1 .nav .fa-large.headerlink,.rst-content h2 .btn .fa-large.headerlink,.rst-content h2 .nav .fa-large.headerlink,.rst-content h3 .btn .fa-large.headerlink,.rst-content h3 .nav .fa-large.headerlink,.rst-content h4 .btn .fa-large.headerlink,.rst-content h4 .nav .fa-large.headerlink,.rst-content h5 .btn .fa-large.headerlink,.rst-content h5 .nav .fa-large.headerlink,.rst-content h6 .btn .fa-large.headerlink,.rst-content h6 .nav .fa-large.headerlink,.rst-content p.caption .btn .fa-large.headerlink,.rst-content p.caption .nav .fa-large.headerlink,.rst-content table>caption .btn .fa-large.headerlink,.rst-content table>caption .nav .fa-large.headerlink,.rst-content tt.download .btn span.fa-large:first-child,.rst-content tt.download .nav span.fa-large:first-child,.wy-menu-vertical li .btn span.fa-large.toctree-expand,.wy-menu-vertical li .nav span.fa-large.toctree-expand{line-height:.9em}.btn .fa-spin.icon,.btn .fa.fa-spin,.btn .rst-content .code-block-caption .fa-spin.headerlink,.btn .rst-content .fa-spin.admonition-title,.btn .rst-content code.download span.fa-spin:first-child,.btn .rst-content dl dt .fa-spin.headerlink,.btn .rst-content h1 .fa-spin.headerlink,.btn .rst-content h2 .fa-spin.headerlink,.btn .rst-content h3 .fa-spin.headerlink,.btn .rst-content h4 .fa-spin.headerlink,.btn .rst-content h5 .fa-spin.headerlink,.btn .rst-content h6 .fa-spin.headerlink,.btn .rst-content p.caption .fa-spin.headerlink,.btn .rst-content table>caption .fa-spin.headerlink,.btn .rst-content tt.download span.fa-spin:first-child,.btn .wy-menu-vertical li span.fa-spin.toctree-expand,.nav .fa-spin.icon,.nav .fa.fa-spin,.nav .rst-content .code-block-caption .fa-spin.headerlink,.nav .rst-content .fa-spin.admonition-title,.nav .rst-content code.download span.fa-spin:first-child,.nav .rst-content dl dt .fa-spin.headerlink,.nav .rst-content h1 .fa-spin.headerlink,.nav .rst-content h2 .fa-spin.headerlink,.nav .rst-content h3 .fa-spin.headerlink,.nav .rst-content h4 .fa-spin.headerlink,.nav .rst-content h5 .fa-spin.headerlink,.nav .rst-content h6 .fa-spin.headerlink,.nav .rst-content p.caption .fa-spin.headerlink,.nav .rst-content table>caption .fa-spin.headerlink,.nav .rst-content tt.download span.fa-spin:first-child,.nav .wy-menu-vertical li span.fa-spin.toctree-expand,.rst-content .btn .fa-spin.admonition-title,.rst-content .code-block-caption .btn .fa-spin.headerlink,.rst-content .code-block-caption .nav .fa-spin.headerlink,.rst-content .nav .fa-spin.admonition-title,.rst-content code.download .btn span.fa-spin:first-child,.rst-content code.download .nav span.fa-spin:first-child,.rst-content dl dt .btn .fa-spin.headerlink,.rst-content dl dt .nav .fa-spin.headerlink,.rst-content h1 .btn .fa-spin.headerlink,.rst-content h1 .nav .fa-spin.headerlink,.rst-content h2 .btn .fa-spin.headerlink,.rst-content h2 .nav .fa-spin.headerlink,.rst-content h3 .btn .fa-spin.headerlink,.rst-content h3 .nav .fa-spin.headerlink,.rst-content h4 .btn .fa-spin.headerlink,.rst-content h4 .nav .fa-spin.headerlink,.rst-content h5 .btn .fa-spin.headerlink,.rst-content h5 .nav .fa-spin.headerlink,.rst-content h6 .btn .fa-spin.headerlink,.rst-content h6 .nav .fa-spin.headerlink,.rst-content p.caption .btn .fa-spin.headerlink,.rst-content p.caption .nav .fa-spin.headerlink,.rst-content table>caption .btn .fa-spin.headerlink,.rst-content table>caption .nav .fa-spin.headerlink,.rst-content tt.download .btn span.fa-spin:first-child,.rst-content tt.download .nav span.fa-spin:first-child,.wy-menu-vertical li .btn span.fa-spin.toctree-expand,.wy-menu-vertical li .nav span.fa-spin.toctree-expand{display:inline-block}.btn.fa:before,.btn.icon:before,.rst-content .btn.admonition-title:before,.rst-content .code-block-caption .btn.headerlink:before,.rst-content code.download span.btn:first-child:before,.rst-content dl dt .btn.headerlink:before,.rst-content h1 .btn.headerlink:before,.rst-content h2 .btn.headerlink:before,.rst-content h3 .btn.headerlink:before,.rst-content h4 .btn.headerlink:before,.rst-content h5 .btn.headerlink:before,.rst-content h6 .btn.headerlink:before,.rst-content p.caption .btn.headerlink:before,.rst-content table>caption .btn.headerlink:before,.rst-content tt.download span.btn:first-child:before,.wy-menu-vertical li span.btn.toctree-expand:before{opacity:.5;-webkit-transition:opacity .05s ease-in;-moz-transition:opacity .05s ease-in;transition:opacity .05s ease-in}.btn.fa:hover:before,.btn.icon:hover:before,.rst-content .btn.admonition-title:hover:before,.rst-content .code-block-caption .btn.headerlink:hover:before,.rst-content code.download span.btn:first-child:hover:before,.rst-content dl dt .btn.headerlink:hover:before,.rst-content h1 .btn.headerlink:hover:before,.rst-content h2 .btn.headerlink:hover:before,.rst-content h3 .btn.headerlink:hover:before,.rst-content h4 .btn.headerlink:hover:before,.rst-content h5 .btn.headerlink:hover:before,.rst-content h6 .btn.headerlink:hover:before,.rst-content p.caption .btn.headerlink:hover:before,.rst-content table>caption .btn.headerlink:hover:before,.rst-content tt.download span.btn:first-child:hover:before,.wy-menu-vertical li span.btn.toctree-expand:hover:before{opacity:1}.btn-mini .fa:before,.btn-mini .icon:before,.btn-mini .rst-content .admonition-title:before,.btn-mini .rst-content .code-block-caption .headerlink:before,.btn-mini .rst-content code.download span:first-child:before,.btn-mini .rst-content dl dt .headerlink:before,.btn-mini .rst-content h1 .headerlink:before,.btn-mini .rst-content h2 .headerlink:before,.btn-mini .rst-content h3 .headerlink:before,.btn-mini .rst-content h4 .headerlink:before,.btn-mini .rst-content h5 .headerlink:before,.btn-mini .rst-content h6 .headerlink:before,.btn-mini .rst-content p.caption .headerlink:before,.btn-mini .rst-content table>caption .headerlink:before,.btn-mini .rst-content tt.download span:first-child:before,.btn-mini .wy-menu-vertical li span.toctree-expand:before,.rst-content .btn-mini .admonition-title:before,.rst-content .code-block-caption .btn-mini .headerlink:before,.rst-content code.download .btn-mini span:first-child:before,.rst-content dl dt .btn-mini .headerlink:before,.rst-content h1 .btn-mini .headerlink:before,.rst-content h2 .btn-mini .headerlink:before,.rst-content h3 .btn-mini .headerlink:before,.rst-content h4 .btn-mini .headerlink:before,.rst-content h5 .btn-mini .headerlink:before,.rst-content h6 .btn-mini .headerlink:before,.rst-content p.caption .btn-mini .headerlink:before,.rst-content table>caption .btn-mini .headerlink:before,.rst-content tt.download .btn-mini span:first-child:before,.wy-menu-vertical li .btn-mini span.toctree-expand:before{font-size:14px;vertical-align:-15%}.rst-content .admonition,.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .danger,.rst-content .error,.rst-content .hint,.rst-content .important,.rst-content .note,.rst-content .seealso,.rst-content .tip,.rst-content .warning,.wy-alert{padding:12px;line-height:24px;margin-bottom:24px;background:#e7f2fa}.rst-content .admonition-title,.wy-alert-title{font-weight:700;display:block;color:#fff;background:#6ab0de;padding:6px 12px;margin:-12px -12px 12px}.rst-content .danger,.rst-content .error,.rst-content .wy-alert-danger.admonition,.rst-content .wy-alert-danger.admonition-todo,.rst-content .wy-alert-danger.attention,.rst-content .wy-alert-danger.caution,.rst-content .wy-alert-danger.hint,.rst-content .wy-alert-danger.important,.rst-content .wy-alert-danger.note,.rst-content .wy-alert-danger.seealso,.rst-content .wy-alert-danger.tip,.rst-content .wy-alert-danger.warning,.wy-alert.wy-alert-danger{background:#fdf3f2}.rst-content .danger .admonition-title,.rst-content .danger .wy-alert-title,.rst-content .error .admonition-title,.rst-content .error .wy-alert-title,.rst-content .wy-alert-danger.admonition-todo .admonition-title,.rst-content .wy-alert-danger.admonition-todo .wy-alert-title,.rst-content .wy-alert-danger.admonition .admonition-title,.rst-content .wy-alert-danger.admonition .wy-alert-title,.rst-content .wy-alert-danger.attention .admonition-title,.rst-content .wy-alert-danger.attention .wy-alert-title,.rst-content .wy-alert-danger.caution .admonition-title,.rst-content .wy-alert-danger.caution .wy-alert-title,.rst-content .wy-alert-danger.hint .admonition-title,.rst-content .wy-alert-danger.hint .wy-alert-title,.rst-content .wy-alert-danger.important .admonition-title,.rst-content .wy-alert-danger.important .wy-alert-title,.rst-content .wy-alert-danger.note .admonition-title,.rst-content .wy-alert-danger.note .wy-alert-title,.rst-content .wy-alert-danger.seealso .admonition-title,.rst-content .wy-alert-danger.seealso .wy-alert-title,.rst-content .wy-alert-danger.tip .admonition-title,.rst-content .wy-alert-danger.tip .wy-alert-title,.rst-content .wy-alert-danger.warning .admonition-title,.rst-content .wy-alert-danger.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-danger .admonition-title,.wy-alert.wy-alert-danger .rst-content .admonition-title,.wy-alert.wy-alert-danger .wy-alert-title{background:#f29f97}.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .warning,.rst-content .wy-alert-warning.admonition,.rst-content .wy-alert-warning.danger,.rst-content .wy-alert-warning.error,.rst-content .wy-alert-warning.hint,.rst-content .wy-alert-warning.important,.rst-content .wy-alert-warning.note,.rst-content .wy-alert-warning.seealso,.rst-content .wy-alert-warning.tip,.wy-alert.wy-alert-warning{background:#ffedcc}.rst-content .admonition-todo .admonition-title,.rst-content .admonition-todo .wy-alert-title,.rst-content .attention .admonition-title,.rst-content .attention .wy-alert-title,.rst-content .caution .admonition-title,.rst-content .caution .wy-alert-title,.rst-content .warning .admonition-title,.rst-content .warning .wy-alert-title,.rst-content .wy-alert-warning.admonition .admonition-title,.rst-content .wy-alert-warning.admonition .wy-alert-title,.rst-content .wy-alert-warning.danger .admonition-title,.rst-content .wy-alert-warning.danger .wy-alert-title,.rst-content .wy-alert-warning.error .admonition-title,.rst-content .wy-alert-warning.error .wy-alert-title,.rst-content .wy-alert-warning.hint .admonition-title,.rst-content .wy-alert-warning.hint .wy-alert-title,.rst-content .wy-alert-warning.important .admonition-title,.rst-content .wy-alert-warning.important .wy-alert-title,.rst-content .wy-alert-warning.note .admonition-title,.rst-content .wy-alert-warning.note .wy-alert-title,.rst-content .wy-alert-warning.seealso .admonition-title,.rst-content .wy-alert-warning.seealso .wy-alert-title,.rst-content .wy-alert-warning.tip .admonition-title,.rst-content .wy-alert-warning.tip .wy-alert-title,.rst-content .wy-alert.wy-alert-warning .admonition-title,.wy-alert.wy-alert-warning .rst-content .admonition-title,.wy-alert.wy-alert-warning .wy-alert-title{background:#f0b37e}.rst-content .note,.rst-content .seealso,.rst-content .wy-alert-info.admonition,.rst-content .wy-alert-info.admonition-todo,.rst-content .wy-alert-info.attention,.rst-content .wy-alert-info.caution,.rst-content .wy-alert-info.danger,.rst-content .wy-alert-info.error,.rst-content .wy-alert-info.hint,.rst-content .wy-alert-info.important,.rst-content .wy-alert-info.tip,.rst-content .wy-alert-info.warning,.wy-alert.wy-alert-info{background:#e7f2fa}.rst-content .note .admonition-title,.rst-content .note .wy-alert-title,.rst-content .seealso .admonition-title,.rst-content .seealso .wy-alert-title,.rst-content .wy-alert-info.admonition-todo .admonition-title,.rst-content .wy-alert-info.admonition-todo .wy-alert-title,.rst-content .wy-alert-info.admonition .admonition-title,.rst-content .wy-alert-info.admonition .wy-alert-title,.rst-content .wy-alert-info.attention .admonition-title,.rst-content .wy-alert-info.attention .wy-alert-title,.rst-content .wy-alert-info.caution .admonition-title,.rst-content .wy-alert-info.caution .wy-alert-title,.rst-content .wy-alert-info.danger .admonition-title,.rst-content .wy-alert-info.danger .wy-alert-title,.rst-content .wy-alert-info.error .admonition-title,.rst-content .wy-alert-info.error .wy-alert-title,.rst-content .wy-alert-info.hint .admonition-title,.rst-content .wy-alert-info.hint .wy-alert-title,.rst-content .wy-alert-info.important .admonition-title,.rst-content .wy-alert-info.important .wy-alert-title,.rst-content .wy-alert-info.tip .admonition-title,.rst-content .wy-alert-info.tip .wy-alert-title,.rst-content .wy-alert-info.warning .admonition-title,.rst-content .wy-alert-info.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-info .admonition-title,.wy-alert.wy-alert-info .rst-content .admonition-title,.wy-alert.wy-alert-info .wy-alert-title{background:#6ab0de}.rst-content .hint,.rst-content .important,.rst-content .tip,.rst-content .wy-alert-success.admonition,.rst-content .wy-alert-success.admonition-todo,.rst-content .wy-alert-success.attention,.rst-content .wy-alert-success.caution,.rst-content .wy-alert-success.danger,.rst-content .wy-alert-success.error,.rst-content .wy-alert-success.note,.rst-content .wy-alert-success.seealso,.rst-content .wy-alert-success.warning,.wy-alert.wy-alert-success{background:#dbfaf4}.rst-content .hint .admonition-title,.rst-content .hint .wy-alert-title,.rst-content .important .admonition-title,.rst-content .important .wy-alert-title,.rst-content .tip .admonition-title,.rst-content .tip .wy-alert-title,.rst-content .wy-alert-success.admonition-todo .admonition-title,.rst-content .wy-alert-success.admonition-todo .wy-alert-title,.rst-content .wy-alert-success.admonition .admonition-title,.rst-content .wy-alert-success.admonition .wy-alert-title,.rst-content .wy-alert-success.attention .admonition-title,.rst-content .wy-alert-success.attention .wy-alert-title,.rst-content .wy-alert-success.caution .admonition-title,.rst-content .wy-alert-success.caution .wy-alert-title,.rst-content .wy-alert-success.danger .admonition-title,.rst-content .wy-alert-success.danger .wy-alert-title,.rst-content .wy-alert-success.error .admonition-title,.rst-content .wy-alert-success.error .wy-alert-title,.rst-content .wy-alert-success.note .admonition-title,.rst-content .wy-alert-success.note .wy-alert-title,.rst-content .wy-alert-success.seealso .admonition-title,.rst-content .wy-alert-success.seealso .wy-alert-title,.rst-content .wy-alert-success.warning .admonition-title,.rst-content .wy-alert-success.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-success .admonition-title,.wy-alert.wy-alert-success .rst-content .admonition-title,.wy-alert.wy-alert-success .wy-alert-title{background:#1abc9c}.rst-content .wy-alert-neutral.admonition,.rst-content .wy-alert-neutral.admonition-todo,.rst-content .wy-alert-neutral.attention,.rst-content .wy-alert-neutral.caution,.rst-content .wy-alert-neutral.danger,.rst-content .wy-alert-neutral.error,.rst-content .wy-alert-neutral.hint,.rst-content .wy-alert-neutral.important,.rst-content .wy-alert-neutral.note,.rst-content .wy-alert-neutral.seealso,.rst-content .wy-alert-neutral.tip,.rst-content .wy-alert-neutral.warning,.wy-alert.wy-alert-neutral{background:#f3f6f6}.rst-content .wy-alert-neutral.admonition-todo .admonition-title,.rst-content .wy-alert-neutral.admonition-todo .wy-alert-title,.rst-content .wy-alert-neutral.admonition .admonition-title,.rst-content .wy-alert-neutral.admonition .wy-alert-title,.rst-content .wy-alert-neutral.attention .admonition-title,.rst-content .wy-alert-neutral.attention .wy-alert-title,.rst-content .wy-alert-neutral.caution .admonition-title,.rst-content .wy-alert-neutral.caution .wy-alert-title,.rst-content .wy-alert-neutral.danger .admonition-title,.rst-content .wy-alert-neutral.danger .wy-alert-title,.rst-content .wy-alert-neutral.error .admonition-title,.rst-content .wy-alert-neutral.error .wy-alert-title,.rst-content .wy-alert-neutral.hint .admonition-title,.rst-content .wy-alert-neutral.hint .wy-alert-title,.rst-content .wy-alert-neutral.important .admonition-title,.rst-content .wy-alert-neutral.important .wy-alert-title,.rst-content .wy-alert-neutral.note .admonition-title,.rst-content .wy-alert-neutral.note .wy-alert-title,.rst-content .wy-alert-neutral.seealso .admonition-title,.rst-content .wy-alert-neutral.seealso .wy-alert-title,.rst-content .wy-alert-neutral.tip .admonition-title,.rst-content .wy-alert-neutral.tip .wy-alert-title,.rst-content .wy-alert-neutral.warning .admonition-title,.rst-content .wy-alert-neutral.warning .wy-alert-title,.rst-content .wy-alert.wy-alert-neutral .admonition-title,.wy-alert.wy-alert-neutral .rst-content .admonition-title,.wy-alert.wy-alert-neutral .wy-alert-title{color:#404040;background:#e1e4e5}.rst-content .wy-alert-neutral.admonition-todo a,.rst-content .wy-alert-neutral.admonition a,.rst-content .wy-alert-neutral.attention a,.rst-content .wy-alert-neutral.caution a,.rst-content .wy-alert-neutral.danger a,.rst-content .wy-alert-neutral.error a,.rst-content .wy-alert-neutral.hint a,.rst-content .wy-alert-neutral.important a,.rst-content .wy-alert-neutral.note a,.rst-content .wy-alert-neutral.seealso a,.rst-content .wy-alert-neutral.tip a,.rst-content .wy-alert-neutral.warning a,.wy-alert.wy-alert-neutral a{color:#2980b9}.rst-content .admonition-todo p:last-child,.rst-content .admonition p:last-child,.rst-content .attention p:last-child,.rst-content .caution p:last-child,.rst-content .danger p:last-child,.rst-content .error p:last-child,.rst-content .hint p:last-child,.rst-content .important p:last-child,.rst-content .note p:last-child,.rst-content .seealso p:last-child,.rst-content .tip p:last-child,.rst-content .warning p:last-child,.wy-alert p:last-child{margin-bottom:0}.wy-tray-container{position:fixed;bottom:0;left:0;z-index:600}.wy-tray-container li{display:block;width:300px;background:transparent;color:#fff;text-align:center;box-shadow:0 5px 5px 0 rgba(0,0,0,.1);padding:0 24px;min-width:20%;opacity:0;height:0;line-height:56px;overflow:hidden;-webkit-transition:all .3s ease-in;-moz-transition:all .3s ease-in;transition:all .3s ease-in}.wy-tray-container li.wy-tray-item-success{background:#27ae60}.wy-tray-container li.wy-tray-item-info{background:#2980b9}.wy-tray-container li.wy-tray-item-warning{background:#e67e22}.wy-tray-container li.wy-tray-item-danger{background:#e74c3c}.wy-tray-container li.on{opacity:1;height:56px}@media screen and (max-width:768px){.wy-tray-container{bottom:auto;top:0;width:100%}.wy-tray-container li{width:100%}}button{font-size:100%;margin:0;vertical-align:baseline;*vertical-align:middle;cursor:pointer;line-height:normal;-webkit-appearance:button;*overflow:visible}button::-moz-focus-inner,input::-moz-focus-inner{border:0;padding:0}button[disabled]{cursor:default}.btn{display:inline-block;border-radius:2px;line-height:normal;white-space:nowrap;text-align:center;cursor:pointer;font-size:100%;padding:6px 12px 8px;color:#fff;border:1px solid rgba(0,0,0,.1);background-color:#27ae60;text-decoration:none;font-weight:400;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;box-shadow:inset 0 1px 2px -1px hsla(0,0%,100%,.5),inset 0 -2px 0 0 rgba(0,0,0,.1);outline-none:false;vertical-align:middle;*display:inline;zoom:1;-webkit-user-drag:none;-webkit-user-select:none;-moz-user-select:none;-ms-user-select:none;user-select:none;-webkit-transition:all .1s linear;-moz-transition:all .1s linear;transition:all .1s linear}.btn-hover{background:#2e8ece;color:#fff}.btn:hover{background:#2cc36b;color:#fff}.btn:focus{background:#2cc36b;outline:0}.btn:active{box-shadow:inset 0 -1px 0 0 rgba(0,0,0,.05),inset 0 2px 0 0 rgba(0,0,0,.1);padding:8px 12px 6px}.btn:visited{color:#fff}.btn-disabled,.btn-disabled:active,.btn-disabled:focus,.btn-disabled:hover,.btn:disabled{background-image:none;filter:progid:DXImageTransform.Microsoft.gradient(enabled = false);filter:alpha(opacity=40);opacity:.4;cursor:not-allowed;box-shadow:none}.btn::-moz-focus-inner{padding:0;border:0}.btn-small{font-size:80%}.btn-info{background-color:#2980b9!important}.btn-info:hover{background-color:#2e8ece!important}.btn-neutral{background-color:#f3f6f6!important;color:#404040!important}.btn-neutral:hover{background-color:#e5ebeb!important;color:#404040}.btn-neutral:visited{color:#404040!important}.btn-success{background-color:#27ae60!important}.btn-success:hover{background-color:#295!important}.btn-danger{background-color:#e74c3c!important}.btn-danger:hover{background-color:#ea6153!important}.btn-warning{background-color:#e67e22!important}.btn-warning:hover{background-color:#e98b39!important}.btn-invert{background-color:#222}.btn-invert:hover{background-color:#2f2f2f!important}.btn-link{background-color:transparent!important;color:#2980b9;box-shadow:none;border-color:transparent!important}.btn-link:active,.btn-link:hover{background-color:transparent!important;color:#409ad5!important;box-shadow:none}.btn-link:visited{color:#9b59b6}.wy-btn-group .btn,.wy-control .btn{vertical-align:middle}.wy-btn-group{margin-bottom:24px;*zoom:1}.wy-btn-group:after,.wy-btn-group:before{display:table;content:""}.wy-btn-group:after{clear:both}.wy-dropdown{position:relative;display:inline-block}.wy-dropdown-active .wy-dropdown-menu{display:block}.wy-dropdown-menu{position:absolute;left:0;display:none;float:left;top:100%;min-width:100%;background:#fcfcfc;z-index:100;border:1px solid #cfd7dd;box-shadow:0 2px 2px 0 rgba(0,0,0,.1);padding:12px}.wy-dropdown-menu>dd>a{display:block;clear:both;color:#404040;white-space:nowrap;font-size:90%;padding:0 12px;cursor:pointer}.wy-dropdown-menu>dd>a:hover{background:#2980b9;color:#fff}.wy-dropdown-menu>dd.divider{border-top:1px solid #cfd7dd;margin:6px 0}.wy-dropdown-menu>dd.search{padding-bottom:12px}.wy-dropdown-menu>dd.search input[type=search]{width:100%}.wy-dropdown-menu>dd.call-to-action{background:#e3e3e3;text-transform:uppercase;font-weight:500;font-size:80%}.wy-dropdown-menu>dd.call-to-action:hover{background:#e3e3e3}.wy-dropdown-menu>dd.call-to-action .btn{color:#fff}.wy-dropdown.wy-dropdown-up .wy-dropdown-menu{bottom:100%;top:auto;left:auto;right:0}.wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu{background:#fcfcfc;margin-top:2px}.wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu a{padding:6px 12px}.wy-dropdown.wy-dropdown-bubble .wy-dropdown-menu a:hover{background:#2980b9;color:#fff}.wy-dropdown.wy-dropdown-left .wy-dropdown-menu{right:0;left:auto;text-align:right}.wy-dropdown-arrow:before{content:" ";border-bottom:5px solid #f5f5f5;border-left:5px solid transparent;border-right:5px solid transparent;position:absolute;display:block;top:-4px;left:50%;margin-left:-3px}.wy-dropdown-arrow.wy-dropdown-arrow-left:before{left:11px}.wy-form-stacked select{display:block}.wy-form-aligned .wy-help-inline,.wy-form-aligned input,.wy-form-aligned label,.wy-form-aligned select,.wy-form-aligned textarea{display:inline-block;*display:inline;*zoom:1;vertical-align:middle}.wy-form-aligned .wy-control-group>label{display:inline-block;vertical-align:middle;width:10em;margin:6px 12px 0 0;float:left}.wy-form-aligned .wy-control{float:left}.wy-form-aligned .wy-control label{display:block}.wy-form-aligned .wy-control select{margin-top:6px}fieldset{margin:0}fieldset,legend{border:0;padding:0}legend{width:100%;white-space:normal;margin-bottom:24px;font-size:150%;*margin-left:-7px}label,legend{display:block}label{margin:0 0 .3125em;color:#333;font-size:90%}input,select,textarea{font-size:100%;margin:0;vertical-align:baseline;*vertical-align:middle}.wy-control-group{margin-bottom:24px;max-width:1200px;margin-left:auto;margin-right:auto;*zoom:1}.wy-control-group:after,.wy-control-group:before{display:table;content:""}.wy-control-group:after{clear:both}.wy-control-group.wy-control-group-required>label:after{content:" *";color:#e74c3c}.wy-control-group .wy-form-full,.wy-control-group .wy-form-halves,.wy-control-group .wy-form-thirds{padding-bottom:12px}.wy-control-group .wy-form-full input[type=color],.wy-control-group .wy-form-full input[type=date],.wy-control-group .wy-form-full input[type=datetime-local],.wy-control-group .wy-form-full input[type=datetime],.wy-control-group .wy-form-full input[type=email],.wy-control-group .wy-form-full input[type=month],.wy-control-group .wy-form-full input[type=number],.wy-control-group .wy-form-full input[type=password],.wy-control-group .wy-form-full input[type=search],.wy-control-group .wy-form-full input[type=tel],.wy-control-group .wy-form-full input[type=text],.wy-control-group .wy-form-full input[type=time],.wy-control-group .wy-form-full input[type=url],.wy-control-group .wy-form-full input[type=week],.wy-control-group .wy-form-full select,.wy-control-group .wy-form-halves input[type=color],.wy-control-group .wy-form-halves input[type=date],.wy-control-group .wy-form-halves input[type=datetime-local],.wy-control-group .wy-form-halves input[type=datetime],.wy-control-group .wy-form-halves input[type=email],.wy-control-group .wy-form-halves input[type=month],.wy-control-group .wy-form-halves input[type=number],.wy-control-group .wy-form-halves input[type=password],.wy-control-group .wy-form-halves input[type=search],.wy-control-group .wy-form-halves input[type=tel],.wy-control-group .wy-form-halves input[type=text],.wy-control-group .wy-form-halves input[type=time],.wy-control-group .wy-form-halves input[type=url],.wy-control-group .wy-form-halves input[type=week],.wy-control-group .wy-form-halves select,.wy-control-group .wy-form-thirds input[type=color],.wy-control-group .wy-form-thirds input[type=date],.wy-control-group .wy-form-thirds input[type=datetime-local],.wy-control-group .wy-form-thirds input[type=datetime],.wy-control-group .wy-form-thirds input[type=email],.wy-control-group .wy-form-thirds input[type=month],.wy-control-group .wy-form-thirds input[type=number],.wy-control-group .wy-form-thirds input[type=password],.wy-control-group .wy-form-thirds input[type=search],.wy-control-group .wy-form-thirds input[type=tel],.wy-control-group .wy-form-thirds input[type=text],.wy-control-group .wy-form-thirds input[type=time],.wy-control-group .wy-form-thirds input[type=url],.wy-control-group .wy-form-thirds input[type=week],.wy-control-group .wy-form-thirds select{width:100%}.wy-control-group .wy-form-full{float:left;display:block;width:100%;margin-right:0}.wy-control-group .wy-form-full:last-child{margin-right:0}.wy-control-group .wy-form-halves{float:left;display:block;margin-right:2.35765%;width:48.82117%}.wy-control-group .wy-form-halves:last-child,.wy-control-group .wy-form-halves:nth-of-type(2n){margin-right:0}.wy-control-group .wy-form-halves:nth-of-type(odd){clear:left}.wy-control-group .wy-form-thirds{float:left;display:block;margin-right:2.35765%;width:31.76157%}.wy-control-group .wy-form-thirds:last-child,.wy-control-group .wy-form-thirds:nth-of-type(3n){margin-right:0}.wy-control-group .wy-form-thirds:nth-of-type(3n+1){clear:left}.wy-control-group.wy-control-group-no-input .wy-control,.wy-control-no-input{margin:6px 0 0;font-size:90%}.wy-control-no-input{display:inline-block}.wy-control-group.fluid-input input[type=color],.wy-control-group.fluid-input input[type=date],.wy-control-group.fluid-input input[type=datetime-local],.wy-control-group.fluid-input input[type=datetime],.wy-control-group.fluid-input input[type=email],.wy-control-group.fluid-input input[type=month],.wy-control-group.fluid-input input[type=number],.wy-control-group.fluid-input input[type=password],.wy-control-group.fluid-input input[type=search],.wy-control-group.fluid-input input[type=tel],.wy-control-group.fluid-input input[type=text],.wy-control-group.fluid-input input[type=time],.wy-control-group.fluid-input input[type=url],.wy-control-group.fluid-input input[type=week]{width:100%}.wy-form-message-inline{padding-left:.3em;color:#666;font-size:90%}.wy-form-message{display:block;color:#999;font-size:70%;margin-top:.3125em;font-style:italic}.wy-form-message p{font-size:inherit;font-style:italic;margin-bottom:6px}.wy-form-message p:last-child{margin-bottom:0}input{line-height:normal}input[type=button],input[type=reset],input[type=submit]{-webkit-appearance:button;cursor:pointer;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;*overflow:visible}input[type=color],input[type=date],input[type=datetime-local],input[type=datetime],input[type=email],input[type=month],input[type=number],input[type=password],input[type=search],input[type=tel],input[type=text],input[type=time],input[type=url],input[type=week]{-webkit-appearance:none;padding:6px;display:inline-block;border:1px solid #ccc;font-size:80%;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;box-shadow:inset 0 1px 3px #ddd;border-radius:0;-webkit-transition:border .3s linear;-moz-transition:border .3s linear;transition:border .3s linear}input[type=datetime-local]{padding:.34375em .625em}input[disabled]{cursor:default}input[type=checkbox],input[type=radio]{padding:0;margin-right:.3125em;*height:13px;*width:13px}input[type=checkbox],input[type=radio],input[type=search]{-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box}input[type=search]::-webkit-search-cancel-button,input[type=search]::-webkit-search-decoration{-webkit-appearance:none}input[type=color]:focus,input[type=date]:focus,input[type=datetime-local]:focus,input[type=datetime]:focus,input[type=email]:focus,input[type=month]:focus,input[type=number]:focus,input[type=password]:focus,input[type=search]:focus,input[type=tel]:focus,input[type=text]:focus,input[type=time]:focus,input[type=url]:focus,input[type=week]:focus{outline:0;outline:thin dotted\9;border-color:#333}input.no-focus:focus{border-color:#ccc!important}input[type=checkbox]:focus,input[type=file]:focus,input[type=radio]:focus{outline:thin dotted #333;outline:1px auto #129fea}input[type=color][disabled],input[type=date][disabled],input[type=datetime-local][disabled],input[type=datetime][disabled],input[type=email][disabled],input[type=month][disabled],input[type=number][disabled],input[type=password][disabled],input[type=search][disabled],input[type=tel][disabled],input[type=text][disabled],input[type=time][disabled],input[type=url][disabled],input[type=week][disabled]{cursor:not-allowed;background-color:#fafafa}input:focus:invalid,select:focus:invalid,textarea:focus:invalid{color:#e74c3c;border:1px solid #e74c3c}input:focus:invalid:focus,select:focus:invalid:focus,textarea:focus:invalid:focus{border-color:#e74c3c}input[type=checkbox]:focus:invalid:focus,input[type=file]:focus:invalid:focus,input[type=radio]:focus:invalid:focus{outline-color:#e74c3c}input.wy-input-large{padding:12px;font-size:100%}textarea{overflow:auto;vertical-align:top;width:100%;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif}select,textarea{padding:.5em .625em;display:inline-block;border:1px solid #ccc;font-size:80%;box-shadow:inset 0 1px 3px #ddd;-webkit-transition:border .3s linear;-moz-transition:border .3s linear;transition:border .3s linear}select{border:1px solid #ccc;background-color:#fff}select[multiple]{height:auto}select:focus,textarea:focus{outline:0}input[readonly],select[disabled],select[readonly],textarea[disabled],textarea[readonly]{cursor:not-allowed;background-color:#fafafa}input[type=checkbox][disabled],input[type=radio][disabled]{cursor:not-allowed}.wy-checkbox,.wy-radio{margin:6px 0;color:#404040;display:block}.wy-checkbox input,.wy-radio input{vertical-align:baseline}.wy-form-message-inline{display:inline-block;*display:inline;*zoom:1;vertical-align:middle}.wy-input-prefix,.wy-input-suffix{white-space:nowrap;padding:6px}.wy-input-prefix .wy-input-context,.wy-input-suffix .wy-input-context{line-height:27px;padding:0 8px;display:inline-block;font-size:80%;background-color:#f3f6f6;border:1px solid #ccc;color:#999}.wy-input-suffix .wy-input-context{border-left:0}.wy-input-prefix .wy-input-context{border-right:0}.wy-switch{position:relative;display:block;height:24px;margin-top:12px;cursor:pointer}.wy-switch:before{left:0;top:0;width:36px;height:12px;background:#ccc}.wy-switch:after,.wy-switch:before{position:absolute;content:"";display:block;border-radius:4px;-webkit-transition:all .2s ease-in-out;-moz-transition:all .2s ease-in-out;transition:all .2s ease-in-out}.wy-switch:after{width:18px;height:18px;background:#999;left:-3px;top:-3px}.wy-switch span{position:absolute;left:48px;display:block;font-size:12px;color:#ccc;line-height:1}.wy-switch.active:before{background:#1e8449}.wy-switch.active:after{left:24px;background:#27ae60}.wy-switch.disabled{cursor:not-allowed;opacity:.8}.wy-control-group.wy-control-group-error .wy-form-message,.wy-control-group.wy-control-group-error>label{color:#e74c3c}.wy-control-group.wy-control-group-error input[type=color],.wy-control-group.wy-control-group-error input[type=date],.wy-control-group.wy-control-group-error input[type=datetime-local],.wy-control-group.wy-control-group-error input[type=datetime],.wy-control-group.wy-control-group-error input[type=email],.wy-control-group.wy-control-group-error input[type=month],.wy-control-group.wy-control-group-error input[type=number],.wy-control-group.wy-control-group-error input[type=password],.wy-control-group.wy-control-group-error input[type=search],.wy-control-group.wy-control-group-error input[type=tel],.wy-control-group.wy-control-group-error input[type=text],.wy-control-group.wy-control-group-error input[type=time],.wy-control-group.wy-control-group-error input[type=url],.wy-control-group.wy-control-group-error input[type=week],.wy-control-group.wy-control-group-error textarea{border:1px solid #e74c3c}.wy-inline-validate{white-space:nowrap}.wy-inline-validate .wy-input-context{padding:.5em .625em;display:inline-block;font-size:80%}.wy-inline-validate.wy-inline-validate-success .wy-input-context{color:#27ae60}.wy-inline-validate.wy-inline-validate-danger .wy-input-context{color:#e74c3c}.wy-inline-validate.wy-inline-validate-warning .wy-input-context{color:#e67e22}.wy-inline-validate.wy-inline-validate-info .wy-input-context{color:#2980b9}.rotate-90{-webkit-transform:rotate(90deg);-moz-transform:rotate(90deg);-ms-transform:rotate(90deg);-o-transform:rotate(90deg);transform:rotate(90deg)}.rotate-180{-webkit-transform:rotate(180deg);-moz-transform:rotate(180deg);-ms-transform:rotate(180deg);-o-transform:rotate(180deg);transform:rotate(180deg)}.rotate-270{-webkit-transform:rotate(270deg);-moz-transform:rotate(270deg);-ms-transform:rotate(270deg);-o-transform:rotate(270deg);transform:rotate(270deg)}.mirror{-webkit-transform:scaleX(-1);-moz-transform:scaleX(-1);-ms-transform:scaleX(-1);-o-transform:scaleX(-1);transform:scaleX(-1)}.mirror.rotate-90{-webkit-transform:scaleX(-1) rotate(90deg);-moz-transform:scaleX(-1) rotate(90deg);-ms-transform:scaleX(-1) rotate(90deg);-o-transform:scaleX(-1) rotate(90deg);transform:scaleX(-1) rotate(90deg)}.mirror.rotate-180{-webkit-transform:scaleX(-1) rotate(180deg);-moz-transform:scaleX(-1) rotate(180deg);-ms-transform:scaleX(-1) rotate(180deg);-o-transform:scaleX(-1) rotate(180deg);transform:scaleX(-1) rotate(180deg)}.mirror.rotate-270{-webkit-transform:scaleX(-1) rotate(270deg);-moz-transform:scaleX(-1) rotate(270deg);-ms-transform:scaleX(-1) rotate(270deg);-o-transform:scaleX(-1) rotate(270deg);transform:scaleX(-1) rotate(270deg)}@media only screen and (max-width:480px){.wy-form button[type=submit]{margin:.7em 0 0}.wy-form input[type=color],.wy-form input[type=date],.wy-form input[type=datetime-local],.wy-form input[type=datetime],.wy-form input[type=email],.wy-form input[type=month],.wy-form input[type=number],.wy-form input[type=password],.wy-form input[type=search],.wy-form input[type=tel],.wy-form input[type=text],.wy-form input[type=time],.wy-form input[type=url],.wy-form input[type=week],.wy-form label{margin-bottom:.3em;display:block}.wy-form input[type=color],.wy-form input[type=date],.wy-form input[type=datetime-local],.wy-form input[type=datetime],.wy-form input[type=email],.wy-form input[type=month],.wy-form input[type=number],.wy-form input[type=password],.wy-form input[type=search],.wy-form input[type=tel],.wy-form input[type=time],.wy-form input[type=url],.wy-form input[type=week]{margin-bottom:0}.wy-form-aligned .wy-control-group label{margin-bottom:.3em;text-align:left;display:block;width:100%}.wy-form-aligned .wy-control{margin:1.5em 0 0}.wy-form-message,.wy-form-message-inline,.wy-form .wy-help-inline{display:block;font-size:80%;padding:6px 0}}@media screen and (max-width:768px){.tablet-hide{display:none}}@media screen and (max-width:480px){.mobile-hide{display:none}}.float-left{float:left}.float-right{float:right}.full-width{width:100%}.rst-content table.docutils,.rst-content table.field-list,.wy-table{border-collapse:collapse;border-spacing:0;empty-cells:show;margin-bottom:24px}.rst-content table.docutils caption,.rst-content table.field-list caption,.wy-table caption{color:#000;font:italic 85%/1 arial,sans-serif;padding:1em 0;text-align:center}.rst-content table.docutils td,.rst-content table.docutils th,.rst-content table.field-list td,.rst-content table.field-list th,.wy-table td,.wy-table th{font-size:90%;margin:0;overflow:visible;padding:8px 16px}.rst-content table.docutils td:first-child,.rst-content table.docutils th:first-child,.rst-content table.field-list td:first-child,.rst-content table.field-list th:first-child,.wy-table td:first-child,.wy-table th:first-child{border-left-width:0}.rst-content table.docutils thead,.rst-content table.field-list thead,.wy-table thead{color:#000;text-align:left;vertical-align:bottom;white-space:nowrap}.rst-content table.docutils thead th,.rst-content table.field-list thead th,.wy-table thead th{font-weight:700;border-bottom:2px solid #e1e4e5}.rst-content table.docutils td,.rst-content table.field-list td,.wy-table td{background-color:transparent;vertical-align:middle}.rst-content table.docutils td p,.rst-content table.field-list td p,.wy-table td p{line-height:18px}.rst-content table.docutils td p:last-child,.rst-content table.field-list td p:last-child,.wy-table td p:last-child{margin-bottom:0}.rst-content table.docutils .wy-table-cell-min,.rst-content table.field-list .wy-table-cell-min,.wy-table .wy-table-cell-min{width:1%;padding-right:0}.rst-content table.docutils .wy-table-cell-min input[type=checkbox],.rst-content table.field-list .wy-table-cell-min input[type=checkbox],.wy-table .wy-table-cell-min input[type=checkbox]{margin:0}.wy-table-secondary{color:grey;font-size:90%}.wy-table-tertiary{color:grey;font-size:80%}.rst-content table.docutils:not(.field-list) tr:nth-child(2n-1) td,.wy-table-backed,.wy-table-odd td,.wy-table-striped tr:nth-child(2n-1) td{background-color:#f3f6f6}.rst-content table.docutils,.wy-table-bordered-all{border:1px solid #e1e4e5}.rst-content table.docutils td,.wy-table-bordered-all td{border-bottom:1px solid #e1e4e5;border-left:1px solid #e1e4e5}.rst-content table.docutils tbody>tr:last-child td,.wy-table-bordered-all tbody>tr:last-child td{border-bottom-width:0}.wy-table-bordered{border:1px solid #e1e4e5}.wy-table-bordered-rows td{border-bottom:1px solid #e1e4e5}.wy-table-bordered-rows tbody>tr:last-child td{border-bottom-width:0}.wy-table-horizontal td,.wy-table-horizontal th{border-width:0 0 1px;border-bottom:1px solid #e1e4e5}.wy-table-horizontal tbody>tr:last-child td{border-bottom-width:0}.wy-table-responsive{margin-bottom:24px;max-width:100%;overflow:auto}.wy-table-responsive table{margin-bottom:0!important}.wy-table-responsive table td,.wy-table-responsive table th{white-space:nowrap}a{color:#2980b9;text-decoration:none;cursor:pointer}a:hover{color:#3091d1}a:visited{color:#9b59b6}html{height:100%}body,html{overflow-x:hidden}body{font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;font-weight:400;color:#404040;min-height:100%;background:#edf0f2}.wy-text-left{text-align:left}.wy-text-center{text-align:center}.wy-text-right{text-align:right}.wy-text-large{font-size:120%}.wy-text-normal{font-size:100%}.wy-text-small,small{font-size:80%}.wy-text-strike{text-decoration:line-through}.wy-text-warning{color:#e67e22!important}a.wy-text-warning:hover{color:#eb9950!important}.wy-text-info{color:#2980b9!important}a.wy-text-info:hover{color:#409ad5!important}.wy-text-success{color:#27ae60!important}a.wy-text-success:hover{color:#36d278!important}.wy-text-danger{color:#e74c3c!important}a.wy-text-danger:hover{color:#ed7669!important}.wy-text-neutral{color:#404040!important}a.wy-text-neutral:hover{color:#595959!important}.rst-content .toctree-wrapper>p.caption,h1,h2,h3,h4,h5,h6,legend{margin-top:0;font-weight:700;font-family:Roboto Slab,ff-tisa-web-pro,Georgia,Arial,sans-serif}p{line-height:24px;font-size:16px;margin:0 0 24px}h1{font-size:175%}.rst-content .toctree-wrapper>p.caption,h2{font-size:150%}h3{font-size:125%}h4{font-size:115%}h5{font-size:110%}h6{font-size:100%}hr{display:block;height:1px;border:0;border-top:1px solid #e1e4e5;margin:24px 0;padding:0}.rst-content code,.rst-content tt,code{white-space:nowrap;max-width:100%;background:#fff;border:1px solid #e1e4e5;font-size:75%;padding:0 5px;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;color:#e74c3c;overflow-x:auto}.rst-content tt.code-large,code.code-large{font-size:90%}.rst-content .section ul,.rst-content .toctree-wrapper ul,.wy-plain-list-disc,article ul{list-style:disc;line-height:24px;margin-bottom:24px}.rst-content .section ul li,.rst-content .toctree-wrapper ul li,.wy-plain-list-disc li,article ul li{list-style:disc;margin-left:24px}.rst-content .section ul li p:last-child,.rst-content .section ul li ul,.rst-content .toctree-wrapper ul li p:last-child,.rst-content .toctree-wrapper ul li ul,.wy-plain-list-disc li p:last-child,.wy-plain-list-disc li ul,article ul li p:last-child,article ul li ul{margin-bottom:0}.rst-content .section ul li li,.rst-content .toctree-wrapper ul li li,.wy-plain-list-disc li li,article ul li li{list-style:circle}.rst-content .section ul li li li,.rst-content .toctree-wrapper ul li li li,.wy-plain-list-disc li li li,article ul li li li{list-style:square}.rst-content .section ul li ol li,.rst-content .toctree-wrapper ul li ol li,.wy-plain-list-disc li ol li,article ul li ol li{list-style:decimal}.rst-content .section ol,.rst-content ol.arabic,.wy-plain-list-decimal,article ol{list-style:decimal;line-height:24px;margin-bottom:24px}.rst-content .section ol li,.rst-content ol.arabic li,.wy-plain-list-decimal li,article ol li{list-style:decimal;margin-left:24px}.rst-content .section ol li p:last-child,.rst-content .section ol li ul,.rst-content ol.arabic li p:last-child,.rst-content ol.arabic li ul,.wy-plain-list-decimal li p:last-child,.wy-plain-list-decimal li ul,article ol li p:last-child,article ol li ul{margin-bottom:0}.rst-content .section ol li ul li,.rst-content ol.arabic li ul li,.wy-plain-list-decimal li ul li,article ol li ul li{list-style:disc}.wy-breadcrumbs{*zoom:1}.wy-breadcrumbs:after,.wy-breadcrumbs:before{display:table;content:""}.wy-breadcrumbs:after{clear:both}.wy-breadcrumbs li{display:inline-block}.wy-breadcrumbs li.wy-breadcrumbs-aside{float:right}.wy-breadcrumbs li a{display:inline-block;padding:5px}.wy-breadcrumbs li a:first-child{padding-left:0}.rst-content .wy-breadcrumbs li tt,.wy-breadcrumbs li .rst-content tt,.wy-breadcrumbs li code{padding:5px;border:none;background:none}.rst-content .wy-breadcrumbs li tt.literal,.wy-breadcrumbs li .rst-content tt.literal,.wy-breadcrumbs li code.literal{color:#404040}.wy-breadcrumbs-extra{margin-bottom:0;color:#b3b3b3;font-size:80%;display:inline-block}@media screen and (max-width:480px){.wy-breadcrumbs-extra,.wy-breadcrumbs li.wy-breadcrumbs-aside{display:none}}@media print{.wy-breadcrumbs li.wy-breadcrumbs-aside{display:none}}html{font-size:16px}.wy-affix{position:fixed;top:1.618em}.wy-menu a:hover{text-decoration:none}.wy-menu-horiz{*zoom:1}.wy-menu-horiz:after,.wy-menu-horiz:before{display:table;content:""}.wy-menu-horiz:after{clear:both}.wy-menu-horiz li,.wy-menu-horiz ul{display:inline-block}.wy-menu-horiz li:hover{background:hsla(0,0%,100%,.1)}.wy-menu-horiz li.divide-left{border-left:1px solid #404040}.wy-menu-horiz li.divide-right{border-right:1px solid #404040}.wy-menu-horiz a{height:32px;display:inline-block;line-height:32px;padding:0 16px}.wy-menu-vertical{width:300px}.wy-menu-vertical header,.wy-menu-vertical p.caption{color:#55a5d9;height:32px;line-height:32px;padding:0 1.618em;margin:12px 0 0;display:block;font-weight:700;text-transform:uppercase;font-size:85%;white-space:nowrap}.wy-menu-vertical ul{margin-bottom:0}.wy-menu-vertical li.divide-top{border-top:1px solid #404040}.wy-menu-vertical li.divide-bottom{border-bottom:1px solid #404040}.wy-menu-vertical li.current{background:#e3e3e3}.wy-menu-vertical li.current a{color:grey;border-right:1px solid #c9c9c9;padding:.4045em 2.427em}.wy-menu-vertical li.current a:hover{background:#d6d6d6}.rst-content .wy-menu-vertical li tt,.wy-menu-vertical li .rst-content tt,.wy-menu-vertical li code{border:none;background:inherit;color:inherit;padding-left:0;padding-right:0}.wy-menu-vertical li span.toctree-expand{display:block;float:left;margin-left:-1.2em;font-size:.8em;line-height:1.6em;color:#4d4d4d}.wy-menu-vertical li.current>a,.wy-menu-vertical li.on a{color:#404040;font-weight:700;position:relative;background:#fcfcfc;border:none;padding:.4045em 1.618em}.wy-menu-vertical li.current>a:hover,.wy-menu-vertical li.on a:hover{background:#fcfcfc}.wy-menu-vertical li.current>a:hover span.toctree-expand,.wy-menu-vertical li.on a:hover span.toctree-expand{color:grey}.wy-menu-vertical li.current>a span.toctree-expand,.wy-menu-vertical li.on a span.toctree-expand{display:block;font-size:.8em;line-height:1.6em;color:#333}.wy-menu-vertical li.toctree-l1.current>a{border-bottom:1px solid #c9c9c9;border-top:1px solid #c9c9c9}.wy-menu-vertical .toctree-l1.current .toctree-l2>ul,.wy-menu-vertical .toctree-l2.current .toctree-l3>ul,.wy-menu-vertical .toctree-l3.current .toctree-l4>ul,.wy-menu-vertical .toctree-l4.current .toctree-l5>ul,.wy-menu-vertical .toctree-l5.current .toctree-l6>ul,.wy-menu-vertical .toctree-l6.current .toctree-l7>ul,.wy-menu-vertical .toctree-l7.current .toctree-l8>ul,.wy-menu-vertical .toctree-l8.current .toctree-l9>ul,.wy-menu-vertical .toctree-l9.current .toctree-l10>ul,.wy-menu-vertical .toctree-l10.current .toctree-l11>ul{display:none}.wy-menu-vertical .toctree-l1.current .current.toctree-l2>ul,.wy-menu-vertical .toctree-l2.current .current.toctree-l3>ul,.wy-menu-vertical .toctree-l3.current .current.toctree-l4>ul,.wy-menu-vertical .toctree-l4.current .current.toctree-l5>ul,.wy-menu-vertical .toctree-l5.current .current.toctree-l6>ul,.wy-menu-vertical .toctree-l6.current .current.toctree-l7>ul,.wy-menu-vertical .toctree-l7.current .current.toctree-l8>ul,.wy-menu-vertical .toctree-l8.current .current.toctree-l9>ul,.wy-menu-vertical .toctree-l9.current .current.toctree-l10>ul,.wy-menu-vertical .toctree-l10.current .current.toctree-l11>ul{display:block}.wy-menu-vertical li.toctree-l3,.wy-menu-vertical li.toctree-l4{font-size:.9em}.wy-menu-vertical li.toctree-l2 a,.wy-menu-vertical li.toctree-l3 a,.wy-menu-vertical li.toctree-l4 a,.wy-menu-vertical li.toctree-l5 a,.wy-menu-vertical li.toctree-l6 a,.wy-menu-vertical li.toctree-l7 a,.wy-menu-vertical li.toctree-l8 a,.wy-menu-vertical li.toctree-l9 a,.wy-menu-vertical li.toctree-l10 a{color:#404040}.wy-menu-vertical li.toctree-l2 a:hover span.toctree-expand,.wy-menu-vertical li.toctree-l3 a:hover span.toctree-expand,.wy-menu-vertical li.toctree-l4 a:hover span.toctree-expand,.wy-menu-vertical li.toctree-l5 a:hover span.toctree-expand,.wy-menu-vertical li.toctree-l6 a:hover span.toctree-expand,.wy-menu-vertical li.toctree-l7 a:hover span.toctree-expand,.wy-menu-vertical li.toctree-l8 a:hover span.toctree-expand,.wy-menu-vertical li.toctree-l9 a:hover span.toctree-expand,.wy-menu-vertical li.toctree-l10 a:hover span.toctree-expand{color:grey}.wy-menu-vertical li.toctree-l2.current li.toctree-l3>a,.wy-menu-vertical li.toctree-l3.current li.toctree-l4>a,.wy-menu-vertical li.toctree-l4.current li.toctree-l5>a,.wy-menu-vertical li.toctree-l5.current li.toctree-l6>a,.wy-menu-vertical li.toctree-l6.current li.toctree-l7>a,.wy-menu-vertical li.toctree-l7.current li.toctree-l8>a,.wy-menu-vertical li.toctree-l8.current li.toctree-l9>a,.wy-menu-vertical li.toctree-l9.current li.toctree-l10>a,.wy-menu-vertical li.toctree-l10.current li.toctree-l11>a{display:block}.wy-menu-vertical li.toctree-l2.current>a{padding:.4045em 2.427em}.wy-menu-vertical li.toctree-l2.current li.toctree-l3>a,.wy-menu-vertical li.toctree-l3.current>a{padding:.4045em 4.045em}.wy-menu-vertical li.toctree-l3.current li.toctree-l4>a,.wy-menu-vertical li.toctree-l4.current>a{padding:.4045em 5.663em}.wy-menu-vertical li.toctree-l4.current li.toctree-l5>a,.wy-menu-vertical li.toctree-l5.current>a{padding:.4045em 7.281em}.wy-menu-vertical li.toctree-l5.current li.toctree-l6>a,.wy-menu-vertical li.toctree-l6.current>a{padding:.4045em 8.899em}.wy-menu-vertical li.toctree-l6.current li.toctree-l7>a,.wy-menu-vertical li.toctree-l7.current>a{padding:.4045em 10.517em}.wy-menu-vertical li.toctree-l7.current li.toctree-l8>a,.wy-menu-vertical li.toctree-l8.current>a{padding:.4045em 12.135em}.wy-menu-vertical li.toctree-l8.current li.toctree-l9>a,.wy-menu-vertical li.toctree-l9.current>a{padding:.4045em 13.753em}.wy-menu-vertical li.toctree-l9.current li.toctree-l10>a,.wy-menu-vertical li.toctree-l10.current>a{padding:.4045em 15.371em}.wy-menu-vertical li.toctree-l10.current li.toctree-l11>a{padding:.4045em 16.989em}.wy-menu-vertical li.toctree-l2.current>a,.wy-menu-vertical li.toctree-l2.current li.toctree-l3>a{background:#c9c9c9}.wy-menu-vertical li.toctree-l2 span.toctree-expand{color:#a3a3a3}.wy-menu-vertical li.toctree-l3.current>a,.wy-menu-vertical li.toctree-l3.current li.toctree-l4>a{background:#bdbdbd}.wy-menu-vertical li.toctree-l3 span.toctree-expand{color:#969696}.wy-menu-vertical li.current ul{display:block}.wy-menu-vertical li ul{margin-bottom:0;display:none}.wy-menu-vertical li ul li a{margin-bottom:0;color:#d9d9d9;font-weight:400}.wy-menu-vertical a{line-height:18px;padding:.4045em 1.618em;display:block;position:relative;font-size:90%;color:#d9d9d9}.wy-menu-vertical a:hover{background-color:#4e4a4a;cursor:pointer}.wy-menu-vertical a:hover span.toctree-expand{color:#d9d9d9}.wy-menu-vertical a:active{background-color:#2980b9;cursor:pointer;color:#fff}.wy-menu-vertical a:active span.toctree-expand{color:#fff}.wy-side-nav-search{display:block;width:300px;padding:.809em;margin-bottom:.809em;z-index:200;background-color:#2980b9;text-align:center;color:#fcfcfc}.wy-side-nav-search input[type=text]{width:100%;border-radius:50px;padding:6px 12px;border-color:#2472a4}.wy-side-nav-search img{display:block;margin:auto auto .809em;height:45px;width:45px;background-color:#2980b9;padding:5px;border-radius:100%}.wy-side-nav-search .wy-dropdown>a,.wy-side-nav-search>a{color:#fcfcfc;font-size:100%;font-weight:700;display:inline-block;padding:4px 6px;margin-bottom:.809em}.wy-side-nav-search .wy-dropdown>a:hover,.wy-side-nav-search>a:hover{background:hsla(0,0%,100%,.1)}.wy-side-nav-search .wy-dropdown>a img.logo,.wy-side-nav-search>a img.logo{display:block;margin:0 auto;height:auto;width:auto;border-radius:0;max-width:100%;background:transparent}.wy-side-nav-search .wy-dropdown>a.icon img.logo,.wy-side-nav-search>a.icon img.logo{margin-top:.85em}.wy-side-nav-search>div.version{margin-top:-.4045em;margin-bottom:.809em;font-weight:400;color:hsla(0,0%,100%,.3)}.wy-nav .wy-menu-vertical header{color:#2980b9}.wy-nav .wy-menu-vertical a{color:#b3b3b3}.wy-nav .wy-menu-vertical a:hover{background-color:#2980b9;color:#fff}[data-menu-wrap]{-webkit-transition:all .2s ease-in;-moz-transition:all .2s ease-in;transition:all .2s ease-in;position:absolute;opacity:1;width:100%;opacity:0}[data-menu-wrap].move-center{left:0;right:auto;opacity:1}[data-menu-wrap].move-left{right:auto;left:-100%;opacity:0}[data-menu-wrap].move-right{right:-100%;left:auto;opacity:0}.wy-body-for-nav{background:#fcfcfc}.wy-grid-for-nav{position:absolute;width:100%;height:100%}.wy-nav-side{position:fixed;top:0;bottom:0;left:0;padding-bottom:2em;width:300px;overflow-x:hidden;overflow-y:hidden;min-height:100%;color:#9b9b9b;background:#343131;z-index:200}.wy-side-scroll{width:320px;position:relative;overflow-x:hidden;overflow-y:scroll;height:100%}.wy-nav-top{display:none;background:#2980b9;color:#fff;padding:.4045em .809em;position:relative;line-height:50px;text-align:center;font-size:100%;*zoom:1}.wy-nav-top:after,.wy-nav-top:before{display:table;content:""}.wy-nav-top:after{clear:both}.wy-nav-top a{color:#fff;font-weight:700}.wy-nav-top img{margin-right:12px;height:45px;width:45px;background-color:#2980b9;padding:5px;border-radius:100%}.wy-nav-top i{font-size:30px;float:left;cursor:pointer;padding-top:inherit}.wy-nav-content-wrap{margin-left:300px;background:#fcfcfc;min-height:100%}.wy-nav-content{padding:1.618em 3.236em;height:100%;max-width:800px;margin:auto}.wy-body-mask{position:fixed;width:100%;height:100%;background:rgba(0,0,0,.2);display:none;z-index:499}.wy-body-mask.on{display:block}footer{color:grey}footer p{margin-bottom:12px}.rst-content footer span.commit tt,footer span.commit .rst-content tt,footer span.commit code{padding:0;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;font-size:1em;background:none;border:none;color:grey}.rst-footer-buttons{*zoom:1}.rst-footer-buttons:after,.rst-footer-buttons:before{width:100%;display:table;content:""}.rst-footer-buttons:after{clear:both}.rst-breadcrumbs-buttons{margin-top:12px;*zoom:1}.rst-breadcrumbs-buttons:after,.rst-breadcrumbs-buttons:before{display:table;content:""}.rst-breadcrumbs-buttons:after{clear:both}#search-results .search li{margin-bottom:24px;border-bottom:1px solid #e1e4e5;padding-bottom:24px}#search-results .search li:first-child{border-top:1px solid #e1e4e5;padding-top:24px}#search-results .search li a{font-size:120%;margin-bottom:12px;display:inline-block}#search-results .context{color:grey;font-size:90%}.genindextable li>ul{margin-left:24px}@media screen and (max-width:768px){.wy-body-for-nav{background:#fcfcfc}.wy-nav-top{display:block}.wy-nav-side{left:-300px}.wy-nav-side.shift{width:85%;left:0}.wy-menu.wy-menu-vertical,.wy-side-nav-search,.wy-side-scroll{width:auto}.wy-nav-content-wrap{margin-left:0}.wy-nav-content-wrap .wy-nav-content{padding:1.618em}.wy-nav-content-wrap.shift{position:fixed;min-width:100%;left:85%;top:0;height:100%;overflow:hidden}}@media screen and (min-width:1100px){.wy-nav-content-wrap{background:rgba(0,0,0,.05)}.wy-nav-content{margin:0;background:#fcfcfc}}@media print{.rst-versions,.wy-nav-side,footer{display:none}.wy-nav-content-wrap{margin-left:0}}.rst-versions{position:fixed;bottom:0;left:0;width:300px;color:#fcfcfc;background:#1f1d1d;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;z-index:400}.rst-versions a{color:#2980b9;text-decoration:none}.rst-versions .rst-badge-small{display:none}.rst-versions .rst-current-version{padding:12px;background-color:#272525;display:block;text-align:right;font-size:90%;cursor:pointer;color:#27ae60;*zoom:1}.rst-versions .rst-current-version:after,.rst-versions .rst-current-version:before{display:table;content:""}.rst-versions .rst-current-version:after{clear:both}.rst-content .code-block-caption .rst-versions .rst-current-version .headerlink,.rst-content .rst-versions .rst-current-version .admonition-title,.rst-content code.download .rst-versions .rst-current-version span:first-child,.rst-content dl dt .rst-versions .rst-current-version .headerlink,.rst-content h1 .rst-versions .rst-current-version .headerlink,.rst-content h2 .rst-versions .rst-current-version .headerlink,.rst-content h3 .rst-versions .rst-current-version .headerlink,.rst-content h4 .rst-versions .rst-current-version .headerlink,.rst-content h5 .rst-versions .rst-current-version .headerlink,.rst-content h6 .rst-versions .rst-current-version .headerlink,.rst-content p.caption .rst-versions .rst-current-version .headerlink,.rst-content table>caption .rst-versions .rst-current-version .headerlink,.rst-content tt.download .rst-versions .rst-current-version span:first-child,.rst-versions .rst-current-version .fa,.rst-versions .rst-current-version .icon,.rst-versions .rst-current-version .rst-content .admonition-title,.rst-versions .rst-current-version .rst-content .code-block-caption .headerlink,.rst-versions .rst-current-version .rst-content code.download span:first-child,.rst-versions .rst-current-version .rst-content dl dt .headerlink,.rst-versions .rst-current-version .rst-content h1 .headerlink,.rst-versions .rst-current-version .rst-content h2 .headerlink,.rst-versions .rst-current-version .rst-content h3 .headerlink,.rst-versions .rst-current-version .rst-content h4 .headerlink,.rst-versions .rst-current-version .rst-content h5 .headerlink,.rst-versions .rst-current-version .rst-content h6 .headerlink,.rst-versions .rst-current-version .rst-content p.caption .headerlink,.rst-versions .rst-current-version .rst-content table>caption .headerlink,.rst-versions .rst-current-version .rst-content tt.download span:first-child,.rst-versions .rst-current-version .wy-menu-vertical li span.toctree-expand,.wy-menu-vertical li .rst-versions .rst-current-version span.toctree-expand{color:#fcfcfc}.rst-versions .rst-current-version .fa-book,.rst-versions .rst-current-version .icon-book{float:left}.rst-versions .rst-current-version.rst-out-of-date{background-color:#e74c3c;color:#fff}.rst-versions .rst-current-version.rst-active-old-version{background-color:#f1c40f;color:#000}.rst-versions.shift-up{height:auto;max-height:100%;overflow-y:scroll}.rst-versions.shift-up .rst-other-versions{display:block}.rst-versions .rst-other-versions{font-size:90%;padding:12px;color:grey;display:none}.rst-versions .rst-other-versions hr{display:block;height:1px;border:0;margin:20px 0;padding:0;border-top:1px solid #413d3d}.rst-versions .rst-other-versions dd{display:inline-block;margin:0}.rst-versions .rst-other-versions dd a{display:inline-block;padding:6px;color:#fcfcfc}.rst-versions.rst-badge{width:auto;bottom:20px;right:20px;left:auto;border:none;max-width:300px;max-height:90%}.rst-versions.rst-badge .fa-book,.rst-versions.rst-badge .icon-book{float:none;line-height:30px}.rst-versions.rst-badge.shift-up .rst-current-version{text-align:right}.rst-versions.rst-badge.shift-up .rst-current-version .fa-book,.rst-versions.rst-badge.shift-up .rst-current-version .icon-book{float:left}.rst-versions.rst-badge>.rst-current-version{width:auto;height:30px;line-height:30px;padding:0 6px;display:block;text-align:center}@media screen and (max-width:768px){.rst-versions{width:85%;display:none}.rst-versions.shift{display:block}}.rst-content img{max-width:100%;height:auto}.rst-content div.figure{margin-bottom:24px}.rst-content div.figure p.caption{font-style:italic}.rst-content div.figure p:last-child.caption{margin-bottom:0}.rst-content div.figure.align-center{text-align:center}.rst-content .section>a>img,.rst-content .section>img{margin-bottom:24px}.rst-content abbr[title]{text-decoration:none}.rst-content.style-external-links a.reference.external:after{font-family:FontAwesome;content:"\f08e";color:#b3b3b3;vertical-align:super;font-size:60%;margin:0 .2em}.rst-content blockquote{margin-left:24px;line-height:24px;margin-bottom:24px}.rst-content pre.literal-block{white-space:pre;margin:0;padding:12px;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;display:block;overflow:auto}.rst-content div[class^=highlight],.rst-content pre.literal-block{border:1px solid #e1e4e5;overflow-x:auto;margin:1px 0 24px}.rst-content div[class^=highlight] div[class^=highlight],.rst-content pre.literal-block div[class^=highlight]{padding:0;border:none;margin:0}.rst-content div[class^=highlight] td.code{width:100%}.rst-content .linenodiv pre{border-right:1px solid #e6e9ea;margin:0;padding:12px;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;user-select:none;pointer-events:none}.rst-content div[class^=highlight] pre{white-space:pre;margin:0;padding:12px;display:block;overflow:auto}.rst-content div[class^=highlight] pre .hll{display:block;margin:0 -12px;padding:0 12px}.rst-content .linenodiv pre,.rst-content div[class^=highlight] pre,.rst-content pre.literal-block{font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;font-size:12px;line-height:1.4}.rst-content div.highlight .gp{user-select:none;pointer-events:none}.rst-content .code-block-caption{font-style:italic;font-size:85%;line-height:1;padding:1em 0;text-align:center}@media print{.rst-content .codeblock,.rst-content div[class^=highlight],.rst-content div[class^=highlight] pre{white-space:pre-wrap}}.rst-content .admonition,.rst-content .admonition-todo,.rst-content .attention,.rst-content .caution,.rst-content .danger,.rst-content .error,.rst-content .hint,.rst-content .important,.rst-content .note,.rst-content .seealso,.rst-content .tip,.rst-content .warning{clear:both}.rst-content .admonition-todo .last,.rst-content .admonition-todo>:last-child,.rst-content .admonition .last,.rst-content .admonition>:last-child,.rst-content .attention .last,.rst-content .attention>:last-child,.rst-content .caution .last,.rst-content .caution>:last-child,.rst-content .danger .last,.rst-content .danger>:last-child,.rst-content .error .last,.rst-content .error>:last-child,.rst-content .hint .last,.rst-content .hint>:last-child,.rst-content .important .last,.rst-content .important>:last-child,.rst-content .note .last,.rst-content .note>:last-child,.rst-content .seealso .last,.rst-content .seealso>:last-child,.rst-content .tip .last,.rst-content .tip>:last-child,.rst-content .warning .last,.rst-content .warning>:last-child{margin-bottom:0}.rst-content .admonition-title:before{margin-right:4px}.rst-content .admonition table{border-color:rgba(0,0,0,.1)}.rst-content .admonition table td,.rst-content .admonition table th{background:transparent!important;border-color:rgba(0,0,0,.1)!important}.rst-content .section ol.loweralpha,.rst-content .section ol.loweralpha>li{list-style:lower-alpha}.rst-content .section ol.upperalpha,.rst-content .section ol.upperalpha>li{list-style:upper-alpha}.rst-content .section ol li>*,.rst-content .section ul li>*{margin-top:12px;margin-bottom:12px}.rst-content .section ol li>:first-child,.rst-content .section ul li>:first-child{margin-top:0}.rst-content .section ol li>p,.rst-content .section ol li>p:last-child,.rst-content .section ul li>p,.rst-content .section ul li>p:last-child{margin-bottom:12px}.rst-content .section ol li>p:only-child,.rst-content .section ol li>p:only-child:last-child,.rst-content .section ul li>p:only-child,.rst-content .section ul li>p:only-child:last-child{margin-bottom:0}.rst-content .section ol li>ol,.rst-content .section ol li>ul,.rst-content .section ul li>ol,.rst-content .section ul li>ul{margin-bottom:12px}.rst-content .section ol.simple li>*,.rst-content .section ol.simple li ol,.rst-content .section ol.simple li ul,.rst-content .section ul.simple li>*,.rst-content .section ul.simple li ol,.rst-content .section ul.simple li ul{margin-top:0;margin-bottom:0}.rst-content .line-block{margin-left:0;margin-bottom:24px;line-height:24px}.rst-content .line-block .line-block{margin-left:24px;margin-bottom:0}.rst-content .topic-title{font-weight:700;margin-bottom:12px}.rst-content .toc-backref{color:#404040}.rst-content .align-right{float:right;margin:0 0 24px 24px}.rst-content .align-left{float:left;margin:0 24px 24px 0}.rst-content .align-center{margin:auto}.rst-content .align-center:not(table){display:block}.rst-content .code-block-caption .headerlink,.rst-content .toctree-wrapper>p.caption .headerlink,.rst-content dl dt .headerlink,.rst-content h1 .headerlink,.rst-content h2 .headerlink,.rst-content h3 .headerlink,.rst-content h4 .headerlink,.rst-content h5 .headerlink,.rst-content h6 .headerlink,.rst-content p.caption .headerlink,.rst-content table>caption .headerlink{visibility:hidden;font-size:14px}.rst-content .code-block-caption .headerlink:after,.rst-content .toctree-wrapper>p.caption .headerlink:after,.rst-content dl dt .headerlink:after,.rst-content h1 .headerlink:after,.rst-content h2 .headerlink:after,.rst-content h3 .headerlink:after,.rst-content h4 .headerlink:after,.rst-content h5 .headerlink:after,.rst-content h6 .headerlink:after,.rst-content p.caption .headerlink:after,.rst-content table>caption .headerlink:after{content:"\f0c1";font-family:FontAwesome}.rst-content .code-block-caption:hover .headerlink:after,.rst-content .toctree-wrapper>p.caption:hover .headerlink:after,.rst-content dl dt:hover .headerlink:after,.rst-content h1:hover .headerlink:after,.rst-content h2:hover .headerlink:after,.rst-content h3:hover .headerlink:after,.rst-content h4:hover .headerlink:after,.rst-content h5:hover .headerlink:after,.rst-content h6:hover .headerlink:after,.rst-content p.caption:hover .headerlink:after,.rst-content table>caption:hover .headerlink:after{visibility:visible}.rst-content table>caption .headerlink:after{font-size:12px}.rst-content .centered{text-align:center}.rst-content .sidebar{float:right;width:40%;display:block;margin:0 0 24px 24px;padding:24px;background:#f3f6f6;border:1px solid #e1e4e5}.rst-content .sidebar dl,.rst-content .sidebar p,.rst-content .sidebar ul{font-size:90%}.rst-content .sidebar .last,.rst-content .sidebar>:last-child{margin-bottom:0}.rst-content .sidebar .sidebar-title{display:block;font-family:Roboto Slab,ff-tisa-web-pro,Georgia,Arial,sans-serif;font-weight:700;background:#e1e4e5;padding:6px 12px;margin:-24px -24px 24px;font-size:100%}.rst-content .highlighted{background:#f1c40f;box-shadow:0 0 0 2px #f1c40f;display:inline;font-weight:700}.rst-content .citation-reference,.rst-content .footnote-reference{vertical-align:baseline;position:relative;top:-.4em;line-height:0;font-size:90%}.rst-content .hlist{width:100%}html.writer-html4 .rst-content table.docutils.citation,html.writer-html4 .rst-content table.docutils.footnote{background:none;border:none}html.writer-html4 .rst-content table.docutils.citation td,html.writer-html4 .rst-content table.docutils.citation tr,html.writer-html4 .rst-content table.docutils.footnote td,html.writer-html4 .rst-content table.docutils.footnote tr{border:none;background-color:transparent!important;white-space:normal}html.writer-html4 .rst-content table.docutils.citation td.label,html.writer-html4 .rst-content table.docutils.footnote td.label{padding-left:0;padding-right:0;vertical-align:top}html.writer-html5 .rst-content dl dt span.classifier:before{content:" : "}html.writer-html5 .rst-content dl.field-list,html.writer-html5 .rst-content dl.footnote{display:grid;grid-template-columns:max-content auto}html.writer-html5 .rst-content dl.field-list>dt,html.writer-html5 .rst-content dl.footnote>dt{padding-left:1rem}html.writer-html5 .rst-content dl.field-list>dt:after,html.writer-html5 .rst-content dl.footnote>dt:after{content:":"}html.writer-html5 .rst-content dl.field-list>dd,html.writer-html5 .rst-content dl.field-list>dt,html.writer-html5 .rst-content dl.footnote>dd,html.writer-html5 .rst-content dl.footnote>dt{margin-bottom:0}html.writer-html5 .rst-content dl.footnote{font-size:.9rem}html.writer-html5 .rst-content dl.footnote>dt{margin:0 .5rem .5rem 0;line-height:1.2rem;word-break:break-all;font-weight:400}html.writer-html5 .rst-content dl.footnote>dt>span.brackets{margin-right:.5rem}html.writer-html5 .rst-content dl.footnote>dt>span.brackets:before{content:"["}html.writer-html5 .rst-content dl.footnote>dt>span.brackets:after{content:"]"}html.writer-html5 .rst-content dl.footnote>dt>span.fn-backref{font-style:italic}html.writer-html5 .rst-content dl.footnote>dd{margin:0 0 .5rem;line-height:1.2rem}html.writer-html5 .rst-content dl.footnote>dd p,html.writer-html5 .rst-content dl.option-list kbd{font-size:.9rem}.rst-content table.docutils.footnote,html.writer-html4 .rst-content table.docutils.citation,html.writer-html5 .rst-content dl.footnote{color:grey}.rst-content table.docutils.footnote code,.rst-content table.docutils.footnote tt,html.writer-html4 .rst-content table.docutils.citation code,html.writer-html4 .rst-content table.docutils.citation tt,html.writer-html5 .rst-content dl.footnote code,html.writer-html5 .rst-content dl.footnote tt{color:#555}.rst-content .wy-table-responsive.citation,.rst-content .wy-table-responsive.footnote{margin-bottom:0}.rst-content .wy-table-responsive.citation+:not(.citation),.rst-content .wy-table-responsive.footnote+:not(.footnote){margin-top:24px}.rst-content .wy-table-responsive.citation:last-child,.rst-content .wy-table-responsive.footnote:last-child{margin-bottom:24px}.rst-content table.docutils th{border-color:#e1e4e5}html.writer-html5 .rst-content table.docutils th{border:1px solid #e1e4e5}html.writer-html5 .rst-content table.docutils td>p,html.writer-html5 .rst-content table.docutils th>p{line-height:1rem;margin-bottom:0;font-size:.9rem}.rst-content table.docutils td .last,.rst-content table.docutils td .last>:last-child{margin-bottom:0}.rst-content table.field-list,.rst-content table.field-list td{border:none}.rst-content table.field-list td p{font-size:inherit;line-height:inherit}.rst-content table.field-list td>strong{display:inline-block}.rst-content table.field-list .field-name{padding-right:10px;text-align:left;white-space:nowrap}.rst-content table.field-list .field-body{text-align:left}.rst-content code,.rst-content tt{color:#000;font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace;padding:2px 5px}.rst-content code big,.rst-content code em,.rst-content tt big,.rst-content tt em{font-size:100%!important;line-height:normal}.rst-content code.literal,.rst-content tt.literal{color:#e74c3c}.rst-content code.xref,.rst-content tt.xref,a .rst-content code,a .rst-content tt{font-weight:700;color:#404040}.rst-content kbd,.rst-content pre,.rst-content samp{font-family:SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,Courier,monospace}.rst-content a code,.rst-content a tt{color:#2980b9}.rst-content dl{margin-bottom:24px}.rst-content dl dt{font-weight:700;margin-bottom:12px}.rst-content dl ol,.rst-content dl p,.rst-content dl table,.rst-content dl ul{margin-bottom:12px}.rst-content dl dd{margin:0 0 12px 24px;line-height:24px}html.writer-html4 .rst-content dl:not(.docutils),html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple){margin-bottom:24px}html.writer-html4 .rst-content dl:not(.docutils)>dt,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple)>dt{display:table;margin:6px 0;font-size:90%;line-height:normal;background:#e7f2fa;color:#2980b9;border-top:3px solid #6ab0de;padding:6px;position:relative}html.writer-html4 .rst-content dl:not(.docutils)>dt:before,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple)>dt:before{color:#6ab0de}html.writer-html4 .rst-content dl:not(.docutils)>dt .headerlink,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple)>dt .headerlink{color:#404040;font-size:100%!important}html.writer-html4 .rst-content dl:not(.docutils) dl:not(.field-list)>dt,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) dl:not(.field-list)>dt{margin-bottom:6px;border:none;border-left:3px solid #ccc;background:#f0f0f0;color:#555}html.writer-html4 .rst-content dl:not(.docutils) dl:not(.field-list)>dt .headerlink,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) dl:not(.field-list)>dt .headerlink{color:#404040;font-size:100%!important}html.writer-html4 .rst-content dl:not(.docutils)>dt:first-child,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple)>dt:first-child{margin-top:0}html.writer-html4 .rst-content dl:not(.docutils) code,html.writer-html4 .rst-content dl:not(.docutils) tt,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) code,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) tt{font-weight:700}html.writer-html4 .rst-content dl:not(.docutils) code.descclassname,html.writer-html4 .rst-content dl:not(.docutils) code.descname,html.writer-html4 .rst-content dl:not(.docutils) tt.descclassname,html.writer-html4 .rst-content dl:not(.docutils) tt.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) code.descclassname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) code.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) tt.descclassname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) tt.descname{background-color:transparent;border:none;padding:0;font-size:100%!important}html.writer-html4 .rst-content dl:not(.docutils) code.descname,html.writer-html4 .rst-content dl:not(.docutils) tt.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) code.descname,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) tt.descname{font-weight:700}html.writer-html4 .rst-content dl:not(.docutils) .optional,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) .optional{display:inline-block;padding:0 4px;color:#000;font-weight:700}html.writer-html4 .rst-content dl:not(.docutils) .property,html.writer-html5 .rst-content dl[class]:not(.option-list):not(.field-list):not(.footnote):not(.glossary):not(.simple) .property{display:inline-block;padding-right:8px}.rst-content .viewcode-back,.rst-content .viewcode-link{display:inline-block;color:#27ae60;font-size:80%;padding-left:24px}.rst-content .viewcode-back{display:block;float:right}.rst-content p.rubric{margin-bottom:12px;font-weight:700}.rst-content code.download,.rst-content tt.download{background:inherit;padding:inherit;font-weight:400;font-family:inherit;font-size:inherit;color:inherit;border:inherit;white-space:inherit}.rst-content code.download span:first-child,.rst-content tt.download span:first-child{-webkit-font-smoothing:subpixel-antialiased}.rst-content code.download span:first-child:before,.rst-content tt.download span:first-child:before{margin-right:4px}.rst-content .guilabel{border:1px solid #7fbbe3;background:#e7f2fa;font-size:80%;font-weight:700;border-radius:4px;padding:2.4px 6px;margin:auto 2px}.rst-content .versionmodified{font-style:italic}@media screen and (max-width:480px){.rst-content .sidebar{width:100%}}span[id*=MathJax-Span]{color:#404040}.math{text-align:center}@font-face{font-family:Lato;src:url(fonts/lato-normal.woff2?bd03a2cc277bbbc338d464e679fe9942) format("woff2"),url(fonts/lato-normal.woff?27bd77b9162d388cb8d4c4217c7c5e2a) format("woff");font-weight:400;font-style:normal;font-display:block}@font-face{font-family:Lato;src:url(fonts/lato-bold.woff2?cccb897485813c7c256901dbca54ecf2) format("woff2"),url(fonts/lato-bold.woff?d878b6c29b10beca227e9eef4246111b) format("woff");font-weight:700;font-style:normal;font-display:block}@font-face{font-family:Lato;src:url(fonts/lato-bold-italic.woff2?0b6bb6725576b072c5d0b02ecdd1900d) format("woff2"),url(fonts/lato-bold-italic.woff?9c7e4e9eb485b4a121c760e61bc3707c) format("woff");font-weight:700;font-style:italic;font-display:block}@font-face{font-family:Lato;src:url(fonts/lato-normal-italic.woff2?4eb103b4d12be57cb1d040ed5e162e9d) format("woff2"),url(fonts/lato-normal-italic.woff?f28f2d6482446544ef1ea1ccc6dd5892) format("woff");font-weight:400;font-style:italic;font-display:block}@font-face{font-family:Roboto Slab;font-style:normal;font-weight:400;src:url(fonts/Roboto-Slab-Regular.woff2?7abf5b8d04d26a2cafea937019bca958) format("woff2"),url(fonts/Roboto-Slab-Regular.woff?c1be9284088d487c5e3ff0a10a92e58c) format("woff");font-display:block}@font-face{font-family:Roboto Slab;font-style:normal;font-weight:700;src:url(fonts/Roboto-Slab-Bold.woff2?9984f4a9bda09be08e83f2506954adbe) format("woff2"),url(fonts/Roboto-Slab-Bold.woff?bed5564a116b05148e3b3bea6fb1162a) format("woff");font-display:block} \ No newline at end of file diff --git a/ophyd/_static/doctools.js b/ophyd/_static/doctools.js deleted file mode 100644 index 0c15c0099b..0000000000 --- a/ophyd/_static/doctools.js +++ /dev/null @@ -1,311 +0,0 @@ -/* - * doctools.js - * ~~~~~~~~~~~ - * - * Sphinx JavaScript utilities for all documentation. - * - * :copyright: Copyright 2007-2018 by the Sphinx team, see AUTHORS. - * :license: BSD, see LICENSE for details. - * - */ - -/** - * select a different prefix for underscore - */ -$u = _.noConflict(); - -/** - * make the code below compatible with browsers without - * an installed firebug like debugger -if (!window.console || !console.firebug) { - var names = ["log", "debug", "info", "warn", "error", "assert", "dir", - "dirxml", "group", "groupEnd", "time", "timeEnd", "count", "trace", - "profile", "profileEnd"]; - window.console = {}; - for (var i = 0; i < names.length; ++i) - window.console[names[i]] = function() {}; -} - */ - -/** - * small helper function to urldecode strings - */ -jQuery.urldecode = function(x) { - return decodeURIComponent(x).replace(/\+/g, ' '); -}; - -/** - * small helper function to urlencode strings - */ -jQuery.urlencode = encodeURIComponent; - -/** - * This function returns the parsed url parameters of the - * current request. Multiple values per key are supported, - * it will always return arrays of strings for the value parts. - */ -jQuery.getQueryParameters = function(s) { - if (typeof s === 'undefined') - s = document.location.search; - var parts = s.substr(s.indexOf('?') + 1).split('&'); - var result = {}; - for (var i = 0; i < parts.length; i++) { - var tmp = parts[i].split('=', 2); - var key = jQuery.urldecode(tmp[0]); - var value = jQuery.urldecode(tmp[1]); - if (key in result) - result[key].push(value); - else - result[key] = [value]; - } - return result; -}; - -/** - * highlight a given string on a jquery object by wrapping it in - * span elements with the given class name. - */ -jQuery.fn.highlightText = function(text, className) { - function highlight(node, addItems) { - if (node.nodeType === 3) { - var val = node.nodeValue; - var pos = val.toLowerCase().indexOf(text); - if (pos >= 0 && !jQuery(node.parentNode).hasClass(className)) { - var span; - var isInSVG = jQuery(node).closest("body, svg, foreignObject").is("svg"); - if (isInSVG) { - span = document.createElementNS("http://www.w3.org/2000/svg", "tspan"); - } else { - span = document.createElement("span"); - span.className = className; - } - span.appendChild(document.createTextNode(val.substr(pos, text.length))); - node.parentNode.insertBefore(span, node.parentNode.insertBefore( - document.createTextNode(val.substr(pos + text.length)), - node.nextSibling)); - node.nodeValue = val.substr(0, pos); - if (isInSVG) { - var bbox = span.getBBox(); - var rect = document.createElementNS("http://www.w3.org/2000/svg", "rect"); - rect.x.baseVal.value = bbox.x; - rect.y.baseVal.value = bbox.y; - rect.width.baseVal.value = bbox.width; - rect.height.baseVal.value = bbox.height; - rect.setAttribute('class', className); - var parentOfText = node.parentNode.parentNode; - addItems.push({ - "parent": node.parentNode, - "target": rect}); - } - } - } - else if (!jQuery(node).is("button, select, textarea")) { - jQuery.each(node.childNodes, function() { - highlight(this, addItems); - }); - } - } - var addItems = []; - var result = this.each(function() { - highlight(this, addItems); - }); - for (var i = 0; i < addItems.length; ++i) { - jQuery(addItems[i].parent).before(addItems[i].target); - } - return result; -}; - -/* - * backward compatibility for jQuery.browser - * This will be supported until firefox bug is fixed. - */ -if (!jQuery.browser) { - jQuery.uaMatch = function(ua) { - ua = ua.toLowerCase(); - - var match = /(chrome)[ \/]([\w.]+)/.exec(ua) || - /(webkit)[ \/]([\w.]+)/.exec(ua) || - /(opera)(?:.*version|)[ \/]([\w.]+)/.exec(ua) || - /(msie) ([\w.]+)/.exec(ua) || - ua.indexOf("compatible") < 0 && /(mozilla)(?:.*? rv:([\w.]+)|)/.exec(ua) || - []; - - return { - browser: match[ 1 ] || "", - version: match[ 2 ] || "0" - }; - }; - jQuery.browser = {}; - jQuery.browser[jQuery.uaMatch(navigator.userAgent).browser] = true; -} - -/** - * Small JavaScript module for the documentation. - */ -var Documentation = { - - init : function() { - this.fixFirefoxAnchorBug(); - this.highlightSearchWords(); - this.initIndexTable(); - - }, - - /** - * i18n support - */ - TRANSLATIONS : {}, - PLURAL_EXPR : function(n) { return n === 1 ? 0 : 1; }, - LOCALE : 'unknown', - - // gettext and ngettext don't access this so that the functions - // can safely bound to a different name (_ = Documentation.gettext) - gettext : function(string) { - var translated = Documentation.TRANSLATIONS[string]; - if (typeof translated === 'undefined') - return string; - return (typeof translated === 'string') ? translated : translated[0]; - }, - - ngettext : function(singular, plural, n) { - var translated = Documentation.TRANSLATIONS[singular]; - if (typeof translated === 'undefined') - return (n == 1) ? singular : plural; - return translated[Documentation.PLURALEXPR(n)]; - }, - - addTranslations : function(catalog) { - for (var key in catalog.messages) - this.TRANSLATIONS[key] = catalog.messages[key]; - this.PLURAL_EXPR = new Function('n', 'return +(' + catalog.plural_expr + ')'); - this.LOCALE = catalog.locale; - }, - - /** - * add context elements like header anchor links - */ - addContextElements : function() { - $('div[id] > :header:first').each(function() { - $('\u00B6'). - attr('href', '#' + this.id). - attr('title', _('Permalink to this headline')). - appendTo(this); - }); - $('dt[id]').each(function() { - $('\u00B6'). - attr('href', '#' + this.id). - attr('title', _('Permalink to this definition')). - appendTo(this); - }); - }, - - /** - * workaround a firefox stupidity - * see: https://bugzilla.mozilla.org/show_bug.cgi?id=645075 - */ - fixFirefoxAnchorBug : function() { - if (document.location.hash && $.browser.mozilla) - window.setTimeout(function() { - document.location.href += ''; - }, 10); - }, - - /** - * highlight the search words provided in the url in the text - */ - highlightSearchWords : function() { - var params = $.getQueryParameters(); - var terms = (params.highlight) ? params.highlight[0].split(/\s+/) : []; - if (terms.length) { - var body = $('div.body'); - if (!body.length) { - body = $('body'); - } - window.setTimeout(function() { - $.each(terms, function() { - body.highlightText(this.toLowerCase(), 'highlighted'); - }); - }, 10); - $('') - .appendTo($('#searchbox')); - } - }, - - /** - * init the domain index toggle buttons - */ - initIndexTable : function() { - var togglers = $('img.toggler').click(function() { - var src = $(this).attr('src'); - var idnum = $(this).attr('id').substr(7); - $('tr.cg-' + idnum).toggle(); - if (src.substr(-9) === 'minus.png') - $(this).attr('src', src.substr(0, src.length-9) + 'plus.png'); - else - $(this).attr('src', src.substr(0, src.length-8) + 'minus.png'); - }).css('display', ''); - if (DOCUMENTATION_OPTIONS.COLLAPSE_INDEX) { - togglers.click(); - } - }, - - /** - * helper function to hide the search marks again - */ - hideSearchWords : function() { - $('#searchbox .highlight-link').fadeOut(300); - $('span.highlighted').removeClass('highlighted'); - }, - - /** - * make the url absolute - */ - makeURL : function(relativeURL) { - return DOCUMENTATION_OPTIONS.URL_ROOT + '/' + relativeURL; - }, - - /** - * get the current relative url - */ - getCurrentURL : function() { - var path = document.location.pathname; - var parts = path.split(/\//); - $.each(DOCUMENTATION_OPTIONS.URL_ROOT.split(/\//), function() { - if (this === '..') - parts.pop(); - }); - var url = parts.join('/'); - return path.substring(url.lastIndexOf('/') + 1, path.length - 1); - }, - - initOnKeyListeners: function() { - $(document).keyup(function(event) { - var activeElementType = document.activeElement.tagName; - // don't navigate when in search box or textarea - if (activeElementType !== 'TEXTAREA' && activeElementType !== 'INPUT' && activeElementType !== 'SELECT') { - switch (event.keyCode) { - case 37: // left - var prevHref = $('link[rel="prev"]').prop('href'); - if (prevHref) { - window.location.href = prevHref; - return false; - } - case 39: // right - var nextHref = $('link[rel="next"]').prop('href'); - if (nextHref) { - window.location.href = nextHref; - return false; - } - } - } - }); - } -}; - -// quick alias for translations -_ = Documentation.gettext; - -$(document).ready(function() { - Documentation.init(); -}); \ No newline at end of file diff --git a/ophyd/_static/documentation_options.js b/ophyd/_static/documentation_options.js deleted file mode 100644 index d0b0ed276b..0000000000 --- a/ophyd/_static/documentation_options.js +++ /dev/null @@ -1,9 +0,0 @@ -var DOCUMENTATION_OPTIONS = { - URL_ROOT: '', - VERSION: '', - LANGUAGE: 'None', - COLLAPSE_INDEX: false, - FILE_SUFFIX: '.html', - HAS_SOURCE: true, - SOURCELINK_SUFFIX: '.txt' -}; \ No newline at end of file diff --git a/ophyd/_static/down-pressed.png b/ophyd/_static/down-pressed.png deleted file mode 100644 index 5756c8cad8..0000000000 Binary files a/ophyd/_static/down-pressed.png and /dev/null differ diff --git a/ophyd/_static/down.png b/ophyd/_static/down.png deleted file mode 100644 index 1b3bdad2ce..0000000000 Binary files a/ophyd/_static/down.png and /dev/null differ diff --git a/ophyd/_static/file.png b/ophyd/_static/file.png deleted file mode 100644 index a858a410e4..0000000000 Binary files a/ophyd/_static/file.png and /dev/null differ diff --git a/ophyd/_static/fonts/FontAwesome.otf b/ophyd/_static/fonts/FontAwesome.otf deleted file mode 100644 index 401ec0f36e..0000000000 Binary files a/ophyd/_static/fonts/FontAwesome.otf and /dev/null differ diff --git a/ophyd/_static/fonts/Lato/lato-bold.eot b/ophyd/_static/fonts/Lato/lato-bold.eot deleted file mode 100644 index 3361183a41..0000000000 Binary files a/ophyd/_static/fonts/Lato/lato-bold.eot and /dev/null differ diff --git a/ophyd/_static/fonts/Lato/lato-bold.ttf b/ophyd/_static/fonts/Lato/lato-bold.ttf deleted file mode 100644 index 29f691d5ed..0000000000 Binary files a/ophyd/_static/fonts/Lato/lato-bold.ttf and /dev/null differ diff --git a/ophyd/_static/fonts/Lato/lato-bold.woff b/ophyd/_static/fonts/Lato/lato-bold.woff deleted file mode 100644 index c6dff51f06..0000000000 Binary files a/ophyd/_static/fonts/Lato/lato-bold.woff and /dev/null differ diff --git a/ophyd/_static/fonts/Lato/lato-bold.woff2 b/ophyd/_static/fonts/Lato/lato-bold.woff2 deleted file mode 100644 index bb195043cf..0000000000 Binary files a/ophyd/_static/fonts/Lato/lato-bold.woff2 and /dev/null differ diff --git a/ophyd/_static/fonts/Lato/lato-bolditalic.eot b/ophyd/_static/fonts/Lato/lato-bolditalic.eot deleted file mode 100644 index 3d4154936b..0000000000 Binary files a/ophyd/_static/fonts/Lato/lato-bolditalic.eot and /dev/null differ diff --git a/ophyd/_static/fonts/Lato/lato-bolditalic.ttf b/ophyd/_static/fonts/Lato/lato-bolditalic.ttf deleted file mode 100644 index f402040b3e..0000000000 Binary files a/ophyd/_static/fonts/Lato/lato-bolditalic.ttf and /dev/null differ diff --git a/ophyd/_static/fonts/Lato/lato-bolditalic.woff b/ophyd/_static/fonts/Lato/lato-bolditalic.woff deleted file mode 100644 index 88ad05b9ff..0000000000 Binary files a/ophyd/_static/fonts/Lato/lato-bolditalic.woff and /dev/null differ diff --git a/ophyd/_static/fonts/Lato/lato-bolditalic.woff2 b/ophyd/_static/fonts/Lato/lato-bolditalic.woff2 deleted file mode 100644 index c4e3d804b5..0000000000 Binary files a/ophyd/_static/fonts/Lato/lato-bolditalic.woff2 and /dev/null differ diff --git a/ophyd/_static/fonts/Lato/lato-italic.eot b/ophyd/_static/fonts/Lato/lato-italic.eot deleted file mode 100644 index 3f826421a1..0000000000 Binary files a/ophyd/_static/fonts/Lato/lato-italic.eot and /dev/null differ diff --git a/ophyd/_static/fonts/Lato/lato-italic.ttf b/ophyd/_static/fonts/Lato/lato-italic.ttf deleted file mode 100644 index b4bfc9b24a..0000000000 Binary files a/ophyd/_static/fonts/Lato/lato-italic.ttf and /dev/null differ diff --git a/ophyd/_static/fonts/Lato/lato-italic.woff b/ophyd/_static/fonts/Lato/lato-italic.woff deleted file mode 100644 index 76114bc033..0000000000 Binary files a/ophyd/_static/fonts/Lato/lato-italic.woff and /dev/null differ diff --git a/ophyd/_static/fonts/Lato/lato-italic.woff2 b/ophyd/_static/fonts/Lato/lato-italic.woff2 deleted file mode 100644 index 3404f37e2e..0000000000 Binary files a/ophyd/_static/fonts/Lato/lato-italic.woff2 and /dev/null differ diff --git a/ophyd/_static/fonts/Lato/lato-regular.eot b/ophyd/_static/fonts/Lato/lato-regular.eot deleted file mode 100644 index 11e3f2a5f0..0000000000 Binary files a/ophyd/_static/fonts/Lato/lato-regular.eot and /dev/null differ diff --git a/ophyd/_static/fonts/Lato/lato-regular.ttf b/ophyd/_static/fonts/Lato/lato-regular.ttf deleted file mode 100644 index 74decd9ebb..0000000000 Binary files a/ophyd/_static/fonts/Lato/lato-regular.ttf and /dev/null differ diff --git a/ophyd/_static/fonts/Lato/lato-regular.woff b/ophyd/_static/fonts/Lato/lato-regular.woff deleted file mode 100644 index ae1307ff5f..0000000000 Binary files a/ophyd/_static/fonts/Lato/lato-regular.woff and /dev/null differ diff --git a/ophyd/_static/fonts/Lato/lato-regular.woff2 b/ophyd/_static/fonts/Lato/lato-regular.woff2 deleted file mode 100644 index 3bf9843328..0000000000 Binary files a/ophyd/_static/fonts/Lato/lato-regular.woff2 and /dev/null differ diff --git a/ophyd/_static/fonts/Roboto-Slab-Bold.woff b/ophyd/_static/fonts/Roboto-Slab-Bold.woff deleted file mode 100644 index 6cb6000018..0000000000 Binary files a/ophyd/_static/fonts/Roboto-Slab-Bold.woff and /dev/null differ diff --git a/ophyd/_static/fonts/Roboto-Slab-Bold.woff2 b/ophyd/_static/fonts/Roboto-Slab-Bold.woff2 deleted file mode 100644 index 7059e23142..0000000000 Binary files a/ophyd/_static/fonts/Roboto-Slab-Bold.woff2 and /dev/null differ diff --git a/ophyd/_static/fonts/Roboto-Slab-Light.woff b/ophyd/_static/fonts/Roboto-Slab-Light.woff deleted file mode 100644 index 337d287116..0000000000 Binary files a/ophyd/_static/fonts/Roboto-Slab-Light.woff and /dev/null differ diff --git a/ophyd/_static/fonts/Roboto-Slab-Light.woff2 b/ophyd/_static/fonts/Roboto-Slab-Light.woff2 deleted file mode 100644 index 20398aff31..0000000000 Binary files a/ophyd/_static/fonts/Roboto-Slab-Light.woff2 and /dev/null differ diff --git a/ophyd/_static/fonts/Roboto-Slab-Regular.woff b/ophyd/_static/fonts/Roboto-Slab-Regular.woff deleted file mode 100644 index f815f63f99..0000000000 Binary files a/ophyd/_static/fonts/Roboto-Slab-Regular.woff and /dev/null differ diff --git a/ophyd/_static/fonts/Roboto-Slab-Regular.woff2 b/ophyd/_static/fonts/Roboto-Slab-Regular.woff2 deleted file mode 100644 index f2c76e5bda..0000000000 Binary files a/ophyd/_static/fonts/Roboto-Slab-Regular.woff2 and /dev/null differ diff --git a/ophyd/_static/fonts/Roboto-Slab-Thin.woff b/ophyd/_static/fonts/Roboto-Slab-Thin.woff deleted file mode 100644 index 6b30ea630d..0000000000 Binary files a/ophyd/_static/fonts/Roboto-Slab-Thin.woff and /dev/null differ diff --git a/ophyd/_static/fonts/Roboto-Slab-Thin.woff2 b/ophyd/_static/fonts/Roboto-Slab-Thin.woff2 deleted file mode 100644 index 328f5bb042..0000000000 Binary files a/ophyd/_static/fonts/Roboto-Slab-Thin.woff2 and /dev/null differ diff --git a/ophyd/_static/fonts/RobotoSlab/roboto-slab-v7-bold.eot b/ophyd/_static/fonts/RobotoSlab/roboto-slab-v7-bold.eot deleted file mode 100644 index 79dc8efed3..0000000000 Binary files a/ophyd/_static/fonts/RobotoSlab/roboto-slab-v7-bold.eot and /dev/null differ diff --git a/ophyd/_static/fonts/RobotoSlab/roboto-slab-v7-bold.ttf b/ophyd/_static/fonts/RobotoSlab/roboto-slab-v7-bold.ttf deleted file mode 100644 index df5d1df273..0000000000 Binary files a/ophyd/_static/fonts/RobotoSlab/roboto-slab-v7-bold.ttf and /dev/null differ diff --git a/ophyd/_static/fonts/RobotoSlab/roboto-slab-v7-bold.woff b/ophyd/_static/fonts/RobotoSlab/roboto-slab-v7-bold.woff deleted file mode 100644 index 6cb6000018..0000000000 Binary files a/ophyd/_static/fonts/RobotoSlab/roboto-slab-v7-bold.woff and /dev/null differ diff --git a/ophyd/_static/fonts/RobotoSlab/roboto-slab-v7-bold.woff2 b/ophyd/_static/fonts/RobotoSlab/roboto-slab-v7-bold.woff2 deleted file mode 100644 index 7059e23142..0000000000 Binary files a/ophyd/_static/fonts/RobotoSlab/roboto-slab-v7-bold.woff2 and /dev/null differ diff --git a/ophyd/_static/fonts/RobotoSlab/roboto-slab-v7-regular.eot b/ophyd/_static/fonts/RobotoSlab/roboto-slab-v7-regular.eot deleted file mode 100644 index 2f7ca78a1e..0000000000 Binary files a/ophyd/_static/fonts/RobotoSlab/roboto-slab-v7-regular.eot and /dev/null differ diff --git a/ophyd/_static/fonts/RobotoSlab/roboto-slab-v7-regular.ttf b/ophyd/_static/fonts/RobotoSlab/roboto-slab-v7-regular.ttf deleted file mode 100644 index eb52a79073..0000000000 Binary files a/ophyd/_static/fonts/RobotoSlab/roboto-slab-v7-regular.ttf and /dev/null differ diff --git a/ophyd/_static/fonts/RobotoSlab/roboto-slab-v7-regular.woff b/ophyd/_static/fonts/RobotoSlab/roboto-slab-v7-regular.woff deleted file mode 100644 index f815f63f99..0000000000 Binary files a/ophyd/_static/fonts/RobotoSlab/roboto-slab-v7-regular.woff and /dev/null differ diff --git a/ophyd/_static/fonts/RobotoSlab/roboto-slab-v7-regular.woff2 b/ophyd/_static/fonts/RobotoSlab/roboto-slab-v7-regular.woff2 deleted file mode 100644 index f2c76e5bda..0000000000 Binary files a/ophyd/_static/fonts/RobotoSlab/roboto-slab-v7-regular.woff2 and /dev/null differ diff --git a/ophyd/_static/fonts/fontawesome-webfont.eot b/ophyd/_static/fonts/fontawesome-webfont.eot deleted file mode 100644 index e9f60ca953..0000000000 Binary files a/ophyd/_static/fonts/fontawesome-webfont.eot and /dev/null differ diff --git a/ophyd/_static/fonts/fontawesome-webfont.svg b/ophyd/_static/fonts/fontawesome-webfont.svg deleted file mode 100644 index 855c845e53..0000000000 --- a/ophyd/_static/fonts/fontawesome-webfont.svg +++ /dev/null @@ -1,2671 +0,0 @@ - - - - -Created by FontForge 20120731 at Mon Oct 24 17:37:40 2016 - By ,,, -Copyright Dave Gandy 2016. All rights reserved. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/ophyd/_static/fonts/fontawesome-webfont.ttf b/ophyd/_static/fonts/fontawesome-webfont.ttf deleted file mode 100644 index 35acda2fa1..0000000000 Binary files a/ophyd/_static/fonts/fontawesome-webfont.ttf and /dev/null differ diff --git a/ophyd/_static/fonts/fontawesome-webfont.woff b/ophyd/_static/fonts/fontawesome-webfont.woff deleted file mode 100644 index 400014a4b0..0000000000 Binary files a/ophyd/_static/fonts/fontawesome-webfont.woff and /dev/null differ diff --git a/ophyd/_static/fonts/fontawesome-webfont.woff2 b/ophyd/_static/fonts/fontawesome-webfont.woff2 deleted file mode 100644 index 4d13fc6040..0000000000 Binary files a/ophyd/_static/fonts/fontawesome-webfont.woff2 and /dev/null differ diff --git a/ophyd/_static/fonts/lato-bold-italic.woff b/ophyd/_static/fonts/lato-bold-italic.woff deleted file mode 100644 index 88ad05b9ff..0000000000 Binary files a/ophyd/_static/fonts/lato-bold-italic.woff and /dev/null differ diff --git a/ophyd/_static/fonts/lato-bold-italic.woff2 b/ophyd/_static/fonts/lato-bold-italic.woff2 deleted file mode 100644 index c4e3d804b5..0000000000 Binary files a/ophyd/_static/fonts/lato-bold-italic.woff2 and /dev/null differ diff --git a/ophyd/_static/fonts/lato-bold.woff b/ophyd/_static/fonts/lato-bold.woff deleted file mode 100644 index c6dff51f06..0000000000 Binary files a/ophyd/_static/fonts/lato-bold.woff and /dev/null differ diff --git a/ophyd/_static/fonts/lato-bold.woff2 b/ophyd/_static/fonts/lato-bold.woff2 deleted file mode 100644 index bb195043cf..0000000000 Binary files a/ophyd/_static/fonts/lato-bold.woff2 and /dev/null differ diff --git a/ophyd/_static/fonts/lato-normal-italic.woff b/ophyd/_static/fonts/lato-normal-italic.woff deleted file mode 100644 index 76114bc033..0000000000 Binary files a/ophyd/_static/fonts/lato-normal-italic.woff and /dev/null differ diff --git a/ophyd/_static/fonts/lato-normal-italic.woff2 b/ophyd/_static/fonts/lato-normal-italic.woff2 deleted file mode 100644 index 3404f37e2e..0000000000 Binary files a/ophyd/_static/fonts/lato-normal-italic.woff2 and /dev/null differ diff --git a/ophyd/_static/fonts/lato-normal.woff b/ophyd/_static/fonts/lato-normal.woff deleted file mode 100644 index ae1307ff5f..0000000000 Binary files a/ophyd/_static/fonts/lato-normal.woff and /dev/null differ diff --git a/ophyd/_static/fonts/lato-normal.woff2 b/ophyd/_static/fonts/lato-normal.woff2 deleted file mode 100644 index 3bf9843328..0000000000 Binary files a/ophyd/_static/fonts/lato-normal.woff2 and /dev/null differ diff --git a/ophyd/_static/jquery-1.11.1.js b/ophyd/_static/jquery-1.11.1.js deleted file mode 100644 index d4b67f7e6c..0000000000 --- a/ophyd/_static/jquery-1.11.1.js +++ /dev/null @@ -1,10308 +0,0 @@ -/*! - * jQuery JavaScript Library v1.11.1 - * http://jquery.com/ - * - * Includes Sizzle.js - * http://sizzlejs.com/ - * - * Copyright 2005, 2014 jQuery Foundation, Inc. and other contributors - * Released under the MIT license - * http://jquery.org/license - * - * Date: 2014-05-01T17:42Z - */ - -(function( global, factory ) { - - if ( typeof module === "object" && typeof module.exports === "object" ) { - // For CommonJS and CommonJS-like environments where a proper window is present, - // execute the factory and get jQuery - // For environments that do not inherently posses a window with a document - // (such as Node.js), expose a jQuery-making factory as module.exports - // This accentuates the need for the creation of a real window - // e.g. var jQuery = require("jquery")(window); - // See ticket #14549 for more info - module.exports = global.document ? - factory( global, true ) : - function( w ) { - if ( !w.document ) { - throw new Error( "jQuery requires a window with a document" ); - } - return factory( w ); - }; - } else { - factory( global ); - } - -// Pass this if window is not defined yet -}(typeof window !== "undefined" ? window : this, function( window, noGlobal ) { - -// Can't do this because several apps including ASP.NET trace -// the stack via arguments.caller.callee and Firefox dies if -// you try to trace through "use strict" call chains. (#13335) -// Support: Firefox 18+ -// - -var deletedIds = []; - -var slice = deletedIds.slice; - -var concat = deletedIds.concat; - -var push = deletedIds.push; - -var indexOf = deletedIds.indexOf; - -var class2type = {}; - -var toString = class2type.toString; - -var hasOwn = class2type.hasOwnProperty; - -var support = {}; - - - -var - version = "1.11.1", - - // Define a local copy of jQuery - jQuery = function( selector, context ) { - // The jQuery object is actually just the init constructor 'enhanced' - // Need init if jQuery is called (just allow error to be thrown if not included) - return new jQuery.fn.init( selector, context ); - }, - - // Support: Android<4.1, IE<9 - // Make sure we trim BOM and NBSP - rtrim = /^[\s\uFEFF\xA0]+|[\s\uFEFF\xA0]+$/g, - - // Matches dashed string for camelizing - rmsPrefix = /^-ms-/, - rdashAlpha = /-([\da-z])/gi, - - // Used by jQuery.camelCase as callback to replace() - fcamelCase = function( all, letter ) { - return letter.toUpperCase(); - }; - -jQuery.fn = jQuery.prototype = { - // The current version of jQuery being used - jquery: version, - - constructor: jQuery, - - // Start with an empty selector - selector: "", - - // The default length of a jQuery object is 0 - length: 0, - - toArray: function() { - return slice.call( this ); - }, - - // Get the Nth element in the matched element set OR - // Get the whole matched element set as a clean array - get: function( num ) { - return num != null ? - - // Return just the one element from the set - ( num < 0 ? this[ num + this.length ] : this[ num ] ) : - - // Return all the elements in a clean array - slice.call( this ); - }, - - // Take an array of elements and push it onto the stack - // (returning the new matched element set) - pushStack: function( elems ) { - - // Build a new jQuery matched element set - var ret = jQuery.merge( this.constructor(), elems ); - - // Add the old object onto the stack (as a reference) - ret.prevObject = this; - ret.context = this.context; - - // Return the newly-formed element set - return ret; - }, - - // Execute a callback for every element in the matched set. - // (You can seed the arguments with an array of args, but this is - // only used internally.) - each: function( callback, args ) { - return jQuery.each( this, callback, args ); - }, - - map: function( callback ) { - return this.pushStack( jQuery.map(this, function( elem, i ) { - return callback.call( elem, i, elem ); - })); - }, - - slice: function() { - return this.pushStack( slice.apply( this, arguments ) ); - }, - - first: function() { - return this.eq( 0 ); - }, - - last: function() { - return this.eq( -1 ); - }, - - eq: function( i ) { - var len = this.length, - j = +i + ( i < 0 ? len : 0 ); - return this.pushStack( j >= 0 && j < len ? [ this[j] ] : [] ); - }, - - end: function() { - return this.prevObject || this.constructor(null); - }, - - // For internal use only. - // Behaves like an Array's method, not like a jQuery method. - push: push, - sort: deletedIds.sort, - splice: deletedIds.splice -}; - -jQuery.extend = jQuery.fn.extend = function() { - var src, copyIsArray, copy, name, options, clone, - target = arguments[0] || {}, - i = 1, - length = arguments.length, - deep = false; - - // Handle a deep copy situation - if ( typeof target === "boolean" ) { - deep = target; - - // skip the boolean and the target - target = arguments[ i ] || {}; - i++; - } - - // Handle case when target is a string or something (possible in deep copy) - if ( typeof target !== "object" && !jQuery.isFunction(target) ) { - target = {}; - } - - // extend jQuery itself if only one argument is passed - if ( i === length ) { - target = this; - i--; - } - - for ( ; i < length; i++ ) { - // Only deal with non-null/undefined values - if ( (options = arguments[ i ]) != null ) { - // Extend the base object - for ( name in options ) { - src = target[ name ]; - copy = options[ name ]; - - // Prevent never-ending loop - if ( target === copy ) { - continue; - } - - // Recurse if we're merging plain objects or arrays - if ( deep && copy && ( jQuery.isPlainObject(copy) || (copyIsArray = jQuery.isArray(copy)) ) ) { - if ( copyIsArray ) { - copyIsArray = false; - clone = src && jQuery.isArray(src) ? src : []; - - } else { - clone = src && jQuery.isPlainObject(src) ? src : {}; - } - - // Never move original objects, clone them - target[ name ] = jQuery.extend( deep, clone, copy ); - - // Don't bring in undefined values - } else if ( copy !== undefined ) { - target[ name ] = copy; - } - } - } - } - - // Return the modified object - return target; -}; - -jQuery.extend({ - // Unique for each copy of jQuery on the page - expando: "jQuery" + ( version + Math.random() ).replace( /\D/g, "" ), - - // Assume jQuery is ready without the ready module - isReady: true, - - error: function( msg ) { - throw new Error( msg ); - }, - - noop: function() {}, - - // See test/unit/core.js for details concerning isFunction. - // Since version 1.3, DOM methods and functions like alert - // aren't supported. They return false on IE (#2968). - isFunction: function( obj ) { - return jQuery.type(obj) === "function"; - }, - - isArray: Array.isArray || function( obj ) { - return jQuery.type(obj) === "array"; - }, - - isWindow: function( obj ) { - /* jshint eqeqeq: false */ - return obj != null && obj == obj.window; - }, - - isNumeric: function( obj ) { - // parseFloat NaNs numeric-cast false positives (null|true|false|"") - // ...but misinterprets leading-number strings, particularly hex literals ("0x...") - // subtraction forces infinities to NaN - return !jQuery.isArray( obj ) && obj - parseFloat( obj ) >= 0; - }, - - isEmptyObject: function( obj ) { - var name; - for ( name in obj ) { - return false; - } - return true; - }, - - isPlainObject: function( obj ) { - var key; - - // Must be an Object. - // Because of IE, we also have to check the presence of the constructor property. - // Make sure that DOM nodes and window objects don't pass through, as well - if ( !obj || jQuery.type(obj) !== "object" || obj.nodeType || jQuery.isWindow( obj ) ) { - return false; - } - - try { - // Not own constructor property must be Object - if ( obj.constructor && - !hasOwn.call(obj, "constructor") && - !hasOwn.call(obj.constructor.prototype, "isPrototypeOf") ) { - return false; - } - } catch ( e ) { - // IE8,9 Will throw exceptions on certain host objects #9897 - return false; - } - - // Support: IE<9 - // Handle iteration over inherited properties before own properties. - if ( support.ownLast ) { - for ( key in obj ) { - return hasOwn.call( obj, key ); - } - } - - // Own properties are enumerated firstly, so to speed up, - // if last one is own, then all properties are own. - for ( key in obj ) {} - - return key === undefined || hasOwn.call( obj, key ); - }, - - type: function( obj ) { - if ( obj == null ) { - return obj + ""; - } - return typeof obj === "object" || typeof obj === "function" ? - class2type[ toString.call(obj) ] || "object" : - typeof obj; - }, - - // Evaluates a script in a global context - // Workarounds based on findings by Jim Driscoll - // http://weblogs.java.net/blog/driscoll/archive/2009/09/08/eval-javascript-global-context - globalEval: function( data ) { - if ( data && jQuery.trim( data ) ) { - // We use execScript on Internet Explorer - // We use an anonymous function so that context is window - // rather than jQuery in Firefox - ( window.execScript || function( data ) { - window[ "eval" ].call( window, data ); - } )( data ); - } - }, - - // Convert dashed to camelCase; used by the css and data modules - // Microsoft forgot to hump their vendor prefix (#9572) - camelCase: function( string ) { - return string.replace( rmsPrefix, "ms-" ).replace( rdashAlpha, fcamelCase ); - }, - - nodeName: function( elem, name ) { - return elem.nodeName && elem.nodeName.toLowerCase() === name.toLowerCase(); - }, - - // args is for internal usage only - each: function( obj, callback, args ) { - var value, - i = 0, - length = obj.length, - isArray = isArraylike( obj ); - - if ( args ) { - if ( isArray ) { - for ( ; i < length; i++ ) { - value = callback.apply( obj[ i ], args ); - - if ( value === false ) { - break; - } - } - } else { - for ( i in obj ) { - value = callback.apply( obj[ i ], args ); - - if ( value === false ) { - break; - } - } - } - - // A special, fast, case for the most common use of each - } else { - if ( isArray ) { - for ( ; i < length; i++ ) { - value = callback.call( obj[ i ], i, obj[ i ] ); - - if ( value === false ) { - break; - } - } - } else { - for ( i in obj ) { - value = callback.call( obj[ i ], i, obj[ i ] ); - - if ( value === false ) { - break; - } - } - } - } - - return obj; - }, - - // Support: Android<4.1, IE<9 - trim: function( text ) { - return text == null ? - "" : - ( text + "" ).replace( rtrim, "" ); - }, - - // results is for internal usage only - makeArray: function( arr, results ) { - var ret = results || []; - - if ( arr != null ) { - if ( isArraylike( Object(arr) ) ) { - jQuery.merge( ret, - typeof arr === "string" ? - [ arr ] : arr - ); - } else { - push.call( ret, arr ); - } - } - - return ret; - }, - - inArray: function( elem, arr, i ) { - var len; - - if ( arr ) { - if ( indexOf ) { - return indexOf.call( arr, elem, i ); - } - - len = arr.length; - i = i ? i < 0 ? Math.max( 0, len + i ) : i : 0; - - for ( ; i < len; i++ ) { - // Skip accessing in sparse arrays - if ( i in arr && arr[ i ] === elem ) { - return i; - } - } - } - - return -1; - }, - - merge: function( first, second ) { - var len = +second.length, - j = 0, - i = first.length; - - while ( j < len ) { - first[ i++ ] = second[ j++ ]; - } - - // Support: IE<9 - // Workaround casting of .length to NaN on otherwise arraylike objects (e.g., NodeLists) - if ( len !== len ) { - while ( second[j] !== undefined ) { - first[ i++ ] = second[ j++ ]; - } - } - - first.length = i; - - return first; - }, - - grep: function( elems, callback, invert ) { - var callbackInverse, - matches = [], - i = 0, - length = elems.length, - callbackExpect = !invert; - - // Go through the array, only saving the items - // that pass the validator function - for ( ; i < length; i++ ) { - callbackInverse = !callback( elems[ i ], i ); - if ( callbackInverse !== callbackExpect ) { - matches.push( elems[ i ] ); - } - } - - return matches; - }, - - // arg is for internal usage only - map: function( elems, callback, arg ) { - var value, - i = 0, - length = elems.length, - isArray = isArraylike( elems ), - ret = []; - - // Go through the array, translating each of the items to their new values - if ( isArray ) { - for ( ; i < length; i++ ) { - value = callback( elems[ i ], i, arg ); - - if ( value != null ) { - ret.push( value ); - } - } - - // Go through every key on the object, - } else { - for ( i in elems ) { - value = callback( elems[ i ], i, arg ); - - if ( value != null ) { - ret.push( value ); - } - } - } - - // Flatten any nested arrays - return concat.apply( [], ret ); - }, - - // A global GUID counter for objects - guid: 1, - - // Bind a function to a context, optionally partially applying any - // arguments. - proxy: function( fn, context ) { - var args, proxy, tmp; - - if ( typeof context === "string" ) { - tmp = fn[ context ]; - context = fn; - fn = tmp; - } - - // Quick check to determine if target is callable, in the spec - // this throws a TypeError, but we will just return undefined. - if ( !jQuery.isFunction( fn ) ) { - return undefined; - } - - // Simulated bind - args = slice.call( arguments, 2 ); - proxy = function() { - return fn.apply( context || this, args.concat( slice.call( arguments ) ) ); - }; - - // Set the guid of unique handler to the same of original handler, so it can be removed - proxy.guid = fn.guid = fn.guid || jQuery.guid++; - - return proxy; - }, - - now: function() { - return +( new Date() ); - }, - - // jQuery.support is not used in Core but other projects attach their - // properties to it so it needs to exist. - support: support -}); - -// Populate the class2type map -jQuery.each("Boolean Number String Function Array Date RegExp Object Error".split(" "), function(i, name) { - class2type[ "[object " + name + "]" ] = name.toLowerCase(); -}); - -function isArraylike( obj ) { - var length = obj.length, - type = jQuery.type( obj ); - - if ( type === "function" || jQuery.isWindow( obj ) ) { - return false; - } - - if ( obj.nodeType === 1 && length ) { - return true; - } - - return type === "array" || length === 0 || - typeof length === "number" && length > 0 && ( length - 1 ) in obj; -} -var Sizzle = -/*! - * Sizzle CSS Selector Engine v1.10.19 - * http://sizzlejs.com/ - * - * Copyright 2013 jQuery Foundation, Inc. and other contributors - * Released under the MIT license - * http://jquery.org/license - * - * Date: 2014-04-18 - */ -(function( window ) { - -var i, - support, - Expr, - getText, - isXML, - tokenize, - compile, - select, - outermostContext, - sortInput, - hasDuplicate, - - // Local document vars - setDocument, - document, - docElem, - documentIsHTML, - rbuggyQSA, - rbuggyMatches, - matches, - contains, - - // Instance-specific data - expando = "sizzle" + -(new Date()), - preferredDoc = window.document, - dirruns = 0, - done = 0, - classCache = createCache(), - tokenCache = createCache(), - compilerCache = createCache(), - sortOrder = function( a, b ) { - if ( a === b ) { - hasDuplicate = true; - } - return 0; - }, - - // General-purpose constants - strundefined = typeof undefined, - MAX_NEGATIVE = 1 << 31, - - // Instance methods - hasOwn = ({}).hasOwnProperty, - arr = [], - pop = arr.pop, - push_native = arr.push, - push = arr.push, - slice = arr.slice, - // Use a stripped-down indexOf if we can't use a native one - indexOf = arr.indexOf || function( elem ) { - var i = 0, - len = this.length; - for ( ; i < len; i++ ) { - if ( this[i] === elem ) { - return i; - } - } - return -1; - }, - - booleans = "checked|selected|async|autofocus|autoplay|controls|defer|disabled|hidden|ismap|loop|multiple|open|readonly|required|scoped", - - // Regular expressions - - // Whitespace characters http://www.w3.org/TR/css3-selectors/#whitespace - whitespace = "[\\x20\\t\\r\\n\\f]", - // http://www.w3.org/TR/css3-syntax/#characters - characterEncoding = "(?:\\\\.|[\\w-]|[^\\x00-\\xa0])+", - - // Loosely modeled on CSS identifier characters - // An unquoted value should be a CSS identifier http://www.w3.org/TR/css3-selectors/#attribute-selectors - // Proper syntax: http://www.w3.org/TR/CSS21/syndata.html#value-def-identifier - identifier = characterEncoding.replace( "w", "w#" ), - - // Attribute selectors: http://www.w3.org/TR/selectors/#attribute-selectors - attributes = "\\[" + whitespace + "*(" + characterEncoding + ")(?:" + whitespace + - // Operator (capture 2) - "*([*^$|!~]?=)" + whitespace + - // "Attribute values must be CSS identifiers [capture 5] or strings [capture 3 or capture 4]" - "*(?:'((?:\\\\.|[^\\\\'])*)'|\"((?:\\\\.|[^\\\\\"])*)\"|(" + identifier + "))|)" + whitespace + - "*\\]", - - pseudos = ":(" + characterEncoding + ")(?:\\((" + - // To reduce the number of selectors needing tokenize in the preFilter, prefer arguments: - // 1. quoted (capture 3; capture 4 or capture 5) - "('((?:\\\\.|[^\\\\'])*)'|\"((?:\\\\.|[^\\\\\"])*)\")|" + - // 2. simple (capture 6) - "((?:\\\\.|[^\\\\()[\\]]|" + attributes + ")*)|" + - // 3. anything else (capture 2) - ".*" + - ")\\)|)", - - // Leading and non-escaped trailing whitespace, capturing some non-whitespace characters preceding the latter - rtrim = new RegExp( "^" + whitespace + "+|((?:^|[^\\\\])(?:\\\\.)*)" + whitespace + "+$", "g" ), - - rcomma = new RegExp( "^" + whitespace + "*," + whitespace + "*" ), - rcombinators = new RegExp( "^" + whitespace + "*([>+~]|" + whitespace + ")" + whitespace + "*" ), - - rattributeQuotes = new RegExp( "=" + whitespace + "*([^\\]'\"]*?)" + whitespace + "*\\]", "g" ), - - rpseudo = new RegExp( pseudos ), - ridentifier = new RegExp( "^" + identifier + "$" ), - - matchExpr = { - "ID": new RegExp( "^#(" + characterEncoding + ")" ), - "CLASS": new RegExp( "^\\.(" + characterEncoding + ")" ), - "TAG": new RegExp( "^(" + characterEncoding.replace( "w", "w*" ) + ")" ), - "ATTR": new RegExp( "^" + attributes ), - "PSEUDO": new RegExp( "^" + pseudos ), - "CHILD": new RegExp( "^:(only|first|last|nth|nth-last)-(child|of-type)(?:\\(" + whitespace + - "*(even|odd|(([+-]|)(\\d*)n|)" + whitespace + "*(?:([+-]|)" + whitespace + - "*(\\d+)|))" + whitespace + "*\\)|)", "i" ), - "bool": new RegExp( "^(?:" + booleans + ")$", "i" ), - // For use in libraries implementing .is() - // We use this for POS matching in `select` - "needsContext": new RegExp( "^" + whitespace + "*[>+~]|:(even|odd|eq|gt|lt|nth|first|last)(?:\\(" + - whitespace + "*((?:-\\d)?\\d*)" + whitespace + "*\\)|)(?=[^-]|$)", "i" ) - }, - - rinputs = /^(?:input|select|textarea|button)$/i, - rheader = /^h\d$/i, - - rnative = /^[^{]+\{\s*\[native \w/, - - // Easily-parseable/retrievable ID or TAG or CLASS selectors - rquickExpr = /^(?:#([\w-]+)|(\w+)|\.([\w-]+))$/, - - rsibling = /[+~]/, - rescape = /'|\\/g, - - // CSS escapes http://www.w3.org/TR/CSS21/syndata.html#escaped-characters - runescape = new RegExp( "\\\\([\\da-f]{1,6}" + whitespace + "?|(" + whitespace + ")|.)", "ig" ), - funescape = function( _, escaped, escapedWhitespace ) { - var high = "0x" + escaped - 0x10000; - // NaN means non-codepoint - // Support: Firefox<24 - // Workaround erroneous numeric interpretation of +"0x" - return high !== high || escapedWhitespace ? - escaped : - high < 0 ? - // BMP codepoint - String.fromCharCode( high + 0x10000 ) : - // Supplemental Plane codepoint (surrogate pair) - String.fromCharCode( high >> 10 | 0xD800, high & 0x3FF | 0xDC00 ); - }; - -// Optimize for push.apply( _, NodeList ) -try { - push.apply( - (arr = slice.call( preferredDoc.childNodes )), - preferredDoc.childNodes - ); - // Support: Android<4.0 - // Detect silently failing push.apply - arr[ preferredDoc.childNodes.length ].nodeType; -} catch ( e ) { - push = { apply: arr.length ? - - // Leverage slice if possible - function( target, els ) { - push_native.apply( target, slice.call(els) ); - } : - - // Support: IE<9 - // Otherwise append directly - function( target, els ) { - var j = target.length, - i = 0; - // Can't trust NodeList.length - while ( (target[j++] = els[i++]) ) {} - target.length = j - 1; - } - }; -} - -function Sizzle( selector, context, results, seed ) { - var match, elem, m, nodeType, - // QSA vars - i, groups, old, nid, newContext, newSelector; - - if ( ( context ? context.ownerDocument || context : preferredDoc ) !== document ) { - setDocument( context ); - } - - context = context || document; - results = results || []; - - if ( !selector || typeof selector !== "string" ) { - return results; - } - - if ( (nodeType = context.nodeType) !== 1 && nodeType !== 9 ) { - return []; - } - - if ( documentIsHTML && !seed ) { - - // Shortcuts - if ( (match = rquickExpr.exec( selector )) ) { - // Speed-up: Sizzle("#ID") - if ( (m = match[1]) ) { - if ( nodeType === 9 ) { - elem = context.getElementById( m ); - // Check parentNode to catch when Blackberry 4.6 returns - // nodes that are no longer in the document (jQuery #6963) - if ( elem && elem.parentNode ) { - // Handle the case where IE, Opera, and Webkit return items - // by name instead of ID - if ( elem.id === m ) { - results.push( elem ); - return results; - } - } else { - return results; - } - } else { - // Context is not a document - if ( context.ownerDocument && (elem = context.ownerDocument.getElementById( m )) && - contains( context, elem ) && elem.id === m ) { - results.push( elem ); - return results; - } - } - - // Speed-up: Sizzle("TAG") - } else if ( match[2] ) { - push.apply( results, context.getElementsByTagName( selector ) ); - return results; - - // Speed-up: Sizzle(".CLASS") - } else if ( (m = match[3]) && support.getElementsByClassName && context.getElementsByClassName ) { - push.apply( results, context.getElementsByClassName( m ) ); - return results; - } - } - - // QSA path - if ( support.qsa && (!rbuggyQSA || !rbuggyQSA.test( selector )) ) { - nid = old = expando; - newContext = context; - newSelector = nodeType === 9 && selector; - - // qSA works strangely on Element-rooted queries - // We can work around this by specifying an extra ID on the root - // and working up from there (Thanks to Andrew Dupont for the technique) - // IE 8 doesn't work on object elements - if ( nodeType === 1 && context.nodeName.toLowerCase() !== "object" ) { - groups = tokenize( selector ); - - if ( (old = context.getAttribute("id")) ) { - nid = old.replace( rescape, "\\$&" ); - } else { - context.setAttribute( "id", nid ); - } - nid = "[id='" + nid + "'] "; - - i = groups.length; - while ( i-- ) { - groups[i] = nid + toSelector( groups[i] ); - } - newContext = rsibling.test( selector ) && testContext( context.parentNode ) || context; - newSelector = groups.join(","); - } - - if ( newSelector ) { - try { - push.apply( results, - newContext.querySelectorAll( newSelector ) - ); - return results; - } catch(qsaError) { - } finally { - if ( !old ) { - context.removeAttribute("id"); - } - } - } - } - } - - // All others - return select( selector.replace( rtrim, "$1" ), context, results, seed ); -} - -/** - * Create key-value caches of limited size - * @returns {Function(string, Object)} Returns the Object data after storing it on itself with - * property name the (space-suffixed) string and (if the cache is larger than Expr.cacheLength) - * deleting the oldest entry - */ -function createCache() { - var keys = []; - - function cache( key, value ) { - // Use (key + " ") to avoid collision with native prototype properties (see Issue #157) - if ( keys.push( key + " " ) > Expr.cacheLength ) { - // Only keep the most recent entries - delete cache[ keys.shift() ]; - } - return (cache[ key + " " ] = value); - } - return cache; -} - -/** - * Mark a function for special use by Sizzle - * @param {Function} fn The function to mark - */ -function markFunction( fn ) { - fn[ expando ] = true; - return fn; -} - -/** - * Support testing using an element - * @param {Function} fn Passed the created div and expects a boolean result - */ -function assert( fn ) { - var div = document.createElement("div"); - - try { - return !!fn( div ); - } catch (e) { - return false; - } finally { - // Remove from its parent by default - if ( div.parentNode ) { - div.parentNode.removeChild( div ); - } - // release memory in IE - div = null; - } -} - -/** - * Adds the same handler for all of the specified attrs - * @param {String} attrs Pipe-separated list of attributes - * @param {Function} handler The method that will be applied - */ -function addHandle( attrs, handler ) { - var arr = attrs.split("|"), - i = attrs.length; - - while ( i-- ) { - Expr.attrHandle[ arr[i] ] = handler; - } -} - -/** - * Checks document order of two siblings - * @param {Element} a - * @param {Element} b - * @returns {Number} Returns less than 0 if a precedes b, greater than 0 if a follows b - */ -function siblingCheck( a, b ) { - var cur = b && a, - diff = cur && a.nodeType === 1 && b.nodeType === 1 && - ( ~b.sourceIndex || MAX_NEGATIVE ) - - ( ~a.sourceIndex || MAX_NEGATIVE ); - - // Use IE sourceIndex if available on both nodes - if ( diff ) { - return diff; - } - - // Check if b follows a - if ( cur ) { - while ( (cur = cur.nextSibling) ) { - if ( cur === b ) { - return -1; - } - } - } - - return a ? 1 : -1; -} - -/** - * Returns a function to use in pseudos for input types - * @param {String} type - */ -function createInputPseudo( type ) { - return function( elem ) { - var name = elem.nodeName.toLowerCase(); - return name === "input" && elem.type === type; - }; -} - -/** - * Returns a function to use in pseudos for buttons - * @param {String} type - */ -function createButtonPseudo( type ) { - return function( elem ) { - var name = elem.nodeName.toLowerCase(); - return (name === "input" || name === "button") && elem.type === type; - }; -} - -/** - * Returns a function to use in pseudos for positionals - * @param {Function} fn - */ -function createPositionalPseudo( fn ) { - return markFunction(function( argument ) { - argument = +argument; - return markFunction(function( seed, matches ) { - var j, - matchIndexes = fn( [], seed.length, argument ), - i = matchIndexes.length; - - // Match elements found at the specified indexes - while ( i-- ) { - if ( seed[ (j = matchIndexes[i]) ] ) { - seed[j] = !(matches[j] = seed[j]); - } - } - }); - }); -} - -/** - * Checks a node for validity as a Sizzle context - * @param {Element|Object=} context - * @returns {Element|Object|Boolean} The input node if acceptable, otherwise a falsy value - */ -function testContext( context ) { - return context && typeof context.getElementsByTagName !== strundefined && context; -} - -// Expose support vars for convenience -support = Sizzle.support = {}; - -/** - * Detects XML nodes - * @param {Element|Object} elem An element or a document - * @returns {Boolean} True iff elem is a non-HTML XML node - */ -isXML = Sizzle.isXML = function( elem ) { - // documentElement is verified for cases where it doesn't yet exist - // (such as loading iframes in IE - #4833) - var documentElement = elem && (elem.ownerDocument || elem).documentElement; - return documentElement ? documentElement.nodeName !== "HTML" : false; -}; - -/** - * Sets document-related variables once based on the current document - * @param {Element|Object} [doc] An element or document object to use to set the document - * @returns {Object} Returns the current document - */ -setDocument = Sizzle.setDocument = function( node ) { - var hasCompare, - doc = node ? node.ownerDocument || node : preferredDoc, - parent = doc.defaultView; - - // If no document and documentElement is available, return - if ( doc === document || doc.nodeType !== 9 || !doc.documentElement ) { - return document; - } - - // Set our document - document = doc; - docElem = doc.documentElement; - - // Support tests - documentIsHTML = !isXML( doc ); - - // Support: IE>8 - // If iframe document is assigned to "document" variable and if iframe has been reloaded, - // IE will throw "permission denied" error when accessing "document" variable, see jQuery #13936 - // IE6-8 do not support the defaultView property so parent will be undefined - if ( parent && parent !== parent.top ) { - // IE11 does not have attachEvent, so all must suffer - if ( parent.addEventListener ) { - parent.addEventListener( "unload", function() { - setDocument(); - }, false ); - } else if ( parent.attachEvent ) { - parent.attachEvent( "onunload", function() { - setDocument(); - }); - } - } - - /* Attributes - ---------------------------------------------------------------------- */ - - // Support: IE<8 - // Verify that getAttribute really returns attributes and not properties (excepting IE8 booleans) - support.attributes = assert(function( div ) { - div.className = "i"; - return !div.getAttribute("className"); - }); - - /* getElement(s)By* - ---------------------------------------------------------------------- */ - - // Check if getElementsByTagName("*") returns only elements - support.getElementsByTagName = assert(function( div ) { - div.appendChild( doc.createComment("") ); - return !div.getElementsByTagName("*").length; - }); - - // Check if getElementsByClassName can be trusted - support.getElementsByClassName = rnative.test( doc.getElementsByClassName ) && assert(function( div ) { - div.innerHTML = "
"; - - // Support: Safari<4 - // Catch class over-caching - div.firstChild.className = "i"; - // Support: Opera<10 - // Catch gEBCN failure to find non-leading classes - return div.getElementsByClassName("i").length === 2; - }); - - // Support: IE<10 - // Check if getElementById returns elements by name - // The broken getElementById methods don't pick up programatically-set names, - // so use a roundabout getElementsByName test - support.getById = assert(function( div ) { - docElem.appendChild( div ).id = expando; - return !doc.getElementsByName || !doc.getElementsByName( expando ).length; - }); - - // ID find and filter - if ( support.getById ) { - Expr.find["ID"] = function( id, context ) { - if ( typeof context.getElementById !== strundefined && documentIsHTML ) { - var m = context.getElementById( id ); - // Check parentNode to catch when Blackberry 4.6 returns - // nodes that are no longer in the document #6963 - return m && m.parentNode ? [ m ] : []; - } - }; - Expr.filter["ID"] = function( id ) { - var attrId = id.replace( runescape, funescape ); - return function( elem ) { - return elem.getAttribute("id") === attrId; - }; - }; - } else { - // Support: IE6/7 - // getElementById is not reliable as a find shortcut - delete Expr.find["ID"]; - - Expr.filter["ID"] = function( id ) { - var attrId = id.replace( runescape, funescape ); - return function( elem ) { - var node = typeof elem.getAttributeNode !== strundefined && elem.getAttributeNode("id"); - return node && node.value === attrId; - }; - }; - } - - // Tag - Expr.find["TAG"] = support.getElementsByTagName ? - function( tag, context ) { - if ( typeof context.getElementsByTagName !== strundefined ) { - return context.getElementsByTagName( tag ); - } - } : - function( tag, context ) { - var elem, - tmp = [], - i = 0, - results = context.getElementsByTagName( tag ); - - // Filter out possible comments - if ( tag === "*" ) { - while ( (elem = results[i++]) ) { - if ( elem.nodeType === 1 ) { - tmp.push( elem ); - } - } - - return tmp; - } - return results; - }; - - // Class - Expr.find["CLASS"] = support.getElementsByClassName && function( className, context ) { - if ( typeof context.getElementsByClassName !== strundefined && documentIsHTML ) { - return context.getElementsByClassName( className ); - } - }; - - /* QSA/matchesSelector - ---------------------------------------------------------------------- */ - - // QSA and matchesSelector support - - // matchesSelector(:active) reports false when true (IE9/Opera 11.5) - rbuggyMatches = []; - - // qSa(:focus) reports false when true (Chrome 21) - // We allow this because of a bug in IE8/9 that throws an error - // whenever `document.activeElement` is accessed on an iframe - // So, we allow :focus to pass through QSA all the time to avoid the IE error - // See http://bugs.jquery.com/ticket/13378 - rbuggyQSA = []; - - if ( (support.qsa = rnative.test( doc.querySelectorAll )) ) { - // Build QSA regex - // Regex strategy adopted from Diego Perini - assert(function( div ) { - // Select is set to empty string on purpose - // This is to test IE's treatment of not explicitly - // setting a boolean content attribute, - // since its presence should be enough - // http://bugs.jquery.com/ticket/12359 - div.innerHTML = ""; - - // Support: IE8, Opera 11-12.16 - // Nothing should be selected when empty strings follow ^= or $= or *= - // The test attribute must be unknown in Opera but "safe" for WinRT - // http://msdn.microsoft.com/en-us/library/ie/hh465388.aspx#attribute_section - if ( div.querySelectorAll("[msallowclip^='']").length ) { - rbuggyQSA.push( "[*^$]=" + whitespace + "*(?:''|\"\")" ); - } - - // Support: IE8 - // Boolean attributes and "value" are not treated correctly - if ( !div.querySelectorAll("[selected]").length ) { - rbuggyQSA.push( "\\[" + whitespace + "*(?:value|" + booleans + ")" ); - } - - // Webkit/Opera - :checked should return selected option elements - // http://www.w3.org/TR/2011/REC-css3-selectors-20110929/#checked - // IE8 throws error here and will not see later tests - if ( !div.querySelectorAll(":checked").length ) { - rbuggyQSA.push(":checked"); - } - }); - - assert(function( div ) { - // Support: Windows 8 Native Apps - // The type and name attributes are restricted during .innerHTML assignment - var input = doc.createElement("input"); - input.setAttribute( "type", "hidden" ); - div.appendChild( input ).setAttribute( "name", "D" ); - - // Support: IE8 - // Enforce case-sensitivity of name attribute - if ( div.querySelectorAll("[name=d]").length ) { - rbuggyQSA.push( "name" + whitespace + "*[*^$|!~]?=" ); - } - - // FF 3.5 - :enabled/:disabled and hidden elements (hidden elements are still enabled) - // IE8 throws error here and will not see later tests - if ( !div.querySelectorAll(":enabled").length ) { - rbuggyQSA.push( ":enabled", ":disabled" ); - } - - // Opera 10-11 does not throw on post-comma invalid pseudos - div.querySelectorAll("*,:x"); - rbuggyQSA.push(",.*:"); - }); - } - - if ( (support.matchesSelector = rnative.test( (matches = docElem.matches || - docElem.webkitMatchesSelector || - docElem.mozMatchesSelector || - docElem.oMatchesSelector || - docElem.msMatchesSelector) )) ) { - - assert(function( div ) { - // Check to see if it's possible to do matchesSelector - // on a disconnected node (IE 9) - support.disconnectedMatch = matches.call( div, "div" ); - - // This should fail with an exception - // Gecko does not error, returns false instead - matches.call( div, "[s!='']:x" ); - rbuggyMatches.push( "!=", pseudos ); - }); - } - - rbuggyQSA = rbuggyQSA.length && new RegExp( rbuggyQSA.join("|") ); - rbuggyMatches = rbuggyMatches.length && new RegExp( rbuggyMatches.join("|") ); - - /* Contains - ---------------------------------------------------------------------- */ - hasCompare = rnative.test( docElem.compareDocumentPosition ); - - // Element contains another - // Purposefully does not implement inclusive descendent - // As in, an element does not contain itself - contains = hasCompare || rnative.test( docElem.contains ) ? - function( a, b ) { - var adown = a.nodeType === 9 ? a.documentElement : a, - bup = b && b.parentNode; - return a === bup || !!( bup && bup.nodeType === 1 && ( - adown.contains ? - adown.contains( bup ) : - a.compareDocumentPosition && a.compareDocumentPosition( bup ) & 16 - )); - } : - function( a, b ) { - if ( b ) { - while ( (b = b.parentNode) ) { - if ( b === a ) { - return true; - } - } - } - return false; - }; - - /* Sorting - ---------------------------------------------------------------------- */ - - // Document order sorting - sortOrder = hasCompare ? - function( a, b ) { - - // Flag for duplicate removal - if ( a === b ) { - hasDuplicate = true; - return 0; - } - - // Sort on method existence if only one input has compareDocumentPosition - var compare = !a.compareDocumentPosition - !b.compareDocumentPosition; - if ( compare ) { - return compare; - } - - // Calculate position if both inputs belong to the same document - compare = ( a.ownerDocument || a ) === ( b.ownerDocument || b ) ? - a.compareDocumentPosition( b ) : - - // Otherwise we know they are disconnected - 1; - - // Disconnected nodes - if ( compare & 1 || - (!support.sortDetached && b.compareDocumentPosition( a ) === compare) ) { - - // Choose the first element that is related to our preferred document - if ( a === doc || a.ownerDocument === preferredDoc && contains(preferredDoc, a) ) { - return -1; - } - if ( b === doc || b.ownerDocument === preferredDoc && contains(preferredDoc, b) ) { - return 1; - } - - // Maintain original order - return sortInput ? - ( indexOf.call( sortInput, a ) - indexOf.call( sortInput, b ) ) : - 0; - } - - return compare & 4 ? -1 : 1; - } : - function( a, b ) { - // Exit early if the nodes are identical - if ( a === b ) { - hasDuplicate = true; - return 0; - } - - var cur, - i = 0, - aup = a.parentNode, - bup = b.parentNode, - ap = [ a ], - bp = [ b ]; - - // Parentless nodes are either documents or disconnected - if ( !aup || !bup ) { - return a === doc ? -1 : - b === doc ? 1 : - aup ? -1 : - bup ? 1 : - sortInput ? - ( indexOf.call( sortInput, a ) - indexOf.call( sortInput, b ) ) : - 0; - - // If the nodes are siblings, we can do a quick check - } else if ( aup === bup ) { - return siblingCheck( a, b ); - } - - // Otherwise we need full lists of their ancestors for comparison - cur = a; - while ( (cur = cur.parentNode) ) { - ap.unshift( cur ); - } - cur = b; - while ( (cur = cur.parentNode) ) { - bp.unshift( cur ); - } - - // Walk down the tree looking for a discrepancy - while ( ap[i] === bp[i] ) { - i++; - } - - return i ? - // Do a sibling check if the nodes have a common ancestor - siblingCheck( ap[i], bp[i] ) : - - // Otherwise nodes in our document sort first - ap[i] === preferredDoc ? -1 : - bp[i] === preferredDoc ? 1 : - 0; - }; - - return doc; -}; - -Sizzle.matches = function( expr, elements ) { - return Sizzle( expr, null, null, elements ); -}; - -Sizzle.matchesSelector = function( elem, expr ) { - // Set document vars if needed - if ( ( elem.ownerDocument || elem ) !== document ) { - setDocument( elem ); - } - - // Make sure that attribute selectors are quoted - expr = expr.replace( rattributeQuotes, "='$1']" ); - - if ( support.matchesSelector && documentIsHTML && - ( !rbuggyMatches || !rbuggyMatches.test( expr ) ) && - ( !rbuggyQSA || !rbuggyQSA.test( expr ) ) ) { - - try { - var ret = matches.call( elem, expr ); - - // IE 9's matchesSelector returns false on disconnected nodes - if ( ret || support.disconnectedMatch || - // As well, disconnected nodes are said to be in a document - // fragment in IE 9 - elem.document && elem.document.nodeType !== 11 ) { - return ret; - } - } catch(e) {} - } - - return Sizzle( expr, document, null, [ elem ] ).length > 0; -}; - -Sizzle.contains = function( context, elem ) { - // Set document vars if needed - if ( ( context.ownerDocument || context ) !== document ) { - setDocument( context ); - } - return contains( context, elem ); -}; - -Sizzle.attr = function( elem, name ) { - // Set document vars if needed - if ( ( elem.ownerDocument || elem ) !== document ) { - setDocument( elem ); - } - - var fn = Expr.attrHandle[ name.toLowerCase() ], - // Don't get fooled by Object.prototype properties (jQuery #13807) - val = fn && hasOwn.call( Expr.attrHandle, name.toLowerCase() ) ? - fn( elem, name, !documentIsHTML ) : - undefined; - - return val !== undefined ? - val : - support.attributes || !documentIsHTML ? - elem.getAttribute( name ) : - (val = elem.getAttributeNode(name)) && val.specified ? - val.value : - null; -}; - -Sizzle.error = function( msg ) { - throw new Error( "Syntax error, unrecognized expression: " + msg ); -}; - -/** - * Document sorting and removing duplicates - * @param {ArrayLike} results - */ -Sizzle.uniqueSort = function( results ) { - var elem, - duplicates = [], - j = 0, - i = 0; - - // Unless we *know* we can detect duplicates, assume their presence - hasDuplicate = !support.detectDuplicates; - sortInput = !support.sortStable && results.slice( 0 ); - results.sort( sortOrder ); - - if ( hasDuplicate ) { - while ( (elem = results[i++]) ) { - if ( elem === results[ i ] ) { - j = duplicates.push( i ); - } - } - while ( j-- ) { - results.splice( duplicates[ j ], 1 ); - } - } - - // Clear input after sorting to release objects - // See https://github.com/jquery/sizzle/pull/225 - sortInput = null; - - return results; -}; - -/** - * Utility function for retrieving the text value of an array of DOM nodes - * @param {Array|Element} elem - */ -getText = Sizzle.getText = function( elem ) { - var node, - ret = "", - i = 0, - nodeType = elem.nodeType; - - if ( !nodeType ) { - // If no nodeType, this is expected to be an array - while ( (node = elem[i++]) ) { - // Do not traverse comment nodes - ret += getText( node ); - } - } else if ( nodeType === 1 || nodeType === 9 || nodeType === 11 ) { - // Use textContent for elements - // innerText usage removed for consistency of new lines (jQuery #11153) - if ( typeof elem.textContent === "string" ) { - return elem.textContent; - } else { - // Traverse its children - for ( elem = elem.firstChild; elem; elem = elem.nextSibling ) { - ret += getText( elem ); - } - } - } else if ( nodeType === 3 || nodeType === 4 ) { - return elem.nodeValue; - } - // Do not include comment or processing instruction nodes - - return ret; -}; - -Expr = Sizzle.selectors = { - - // Can be adjusted by the user - cacheLength: 50, - - createPseudo: markFunction, - - match: matchExpr, - - attrHandle: {}, - - find: {}, - - relative: { - ">": { dir: "parentNode", first: true }, - " ": { dir: "parentNode" }, - "+": { dir: "previousSibling", first: true }, - "~": { dir: "previousSibling" } - }, - - preFilter: { - "ATTR": function( match ) { - match[1] = match[1].replace( runescape, funescape ); - - // Move the given value to match[3] whether quoted or unquoted - match[3] = ( match[3] || match[4] || match[5] || "" ).replace( runescape, funescape ); - - if ( match[2] === "~=" ) { - match[3] = " " + match[3] + " "; - } - - return match.slice( 0, 4 ); - }, - - "CHILD": function( match ) { - /* matches from matchExpr["CHILD"] - 1 type (only|nth|...) - 2 what (child|of-type) - 3 argument (even|odd|\d*|\d*n([+-]\d+)?|...) - 4 xn-component of xn+y argument ([+-]?\d*n|) - 5 sign of xn-component - 6 x of xn-component - 7 sign of y-component - 8 y of y-component - */ - match[1] = match[1].toLowerCase(); - - if ( match[1].slice( 0, 3 ) === "nth" ) { - // nth-* requires argument - if ( !match[3] ) { - Sizzle.error( match[0] ); - } - - // numeric x and y parameters for Expr.filter.CHILD - // remember that false/true cast respectively to 0/1 - match[4] = +( match[4] ? match[5] + (match[6] || 1) : 2 * ( match[3] === "even" || match[3] === "odd" ) ); - match[5] = +( ( match[7] + match[8] ) || match[3] === "odd" ); - - // other types prohibit arguments - } else if ( match[3] ) { - Sizzle.error( match[0] ); - } - - return match; - }, - - "PSEUDO": function( match ) { - var excess, - unquoted = !match[6] && match[2]; - - if ( matchExpr["CHILD"].test( match[0] ) ) { - return null; - } - - // Accept quoted arguments as-is - if ( match[3] ) { - match[2] = match[4] || match[5] || ""; - - // Strip excess characters from unquoted arguments - } else if ( unquoted && rpseudo.test( unquoted ) && - // Get excess from tokenize (recursively) - (excess = tokenize( unquoted, true )) && - // advance to the next closing parenthesis - (excess = unquoted.indexOf( ")", unquoted.length - excess ) - unquoted.length) ) { - - // excess is a negative index - match[0] = match[0].slice( 0, excess ); - match[2] = unquoted.slice( 0, excess ); - } - - // Return only captures needed by the pseudo filter method (type and argument) - return match.slice( 0, 3 ); - } - }, - - filter: { - - "TAG": function( nodeNameSelector ) { - var nodeName = nodeNameSelector.replace( runescape, funescape ).toLowerCase(); - return nodeNameSelector === "*" ? - function() { return true; } : - function( elem ) { - return elem.nodeName && elem.nodeName.toLowerCase() === nodeName; - }; - }, - - "CLASS": function( className ) { - var pattern = classCache[ className + " " ]; - - return pattern || - (pattern = new RegExp( "(^|" + whitespace + ")" + className + "(" + whitespace + "|$)" )) && - classCache( className, function( elem ) { - return pattern.test( typeof elem.className === "string" && elem.className || typeof elem.getAttribute !== strundefined && elem.getAttribute("class") || "" ); - }); - }, - - "ATTR": function( name, operator, check ) { - return function( elem ) { - var result = Sizzle.attr( elem, name ); - - if ( result == null ) { - return operator === "!="; - } - if ( !operator ) { - return true; - } - - result += ""; - - return operator === "=" ? result === check : - operator === "!=" ? result !== check : - operator === "^=" ? check && result.indexOf( check ) === 0 : - operator === "*=" ? check && result.indexOf( check ) > -1 : - operator === "$=" ? check && result.slice( -check.length ) === check : - operator === "~=" ? ( " " + result + " " ).indexOf( check ) > -1 : - operator === "|=" ? result === check || result.slice( 0, check.length + 1 ) === check + "-" : - false; - }; - }, - - "CHILD": function( type, what, argument, first, last ) { - var simple = type.slice( 0, 3 ) !== "nth", - forward = type.slice( -4 ) !== "last", - ofType = what === "of-type"; - - return first === 1 && last === 0 ? - - // Shortcut for :nth-*(n) - function( elem ) { - return !!elem.parentNode; - } : - - function( elem, context, xml ) { - var cache, outerCache, node, diff, nodeIndex, start, - dir = simple !== forward ? "nextSibling" : "previousSibling", - parent = elem.parentNode, - name = ofType && elem.nodeName.toLowerCase(), - useCache = !xml && !ofType; - - if ( parent ) { - - // :(first|last|only)-(child|of-type) - if ( simple ) { - while ( dir ) { - node = elem; - while ( (node = node[ dir ]) ) { - if ( ofType ? node.nodeName.toLowerCase() === name : node.nodeType === 1 ) { - return false; - } - } - // Reverse direction for :only-* (if we haven't yet done so) - start = dir = type === "only" && !start && "nextSibling"; - } - return true; - } - - start = [ forward ? parent.firstChild : parent.lastChild ]; - - // non-xml :nth-child(...) stores cache data on `parent` - if ( forward && useCache ) { - // Seek `elem` from a previously-cached index - outerCache = parent[ expando ] || (parent[ expando ] = {}); - cache = outerCache[ type ] || []; - nodeIndex = cache[0] === dirruns && cache[1]; - diff = cache[0] === dirruns && cache[2]; - node = nodeIndex && parent.childNodes[ nodeIndex ]; - - while ( (node = ++nodeIndex && node && node[ dir ] || - - // Fallback to seeking `elem` from the start - (diff = nodeIndex = 0) || start.pop()) ) { - - // When found, cache indexes on `parent` and break - if ( node.nodeType === 1 && ++diff && node === elem ) { - outerCache[ type ] = [ dirruns, nodeIndex, diff ]; - break; - } - } - - // Use previously-cached element index if available - } else if ( useCache && (cache = (elem[ expando ] || (elem[ expando ] = {}))[ type ]) && cache[0] === dirruns ) { - diff = cache[1]; - - // xml :nth-child(...) or :nth-last-child(...) or :nth(-last)?-of-type(...) - } else { - // Use the same loop as above to seek `elem` from the start - while ( (node = ++nodeIndex && node && node[ dir ] || - (diff = nodeIndex = 0) || start.pop()) ) { - - if ( ( ofType ? node.nodeName.toLowerCase() === name : node.nodeType === 1 ) && ++diff ) { - // Cache the index of each encountered element - if ( useCache ) { - (node[ expando ] || (node[ expando ] = {}))[ type ] = [ dirruns, diff ]; - } - - if ( node === elem ) { - break; - } - } - } - } - - // Incorporate the offset, then check against cycle size - diff -= last; - return diff === first || ( diff % first === 0 && diff / first >= 0 ); - } - }; - }, - - "PSEUDO": function( pseudo, argument ) { - // pseudo-class names are case-insensitive - // http://www.w3.org/TR/selectors/#pseudo-classes - // Prioritize by case sensitivity in case custom pseudos are added with uppercase letters - // Remember that setFilters inherits from pseudos - var args, - fn = Expr.pseudos[ pseudo ] || Expr.setFilters[ pseudo.toLowerCase() ] || - Sizzle.error( "unsupported pseudo: " + pseudo ); - - // The user may use createPseudo to indicate that - // arguments are needed to create the filter function - // just as Sizzle does - if ( fn[ expando ] ) { - return fn( argument ); - } - - // But maintain support for old signatures - if ( fn.length > 1 ) { - args = [ pseudo, pseudo, "", argument ]; - return Expr.setFilters.hasOwnProperty( pseudo.toLowerCase() ) ? - markFunction(function( seed, matches ) { - var idx, - matched = fn( seed, argument ), - i = matched.length; - while ( i-- ) { - idx = indexOf.call( seed, matched[i] ); - seed[ idx ] = !( matches[ idx ] = matched[i] ); - } - }) : - function( elem ) { - return fn( elem, 0, args ); - }; - } - - return fn; - } - }, - - pseudos: { - // Potentially complex pseudos - "not": markFunction(function( selector ) { - // Trim the selector passed to compile - // to avoid treating leading and trailing - // spaces as combinators - var input = [], - results = [], - matcher = compile( selector.replace( rtrim, "$1" ) ); - - return matcher[ expando ] ? - markFunction(function( seed, matches, context, xml ) { - var elem, - unmatched = matcher( seed, null, xml, [] ), - i = seed.length; - - // Match elements unmatched by `matcher` - while ( i-- ) { - if ( (elem = unmatched[i]) ) { - seed[i] = !(matches[i] = elem); - } - } - }) : - function( elem, context, xml ) { - input[0] = elem; - matcher( input, null, xml, results ); - return !results.pop(); - }; - }), - - "has": markFunction(function( selector ) { - return function( elem ) { - return Sizzle( selector, elem ).length > 0; - }; - }), - - "contains": markFunction(function( text ) { - return function( elem ) { - return ( elem.textContent || elem.innerText || getText( elem ) ).indexOf( text ) > -1; - }; - }), - - // "Whether an element is represented by a :lang() selector - // is based solely on the element's language value - // being equal to the identifier C, - // or beginning with the identifier C immediately followed by "-". - // The matching of C against the element's language value is performed case-insensitively. - // The identifier C does not have to be a valid language name." - // http://www.w3.org/TR/selectors/#lang-pseudo - "lang": markFunction( function( lang ) { - // lang value must be a valid identifier - if ( !ridentifier.test(lang || "") ) { - Sizzle.error( "unsupported lang: " + lang ); - } - lang = lang.replace( runescape, funescape ).toLowerCase(); - return function( elem ) { - var elemLang; - do { - if ( (elemLang = documentIsHTML ? - elem.lang : - elem.getAttribute("xml:lang") || elem.getAttribute("lang")) ) { - - elemLang = elemLang.toLowerCase(); - return elemLang === lang || elemLang.indexOf( lang + "-" ) === 0; - } - } while ( (elem = elem.parentNode) && elem.nodeType === 1 ); - return false; - }; - }), - - // Miscellaneous - "target": function( elem ) { - var hash = window.location && window.location.hash; - return hash && hash.slice( 1 ) === elem.id; - }, - - "root": function( elem ) { - return elem === docElem; - }, - - "focus": function( elem ) { - return elem === document.activeElement && (!document.hasFocus || document.hasFocus()) && !!(elem.type || elem.href || ~elem.tabIndex); - }, - - // Boolean properties - "enabled": function( elem ) { - return elem.disabled === false; - }, - - "disabled": function( elem ) { - return elem.disabled === true; - }, - - "checked": function( elem ) { - // In CSS3, :checked should return both checked and selected elements - // http://www.w3.org/TR/2011/REC-css3-selectors-20110929/#checked - var nodeName = elem.nodeName.toLowerCase(); - return (nodeName === "input" && !!elem.checked) || (nodeName === "option" && !!elem.selected); - }, - - "selected": function( elem ) { - // Accessing this property makes selected-by-default - // options in Safari work properly - if ( elem.parentNode ) { - elem.parentNode.selectedIndex; - } - - return elem.selected === true; - }, - - // Contents - "empty": function( elem ) { - // http://www.w3.org/TR/selectors/#empty-pseudo - // :empty is negated by element (1) or content nodes (text: 3; cdata: 4; entity ref: 5), - // but not by others (comment: 8; processing instruction: 7; etc.) - // nodeType < 6 works because attributes (2) do not appear as children - for ( elem = elem.firstChild; elem; elem = elem.nextSibling ) { - if ( elem.nodeType < 6 ) { - return false; - } - } - return true; - }, - - "parent": function( elem ) { - return !Expr.pseudos["empty"]( elem ); - }, - - // Element/input types - "header": function( elem ) { - return rheader.test( elem.nodeName ); - }, - - "input": function( elem ) { - return rinputs.test( elem.nodeName ); - }, - - "button": function( elem ) { - var name = elem.nodeName.toLowerCase(); - return name === "input" && elem.type === "button" || name === "button"; - }, - - "text": function( elem ) { - var attr; - return elem.nodeName.toLowerCase() === "input" && - elem.type === "text" && - - // Support: IE<8 - // New HTML5 attribute values (e.g., "search") appear with elem.type === "text" - ( (attr = elem.getAttribute("type")) == null || attr.toLowerCase() === "text" ); - }, - - // Position-in-collection - "first": createPositionalPseudo(function() { - return [ 0 ]; - }), - - "last": createPositionalPseudo(function( matchIndexes, length ) { - return [ length - 1 ]; - }), - - "eq": createPositionalPseudo(function( matchIndexes, length, argument ) { - return [ argument < 0 ? argument + length : argument ]; - }), - - "even": createPositionalPseudo(function( matchIndexes, length ) { - var i = 0; - for ( ; i < length; i += 2 ) { - matchIndexes.push( i ); - } - return matchIndexes; - }), - - "odd": createPositionalPseudo(function( matchIndexes, length ) { - var i = 1; - for ( ; i < length; i += 2 ) { - matchIndexes.push( i ); - } - return matchIndexes; - }), - - "lt": createPositionalPseudo(function( matchIndexes, length, argument ) { - var i = argument < 0 ? argument + length : argument; - for ( ; --i >= 0; ) { - matchIndexes.push( i ); - } - return matchIndexes; - }), - - "gt": createPositionalPseudo(function( matchIndexes, length, argument ) { - var i = argument < 0 ? argument + length : argument; - for ( ; ++i < length; ) { - matchIndexes.push( i ); - } - return matchIndexes; - }) - } -}; - -Expr.pseudos["nth"] = Expr.pseudos["eq"]; - -// Add button/input type pseudos -for ( i in { radio: true, checkbox: true, file: true, password: true, image: true } ) { - Expr.pseudos[ i ] = createInputPseudo( i ); -} -for ( i in { submit: true, reset: true } ) { - Expr.pseudos[ i ] = createButtonPseudo( i ); -} - -// Easy API for creating new setFilters -function setFilters() {} -setFilters.prototype = Expr.filters = Expr.pseudos; -Expr.setFilters = new setFilters(); - -tokenize = Sizzle.tokenize = function( selector, parseOnly ) { - var matched, match, tokens, type, - soFar, groups, preFilters, - cached = tokenCache[ selector + " " ]; - - if ( cached ) { - return parseOnly ? 0 : cached.slice( 0 ); - } - - soFar = selector; - groups = []; - preFilters = Expr.preFilter; - - while ( soFar ) { - - // Comma and first run - if ( !matched || (match = rcomma.exec( soFar )) ) { - if ( match ) { - // Don't consume trailing commas as valid - soFar = soFar.slice( match[0].length ) || soFar; - } - groups.push( (tokens = []) ); - } - - matched = false; - - // Combinators - if ( (match = rcombinators.exec( soFar )) ) { - matched = match.shift(); - tokens.push({ - value: matched, - // Cast descendant combinators to space - type: match[0].replace( rtrim, " " ) - }); - soFar = soFar.slice( matched.length ); - } - - // Filters - for ( type in Expr.filter ) { - if ( (match = matchExpr[ type ].exec( soFar )) && (!preFilters[ type ] || - (match = preFilters[ type ]( match ))) ) { - matched = match.shift(); - tokens.push({ - value: matched, - type: type, - matches: match - }); - soFar = soFar.slice( matched.length ); - } - } - - if ( !matched ) { - break; - } - } - - // Return the length of the invalid excess - // if we're just parsing - // Otherwise, throw an error or return tokens - return parseOnly ? - soFar.length : - soFar ? - Sizzle.error( selector ) : - // Cache the tokens - tokenCache( selector, groups ).slice( 0 ); -}; - -function toSelector( tokens ) { - var i = 0, - len = tokens.length, - selector = ""; - for ( ; i < len; i++ ) { - selector += tokens[i].value; - } - return selector; -} - -function addCombinator( matcher, combinator, base ) { - var dir = combinator.dir, - checkNonElements = base && dir === "parentNode", - doneName = done++; - - return combinator.first ? - // Check against closest ancestor/preceding element - function( elem, context, xml ) { - while ( (elem = elem[ dir ]) ) { - if ( elem.nodeType === 1 || checkNonElements ) { - return matcher( elem, context, xml ); - } - } - } : - - // Check against all ancestor/preceding elements - function( elem, context, xml ) { - var oldCache, outerCache, - newCache = [ dirruns, doneName ]; - - // We can't set arbitrary data on XML nodes, so they don't benefit from dir caching - if ( xml ) { - while ( (elem = elem[ dir ]) ) { - if ( elem.nodeType === 1 || checkNonElements ) { - if ( matcher( elem, context, xml ) ) { - return true; - } - } - } - } else { - while ( (elem = elem[ dir ]) ) { - if ( elem.nodeType === 1 || checkNonElements ) { - outerCache = elem[ expando ] || (elem[ expando ] = {}); - if ( (oldCache = outerCache[ dir ]) && - oldCache[ 0 ] === dirruns && oldCache[ 1 ] === doneName ) { - - // Assign to newCache so results back-propagate to previous elements - return (newCache[ 2 ] = oldCache[ 2 ]); - } else { - // Reuse newcache so results back-propagate to previous elements - outerCache[ dir ] = newCache; - - // A match means we're done; a fail means we have to keep checking - if ( (newCache[ 2 ] = matcher( elem, context, xml )) ) { - return true; - } - } - } - } - } - }; -} - -function elementMatcher( matchers ) { - return matchers.length > 1 ? - function( elem, context, xml ) { - var i = matchers.length; - while ( i-- ) { - if ( !matchers[i]( elem, context, xml ) ) { - return false; - } - } - return true; - } : - matchers[0]; -} - -function multipleContexts( selector, contexts, results ) { - var i = 0, - len = contexts.length; - for ( ; i < len; i++ ) { - Sizzle( selector, contexts[i], results ); - } - return results; -} - -function condense( unmatched, map, filter, context, xml ) { - var elem, - newUnmatched = [], - i = 0, - len = unmatched.length, - mapped = map != null; - - for ( ; i < len; i++ ) { - if ( (elem = unmatched[i]) ) { - if ( !filter || filter( elem, context, xml ) ) { - newUnmatched.push( elem ); - if ( mapped ) { - map.push( i ); - } - } - } - } - - return newUnmatched; -} - -function setMatcher( preFilter, selector, matcher, postFilter, postFinder, postSelector ) { - if ( postFilter && !postFilter[ expando ] ) { - postFilter = setMatcher( postFilter ); - } - if ( postFinder && !postFinder[ expando ] ) { - postFinder = setMatcher( postFinder, postSelector ); - } - return markFunction(function( seed, results, context, xml ) { - var temp, i, elem, - preMap = [], - postMap = [], - preexisting = results.length, - - // Get initial elements from seed or context - elems = seed || multipleContexts( selector || "*", context.nodeType ? [ context ] : context, [] ), - - // Prefilter to get matcher input, preserving a map for seed-results synchronization - matcherIn = preFilter && ( seed || !selector ) ? - condense( elems, preMap, preFilter, context, xml ) : - elems, - - matcherOut = matcher ? - // If we have a postFinder, or filtered seed, or non-seed postFilter or preexisting results, - postFinder || ( seed ? preFilter : preexisting || postFilter ) ? - - // ...intermediate processing is necessary - [] : - - // ...otherwise use results directly - results : - matcherIn; - - // Find primary matches - if ( matcher ) { - matcher( matcherIn, matcherOut, context, xml ); - } - - // Apply postFilter - if ( postFilter ) { - temp = condense( matcherOut, postMap ); - postFilter( temp, [], context, xml ); - - // Un-match failing elements by moving them back to matcherIn - i = temp.length; - while ( i-- ) { - if ( (elem = temp[i]) ) { - matcherOut[ postMap[i] ] = !(matcherIn[ postMap[i] ] = elem); - } - } - } - - if ( seed ) { - if ( postFinder || preFilter ) { - if ( postFinder ) { - // Get the final matcherOut by condensing this intermediate into postFinder contexts - temp = []; - i = matcherOut.length; - while ( i-- ) { - if ( (elem = matcherOut[i]) ) { - // Restore matcherIn since elem is not yet a final match - temp.push( (matcherIn[i] = elem) ); - } - } - postFinder( null, (matcherOut = []), temp, xml ); - } - - // Move matched elements from seed to results to keep them synchronized - i = matcherOut.length; - while ( i-- ) { - if ( (elem = matcherOut[i]) && - (temp = postFinder ? indexOf.call( seed, elem ) : preMap[i]) > -1 ) { - - seed[temp] = !(results[temp] = elem); - } - } - } - - // Add elements to results, through postFinder if defined - } else { - matcherOut = condense( - matcherOut === results ? - matcherOut.splice( preexisting, matcherOut.length ) : - matcherOut - ); - if ( postFinder ) { - postFinder( null, results, matcherOut, xml ); - } else { - push.apply( results, matcherOut ); - } - } - }); -} - -function matcherFromTokens( tokens ) { - var checkContext, matcher, j, - len = tokens.length, - leadingRelative = Expr.relative[ tokens[0].type ], - implicitRelative = leadingRelative || Expr.relative[" "], - i = leadingRelative ? 1 : 0, - - // The foundational matcher ensures that elements are reachable from top-level context(s) - matchContext = addCombinator( function( elem ) { - return elem === checkContext; - }, implicitRelative, true ), - matchAnyContext = addCombinator( function( elem ) { - return indexOf.call( checkContext, elem ) > -1; - }, implicitRelative, true ), - matchers = [ function( elem, context, xml ) { - return ( !leadingRelative && ( xml || context !== outermostContext ) ) || ( - (checkContext = context).nodeType ? - matchContext( elem, context, xml ) : - matchAnyContext( elem, context, xml ) ); - } ]; - - for ( ; i < len; i++ ) { - if ( (matcher = Expr.relative[ tokens[i].type ]) ) { - matchers = [ addCombinator(elementMatcher( matchers ), matcher) ]; - } else { - matcher = Expr.filter[ tokens[i].type ].apply( null, tokens[i].matches ); - - // Return special upon seeing a positional matcher - if ( matcher[ expando ] ) { - // Find the next relative operator (if any) for proper handling - j = ++i; - for ( ; j < len; j++ ) { - if ( Expr.relative[ tokens[j].type ] ) { - break; - } - } - return setMatcher( - i > 1 && elementMatcher( matchers ), - i > 1 && toSelector( - // If the preceding token was a descendant combinator, insert an implicit any-element `*` - tokens.slice( 0, i - 1 ).concat({ value: tokens[ i - 2 ].type === " " ? "*" : "" }) - ).replace( rtrim, "$1" ), - matcher, - i < j && matcherFromTokens( tokens.slice( i, j ) ), - j < len && matcherFromTokens( (tokens = tokens.slice( j )) ), - j < len && toSelector( tokens ) - ); - } - matchers.push( matcher ); - } - } - - return elementMatcher( matchers ); -} - -function matcherFromGroupMatchers( elementMatchers, setMatchers ) { - var bySet = setMatchers.length > 0, - byElement = elementMatchers.length > 0, - superMatcher = function( seed, context, xml, results, outermost ) { - var elem, j, matcher, - matchedCount = 0, - i = "0", - unmatched = seed && [], - setMatched = [], - contextBackup = outermostContext, - // We must always have either seed elements or outermost context - elems = seed || byElement && Expr.find["TAG"]( "*", outermost ), - // Use integer dirruns iff this is the outermost matcher - dirrunsUnique = (dirruns += contextBackup == null ? 1 : Math.random() || 0.1), - len = elems.length; - - if ( outermost ) { - outermostContext = context !== document && context; - } - - // Add elements passing elementMatchers directly to results - // Keep `i` a string if there are no elements so `matchedCount` will be "00" below - // Support: IE<9, Safari - // Tolerate NodeList properties (IE: "length"; Safari: ) matching elements by id - for ( ; i !== len && (elem = elems[i]) != null; i++ ) { - if ( byElement && elem ) { - j = 0; - while ( (matcher = elementMatchers[j++]) ) { - if ( matcher( elem, context, xml ) ) { - results.push( elem ); - break; - } - } - if ( outermost ) { - dirruns = dirrunsUnique; - } - } - - // Track unmatched elements for set filters - if ( bySet ) { - // They will have gone through all possible matchers - if ( (elem = !matcher && elem) ) { - matchedCount--; - } - - // Lengthen the array for every element, matched or not - if ( seed ) { - unmatched.push( elem ); - } - } - } - - // Apply set filters to unmatched elements - matchedCount += i; - if ( bySet && i !== matchedCount ) { - j = 0; - while ( (matcher = setMatchers[j++]) ) { - matcher( unmatched, setMatched, context, xml ); - } - - if ( seed ) { - // Reintegrate element matches to eliminate the need for sorting - if ( matchedCount > 0 ) { - while ( i-- ) { - if ( !(unmatched[i] || setMatched[i]) ) { - setMatched[i] = pop.call( results ); - } - } - } - - // Discard index placeholder values to get only actual matches - setMatched = condense( setMatched ); - } - - // Add matches to results - push.apply( results, setMatched ); - - // Seedless set matches succeeding multiple successful matchers stipulate sorting - if ( outermost && !seed && setMatched.length > 0 && - ( matchedCount + setMatchers.length ) > 1 ) { - - Sizzle.uniqueSort( results ); - } - } - - // Override manipulation of globals by nested matchers - if ( outermost ) { - dirruns = dirrunsUnique; - outermostContext = contextBackup; - } - - return unmatched; - }; - - return bySet ? - markFunction( superMatcher ) : - superMatcher; -} - -compile = Sizzle.compile = function( selector, match /* Internal Use Only */ ) { - var i, - setMatchers = [], - elementMatchers = [], - cached = compilerCache[ selector + " " ]; - - if ( !cached ) { - // Generate a function of recursive functions that can be used to check each element - if ( !match ) { - match = tokenize( selector ); - } - i = match.length; - while ( i-- ) { - cached = matcherFromTokens( match[i] ); - if ( cached[ expando ] ) { - setMatchers.push( cached ); - } else { - elementMatchers.push( cached ); - } - } - - // Cache the compiled function - cached = compilerCache( selector, matcherFromGroupMatchers( elementMatchers, setMatchers ) ); - - // Save selector and tokenization - cached.selector = selector; - } - return cached; -}; - -/** - * A low-level selection function that works with Sizzle's compiled - * selector functions - * @param {String|Function} selector A selector or a pre-compiled - * selector function built with Sizzle.compile - * @param {Element} context - * @param {Array} [results] - * @param {Array} [seed] A set of elements to match against - */ -select = Sizzle.select = function( selector, context, results, seed ) { - var i, tokens, token, type, find, - compiled = typeof selector === "function" && selector, - match = !seed && tokenize( (selector = compiled.selector || selector) ); - - results = results || []; - - // Try to minimize operations if there is no seed and only one group - if ( match.length === 1 ) { - - // Take a shortcut and set the context if the root selector is an ID - tokens = match[0] = match[0].slice( 0 ); - if ( tokens.length > 2 && (token = tokens[0]).type === "ID" && - support.getById && context.nodeType === 9 && documentIsHTML && - Expr.relative[ tokens[1].type ] ) { - - context = ( Expr.find["ID"]( token.matches[0].replace(runescape, funescape), context ) || [] )[0]; - if ( !context ) { - return results; - - // Precompiled matchers will still verify ancestry, so step up a level - } else if ( compiled ) { - context = context.parentNode; - } - - selector = selector.slice( tokens.shift().value.length ); - } - - // Fetch a seed set for right-to-left matching - i = matchExpr["needsContext"].test( selector ) ? 0 : tokens.length; - while ( i-- ) { - token = tokens[i]; - - // Abort if we hit a combinator - if ( Expr.relative[ (type = token.type) ] ) { - break; - } - if ( (find = Expr.find[ type ]) ) { - // Search, expanding context for leading sibling combinators - if ( (seed = find( - token.matches[0].replace( runescape, funescape ), - rsibling.test( tokens[0].type ) && testContext( context.parentNode ) || context - )) ) { - - // If seed is empty or no tokens remain, we can return early - tokens.splice( i, 1 ); - selector = seed.length && toSelector( tokens ); - if ( !selector ) { - push.apply( results, seed ); - return results; - } - - break; - } - } - } - } - - // Compile and execute a filtering function if one is not provided - // Provide `match` to avoid retokenization if we modified the selector above - ( compiled || compile( selector, match ) )( - seed, - context, - !documentIsHTML, - results, - rsibling.test( selector ) && testContext( context.parentNode ) || context - ); - return results; -}; - -// One-time assignments - -// Sort stability -support.sortStable = expando.split("").sort( sortOrder ).join("") === expando; - -// Support: Chrome<14 -// Always assume duplicates if they aren't passed to the comparison function -support.detectDuplicates = !!hasDuplicate; - -// Initialize against the default document -setDocument(); - -// Support: Webkit<537.32 - Safari 6.0.3/Chrome 25 (fixed in Chrome 27) -// Detached nodes confoundingly follow *each other* -support.sortDetached = assert(function( div1 ) { - // Should return 1, but returns 4 (following) - return div1.compareDocumentPosition( document.createElement("div") ) & 1; -}); - -// Support: IE<8 -// Prevent attribute/property "interpolation" -// http://msdn.microsoft.com/en-us/library/ms536429%28VS.85%29.aspx -if ( !assert(function( div ) { - div.innerHTML = ""; - return div.firstChild.getAttribute("href") === "#" ; -}) ) { - addHandle( "type|href|height|width", function( elem, name, isXML ) { - if ( !isXML ) { - return elem.getAttribute( name, name.toLowerCase() === "type" ? 1 : 2 ); - } - }); -} - -// Support: IE<9 -// Use defaultValue in place of getAttribute("value") -if ( !support.attributes || !assert(function( div ) { - div.innerHTML = ""; - div.firstChild.setAttribute( "value", "" ); - return div.firstChild.getAttribute( "value" ) === ""; -}) ) { - addHandle( "value", function( elem, name, isXML ) { - if ( !isXML && elem.nodeName.toLowerCase() === "input" ) { - return elem.defaultValue; - } - }); -} - -// Support: IE<9 -// Use getAttributeNode to fetch booleans when getAttribute lies -if ( !assert(function( div ) { - return div.getAttribute("disabled") == null; -}) ) { - addHandle( booleans, function( elem, name, isXML ) { - var val; - if ( !isXML ) { - return elem[ name ] === true ? name.toLowerCase() : - (val = elem.getAttributeNode( name )) && val.specified ? - val.value : - null; - } - }); -} - -return Sizzle; - -})( window ); - - - -jQuery.find = Sizzle; -jQuery.expr = Sizzle.selectors; -jQuery.expr[":"] = jQuery.expr.pseudos; -jQuery.unique = Sizzle.uniqueSort; -jQuery.text = Sizzle.getText; -jQuery.isXMLDoc = Sizzle.isXML; -jQuery.contains = Sizzle.contains; - - - -var rneedsContext = jQuery.expr.match.needsContext; - -var rsingleTag = (/^<(\w+)\s*\/?>(?:<\/\1>|)$/); - - - -var risSimple = /^.[^:#\[\.,]*$/; - -// Implement the identical functionality for filter and not -function winnow( elements, qualifier, not ) { - if ( jQuery.isFunction( qualifier ) ) { - return jQuery.grep( elements, function( elem, i ) { - /* jshint -W018 */ - return !!qualifier.call( elem, i, elem ) !== not; - }); - - } - - if ( qualifier.nodeType ) { - return jQuery.grep( elements, function( elem ) { - return ( elem === qualifier ) !== not; - }); - - } - - if ( typeof qualifier === "string" ) { - if ( risSimple.test( qualifier ) ) { - return jQuery.filter( qualifier, elements, not ); - } - - qualifier = jQuery.filter( qualifier, elements ); - } - - return jQuery.grep( elements, function( elem ) { - return ( jQuery.inArray( elem, qualifier ) >= 0 ) !== not; - }); -} - -jQuery.filter = function( expr, elems, not ) { - var elem = elems[ 0 ]; - - if ( not ) { - expr = ":not(" + expr + ")"; - } - - return elems.length === 1 && elem.nodeType === 1 ? - jQuery.find.matchesSelector( elem, expr ) ? [ elem ] : [] : - jQuery.find.matches( expr, jQuery.grep( elems, function( elem ) { - return elem.nodeType === 1; - })); -}; - -jQuery.fn.extend({ - find: function( selector ) { - var i, - ret = [], - self = this, - len = self.length; - - if ( typeof selector !== "string" ) { - return this.pushStack( jQuery( selector ).filter(function() { - for ( i = 0; i < len; i++ ) { - if ( jQuery.contains( self[ i ], this ) ) { - return true; - } - } - }) ); - } - - for ( i = 0; i < len; i++ ) { - jQuery.find( selector, self[ i ], ret ); - } - - // Needed because $( selector, context ) becomes $( context ).find( selector ) - ret = this.pushStack( len > 1 ? jQuery.unique( ret ) : ret ); - ret.selector = this.selector ? this.selector + " " + selector : selector; - return ret; - }, - filter: function( selector ) { - return this.pushStack( winnow(this, selector || [], false) ); - }, - not: function( selector ) { - return this.pushStack( winnow(this, selector || [], true) ); - }, - is: function( selector ) { - return !!winnow( - this, - - // If this is a positional/relative selector, check membership in the returned set - // so $("p:first").is("p:last") won't return true for a doc with two "p". - typeof selector === "string" && rneedsContext.test( selector ) ? - jQuery( selector ) : - selector || [], - false - ).length; - } -}); - - -// Initialize a jQuery object - - -// A central reference to the root jQuery(document) -var rootjQuery, - - // Use the correct document accordingly with window argument (sandbox) - document = window.document, - - // A simple way to check for HTML strings - // Prioritize #id over to avoid XSS via location.hash (#9521) - // Strict HTML recognition (#11290: must start with <) - rquickExpr = /^(?:\s*(<[\w\W]+>)[^>]*|#([\w-]*))$/, - - init = jQuery.fn.init = function( selector, context ) { - var match, elem; - - // HANDLE: $(""), $(null), $(undefined), $(false) - if ( !selector ) { - return this; - } - - // Handle HTML strings - if ( typeof selector === "string" ) { - if ( selector.charAt(0) === "<" && selector.charAt( selector.length - 1 ) === ">" && selector.length >= 3 ) { - // Assume that strings that start and end with <> are HTML and skip the regex check - match = [ null, selector, null ]; - - } else { - match = rquickExpr.exec( selector ); - } - - // Match html or make sure no context is specified for #id - if ( match && (match[1] || !context) ) { - - // HANDLE: $(html) -> $(array) - if ( match[1] ) { - context = context instanceof jQuery ? context[0] : context; - - // scripts is true for back-compat - // Intentionally let the error be thrown if parseHTML is not present - jQuery.merge( this, jQuery.parseHTML( - match[1], - context && context.nodeType ? context.ownerDocument || context : document, - true - ) ); - - // HANDLE: $(html, props) - if ( rsingleTag.test( match[1] ) && jQuery.isPlainObject( context ) ) { - for ( match in context ) { - // Properties of context are called as methods if possible - if ( jQuery.isFunction( this[ match ] ) ) { - this[ match ]( context[ match ] ); - - // ...and otherwise set as attributes - } else { - this.attr( match, context[ match ] ); - } - } - } - - return this; - - // HANDLE: $(#id) - } else { - elem = document.getElementById( match[2] ); - - // Check parentNode to catch when Blackberry 4.6 returns - // nodes that are no longer in the document #6963 - if ( elem && elem.parentNode ) { - // Handle the case where IE and Opera return items - // by name instead of ID - if ( elem.id !== match[2] ) { - return rootjQuery.find( selector ); - } - - // Otherwise, we inject the element directly into the jQuery object - this.length = 1; - this[0] = elem; - } - - this.context = document; - this.selector = selector; - return this; - } - - // HANDLE: $(expr, $(...)) - } else if ( !context || context.jquery ) { - return ( context || rootjQuery ).find( selector ); - - // HANDLE: $(expr, context) - // (which is just equivalent to: $(context).find(expr) - } else { - return this.constructor( context ).find( selector ); - } - - // HANDLE: $(DOMElement) - } else if ( selector.nodeType ) { - this.context = this[0] = selector; - this.length = 1; - return this; - - // HANDLE: $(function) - // Shortcut for document ready - } else if ( jQuery.isFunction( selector ) ) { - return typeof rootjQuery.ready !== "undefined" ? - rootjQuery.ready( selector ) : - // Execute immediately if ready is not present - selector( jQuery ); - } - - if ( selector.selector !== undefined ) { - this.selector = selector.selector; - this.context = selector.context; - } - - return jQuery.makeArray( selector, this ); - }; - -// Give the init function the jQuery prototype for later instantiation -init.prototype = jQuery.fn; - -// Initialize central reference -rootjQuery = jQuery( document ); - - -var rparentsprev = /^(?:parents|prev(?:Until|All))/, - // methods guaranteed to produce a unique set when starting from a unique set - guaranteedUnique = { - children: true, - contents: true, - next: true, - prev: true - }; - -jQuery.extend({ - dir: function( elem, dir, until ) { - var matched = [], - cur = elem[ dir ]; - - while ( cur && cur.nodeType !== 9 && (until === undefined || cur.nodeType !== 1 || !jQuery( cur ).is( until )) ) { - if ( cur.nodeType === 1 ) { - matched.push( cur ); - } - cur = cur[dir]; - } - return matched; - }, - - sibling: function( n, elem ) { - var r = []; - - for ( ; n; n = n.nextSibling ) { - if ( n.nodeType === 1 && n !== elem ) { - r.push( n ); - } - } - - return r; - } -}); - -jQuery.fn.extend({ - has: function( target ) { - var i, - targets = jQuery( target, this ), - len = targets.length; - - return this.filter(function() { - for ( i = 0; i < len; i++ ) { - if ( jQuery.contains( this, targets[i] ) ) { - return true; - } - } - }); - }, - - closest: function( selectors, context ) { - var cur, - i = 0, - l = this.length, - matched = [], - pos = rneedsContext.test( selectors ) || typeof selectors !== "string" ? - jQuery( selectors, context || this.context ) : - 0; - - for ( ; i < l; i++ ) { - for ( cur = this[i]; cur && cur !== context; cur = cur.parentNode ) { - // Always skip document fragments - if ( cur.nodeType < 11 && (pos ? - pos.index(cur) > -1 : - - // Don't pass non-elements to Sizzle - cur.nodeType === 1 && - jQuery.find.matchesSelector(cur, selectors)) ) { - - matched.push( cur ); - break; - } - } - } - - return this.pushStack( matched.length > 1 ? jQuery.unique( matched ) : matched ); - }, - - // Determine the position of an element within - // the matched set of elements - index: function( elem ) { - - // No argument, return index in parent - if ( !elem ) { - return ( this[0] && this[0].parentNode ) ? this.first().prevAll().length : -1; - } - - // index in selector - if ( typeof elem === "string" ) { - return jQuery.inArray( this[0], jQuery( elem ) ); - } - - // Locate the position of the desired element - return jQuery.inArray( - // If it receives a jQuery object, the first element is used - elem.jquery ? elem[0] : elem, this ); - }, - - add: function( selector, context ) { - return this.pushStack( - jQuery.unique( - jQuery.merge( this.get(), jQuery( selector, context ) ) - ) - ); - }, - - addBack: function( selector ) { - return this.add( selector == null ? - this.prevObject : this.prevObject.filter(selector) - ); - } -}); - -function sibling( cur, dir ) { - do { - cur = cur[ dir ]; - } while ( cur && cur.nodeType !== 1 ); - - return cur; -} - -jQuery.each({ - parent: function( elem ) { - var parent = elem.parentNode; - return parent && parent.nodeType !== 11 ? parent : null; - }, - parents: function( elem ) { - return jQuery.dir( elem, "parentNode" ); - }, - parentsUntil: function( elem, i, until ) { - return jQuery.dir( elem, "parentNode", until ); - }, - next: function( elem ) { - return sibling( elem, "nextSibling" ); - }, - prev: function( elem ) { - return sibling( elem, "previousSibling" ); - }, - nextAll: function( elem ) { - return jQuery.dir( elem, "nextSibling" ); - }, - prevAll: function( elem ) { - return jQuery.dir( elem, "previousSibling" ); - }, - nextUntil: function( elem, i, until ) { - return jQuery.dir( elem, "nextSibling", until ); - }, - prevUntil: function( elem, i, until ) { - return jQuery.dir( elem, "previousSibling", until ); - }, - siblings: function( elem ) { - return jQuery.sibling( ( elem.parentNode || {} ).firstChild, elem ); - }, - children: function( elem ) { - return jQuery.sibling( elem.firstChild ); - }, - contents: function( elem ) { - return jQuery.nodeName( elem, "iframe" ) ? - elem.contentDocument || elem.contentWindow.document : - jQuery.merge( [], elem.childNodes ); - } -}, function( name, fn ) { - jQuery.fn[ name ] = function( until, selector ) { - var ret = jQuery.map( this, fn, until ); - - if ( name.slice( -5 ) !== "Until" ) { - selector = until; - } - - if ( selector && typeof selector === "string" ) { - ret = jQuery.filter( selector, ret ); - } - - if ( this.length > 1 ) { - // Remove duplicates - if ( !guaranteedUnique[ name ] ) { - ret = jQuery.unique( ret ); - } - - // Reverse order for parents* and prev-derivatives - if ( rparentsprev.test( name ) ) { - ret = ret.reverse(); - } - } - - return this.pushStack( ret ); - }; -}); -var rnotwhite = (/\S+/g); - - - -// String to Object options format cache -var optionsCache = {}; - -// Convert String-formatted options into Object-formatted ones and store in cache -function createOptions( options ) { - var object = optionsCache[ options ] = {}; - jQuery.each( options.match( rnotwhite ) || [], function( _, flag ) { - object[ flag ] = true; - }); - return object; -} - -/* - * Create a callback list using the following parameters: - * - * options: an optional list of space-separated options that will change how - * the callback list behaves or a more traditional option object - * - * By default a callback list will act like an event callback list and can be - * "fired" multiple times. - * - * Possible options: - * - * once: will ensure the callback list can only be fired once (like a Deferred) - * - * memory: will keep track of previous values and will call any callback added - * after the list has been fired right away with the latest "memorized" - * values (like a Deferred) - * - * unique: will ensure a callback can only be added once (no duplicate in the list) - * - * stopOnFalse: interrupt callings when a callback returns false - * - */ -jQuery.Callbacks = function( options ) { - - // Convert options from String-formatted to Object-formatted if needed - // (we check in cache first) - options = typeof options === "string" ? - ( optionsCache[ options ] || createOptions( options ) ) : - jQuery.extend( {}, options ); - - var // Flag to know if list is currently firing - firing, - // Last fire value (for non-forgettable lists) - memory, - // Flag to know if list was already fired - fired, - // End of the loop when firing - firingLength, - // Index of currently firing callback (modified by remove if needed) - firingIndex, - // First callback to fire (used internally by add and fireWith) - firingStart, - // Actual callback list - list = [], - // Stack of fire calls for repeatable lists - stack = !options.once && [], - // Fire callbacks - fire = function( data ) { - memory = options.memory && data; - fired = true; - firingIndex = firingStart || 0; - firingStart = 0; - firingLength = list.length; - firing = true; - for ( ; list && firingIndex < firingLength; firingIndex++ ) { - if ( list[ firingIndex ].apply( data[ 0 ], data[ 1 ] ) === false && options.stopOnFalse ) { - memory = false; // To prevent further calls using add - break; - } - } - firing = false; - if ( list ) { - if ( stack ) { - if ( stack.length ) { - fire( stack.shift() ); - } - } else if ( memory ) { - list = []; - } else { - self.disable(); - } - } - }, - // Actual Callbacks object - self = { - // Add a callback or a collection of callbacks to the list - add: function() { - if ( list ) { - // First, we save the current length - var start = list.length; - (function add( args ) { - jQuery.each( args, function( _, arg ) { - var type = jQuery.type( arg ); - if ( type === "function" ) { - if ( !options.unique || !self.has( arg ) ) { - list.push( arg ); - } - } else if ( arg && arg.length && type !== "string" ) { - // Inspect recursively - add( arg ); - } - }); - })( arguments ); - // Do we need to add the callbacks to the - // current firing batch? - if ( firing ) { - firingLength = list.length; - // With memory, if we're not firing then - // we should call right away - } else if ( memory ) { - firingStart = start; - fire( memory ); - } - } - return this; - }, - // Remove a callback from the list - remove: function() { - if ( list ) { - jQuery.each( arguments, function( _, arg ) { - var index; - while ( ( index = jQuery.inArray( arg, list, index ) ) > -1 ) { - list.splice( index, 1 ); - // Handle firing indexes - if ( firing ) { - if ( index <= firingLength ) { - firingLength--; - } - if ( index <= firingIndex ) { - firingIndex--; - } - } - } - }); - } - return this; - }, - // Check if a given callback is in the list. - // If no argument is given, return whether or not list has callbacks attached. - has: function( fn ) { - return fn ? jQuery.inArray( fn, list ) > -1 : !!( list && list.length ); - }, - // Remove all callbacks from the list - empty: function() { - list = []; - firingLength = 0; - return this; - }, - // Have the list do nothing anymore - disable: function() { - list = stack = memory = undefined; - return this; - }, - // Is it disabled? - disabled: function() { - return !list; - }, - // Lock the list in its current state - lock: function() { - stack = undefined; - if ( !memory ) { - self.disable(); - } - return this; - }, - // Is it locked? - locked: function() { - return !stack; - }, - // Call all callbacks with the given context and arguments - fireWith: function( context, args ) { - if ( list && ( !fired || stack ) ) { - args = args || []; - args = [ context, args.slice ? args.slice() : args ]; - if ( firing ) { - stack.push( args ); - } else { - fire( args ); - } - } - return this; - }, - // Call all the callbacks with the given arguments - fire: function() { - self.fireWith( this, arguments ); - return this; - }, - // To know if the callbacks have already been called at least once - fired: function() { - return !!fired; - } - }; - - return self; -}; - - -jQuery.extend({ - - Deferred: function( func ) { - var tuples = [ - // action, add listener, listener list, final state - [ "resolve", "done", jQuery.Callbacks("once memory"), "resolved" ], - [ "reject", "fail", jQuery.Callbacks("once memory"), "rejected" ], - [ "notify", "progress", jQuery.Callbacks("memory") ] - ], - state = "pending", - promise = { - state: function() { - return state; - }, - always: function() { - deferred.done( arguments ).fail( arguments ); - return this; - }, - then: function( /* fnDone, fnFail, fnProgress */ ) { - var fns = arguments; - return jQuery.Deferred(function( newDefer ) { - jQuery.each( tuples, function( i, tuple ) { - var fn = jQuery.isFunction( fns[ i ] ) && fns[ i ]; - // deferred[ done | fail | progress ] for forwarding actions to newDefer - deferred[ tuple[1] ](function() { - var returned = fn && fn.apply( this, arguments ); - if ( returned && jQuery.isFunction( returned.promise ) ) { - returned.promise() - .done( newDefer.resolve ) - .fail( newDefer.reject ) - .progress( newDefer.notify ); - } else { - newDefer[ tuple[ 0 ] + "With" ]( this === promise ? newDefer.promise() : this, fn ? [ returned ] : arguments ); - } - }); - }); - fns = null; - }).promise(); - }, - // Get a promise for this deferred - // If obj is provided, the promise aspect is added to the object - promise: function( obj ) { - return obj != null ? jQuery.extend( obj, promise ) : promise; - } - }, - deferred = {}; - - // Keep pipe for back-compat - promise.pipe = promise.then; - - // Add list-specific methods - jQuery.each( tuples, function( i, tuple ) { - var list = tuple[ 2 ], - stateString = tuple[ 3 ]; - - // promise[ done | fail | progress ] = list.add - promise[ tuple[1] ] = list.add; - - // Handle state - if ( stateString ) { - list.add(function() { - // state = [ resolved | rejected ] - state = stateString; - - // [ reject_list | resolve_list ].disable; progress_list.lock - }, tuples[ i ^ 1 ][ 2 ].disable, tuples[ 2 ][ 2 ].lock ); - } - - // deferred[ resolve | reject | notify ] - deferred[ tuple[0] ] = function() { - deferred[ tuple[0] + "With" ]( this === deferred ? promise : this, arguments ); - return this; - }; - deferred[ tuple[0] + "With" ] = list.fireWith; - }); - - // Make the deferred a promise - promise.promise( deferred ); - - // Call given func if any - if ( func ) { - func.call( deferred, deferred ); - } - - // All done! - return deferred; - }, - - // Deferred helper - when: function( subordinate /* , ..., subordinateN */ ) { - var i = 0, - resolveValues = slice.call( arguments ), - length = resolveValues.length, - - // the count of uncompleted subordinates - remaining = length !== 1 || ( subordinate && jQuery.isFunction( subordinate.promise ) ) ? length : 0, - - // the master Deferred. If resolveValues consist of only a single Deferred, just use that. - deferred = remaining === 1 ? subordinate : jQuery.Deferred(), - - // Update function for both resolve and progress values - updateFunc = function( i, contexts, values ) { - return function( value ) { - contexts[ i ] = this; - values[ i ] = arguments.length > 1 ? slice.call( arguments ) : value; - if ( values === progressValues ) { - deferred.notifyWith( contexts, values ); - - } else if ( !(--remaining) ) { - deferred.resolveWith( contexts, values ); - } - }; - }, - - progressValues, progressContexts, resolveContexts; - - // add listeners to Deferred subordinates; treat others as resolved - if ( length > 1 ) { - progressValues = new Array( length ); - progressContexts = new Array( length ); - resolveContexts = new Array( length ); - for ( ; i < length; i++ ) { - if ( resolveValues[ i ] && jQuery.isFunction( resolveValues[ i ].promise ) ) { - resolveValues[ i ].promise() - .done( updateFunc( i, resolveContexts, resolveValues ) ) - .fail( deferred.reject ) - .progress( updateFunc( i, progressContexts, progressValues ) ); - } else { - --remaining; - } - } - } - - // if we're not waiting on anything, resolve the master - if ( !remaining ) { - deferred.resolveWith( resolveContexts, resolveValues ); - } - - return deferred.promise(); - } -}); - - -// The deferred used on DOM ready -var readyList; - -jQuery.fn.ready = function( fn ) { - // Add the callback - jQuery.ready.promise().done( fn ); - - return this; -}; - -jQuery.extend({ - // Is the DOM ready to be used? Set to true once it occurs. - isReady: false, - - // A counter to track how many items to wait for before - // the ready event fires. See #6781 - readyWait: 1, - - // Hold (or release) the ready event - holdReady: function( hold ) { - if ( hold ) { - jQuery.readyWait++; - } else { - jQuery.ready( true ); - } - }, - - // Handle when the DOM is ready - ready: function( wait ) { - - // Abort if there are pending holds or we're already ready - if ( wait === true ? --jQuery.readyWait : jQuery.isReady ) { - return; - } - - // Make sure body exists, at least, in case IE gets a little overzealous (ticket #5443). - if ( !document.body ) { - return setTimeout( jQuery.ready ); - } - - // Remember that the DOM is ready - jQuery.isReady = true; - - // If a normal DOM Ready event fired, decrement, and wait if need be - if ( wait !== true && --jQuery.readyWait > 0 ) { - return; - } - - // If there are functions bound, to execute - readyList.resolveWith( document, [ jQuery ] ); - - // Trigger any bound ready events - if ( jQuery.fn.triggerHandler ) { - jQuery( document ).triggerHandler( "ready" ); - jQuery( document ).off( "ready" ); - } - } -}); - -/** - * Clean-up method for dom ready events - */ -function detach() { - if ( document.addEventListener ) { - document.removeEventListener( "DOMContentLoaded", completed, false ); - window.removeEventListener( "load", completed, false ); - - } else { - document.detachEvent( "onreadystatechange", completed ); - window.detachEvent( "onload", completed ); - } -} - -/** - * The ready event handler and self cleanup method - */ -function completed() { - // readyState === "complete" is good enough for us to call the dom ready in oldIE - if ( document.addEventListener || event.type === "load" || document.readyState === "complete" ) { - detach(); - jQuery.ready(); - } -} - -jQuery.ready.promise = function( obj ) { - if ( !readyList ) { - - readyList = jQuery.Deferred(); - - // Catch cases where $(document).ready() is called after the browser event has already occurred. - // we once tried to use readyState "interactive" here, but it caused issues like the one - // discovered by ChrisS here: http://bugs.jquery.com/ticket/12282#comment:15 - if ( document.readyState === "complete" ) { - // Handle it asynchronously to allow scripts the opportunity to delay ready - setTimeout( jQuery.ready ); - - // Standards-based browsers support DOMContentLoaded - } else if ( document.addEventListener ) { - // Use the handy event callback - document.addEventListener( "DOMContentLoaded", completed, false ); - - // A fallback to window.onload, that will always work - window.addEventListener( "load", completed, false ); - - // If IE event model is used - } else { - // Ensure firing before onload, maybe late but safe also for iframes - document.attachEvent( "onreadystatechange", completed ); - - // A fallback to window.onload, that will always work - window.attachEvent( "onload", completed ); - - // If IE and not a frame - // continually check to see if the document is ready - var top = false; - - try { - top = window.frameElement == null && document.documentElement; - } catch(e) {} - - if ( top && top.doScroll ) { - (function doScrollCheck() { - if ( !jQuery.isReady ) { - - try { - // Use the trick by Diego Perini - // http://javascript.nwbox.com/IEContentLoaded/ - top.doScroll("left"); - } catch(e) { - return setTimeout( doScrollCheck, 50 ); - } - - // detach all dom ready events - detach(); - - // and execute any waiting functions - jQuery.ready(); - } - })(); - } - } - } - return readyList.promise( obj ); -}; - - -var strundefined = typeof undefined; - - - -// Support: IE<9 -// Iteration over object's inherited properties before its own -var i; -for ( i in jQuery( support ) ) { - break; -} -support.ownLast = i !== "0"; - -// Note: most support tests are defined in their respective modules. -// false until the test is run -support.inlineBlockNeedsLayout = false; - -// Execute ASAP in case we need to set body.style.zoom -jQuery(function() { - // Minified: var a,b,c,d - var val, div, body, container; - - body = document.getElementsByTagName( "body" )[ 0 ]; - if ( !body || !body.style ) { - // Return for frameset docs that don't have a body - return; - } - - // Setup - div = document.createElement( "div" ); - container = document.createElement( "div" ); - container.style.cssText = "position:absolute;border:0;width:0;height:0;top:0;left:-9999px"; - body.appendChild( container ).appendChild( div ); - - if ( typeof div.style.zoom !== strundefined ) { - // Support: IE<8 - // Check if natively block-level elements act like inline-block - // elements when setting their display to 'inline' and giving - // them layout - div.style.cssText = "display:inline;margin:0;border:0;padding:1px;width:1px;zoom:1"; - - support.inlineBlockNeedsLayout = val = div.offsetWidth === 3; - if ( val ) { - // Prevent IE 6 from affecting layout for positioned elements #11048 - // Prevent IE from shrinking the body in IE 7 mode #12869 - // Support: IE<8 - body.style.zoom = 1; - } - } - - body.removeChild( container ); -}); - - - - -(function() { - var div = document.createElement( "div" ); - - // Execute the test only if not already executed in another module. - if (support.deleteExpando == null) { - // Support: IE<9 - support.deleteExpando = true; - try { - delete div.test; - } catch( e ) { - support.deleteExpando = false; - } - } - - // Null elements to avoid leaks in IE. - div = null; -})(); - - -/** - * Determines whether an object can have data - */ -jQuery.acceptData = function( elem ) { - var noData = jQuery.noData[ (elem.nodeName + " ").toLowerCase() ], - nodeType = +elem.nodeType || 1; - - // Do not set data on non-element DOM nodes because it will not be cleared (#8335). - return nodeType !== 1 && nodeType !== 9 ? - false : - - // Nodes accept data unless otherwise specified; rejection can be conditional - !noData || noData !== true && elem.getAttribute("classid") === noData; -}; - - -var rbrace = /^(?:\{[\w\W]*\}|\[[\w\W]*\])$/, - rmultiDash = /([A-Z])/g; - -function dataAttr( elem, key, data ) { - // If nothing was found internally, try to fetch any - // data from the HTML5 data-* attribute - if ( data === undefined && elem.nodeType === 1 ) { - - var name = "data-" + key.replace( rmultiDash, "-$1" ).toLowerCase(); - - data = elem.getAttribute( name ); - - if ( typeof data === "string" ) { - try { - data = data === "true" ? true : - data === "false" ? false : - data === "null" ? null : - // Only convert to a number if it doesn't change the string - +data + "" === data ? +data : - rbrace.test( data ) ? jQuery.parseJSON( data ) : - data; - } catch( e ) {} - - // Make sure we set the data so it isn't changed later - jQuery.data( elem, key, data ); - - } else { - data = undefined; - } - } - - return data; -} - -// checks a cache object for emptiness -function isEmptyDataObject( obj ) { - var name; - for ( name in obj ) { - - // if the public data object is empty, the private is still empty - if ( name === "data" && jQuery.isEmptyObject( obj[name] ) ) { - continue; - } - if ( name !== "toJSON" ) { - return false; - } - } - - return true; -} - -function internalData( elem, name, data, pvt /* Internal Use Only */ ) { - if ( !jQuery.acceptData( elem ) ) { - return; - } - - var ret, thisCache, - internalKey = jQuery.expando, - - // We have to handle DOM nodes and JS objects differently because IE6-7 - // can't GC object references properly across the DOM-JS boundary - isNode = elem.nodeType, - - // Only DOM nodes need the global jQuery cache; JS object data is - // attached directly to the object so GC can occur automatically - cache = isNode ? jQuery.cache : elem, - - // Only defining an ID for JS objects if its cache already exists allows - // the code to shortcut on the same path as a DOM node with no cache - id = isNode ? elem[ internalKey ] : elem[ internalKey ] && internalKey; - - // Avoid doing any more work than we need to when trying to get data on an - // object that has no data at all - if ( (!id || !cache[id] || (!pvt && !cache[id].data)) && data === undefined && typeof name === "string" ) { - return; - } - - if ( !id ) { - // Only DOM nodes need a new unique ID for each element since their data - // ends up in the global cache - if ( isNode ) { - id = elem[ internalKey ] = deletedIds.pop() || jQuery.guid++; - } else { - id = internalKey; - } - } - - if ( !cache[ id ] ) { - // Avoid exposing jQuery metadata on plain JS objects when the object - // is serialized using JSON.stringify - cache[ id ] = isNode ? {} : { toJSON: jQuery.noop }; - } - - // An object can be passed to jQuery.data instead of a key/value pair; this gets - // shallow copied over onto the existing cache - if ( typeof name === "object" || typeof name === "function" ) { - if ( pvt ) { - cache[ id ] = jQuery.extend( cache[ id ], name ); - } else { - cache[ id ].data = jQuery.extend( cache[ id ].data, name ); - } - } - - thisCache = cache[ id ]; - - // jQuery data() is stored in a separate object inside the object's internal data - // cache in order to avoid key collisions between internal data and user-defined - // data. - if ( !pvt ) { - if ( !thisCache.data ) { - thisCache.data = {}; - } - - thisCache = thisCache.data; - } - - if ( data !== undefined ) { - thisCache[ jQuery.camelCase( name ) ] = data; - } - - // Check for both converted-to-camel and non-converted data property names - // If a data property was specified - if ( typeof name === "string" ) { - - // First Try to find as-is property data - ret = thisCache[ name ]; - - // Test for null|undefined property data - if ( ret == null ) { - - // Try to find the camelCased property - ret = thisCache[ jQuery.camelCase( name ) ]; - } - } else { - ret = thisCache; - } - - return ret; -} - -function internalRemoveData( elem, name, pvt ) { - if ( !jQuery.acceptData( elem ) ) { - return; - } - - var thisCache, i, - isNode = elem.nodeType, - - // See jQuery.data for more information - cache = isNode ? jQuery.cache : elem, - id = isNode ? elem[ jQuery.expando ] : jQuery.expando; - - // If there is already no cache entry for this object, there is no - // purpose in continuing - if ( !cache[ id ] ) { - return; - } - - if ( name ) { - - thisCache = pvt ? cache[ id ] : cache[ id ].data; - - if ( thisCache ) { - - // Support array or space separated string names for data keys - if ( !jQuery.isArray( name ) ) { - - // try the string as a key before any manipulation - if ( name in thisCache ) { - name = [ name ]; - } else { - - // split the camel cased version by spaces unless a key with the spaces exists - name = jQuery.camelCase( name ); - if ( name in thisCache ) { - name = [ name ]; - } else { - name = name.split(" "); - } - } - } else { - // If "name" is an array of keys... - // When data is initially created, via ("key", "val") signature, - // keys will be converted to camelCase. - // Since there is no way to tell _how_ a key was added, remove - // both plain key and camelCase key. #12786 - // This will only penalize the array argument path. - name = name.concat( jQuery.map( name, jQuery.camelCase ) ); - } - - i = name.length; - while ( i-- ) { - delete thisCache[ name[i] ]; - } - - // If there is no data left in the cache, we want to continue - // and let the cache object itself get destroyed - if ( pvt ? !isEmptyDataObject(thisCache) : !jQuery.isEmptyObject(thisCache) ) { - return; - } - } - } - - // See jQuery.data for more information - if ( !pvt ) { - delete cache[ id ].data; - - // Don't destroy the parent cache unless the internal data object - // had been the only thing left in it - if ( !isEmptyDataObject( cache[ id ] ) ) { - return; - } - } - - // Destroy the cache - if ( isNode ) { - jQuery.cleanData( [ elem ], true ); - - // Use delete when supported for expandos or `cache` is not a window per isWindow (#10080) - /* jshint eqeqeq: false */ - } else if ( support.deleteExpando || cache != cache.window ) { - /* jshint eqeqeq: true */ - delete cache[ id ]; - - // When all else fails, null - } else { - cache[ id ] = null; - } -} - -jQuery.extend({ - cache: {}, - - // The following elements (space-suffixed to avoid Object.prototype collisions) - // throw uncatchable exceptions if you attempt to set expando properties - noData: { - "applet ": true, - "embed ": true, - // ...but Flash objects (which have this classid) *can* handle expandos - "object ": "clsid:D27CDB6E-AE6D-11cf-96B8-444553540000" - }, - - hasData: function( elem ) { - elem = elem.nodeType ? jQuery.cache[ elem[jQuery.expando] ] : elem[ jQuery.expando ]; - return !!elem && !isEmptyDataObject( elem ); - }, - - data: function( elem, name, data ) { - return internalData( elem, name, data ); - }, - - removeData: function( elem, name ) { - return internalRemoveData( elem, name ); - }, - - // For internal use only. - _data: function( elem, name, data ) { - return internalData( elem, name, data, true ); - }, - - _removeData: function( elem, name ) { - return internalRemoveData( elem, name, true ); - } -}); - -jQuery.fn.extend({ - data: function( key, value ) { - var i, name, data, - elem = this[0], - attrs = elem && elem.attributes; - - // Special expections of .data basically thwart jQuery.access, - // so implement the relevant behavior ourselves - - // Gets all values - if ( key === undefined ) { - if ( this.length ) { - data = jQuery.data( elem ); - - if ( elem.nodeType === 1 && !jQuery._data( elem, "parsedAttrs" ) ) { - i = attrs.length; - while ( i-- ) { - - // Support: IE11+ - // The attrs elements can be null (#14894) - if ( attrs[ i ] ) { - name = attrs[ i ].name; - if ( name.indexOf( "data-" ) === 0 ) { - name = jQuery.camelCase( name.slice(5) ); - dataAttr( elem, name, data[ name ] ); - } - } - } - jQuery._data( elem, "parsedAttrs", true ); - } - } - - return data; - } - - // Sets multiple values - if ( typeof key === "object" ) { - return this.each(function() { - jQuery.data( this, key ); - }); - } - - return arguments.length > 1 ? - - // Sets one value - this.each(function() { - jQuery.data( this, key, value ); - }) : - - // Gets one value - // Try to fetch any internally stored data first - elem ? dataAttr( elem, key, jQuery.data( elem, key ) ) : undefined; - }, - - removeData: function( key ) { - return this.each(function() { - jQuery.removeData( this, key ); - }); - } -}); - - -jQuery.extend({ - queue: function( elem, type, data ) { - var queue; - - if ( elem ) { - type = ( type || "fx" ) + "queue"; - queue = jQuery._data( elem, type ); - - // Speed up dequeue by getting out quickly if this is just a lookup - if ( data ) { - if ( !queue || jQuery.isArray(data) ) { - queue = jQuery._data( elem, type, jQuery.makeArray(data) ); - } else { - queue.push( data ); - } - } - return queue || []; - } - }, - - dequeue: function( elem, type ) { - type = type || "fx"; - - var queue = jQuery.queue( elem, type ), - startLength = queue.length, - fn = queue.shift(), - hooks = jQuery._queueHooks( elem, type ), - next = function() { - jQuery.dequeue( elem, type ); - }; - - // If the fx queue is dequeued, always remove the progress sentinel - if ( fn === "inprogress" ) { - fn = queue.shift(); - startLength--; - } - - if ( fn ) { - - // Add a progress sentinel to prevent the fx queue from being - // automatically dequeued - if ( type === "fx" ) { - queue.unshift( "inprogress" ); - } - - // clear up the last queue stop function - delete hooks.stop; - fn.call( elem, next, hooks ); - } - - if ( !startLength && hooks ) { - hooks.empty.fire(); - } - }, - - // not intended for public consumption - generates a queueHooks object, or returns the current one - _queueHooks: function( elem, type ) { - var key = type + "queueHooks"; - return jQuery._data( elem, key ) || jQuery._data( elem, key, { - empty: jQuery.Callbacks("once memory").add(function() { - jQuery._removeData( elem, type + "queue" ); - jQuery._removeData( elem, key ); - }) - }); - } -}); - -jQuery.fn.extend({ - queue: function( type, data ) { - var setter = 2; - - if ( typeof type !== "string" ) { - data = type; - type = "fx"; - setter--; - } - - if ( arguments.length < setter ) { - return jQuery.queue( this[0], type ); - } - - return data === undefined ? - this : - this.each(function() { - var queue = jQuery.queue( this, type, data ); - - // ensure a hooks for this queue - jQuery._queueHooks( this, type ); - - if ( type === "fx" && queue[0] !== "inprogress" ) { - jQuery.dequeue( this, type ); - } - }); - }, - dequeue: function( type ) { - return this.each(function() { - jQuery.dequeue( this, type ); - }); - }, - clearQueue: function( type ) { - return this.queue( type || "fx", [] ); - }, - // Get a promise resolved when queues of a certain type - // are emptied (fx is the type by default) - promise: function( type, obj ) { - var tmp, - count = 1, - defer = jQuery.Deferred(), - elements = this, - i = this.length, - resolve = function() { - if ( !( --count ) ) { - defer.resolveWith( elements, [ elements ] ); - } - }; - - if ( typeof type !== "string" ) { - obj = type; - type = undefined; - } - type = type || "fx"; - - while ( i-- ) { - tmp = jQuery._data( elements[ i ], type + "queueHooks" ); - if ( tmp && tmp.empty ) { - count++; - tmp.empty.add( resolve ); - } - } - resolve(); - return defer.promise( obj ); - } -}); -var pnum = (/[+-]?(?:\d*\.|)\d+(?:[eE][+-]?\d+|)/).source; - -var cssExpand = [ "Top", "Right", "Bottom", "Left" ]; - -var isHidden = function( elem, el ) { - // isHidden might be called from jQuery#filter function; - // in that case, element will be second argument - elem = el || elem; - return jQuery.css( elem, "display" ) === "none" || !jQuery.contains( elem.ownerDocument, elem ); - }; - - - -// Multifunctional method to get and set values of a collection -// The value/s can optionally be executed if it's a function -var access = jQuery.access = function( elems, fn, key, value, chainable, emptyGet, raw ) { - var i = 0, - length = elems.length, - bulk = key == null; - - // Sets many values - if ( jQuery.type( key ) === "object" ) { - chainable = true; - for ( i in key ) { - jQuery.access( elems, fn, i, key[i], true, emptyGet, raw ); - } - - // Sets one value - } else if ( value !== undefined ) { - chainable = true; - - if ( !jQuery.isFunction( value ) ) { - raw = true; - } - - if ( bulk ) { - // Bulk operations run against the entire set - if ( raw ) { - fn.call( elems, value ); - fn = null; - - // ...except when executing function values - } else { - bulk = fn; - fn = function( elem, key, value ) { - return bulk.call( jQuery( elem ), value ); - }; - } - } - - if ( fn ) { - for ( ; i < length; i++ ) { - fn( elems[i], key, raw ? value : value.call( elems[i], i, fn( elems[i], key ) ) ); - } - } - } - - return chainable ? - elems : - - // Gets - bulk ? - fn.call( elems ) : - length ? fn( elems[0], key ) : emptyGet; -}; -var rcheckableType = (/^(?:checkbox|radio)$/i); - - - -(function() { - // Minified: var a,b,c - var input = document.createElement( "input" ), - div = document.createElement( "div" ), - fragment = document.createDocumentFragment(); - - // Setup - div.innerHTML = "
a"; - - // IE strips leading whitespace when .innerHTML is used - support.leadingWhitespace = div.firstChild.nodeType === 3; - - // Make sure that tbody elements aren't automatically inserted - // IE will insert them into empty tables - support.tbody = !div.getElementsByTagName( "tbody" ).length; - - // Make sure that link elements get serialized correctly by innerHTML - // This requires a wrapper element in IE - support.htmlSerialize = !!div.getElementsByTagName( "link" ).length; - - // Makes sure cloning an html5 element does not cause problems - // Where outerHTML is undefined, this still works - support.html5Clone = - document.createElement( "nav" ).cloneNode( true ).outerHTML !== "<:nav>"; - - // Check if a disconnected checkbox will retain its checked - // value of true after appended to the DOM (IE6/7) - input.type = "checkbox"; - input.checked = true; - fragment.appendChild( input ); - support.appendChecked = input.checked; - - // Make sure textarea (and checkbox) defaultValue is properly cloned - // Support: IE6-IE11+ - div.innerHTML = ""; - support.noCloneChecked = !!div.cloneNode( true ).lastChild.defaultValue; - - // #11217 - WebKit loses check when the name is after the checked attribute - fragment.appendChild( div ); - div.innerHTML = ""; - - // Support: Safari 5.1, iOS 5.1, Android 4.x, Android 2.3 - // old WebKit doesn't clone checked state correctly in fragments - support.checkClone = div.cloneNode( true ).cloneNode( true ).lastChild.checked; - - // Support: IE<9 - // Opera does not clone events (and typeof div.attachEvent === undefined). - // IE9-10 clones events bound via attachEvent, but they don't trigger with .click() - support.noCloneEvent = true; - if ( div.attachEvent ) { - div.attachEvent( "onclick", function() { - support.noCloneEvent = false; - }); - - div.cloneNode( true ).click(); - } - - // Execute the test only if not already executed in another module. - if (support.deleteExpando == null) { - // Support: IE<9 - support.deleteExpando = true; - try { - delete div.test; - } catch( e ) { - support.deleteExpando = false; - } - } -})(); - - -(function() { - var i, eventName, - div = document.createElement( "div" ); - - // Support: IE<9 (lack submit/change bubble), Firefox 23+ (lack focusin event) - for ( i in { submit: true, change: true, focusin: true }) { - eventName = "on" + i; - - if ( !(support[ i + "Bubbles" ] = eventName in window) ) { - // Beware of CSP restrictions (https://developer.mozilla.org/en/Security/CSP) - div.setAttribute( eventName, "t" ); - support[ i + "Bubbles" ] = div.attributes[ eventName ].expando === false; - } - } - - // Null elements to avoid leaks in IE. - div = null; -})(); - - -var rformElems = /^(?:input|select|textarea)$/i, - rkeyEvent = /^key/, - rmouseEvent = /^(?:mouse|pointer|contextmenu)|click/, - rfocusMorph = /^(?:focusinfocus|focusoutblur)$/, - rtypenamespace = /^([^.]*)(?:\.(.+)|)$/; - -function returnTrue() { - return true; -} - -function returnFalse() { - return false; -} - -function safeActiveElement() { - try { - return document.activeElement; - } catch ( err ) { } -} - -/* - * Helper functions for managing events -- not part of the public interface. - * Props to Dean Edwards' addEvent library for many of the ideas. - */ -jQuery.event = { - - global: {}, - - add: function( elem, types, handler, data, selector ) { - var tmp, events, t, handleObjIn, - special, eventHandle, handleObj, - handlers, type, namespaces, origType, - elemData = jQuery._data( elem ); - - // Don't attach events to noData or text/comment nodes (but allow plain objects) - if ( !elemData ) { - return; - } - - // Caller can pass in an object of custom data in lieu of the handler - if ( handler.handler ) { - handleObjIn = handler; - handler = handleObjIn.handler; - selector = handleObjIn.selector; - } - - // Make sure that the handler has a unique ID, used to find/remove it later - if ( !handler.guid ) { - handler.guid = jQuery.guid++; - } - - // Init the element's event structure and main handler, if this is the first - if ( !(events = elemData.events) ) { - events = elemData.events = {}; - } - if ( !(eventHandle = elemData.handle) ) { - eventHandle = elemData.handle = function( e ) { - // Discard the second event of a jQuery.event.trigger() and - // when an event is called after a page has unloaded - return typeof jQuery !== strundefined && (!e || jQuery.event.triggered !== e.type) ? - jQuery.event.dispatch.apply( eventHandle.elem, arguments ) : - undefined; - }; - // Add elem as a property of the handle fn to prevent a memory leak with IE non-native events - eventHandle.elem = elem; - } - - // Handle multiple events separated by a space - types = ( types || "" ).match( rnotwhite ) || [ "" ]; - t = types.length; - while ( t-- ) { - tmp = rtypenamespace.exec( types[t] ) || []; - type = origType = tmp[1]; - namespaces = ( tmp[2] || "" ).split( "." ).sort(); - - // There *must* be a type, no attaching namespace-only handlers - if ( !type ) { - continue; - } - - // If event changes its type, use the special event handlers for the changed type - special = jQuery.event.special[ type ] || {}; - - // If selector defined, determine special event api type, otherwise given type - type = ( selector ? special.delegateType : special.bindType ) || type; - - // Update special based on newly reset type - special = jQuery.event.special[ type ] || {}; - - // handleObj is passed to all event handlers - handleObj = jQuery.extend({ - type: type, - origType: origType, - data: data, - handler: handler, - guid: handler.guid, - selector: selector, - needsContext: selector && jQuery.expr.match.needsContext.test( selector ), - namespace: namespaces.join(".") - }, handleObjIn ); - - // Init the event handler queue if we're the first - if ( !(handlers = events[ type ]) ) { - handlers = events[ type ] = []; - handlers.delegateCount = 0; - - // Only use addEventListener/attachEvent if the special events handler returns false - if ( !special.setup || special.setup.call( elem, data, namespaces, eventHandle ) === false ) { - // Bind the global event handler to the element - if ( elem.addEventListener ) { - elem.addEventListener( type, eventHandle, false ); - - } else if ( elem.attachEvent ) { - elem.attachEvent( "on" + type, eventHandle ); - } - } - } - - if ( special.add ) { - special.add.call( elem, handleObj ); - - if ( !handleObj.handler.guid ) { - handleObj.handler.guid = handler.guid; - } - } - - // Add to the element's handler list, delegates in front - if ( selector ) { - handlers.splice( handlers.delegateCount++, 0, handleObj ); - } else { - handlers.push( handleObj ); - } - - // Keep track of which events have ever been used, for event optimization - jQuery.event.global[ type ] = true; - } - - // Nullify elem to prevent memory leaks in IE - elem = null; - }, - - // Detach an event or set of events from an element - remove: function( elem, types, handler, selector, mappedTypes ) { - var j, handleObj, tmp, - origCount, t, events, - special, handlers, type, - namespaces, origType, - elemData = jQuery.hasData( elem ) && jQuery._data( elem ); - - if ( !elemData || !(events = elemData.events) ) { - return; - } - - // Once for each type.namespace in types; type may be omitted - types = ( types || "" ).match( rnotwhite ) || [ "" ]; - t = types.length; - while ( t-- ) { - tmp = rtypenamespace.exec( types[t] ) || []; - type = origType = tmp[1]; - namespaces = ( tmp[2] || "" ).split( "." ).sort(); - - // Unbind all events (on this namespace, if provided) for the element - if ( !type ) { - for ( type in events ) { - jQuery.event.remove( elem, type + types[ t ], handler, selector, true ); - } - continue; - } - - special = jQuery.event.special[ type ] || {}; - type = ( selector ? special.delegateType : special.bindType ) || type; - handlers = events[ type ] || []; - tmp = tmp[2] && new RegExp( "(^|\\.)" + namespaces.join("\\.(?:.*\\.|)") + "(\\.|$)" ); - - // Remove matching events - origCount = j = handlers.length; - while ( j-- ) { - handleObj = handlers[ j ]; - - if ( ( mappedTypes || origType === handleObj.origType ) && - ( !handler || handler.guid === handleObj.guid ) && - ( !tmp || tmp.test( handleObj.namespace ) ) && - ( !selector || selector === handleObj.selector || selector === "**" && handleObj.selector ) ) { - handlers.splice( j, 1 ); - - if ( handleObj.selector ) { - handlers.delegateCount--; - } - if ( special.remove ) { - special.remove.call( elem, handleObj ); - } - } - } - - // Remove generic event handler if we removed something and no more handlers exist - // (avoids potential for endless recursion during removal of special event handlers) - if ( origCount && !handlers.length ) { - if ( !special.teardown || special.teardown.call( elem, namespaces, elemData.handle ) === false ) { - jQuery.removeEvent( elem, type, elemData.handle ); - } - - delete events[ type ]; - } - } - - // Remove the expando if it's no longer used - if ( jQuery.isEmptyObject( events ) ) { - delete elemData.handle; - - // removeData also checks for emptiness and clears the expando if empty - // so use it instead of delete - jQuery._removeData( elem, "events" ); - } - }, - - trigger: function( event, data, elem, onlyHandlers ) { - var handle, ontype, cur, - bubbleType, special, tmp, i, - eventPath = [ elem || document ], - type = hasOwn.call( event, "type" ) ? event.type : event, - namespaces = hasOwn.call( event, "namespace" ) ? event.namespace.split(".") : []; - - cur = tmp = elem = elem || document; - - // Don't do events on text and comment nodes - if ( elem.nodeType === 3 || elem.nodeType === 8 ) { - return; - } - - // focus/blur morphs to focusin/out; ensure we're not firing them right now - if ( rfocusMorph.test( type + jQuery.event.triggered ) ) { - return; - } - - if ( type.indexOf(".") >= 0 ) { - // Namespaced trigger; create a regexp to match event type in handle() - namespaces = type.split("."); - type = namespaces.shift(); - namespaces.sort(); - } - ontype = type.indexOf(":") < 0 && "on" + type; - - // Caller can pass in a jQuery.Event object, Object, or just an event type string - event = event[ jQuery.expando ] ? - event : - new jQuery.Event( type, typeof event === "object" && event ); - - // Trigger bitmask: & 1 for native handlers; & 2 for jQuery (always true) - event.isTrigger = onlyHandlers ? 2 : 3; - event.namespace = namespaces.join("."); - event.namespace_re = event.namespace ? - new RegExp( "(^|\\.)" + namespaces.join("\\.(?:.*\\.|)") + "(\\.|$)" ) : - null; - - // Clean up the event in case it is being reused - event.result = undefined; - if ( !event.target ) { - event.target = elem; - } - - // Clone any incoming data and prepend the event, creating the handler arg list - data = data == null ? - [ event ] : - jQuery.makeArray( data, [ event ] ); - - // Allow special events to draw outside the lines - special = jQuery.event.special[ type ] || {}; - if ( !onlyHandlers && special.trigger && special.trigger.apply( elem, data ) === false ) { - return; - } - - // Determine event propagation path in advance, per W3C events spec (#9951) - // Bubble up to document, then to window; watch for a global ownerDocument var (#9724) - if ( !onlyHandlers && !special.noBubble && !jQuery.isWindow( elem ) ) { - - bubbleType = special.delegateType || type; - if ( !rfocusMorph.test( bubbleType + type ) ) { - cur = cur.parentNode; - } - for ( ; cur; cur = cur.parentNode ) { - eventPath.push( cur ); - tmp = cur; - } - - // Only add window if we got to document (e.g., not plain obj or detached DOM) - if ( tmp === (elem.ownerDocument || document) ) { - eventPath.push( tmp.defaultView || tmp.parentWindow || window ); - } - } - - // Fire handlers on the event path - i = 0; - while ( (cur = eventPath[i++]) && !event.isPropagationStopped() ) { - - event.type = i > 1 ? - bubbleType : - special.bindType || type; - - // jQuery handler - handle = ( jQuery._data( cur, "events" ) || {} )[ event.type ] && jQuery._data( cur, "handle" ); - if ( handle ) { - handle.apply( cur, data ); - } - - // Native handler - handle = ontype && cur[ ontype ]; - if ( handle && handle.apply && jQuery.acceptData( cur ) ) { - event.result = handle.apply( cur, data ); - if ( event.result === false ) { - event.preventDefault(); - } - } - } - event.type = type; - - // If nobody prevented the default action, do it now - if ( !onlyHandlers && !event.isDefaultPrevented() ) { - - if ( (!special._default || special._default.apply( eventPath.pop(), data ) === false) && - jQuery.acceptData( elem ) ) { - - // Call a native DOM method on the target with the same name name as the event. - // Can't use an .isFunction() check here because IE6/7 fails that test. - // Don't do default actions on window, that's where global variables be (#6170) - if ( ontype && elem[ type ] && !jQuery.isWindow( elem ) ) { - - // Don't re-trigger an onFOO event when we call its FOO() method - tmp = elem[ ontype ]; - - if ( tmp ) { - elem[ ontype ] = null; - } - - // Prevent re-triggering of the same event, since we already bubbled it above - jQuery.event.triggered = type; - try { - elem[ type ](); - } catch ( e ) { - // IE<9 dies on focus/blur to hidden element (#1486,#12518) - // only reproducible on winXP IE8 native, not IE9 in IE8 mode - } - jQuery.event.triggered = undefined; - - if ( tmp ) { - elem[ ontype ] = tmp; - } - } - } - } - - return event.result; - }, - - dispatch: function( event ) { - - // Make a writable jQuery.Event from the native event object - event = jQuery.event.fix( event ); - - var i, ret, handleObj, matched, j, - handlerQueue = [], - args = slice.call( arguments ), - handlers = ( jQuery._data( this, "events" ) || {} )[ event.type ] || [], - special = jQuery.event.special[ event.type ] || {}; - - // Use the fix-ed jQuery.Event rather than the (read-only) native event - args[0] = event; - event.delegateTarget = this; - - // Call the preDispatch hook for the mapped type, and let it bail if desired - if ( special.preDispatch && special.preDispatch.call( this, event ) === false ) { - return; - } - - // Determine handlers - handlerQueue = jQuery.event.handlers.call( this, event, handlers ); - - // Run delegates first; they may want to stop propagation beneath us - i = 0; - while ( (matched = handlerQueue[ i++ ]) && !event.isPropagationStopped() ) { - event.currentTarget = matched.elem; - - j = 0; - while ( (handleObj = matched.handlers[ j++ ]) && !event.isImmediatePropagationStopped() ) { - - // Triggered event must either 1) have no namespace, or - // 2) have namespace(s) a subset or equal to those in the bound event (both can have no namespace). - if ( !event.namespace_re || event.namespace_re.test( handleObj.namespace ) ) { - - event.handleObj = handleObj; - event.data = handleObj.data; - - ret = ( (jQuery.event.special[ handleObj.origType ] || {}).handle || handleObj.handler ) - .apply( matched.elem, args ); - - if ( ret !== undefined ) { - if ( (event.result = ret) === false ) { - event.preventDefault(); - event.stopPropagation(); - } - } - } - } - } - - // Call the postDispatch hook for the mapped type - if ( special.postDispatch ) { - special.postDispatch.call( this, event ); - } - - return event.result; - }, - - handlers: function( event, handlers ) { - var sel, handleObj, matches, i, - handlerQueue = [], - delegateCount = handlers.delegateCount, - cur = event.target; - - // Find delegate handlers - // Black-hole SVG instance trees (#13180) - // Avoid non-left-click bubbling in Firefox (#3861) - if ( delegateCount && cur.nodeType && (!event.button || event.type !== "click") ) { - - /* jshint eqeqeq: false */ - for ( ; cur != this; cur = cur.parentNode || this ) { - /* jshint eqeqeq: true */ - - // Don't check non-elements (#13208) - // Don't process clicks on disabled elements (#6911, #8165, #11382, #11764) - if ( cur.nodeType === 1 && (cur.disabled !== true || event.type !== "click") ) { - matches = []; - for ( i = 0; i < delegateCount; i++ ) { - handleObj = handlers[ i ]; - - // Don't conflict with Object.prototype properties (#13203) - sel = handleObj.selector + " "; - - if ( matches[ sel ] === undefined ) { - matches[ sel ] = handleObj.needsContext ? - jQuery( sel, this ).index( cur ) >= 0 : - jQuery.find( sel, this, null, [ cur ] ).length; - } - if ( matches[ sel ] ) { - matches.push( handleObj ); - } - } - if ( matches.length ) { - handlerQueue.push({ elem: cur, handlers: matches }); - } - } - } - } - - // Add the remaining (directly-bound) handlers - if ( delegateCount < handlers.length ) { - handlerQueue.push({ elem: this, handlers: handlers.slice( delegateCount ) }); - } - - return handlerQueue; - }, - - fix: function( event ) { - if ( event[ jQuery.expando ] ) { - return event; - } - - // Create a writable copy of the event object and normalize some properties - var i, prop, copy, - type = event.type, - originalEvent = event, - fixHook = this.fixHooks[ type ]; - - if ( !fixHook ) { - this.fixHooks[ type ] = fixHook = - rmouseEvent.test( type ) ? this.mouseHooks : - rkeyEvent.test( type ) ? this.keyHooks : - {}; - } - copy = fixHook.props ? this.props.concat( fixHook.props ) : this.props; - - event = new jQuery.Event( originalEvent ); - - i = copy.length; - while ( i-- ) { - prop = copy[ i ]; - event[ prop ] = originalEvent[ prop ]; - } - - // Support: IE<9 - // Fix target property (#1925) - if ( !event.target ) { - event.target = originalEvent.srcElement || document; - } - - // Support: Chrome 23+, Safari? - // Target should not be a text node (#504, #13143) - if ( event.target.nodeType === 3 ) { - event.target = event.target.parentNode; - } - - // Support: IE<9 - // For mouse/key events, metaKey==false if it's undefined (#3368, #11328) - event.metaKey = !!event.metaKey; - - return fixHook.filter ? fixHook.filter( event, originalEvent ) : event; - }, - - // Includes some event props shared by KeyEvent and MouseEvent - props: "altKey bubbles cancelable ctrlKey currentTarget eventPhase metaKey relatedTarget shiftKey target timeStamp view which".split(" "), - - fixHooks: {}, - - keyHooks: { - props: "char charCode key keyCode".split(" "), - filter: function( event, original ) { - - // Add which for key events - if ( event.which == null ) { - event.which = original.charCode != null ? original.charCode : original.keyCode; - } - - return event; - } - }, - - mouseHooks: { - props: "button buttons clientX clientY fromElement offsetX offsetY pageX pageY screenX screenY toElement".split(" "), - filter: function( event, original ) { - var body, eventDoc, doc, - button = original.button, - fromElement = original.fromElement; - - // Calculate pageX/Y if missing and clientX/Y available - if ( event.pageX == null && original.clientX != null ) { - eventDoc = event.target.ownerDocument || document; - doc = eventDoc.documentElement; - body = eventDoc.body; - - event.pageX = original.clientX + ( doc && doc.scrollLeft || body && body.scrollLeft || 0 ) - ( doc && doc.clientLeft || body && body.clientLeft || 0 ); - event.pageY = original.clientY + ( doc && doc.scrollTop || body && body.scrollTop || 0 ) - ( doc && doc.clientTop || body && body.clientTop || 0 ); - } - - // Add relatedTarget, if necessary - if ( !event.relatedTarget && fromElement ) { - event.relatedTarget = fromElement === event.target ? original.toElement : fromElement; - } - - // Add which for click: 1 === left; 2 === middle; 3 === right - // Note: button is not normalized, so don't use it - if ( !event.which && button !== undefined ) { - event.which = ( button & 1 ? 1 : ( button & 2 ? 3 : ( button & 4 ? 2 : 0 ) ) ); - } - - return event; - } - }, - - special: { - load: { - // Prevent triggered image.load events from bubbling to window.load - noBubble: true - }, - focus: { - // Fire native event if possible so blur/focus sequence is correct - trigger: function() { - if ( this !== safeActiveElement() && this.focus ) { - try { - this.focus(); - return false; - } catch ( e ) { - // Support: IE<9 - // If we error on focus to hidden element (#1486, #12518), - // let .trigger() run the handlers - } - } - }, - delegateType: "focusin" - }, - blur: { - trigger: function() { - if ( this === safeActiveElement() && this.blur ) { - this.blur(); - return false; - } - }, - delegateType: "focusout" - }, - click: { - // For checkbox, fire native event so checked state will be right - trigger: function() { - if ( jQuery.nodeName( this, "input" ) && this.type === "checkbox" && this.click ) { - this.click(); - return false; - } - }, - - // For cross-browser consistency, don't fire native .click() on links - _default: function( event ) { - return jQuery.nodeName( event.target, "a" ); - } - }, - - beforeunload: { - postDispatch: function( event ) { - - // Support: Firefox 20+ - // Firefox doesn't alert if the returnValue field is not set. - if ( event.result !== undefined && event.originalEvent ) { - event.originalEvent.returnValue = event.result; - } - } - } - }, - - simulate: function( type, elem, event, bubble ) { - // Piggyback on a donor event to simulate a different one. - // Fake originalEvent to avoid donor's stopPropagation, but if the - // simulated event prevents default then we do the same on the donor. - var e = jQuery.extend( - new jQuery.Event(), - event, - { - type: type, - isSimulated: true, - originalEvent: {} - } - ); - if ( bubble ) { - jQuery.event.trigger( e, null, elem ); - } else { - jQuery.event.dispatch.call( elem, e ); - } - if ( e.isDefaultPrevented() ) { - event.preventDefault(); - } - } -}; - -jQuery.removeEvent = document.removeEventListener ? - function( elem, type, handle ) { - if ( elem.removeEventListener ) { - elem.removeEventListener( type, handle, false ); - } - } : - function( elem, type, handle ) { - var name = "on" + type; - - if ( elem.detachEvent ) { - - // #8545, #7054, preventing memory leaks for custom events in IE6-8 - // detachEvent needed property on element, by name of that event, to properly expose it to GC - if ( typeof elem[ name ] === strundefined ) { - elem[ name ] = null; - } - - elem.detachEvent( name, handle ); - } - }; - -jQuery.Event = function( src, props ) { - // Allow instantiation without the 'new' keyword - if ( !(this instanceof jQuery.Event) ) { - return new jQuery.Event( src, props ); - } - - // Event object - if ( src && src.type ) { - this.originalEvent = src; - this.type = src.type; - - // Events bubbling up the document may have been marked as prevented - // by a handler lower down the tree; reflect the correct value. - this.isDefaultPrevented = src.defaultPrevented || - src.defaultPrevented === undefined && - // Support: IE < 9, Android < 4.0 - src.returnValue === false ? - returnTrue : - returnFalse; - - // Event type - } else { - this.type = src; - } - - // Put explicitly provided properties onto the event object - if ( props ) { - jQuery.extend( this, props ); - } - - // Create a timestamp if incoming event doesn't have one - this.timeStamp = src && src.timeStamp || jQuery.now(); - - // Mark it as fixed - this[ jQuery.expando ] = true; -}; - -// jQuery.Event is based on DOM3 Events as specified by the ECMAScript Language Binding -// http://www.w3.org/TR/2003/WD-DOM-Level-3-Events-20030331/ecma-script-binding.html -jQuery.Event.prototype = { - isDefaultPrevented: returnFalse, - isPropagationStopped: returnFalse, - isImmediatePropagationStopped: returnFalse, - - preventDefault: function() { - var e = this.originalEvent; - - this.isDefaultPrevented = returnTrue; - if ( !e ) { - return; - } - - // If preventDefault exists, run it on the original event - if ( e.preventDefault ) { - e.preventDefault(); - - // Support: IE - // Otherwise set the returnValue property of the original event to false - } else { - e.returnValue = false; - } - }, - stopPropagation: function() { - var e = this.originalEvent; - - this.isPropagationStopped = returnTrue; - if ( !e ) { - return; - } - // If stopPropagation exists, run it on the original event - if ( e.stopPropagation ) { - e.stopPropagation(); - } - - // Support: IE - // Set the cancelBubble property of the original event to true - e.cancelBubble = true; - }, - stopImmediatePropagation: function() { - var e = this.originalEvent; - - this.isImmediatePropagationStopped = returnTrue; - - if ( e && e.stopImmediatePropagation ) { - e.stopImmediatePropagation(); - } - - this.stopPropagation(); - } -}; - -// Create mouseenter/leave events using mouseover/out and event-time checks -jQuery.each({ - mouseenter: "mouseover", - mouseleave: "mouseout", - pointerenter: "pointerover", - pointerleave: "pointerout" -}, function( orig, fix ) { - jQuery.event.special[ orig ] = { - delegateType: fix, - bindType: fix, - - handle: function( event ) { - var ret, - target = this, - related = event.relatedTarget, - handleObj = event.handleObj; - - // For mousenter/leave call the handler if related is outside the target. - // NB: No relatedTarget if the mouse left/entered the browser window - if ( !related || (related !== target && !jQuery.contains( target, related )) ) { - event.type = handleObj.origType; - ret = handleObj.handler.apply( this, arguments ); - event.type = fix; - } - return ret; - } - }; -}); - -// IE submit delegation -if ( !support.submitBubbles ) { - - jQuery.event.special.submit = { - setup: function() { - // Only need this for delegated form submit events - if ( jQuery.nodeName( this, "form" ) ) { - return false; - } - - // Lazy-add a submit handler when a descendant form may potentially be submitted - jQuery.event.add( this, "click._submit keypress._submit", function( e ) { - // Node name check avoids a VML-related crash in IE (#9807) - var elem = e.target, - form = jQuery.nodeName( elem, "input" ) || jQuery.nodeName( elem, "button" ) ? elem.form : undefined; - if ( form && !jQuery._data( form, "submitBubbles" ) ) { - jQuery.event.add( form, "submit._submit", function( event ) { - event._submit_bubble = true; - }); - jQuery._data( form, "submitBubbles", true ); - } - }); - // return undefined since we don't need an event listener - }, - - postDispatch: function( event ) { - // If form was submitted by the user, bubble the event up the tree - if ( event._submit_bubble ) { - delete event._submit_bubble; - if ( this.parentNode && !event.isTrigger ) { - jQuery.event.simulate( "submit", this.parentNode, event, true ); - } - } - }, - - teardown: function() { - // Only need this for delegated form submit events - if ( jQuery.nodeName( this, "form" ) ) { - return false; - } - - // Remove delegated handlers; cleanData eventually reaps submit handlers attached above - jQuery.event.remove( this, "._submit" ); - } - }; -} - -// IE change delegation and checkbox/radio fix -if ( !support.changeBubbles ) { - - jQuery.event.special.change = { - - setup: function() { - - if ( rformElems.test( this.nodeName ) ) { - // IE doesn't fire change on a check/radio until blur; trigger it on click - // after a propertychange. Eat the blur-change in special.change.handle. - // This still fires onchange a second time for check/radio after blur. - if ( this.type === "checkbox" || this.type === "radio" ) { - jQuery.event.add( this, "propertychange._change", function( event ) { - if ( event.originalEvent.propertyName === "checked" ) { - this._just_changed = true; - } - }); - jQuery.event.add( this, "click._change", function( event ) { - if ( this._just_changed && !event.isTrigger ) { - this._just_changed = false; - } - // Allow triggered, simulated change events (#11500) - jQuery.event.simulate( "change", this, event, true ); - }); - } - return false; - } - // Delegated event; lazy-add a change handler on descendant inputs - jQuery.event.add( this, "beforeactivate._change", function( e ) { - var elem = e.target; - - if ( rformElems.test( elem.nodeName ) && !jQuery._data( elem, "changeBubbles" ) ) { - jQuery.event.add( elem, "change._change", function( event ) { - if ( this.parentNode && !event.isSimulated && !event.isTrigger ) { - jQuery.event.simulate( "change", this.parentNode, event, true ); - } - }); - jQuery._data( elem, "changeBubbles", true ); - } - }); - }, - - handle: function( event ) { - var elem = event.target; - - // Swallow native change events from checkbox/radio, we already triggered them above - if ( this !== elem || event.isSimulated || event.isTrigger || (elem.type !== "radio" && elem.type !== "checkbox") ) { - return event.handleObj.handler.apply( this, arguments ); - } - }, - - teardown: function() { - jQuery.event.remove( this, "._change" ); - - return !rformElems.test( this.nodeName ); - } - }; -} - -// Create "bubbling" focus and blur events -if ( !support.focusinBubbles ) { - jQuery.each({ focus: "focusin", blur: "focusout" }, function( orig, fix ) { - - // Attach a single capturing handler on the document while someone wants focusin/focusout - var handler = function( event ) { - jQuery.event.simulate( fix, event.target, jQuery.event.fix( event ), true ); - }; - - jQuery.event.special[ fix ] = { - setup: function() { - var doc = this.ownerDocument || this, - attaches = jQuery._data( doc, fix ); - - if ( !attaches ) { - doc.addEventListener( orig, handler, true ); - } - jQuery._data( doc, fix, ( attaches || 0 ) + 1 ); - }, - teardown: function() { - var doc = this.ownerDocument || this, - attaches = jQuery._data( doc, fix ) - 1; - - if ( !attaches ) { - doc.removeEventListener( orig, handler, true ); - jQuery._removeData( doc, fix ); - } else { - jQuery._data( doc, fix, attaches ); - } - } - }; - }); -} - -jQuery.fn.extend({ - - on: function( types, selector, data, fn, /*INTERNAL*/ one ) { - var type, origFn; - - // Types can be a map of types/handlers - if ( typeof types === "object" ) { - // ( types-Object, selector, data ) - if ( typeof selector !== "string" ) { - // ( types-Object, data ) - data = data || selector; - selector = undefined; - } - for ( type in types ) { - this.on( type, selector, data, types[ type ], one ); - } - return this; - } - - if ( data == null && fn == null ) { - // ( types, fn ) - fn = selector; - data = selector = undefined; - } else if ( fn == null ) { - if ( typeof selector === "string" ) { - // ( types, selector, fn ) - fn = data; - data = undefined; - } else { - // ( types, data, fn ) - fn = data; - data = selector; - selector = undefined; - } - } - if ( fn === false ) { - fn = returnFalse; - } else if ( !fn ) { - return this; - } - - if ( one === 1 ) { - origFn = fn; - fn = function( event ) { - // Can use an empty set, since event contains the info - jQuery().off( event ); - return origFn.apply( this, arguments ); - }; - // Use same guid so caller can remove using origFn - fn.guid = origFn.guid || ( origFn.guid = jQuery.guid++ ); - } - return this.each( function() { - jQuery.event.add( this, types, fn, data, selector ); - }); - }, - one: function( types, selector, data, fn ) { - return this.on( types, selector, data, fn, 1 ); - }, - off: function( types, selector, fn ) { - var handleObj, type; - if ( types && types.preventDefault && types.handleObj ) { - // ( event ) dispatched jQuery.Event - handleObj = types.handleObj; - jQuery( types.delegateTarget ).off( - handleObj.namespace ? handleObj.origType + "." + handleObj.namespace : handleObj.origType, - handleObj.selector, - handleObj.handler - ); - return this; - } - if ( typeof types === "object" ) { - // ( types-object [, selector] ) - for ( type in types ) { - this.off( type, selector, types[ type ] ); - } - return this; - } - if ( selector === false || typeof selector === "function" ) { - // ( types [, fn] ) - fn = selector; - selector = undefined; - } - if ( fn === false ) { - fn = returnFalse; - } - return this.each(function() { - jQuery.event.remove( this, types, fn, selector ); - }); - }, - - trigger: function( type, data ) { - return this.each(function() { - jQuery.event.trigger( type, data, this ); - }); - }, - triggerHandler: function( type, data ) { - var elem = this[0]; - if ( elem ) { - return jQuery.event.trigger( type, data, elem, true ); - } - } -}); - - -function createSafeFragment( document ) { - var list = nodeNames.split( "|" ), - safeFrag = document.createDocumentFragment(); - - if ( safeFrag.createElement ) { - while ( list.length ) { - safeFrag.createElement( - list.pop() - ); - } - } - return safeFrag; -} - -var nodeNames = "abbr|article|aside|audio|bdi|canvas|data|datalist|details|figcaption|figure|footer|" + - "header|hgroup|mark|meter|nav|output|progress|section|summary|time|video", - rinlinejQuery = / jQuery\d+="(?:null|\d+)"/g, - rnoshimcache = new RegExp("<(?:" + nodeNames + ")[\\s/>]", "i"), - rleadingWhitespace = /^\s+/, - rxhtmlTag = /<(?!area|br|col|embed|hr|img|input|link|meta|param)(([\w:]+)[^>]*)\/>/gi, - rtagName = /<([\w:]+)/, - rtbody = /\s*$/g, - - // We have to close these tags to support XHTML (#13200) - wrapMap = { - option: [ 1, "" ], - legend: [ 1, "
", "
" ], - area: [ 1, "", "" ], - param: [ 1, "", "" ], - thead: [ 1, "", "
" ], - tr: [ 2, "", "
" ], - col: [ 2, "", "
" ], - td: [ 3, "", "
" ], - - // IE6-8 can't serialize link, script, style, or any html5 (NoScope) tags, - // unless wrapped in a div with non-breaking characters in front of it. - _default: support.htmlSerialize ? [ 0, "", "" ] : [ 1, "X
", "
" ] - }, - safeFragment = createSafeFragment( document ), - fragmentDiv = safeFragment.appendChild( document.createElement("div") ); - -wrapMap.optgroup = wrapMap.option; -wrapMap.tbody = wrapMap.tfoot = wrapMap.colgroup = wrapMap.caption = wrapMap.thead; -wrapMap.th = wrapMap.td; - -function getAll( context, tag ) { - var elems, elem, - i = 0, - found = typeof context.getElementsByTagName !== strundefined ? context.getElementsByTagName( tag || "*" ) : - typeof context.querySelectorAll !== strundefined ? context.querySelectorAll( tag || "*" ) : - undefined; - - if ( !found ) { - for ( found = [], elems = context.childNodes || context; (elem = elems[i]) != null; i++ ) { - if ( !tag || jQuery.nodeName( elem, tag ) ) { - found.push( elem ); - } else { - jQuery.merge( found, getAll( elem, tag ) ); - } - } - } - - return tag === undefined || tag && jQuery.nodeName( context, tag ) ? - jQuery.merge( [ context ], found ) : - found; -} - -// Used in buildFragment, fixes the defaultChecked property -function fixDefaultChecked( elem ) { - if ( rcheckableType.test( elem.type ) ) { - elem.defaultChecked = elem.checked; - } -} - -// Support: IE<8 -// Manipulating tables requires a tbody -function manipulationTarget( elem, content ) { - return jQuery.nodeName( elem, "table" ) && - jQuery.nodeName( content.nodeType !== 11 ? content : content.firstChild, "tr" ) ? - - elem.getElementsByTagName("tbody")[0] || - elem.appendChild( elem.ownerDocument.createElement("tbody") ) : - elem; -} - -// Replace/restore the type attribute of script elements for safe DOM manipulation -function disableScript( elem ) { - elem.type = (jQuery.find.attr( elem, "type" ) !== null) + "/" + elem.type; - return elem; -} -function restoreScript( elem ) { - var match = rscriptTypeMasked.exec( elem.type ); - if ( match ) { - elem.type = match[1]; - } else { - elem.removeAttribute("type"); - } - return elem; -} - -// Mark scripts as having already been evaluated -function setGlobalEval( elems, refElements ) { - var elem, - i = 0; - for ( ; (elem = elems[i]) != null; i++ ) { - jQuery._data( elem, "globalEval", !refElements || jQuery._data( refElements[i], "globalEval" ) ); - } -} - -function cloneCopyEvent( src, dest ) { - - if ( dest.nodeType !== 1 || !jQuery.hasData( src ) ) { - return; - } - - var type, i, l, - oldData = jQuery._data( src ), - curData = jQuery._data( dest, oldData ), - events = oldData.events; - - if ( events ) { - delete curData.handle; - curData.events = {}; - - for ( type in events ) { - for ( i = 0, l = events[ type ].length; i < l; i++ ) { - jQuery.event.add( dest, type, events[ type ][ i ] ); - } - } - } - - // make the cloned public data object a copy from the original - if ( curData.data ) { - curData.data = jQuery.extend( {}, curData.data ); - } -} - -function fixCloneNodeIssues( src, dest ) { - var nodeName, e, data; - - // We do not need to do anything for non-Elements - if ( dest.nodeType !== 1 ) { - return; - } - - nodeName = dest.nodeName.toLowerCase(); - - // IE6-8 copies events bound via attachEvent when using cloneNode. - if ( !support.noCloneEvent && dest[ jQuery.expando ] ) { - data = jQuery._data( dest ); - - for ( e in data.events ) { - jQuery.removeEvent( dest, e, data.handle ); - } - - // Event data gets referenced instead of copied if the expando gets copied too - dest.removeAttribute( jQuery.expando ); - } - - // IE blanks contents when cloning scripts, and tries to evaluate newly-set text - if ( nodeName === "script" && dest.text !== src.text ) { - disableScript( dest ).text = src.text; - restoreScript( dest ); - - // IE6-10 improperly clones children of object elements using classid. - // IE10 throws NoModificationAllowedError if parent is null, #12132. - } else if ( nodeName === "object" ) { - if ( dest.parentNode ) { - dest.outerHTML = src.outerHTML; - } - - // This path appears unavoidable for IE9. When cloning an object - // element in IE9, the outerHTML strategy above is not sufficient. - // If the src has innerHTML and the destination does not, - // copy the src.innerHTML into the dest.innerHTML. #10324 - if ( support.html5Clone && ( src.innerHTML && !jQuery.trim(dest.innerHTML) ) ) { - dest.innerHTML = src.innerHTML; - } - - } else if ( nodeName === "input" && rcheckableType.test( src.type ) ) { - // IE6-8 fails to persist the checked state of a cloned checkbox - // or radio button. Worse, IE6-7 fail to give the cloned element - // a checked appearance if the defaultChecked value isn't also set - - dest.defaultChecked = dest.checked = src.checked; - - // IE6-7 get confused and end up setting the value of a cloned - // checkbox/radio button to an empty string instead of "on" - if ( dest.value !== src.value ) { - dest.value = src.value; - } - - // IE6-8 fails to return the selected option to the default selected - // state when cloning options - } else if ( nodeName === "option" ) { - dest.defaultSelected = dest.selected = src.defaultSelected; - - // IE6-8 fails to set the defaultValue to the correct value when - // cloning other types of input fields - } else if ( nodeName === "input" || nodeName === "textarea" ) { - dest.defaultValue = src.defaultValue; - } -} - -jQuery.extend({ - clone: function( elem, dataAndEvents, deepDataAndEvents ) { - var destElements, node, clone, i, srcElements, - inPage = jQuery.contains( elem.ownerDocument, elem ); - - if ( support.html5Clone || jQuery.isXMLDoc(elem) || !rnoshimcache.test( "<" + elem.nodeName + ">" ) ) { - clone = elem.cloneNode( true ); - - // IE<=8 does not properly clone detached, unknown element nodes - } else { - fragmentDiv.innerHTML = elem.outerHTML; - fragmentDiv.removeChild( clone = fragmentDiv.firstChild ); - } - - if ( (!support.noCloneEvent || !support.noCloneChecked) && - (elem.nodeType === 1 || elem.nodeType === 11) && !jQuery.isXMLDoc(elem) ) { - - // We eschew Sizzle here for performance reasons: http://jsperf.com/getall-vs-sizzle/2 - destElements = getAll( clone ); - srcElements = getAll( elem ); - - // Fix all IE cloning issues - for ( i = 0; (node = srcElements[i]) != null; ++i ) { - // Ensure that the destination node is not null; Fixes #9587 - if ( destElements[i] ) { - fixCloneNodeIssues( node, destElements[i] ); - } - } - } - - // Copy the events from the original to the clone - if ( dataAndEvents ) { - if ( deepDataAndEvents ) { - srcElements = srcElements || getAll( elem ); - destElements = destElements || getAll( clone ); - - for ( i = 0; (node = srcElements[i]) != null; i++ ) { - cloneCopyEvent( node, destElements[i] ); - } - } else { - cloneCopyEvent( elem, clone ); - } - } - - // Preserve script evaluation history - destElements = getAll( clone, "script" ); - if ( destElements.length > 0 ) { - setGlobalEval( destElements, !inPage && getAll( elem, "script" ) ); - } - - destElements = srcElements = node = null; - - // Return the cloned set - return clone; - }, - - buildFragment: function( elems, context, scripts, selection ) { - var j, elem, contains, - tmp, tag, tbody, wrap, - l = elems.length, - - // Ensure a safe fragment - safe = createSafeFragment( context ), - - nodes = [], - i = 0; - - for ( ; i < l; i++ ) { - elem = elems[ i ]; - - if ( elem || elem === 0 ) { - - // Add nodes directly - if ( jQuery.type( elem ) === "object" ) { - jQuery.merge( nodes, elem.nodeType ? [ elem ] : elem ); - - // Convert non-html into a text node - } else if ( !rhtml.test( elem ) ) { - nodes.push( context.createTextNode( elem ) ); - - // Convert html into DOM nodes - } else { - tmp = tmp || safe.appendChild( context.createElement("div") ); - - // Deserialize a standard representation - tag = (rtagName.exec( elem ) || [ "", "" ])[ 1 ].toLowerCase(); - wrap = wrapMap[ tag ] || wrapMap._default; - - tmp.innerHTML = wrap[1] + elem.replace( rxhtmlTag, "<$1>" ) + wrap[2]; - - // Descend through wrappers to the right content - j = wrap[0]; - while ( j-- ) { - tmp = tmp.lastChild; - } - - // Manually add leading whitespace removed by IE - if ( !support.leadingWhitespace && rleadingWhitespace.test( elem ) ) { - nodes.push( context.createTextNode( rleadingWhitespace.exec( elem )[0] ) ); - } - - // Remove IE's autoinserted from table fragments - if ( !support.tbody ) { - - // String was a , *may* have spurious - elem = tag === "table" && !rtbody.test( elem ) ? - tmp.firstChild : - - // String was a bare or - wrap[1] === "
" && !rtbody.test( elem ) ? - tmp : - 0; - - j = elem && elem.childNodes.length; - while ( j-- ) { - if ( jQuery.nodeName( (tbody = elem.childNodes[j]), "tbody" ) && !tbody.childNodes.length ) { - elem.removeChild( tbody ); - } - } - } - - jQuery.merge( nodes, tmp.childNodes ); - - // Fix #12392 for WebKit and IE > 9 - tmp.textContent = ""; - - // Fix #12392 for oldIE - while ( tmp.firstChild ) { - tmp.removeChild( tmp.firstChild ); - } - - // Remember the top-level container for proper cleanup - tmp = safe.lastChild; - } - } - } - - // Fix #11356: Clear elements from fragment - if ( tmp ) { - safe.removeChild( tmp ); - } - - // Reset defaultChecked for any radios and checkboxes - // about to be appended to the DOM in IE 6/7 (#8060) - if ( !support.appendChecked ) { - jQuery.grep( getAll( nodes, "input" ), fixDefaultChecked ); - } - - i = 0; - while ( (elem = nodes[ i++ ]) ) { - - // #4087 - If origin and destination elements are the same, and this is - // that element, do not do anything - if ( selection && jQuery.inArray( elem, selection ) !== -1 ) { - continue; - } - - contains = jQuery.contains( elem.ownerDocument, elem ); - - // Append to fragment - tmp = getAll( safe.appendChild( elem ), "script" ); - - // Preserve script evaluation history - if ( contains ) { - setGlobalEval( tmp ); - } - - // Capture executables - if ( scripts ) { - j = 0; - while ( (elem = tmp[ j++ ]) ) { - if ( rscriptType.test( elem.type || "" ) ) { - scripts.push( elem ); - } - } - } - } - - tmp = null; - - return safe; - }, - - cleanData: function( elems, /* internal */ acceptData ) { - var elem, type, id, data, - i = 0, - internalKey = jQuery.expando, - cache = jQuery.cache, - deleteExpando = support.deleteExpando, - special = jQuery.event.special; - - for ( ; (elem = elems[i]) != null; i++ ) { - if ( acceptData || jQuery.acceptData( elem ) ) { - - id = elem[ internalKey ]; - data = id && cache[ id ]; - - if ( data ) { - if ( data.events ) { - for ( type in data.events ) { - if ( special[ type ] ) { - jQuery.event.remove( elem, type ); - - // This is a shortcut to avoid jQuery.event.remove's overhead - } else { - jQuery.removeEvent( elem, type, data.handle ); - } - } - } - - // Remove cache only if it was not already removed by jQuery.event.remove - if ( cache[ id ] ) { - - delete cache[ id ]; - - // IE does not allow us to delete expando properties from nodes, - // nor does it have a removeAttribute function on Document nodes; - // we must handle all of these cases - if ( deleteExpando ) { - delete elem[ internalKey ]; - - } else if ( typeof elem.removeAttribute !== strundefined ) { - elem.removeAttribute( internalKey ); - - } else { - elem[ internalKey ] = null; - } - - deletedIds.push( id ); - } - } - } - } - } -}); - -jQuery.fn.extend({ - text: function( value ) { - return access( this, function( value ) { - return value === undefined ? - jQuery.text( this ) : - this.empty().append( ( this[0] && this[0].ownerDocument || document ).createTextNode( value ) ); - }, null, value, arguments.length ); - }, - - append: function() { - return this.domManip( arguments, function( elem ) { - if ( this.nodeType === 1 || this.nodeType === 11 || this.nodeType === 9 ) { - var target = manipulationTarget( this, elem ); - target.appendChild( elem ); - } - }); - }, - - prepend: function() { - return this.domManip( arguments, function( elem ) { - if ( this.nodeType === 1 || this.nodeType === 11 || this.nodeType === 9 ) { - var target = manipulationTarget( this, elem ); - target.insertBefore( elem, target.firstChild ); - } - }); - }, - - before: function() { - return this.domManip( arguments, function( elem ) { - if ( this.parentNode ) { - this.parentNode.insertBefore( elem, this ); - } - }); - }, - - after: function() { - return this.domManip( arguments, function( elem ) { - if ( this.parentNode ) { - this.parentNode.insertBefore( elem, this.nextSibling ); - } - }); - }, - - remove: function( selector, keepData /* Internal Use Only */ ) { - var elem, - elems = selector ? jQuery.filter( selector, this ) : this, - i = 0; - - for ( ; (elem = elems[i]) != null; i++ ) { - - if ( !keepData && elem.nodeType === 1 ) { - jQuery.cleanData( getAll( elem ) ); - } - - if ( elem.parentNode ) { - if ( keepData && jQuery.contains( elem.ownerDocument, elem ) ) { - setGlobalEval( getAll( elem, "script" ) ); - } - elem.parentNode.removeChild( elem ); - } - } - - return this; - }, - - empty: function() { - var elem, - i = 0; - - for ( ; (elem = this[i]) != null; i++ ) { - // Remove element nodes and prevent memory leaks - if ( elem.nodeType === 1 ) { - jQuery.cleanData( getAll( elem, false ) ); - } - - // Remove any remaining nodes - while ( elem.firstChild ) { - elem.removeChild( elem.firstChild ); - } - - // If this is a select, ensure that it displays empty (#12336) - // Support: IE<9 - if ( elem.options && jQuery.nodeName( elem, "select" ) ) { - elem.options.length = 0; - } - } - - return this; - }, - - clone: function( dataAndEvents, deepDataAndEvents ) { - dataAndEvents = dataAndEvents == null ? false : dataAndEvents; - deepDataAndEvents = deepDataAndEvents == null ? dataAndEvents : deepDataAndEvents; - - return this.map(function() { - return jQuery.clone( this, dataAndEvents, deepDataAndEvents ); - }); - }, - - html: function( value ) { - return access( this, function( value ) { - var elem = this[ 0 ] || {}, - i = 0, - l = this.length; - - if ( value === undefined ) { - return elem.nodeType === 1 ? - elem.innerHTML.replace( rinlinejQuery, "" ) : - undefined; - } - - // See if we can take a shortcut and just use innerHTML - if ( typeof value === "string" && !rnoInnerhtml.test( value ) && - ( support.htmlSerialize || !rnoshimcache.test( value ) ) && - ( support.leadingWhitespace || !rleadingWhitespace.test( value ) ) && - !wrapMap[ (rtagName.exec( value ) || [ "", "" ])[ 1 ].toLowerCase() ] ) { - - value = value.replace( rxhtmlTag, "<$1>" ); - - try { - for (; i < l; i++ ) { - // Remove element nodes and prevent memory leaks - elem = this[i] || {}; - if ( elem.nodeType === 1 ) { - jQuery.cleanData( getAll( elem, false ) ); - elem.innerHTML = value; - } - } - - elem = 0; - - // If using innerHTML throws an exception, use the fallback method - } catch(e) {} - } - - if ( elem ) { - this.empty().append( value ); - } - }, null, value, arguments.length ); - }, - - replaceWith: function() { - var arg = arguments[ 0 ]; - - // Make the changes, replacing each context element with the new content - this.domManip( arguments, function( elem ) { - arg = this.parentNode; - - jQuery.cleanData( getAll( this ) ); - - if ( arg ) { - arg.replaceChild( elem, this ); - } - }); - - // Force removal if there was no new content (e.g., from empty arguments) - return arg && (arg.length || arg.nodeType) ? this : this.remove(); - }, - - detach: function( selector ) { - return this.remove( selector, true ); - }, - - domManip: function( args, callback ) { - - // Flatten any nested arrays - args = concat.apply( [], args ); - - var first, node, hasScripts, - scripts, doc, fragment, - i = 0, - l = this.length, - set = this, - iNoClone = l - 1, - value = args[0], - isFunction = jQuery.isFunction( value ); - - // We can't cloneNode fragments that contain checked, in WebKit - if ( isFunction || - ( l > 1 && typeof value === "string" && - !support.checkClone && rchecked.test( value ) ) ) { - return this.each(function( index ) { - var self = set.eq( index ); - if ( isFunction ) { - args[0] = value.call( this, index, self.html() ); - } - self.domManip( args, callback ); - }); - } - - if ( l ) { - fragment = jQuery.buildFragment( args, this[ 0 ].ownerDocument, false, this ); - first = fragment.firstChild; - - if ( fragment.childNodes.length === 1 ) { - fragment = first; - } - - if ( first ) { - scripts = jQuery.map( getAll( fragment, "script" ), disableScript ); - hasScripts = scripts.length; - - // Use the original fragment for the last item instead of the first because it can end up - // being emptied incorrectly in certain situations (#8070). - for ( ; i < l; i++ ) { - node = fragment; - - if ( i !== iNoClone ) { - node = jQuery.clone( node, true, true ); - - // Keep references to cloned scripts for later restoration - if ( hasScripts ) { - jQuery.merge( scripts, getAll( node, "script" ) ); - } - } - - callback.call( this[i], node, i ); - } - - if ( hasScripts ) { - doc = scripts[ scripts.length - 1 ].ownerDocument; - - // Reenable scripts - jQuery.map( scripts, restoreScript ); - - // Evaluate executable scripts on first document insertion - for ( i = 0; i < hasScripts; i++ ) { - node = scripts[ i ]; - if ( rscriptType.test( node.type || "" ) && - !jQuery._data( node, "globalEval" ) && jQuery.contains( doc, node ) ) { - - if ( node.src ) { - // Optional AJAX dependency, but won't run scripts if not present - if ( jQuery._evalUrl ) { - jQuery._evalUrl( node.src ); - } - } else { - jQuery.globalEval( ( node.text || node.textContent || node.innerHTML || "" ).replace( rcleanScript, "" ) ); - } - } - } - } - - // Fix #11809: Avoid leaking memory - fragment = first = null; - } - } - - return this; - } -}); - -jQuery.each({ - appendTo: "append", - prependTo: "prepend", - insertBefore: "before", - insertAfter: "after", - replaceAll: "replaceWith" -}, function( name, original ) { - jQuery.fn[ name ] = function( selector ) { - var elems, - i = 0, - ret = [], - insert = jQuery( selector ), - last = insert.length - 1; - - for ( ; i <= last; i++ ) { - elems = i === last ? this : this.clone(true); - jQuery( insert[i] )[ original ]( elems ); - - // Modern browsers can apply jQuery collections as arrays, but oldIE needs a .get() - push.apply( ret, elems.get() ); - } - - return this.pushStack( ret ); - }; -}); - - -var iframe, - elemdisplay = {}; - -/** - * Retrieve the actual display of a element - * @param {String} name nodeName of the element - * @param {Object} doc Document object - */ -// Called only from within defaultDisplay -function actualDisplay( name, doc ) { - var style, - elem = jQuery( doc.createElement( name ) ).appendTo( doc.body ), - - // getDefaultComputedStyle might be reliably used only on attached element - display = window.getDefaultComputedStyle && ( style = window.getDefaultComputedStyle( elem[ 0 ] ) ) ? - - // Use of this method is a temporary fix (more like optmization) until something better comes along, - // since it was removed from specification and supported only in FF - style.display : jQuery.css( elem[ 0 ], "display" ); - - // We don't have any data stored on the element, - // so use "detach" method as fast way to get rid of the element - elem.detach(); - - return display; -} - -/** - * Try to determine the default display value of an element - * @param {String} nodeName - */ -function defaultDisplay( nodeName ) { - var doc = document, - display = elemdisplay[ nodeName ]; - - if ( !display ) { - display = actualDisplay( nodeName, doc ); - - // If the simple way fails, read from inside an iframe - if ( display === "none" || !display ) { - - // Use the already-created iframe if possible - iframe = (iframe || jQuery( "