Objective

class raytracing.Objective(f, NA, focusToFocusLength, backAperture, workingDistance, magnification=None, fieldNumber=None, url=None, label='')

Bases: MatrixGroup

Parameters:

• f (float) – The focal length

• NA (float) – The numerical aperture

• focusToFocusLength (float) – The distance between the front focal point to the back focal point.

• backAperture (float) – The back aperture

• workingDistance (float) – The distance from the front lens element of the objective to the closest surface.

• url (string) – A link to find more info for the lens

• label (string) – The name of the lens

flipOrientation()

Flip the orientation (forward-backward) of this group of elements. Each element is also flipped individually.

pointsOfInterest(z)

List of points of interest for this element as a dictionary:

Parameters:

z (float) – The position

Methods

__init__(f, NA, focusToFocusLength, ...[, ...])	General microscope objective, approximately correct.
flipOrientation()	Flip the orientation (forward-backward) of this group of elements.
maximumOpticalInvariant()
pointsOfInterest(z)	List of points of interest for this element as a dictionary:

Inherited Methods

append(matrix)	This function adds an element at the end of the path.
backFocalLength()	The focal lengths measured from the back vertex.
backwardConjugate()	With an image at the back edge of the element, where is the object ? Distance before the element by which a ray must travel to reach the conjugate plane at the back of the element.
display()
displayHalfHeight()	A reasonable height for display purposes for an element, whether it is infinite or not.
effectiveFocalLengths()	The effective focal lengths calculated from the power (C) of the matrix.
focalDistances()	This is the synonym of effectiveFocalLengths()
focusPositions(z)	Positions of both focal points on either side of the element.
forwardConjugate()	With an object at the front edge of the element, where is the image? Distance after the element by which a ray must travel to reach the conjugate plane of the front of the element.
fromFocusToFocus()	A simple method to obtain a MatrixGroup that includes all three matrices to travel from the front focus, through the lens, and then to the back focus.
fromStruct(theStruct)
frontFocalLength()	The focal lengths measured from the front vertex.
hasFiniteApertureDiameter()	True if ImagingPath has at least one element of finite diameter
insert(index, element)	This function is used to insert a matrix at a specific index.
intermediateConjugates()	This function calculates the position and the magnification of the conjugate planes.
load(filePath[, append])	A MatrixGroup saved with save() can be loaded using this function.
magnification()	The magnification of the element
mul_beam(rightSideBeam)	This function calculates the multiplication of a coherent beam with complex radius of curvature q by an ABCD matrix.
mul_matrix(rightSideMatrix)	This function is used to combine two elements into a single matrix.
mul_ray(rightSideRay)	This function does the multiplication of a ray by a matrix.
opticalInvariant(ray1, ray2[, z])	The optical invariant is a quantity that is conserved for any two rays in the system.
pop(index)	This function is used to remove a matrix at a specific index.
principalPlanePositions(z)	Positions of the input and output principal planes.
profileFromRayTraces(rayTraces[, z])
save(filePath)	A MatrixGroup can be saved using this function and loaded with load()
toStruct()
trace(inputRay)	Trace the input ray from first element until after the last element, indicating if the ray was blocked or not.
traceMany(inputRays[, useOpenCL])	This function trace each ray from a group of rays from front edge of element to the back edge.
traceManyNative(inputRays)	This function trace each ray from a group of rays from front edge of element to the back edge.
traceManyOpenCL(inputRays)	This function trace each ray from a group of rays from front edge of element to the back edge.
traceManyThrough(inputRays[, progress, ...])	This function trace each ray from a list or a Rays() distribution from front edge of element to the back edge.
traceManyThroughInParallel(inputRays[, ...])	This is an advanced technique to gain from parallel computation: it is the same as traceManyThrough(), but splits this call in several other parallel processes using the multiprocessing module, which is os-independent.
traceThrough(inputRay)	Contrary to trace(), this only returns the last ray.
transferMatrices()	The list of Matrix() that corresponds to the propagation through this element (or group).
transferMatrix([upTo])	The transfer matrix between front edge and distance=upTo

Attributes

Struct
determinant	The determinant of the ABCD matrix is always frontIndex/backIndex, which is often 1.0.
forwardSurfaces	A list of surfaces that represents the element for drawing purposes
hasPower	If True, then there is a non-null focal length because C!=0.
isIdentity
isImaging	If B=0, then the matrix represents that transfer from a conjugate plane to another (i.e. object at the front edge and image at the back edge).
largestDiameter	Largest finite diameter in all elements
surfaces