Lens Information
Basic Lens object handling
- class transfocate.lens.Lens(*args, **kwargs)[source]
Data structure for basic Lens object
- Parameters:
prefix (str) – Name of the state record that controls the PV
prefix_lens (str) – Prefix for the PVs that contain focusing information
- property focus
Method converts the EPICS focal length signal of the lens into a float
- Returns:
Returns the focal length of the lens in meters
- Return type:
float
- image_from_obj(z_obj)[source]
Method calculates the image distance in meters along the beam pipeline from a point of origin given the focal length of the lens, location of lens, and location of object.
- Parameters:
z_obj – Location of object along the beamline in meters (m)
- Returns:
Returns the distance z_im of the image along the beam pipeline from a point of origin in meters (m)
- Return type:
image
Note
If the location of the object (z_obj) is equal to the focal length of the lens, this function will return infinity.
- property radius
Method converts the EPICS lens radius signal into a float that can be used for calculations.
- Returns:
Returns the radius of the lens
- Return type:
float
- property z
Method converts the z position EPICS signal into a float.
- Returns:
Returns the z position of the lens in meters along the beamline
- Return type:
float
- class transfocate.lens.LensConnect(*args)[source]
Data structure for a basic system of lenses
- Parameters:
args (Lens) – Lens objects
args – Variable length argument list of the lenses in the system, their radii, z position, and focal length.
- classmethod connect(array1, array2)[source]
Create a new LensConnect from the combination of multiple
- property effective_radius
Method calculates the effective radius of the lens array
- Returns:
returns the effective radius of the lens array.
- Return type:
float
- image(z_obj)[source]
Method recursively calculates the z location of the image of a system of lenses and returns it in meters (m)
- Parameters:
z_obj – Location of the object along the beam pipline from a designated point of origin in meters (m)
- Returns:
returns the location z of a system of lenses in meters (m).
- Return type:
float
- property nlens
Method calculates the total number of lenses in the Lens array.
- Returns:
Returns the total number of lenses in the array.
- Return type:
int