Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 20 additions & 7 deletions source/element-kinds.md
Original file line number Diff line number Diff line change
Expand Up @@ -482,24 +482,37 @@ The following element kinds are for instrumentation and diagnostics.

%---------------------------------------------------------------------------------------------------
(s:instrument)=
### Instrument Element
### Screen Element

An Instrument element is a measurement element for diagnostics.

Under Construction...
An Screen element is a transverse profile monitor element that produces a 2-dimensional projection of

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
An Screen element is a transverse profile monitor element that produces a 2-dimensional projection of
A Screen element is a transverse profile monitor element that produces a 2-dimensional projection of

the x/y particle distribution.

Element parameter groups associated with this element kind are:
- [**ApertureP**](#s:aperture.params): Aperture parameters.
- [**BodyShiftP**](#s:bodyshift.params): Orientation of element with respect to its nominal position.
- [**ElectricMultipoleP**](#s:elec.mult.params): Electric multipoles
- [**FloorP**](#s:floor.params): Floor position and orientation.
- [**MagneticMultipoleP**](#s:mag.mult.params): Magnetic multipoles.
- [**MetaP**](#s:meta.params): Meta parameters.
- [**ReferenceP**](#s:ref.params): Reference parameters.
- [**ReferenceChangeP**](#s:ref.change.params): Reference energy change and/or reference time correction.
- [**ScreenP**](#s:screen.params): Screen parameters.
- [**TrackingP**](#s:tracking.params): Tracking parameters.


%---------------------------------------------------------------------------------------------------
(s:instrument)=
### Wire Element

A Wire element is a transverse profile monitor element that produces a
1-dimensional projection of the x/y particle distribution.

Element parameter groups associated with this element kind are:
- [**ApertureP**](#s:aperture.params): Aperture parameters.
- [**BodyShiftP**](#s:bodyshift.params): Orientation of element with respect to its nominal position.
- [**FloorP**](#s:floor.params): Floor position and orientation.
- [**MetaP**](#s:meta.params): Meta parameters.
- [**ReferenceP**](#s:ref.params): Reference parameters.
- [**TrackingP**](#s:tracking.params): Tracking parameters.
- [**WireP**](#s:wire.params): Wire parameters.


%---------------------------------------------------------------------------------------------------
(s:map)=
Expand Down
281 changes: 281 additions & 0 deletions source/figures/wire.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
13 changes: 13 additions & 0 deletions source/parameters/screen.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
(s:screen.params)=
## ScreenP: Screen Parameters

The `ScreenP` parameter group contains parameters for describing a 2-dimensional diagnostic screen used to measure the transverse distribution of a particle beam.
The components of this group and their defaults are:
```{code} yaml
ScreenP:
resolution_x: 0 # [int] Number of screen pixels in the horizontal direction.
resolution_y: 0 # [int] Number of screen pixels in the vertical direction.
pixel_size: 0 # [m] Size of screen pixels.
mirror_x: false # [Boolean] If true, mirror the horizontal image.
mirror_y: false # [Boolean] If turn, mirror the vertical image.
Comment on lines +4 to +12

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A few comments:

  • Pixels may not be square so there should be a size for x and y.
  • resolution is somewhat cryptic here. How about specifying the index bounds (like the Detector element in Bmad) and that way the mirror_x/y parameters can be eliminated.

```
20 changes: 20 additions & 0 deletions source/parameters/wire.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
(s:wire.params)=
## WireP: Wire Parameters

The `WireP` parameter group contains parameters for describing a 1-dimensional diagnostic wire used to measure the transverse distribution of a particle beam.
The components of this group and their defaults are:
```{code} yaml
WireP:
angle: 0 # [radian] Angle of the wire with respect to the horizontal axis.
n_steps: 1 # [int] Number of steps used during a wire scan.
start_offset: 0 # [m] Wire scan start offset from beam axis.
end_offset: 0 # [m] Wire scan end offset from beam axis.
width: 0 # [m] Wire width.
```

```{figure} figures/wire.svg
:width: 90%
:name: f.angle

In detail:
See diagram for parameter descriptions.