API
utils Namespace Reference

Functions

def measure_center_position (image, threshold=1, mask_diameter=20)
 
def knife_edge_dist (image, theta=-0.47, mask_diameter=200, threshold=0.5)
 

Function Documentation

◆ knife_edge_dist()

def utils.knife_edge_dist (   image,
  theta = -0.47,
  mask_diameter = 200,
  threshold = 0.5 
)
Measure the distance from the knife edge focal plane mask to the center of an image.


    Parameters
    ----------
    image : array of floats 
        Default: None.
    theta: integer
        The knife edge mask angle with respect to the image's x-axis. Default: 0.
        mask_diameter: The diameter of the circular mask applied to the image for edge detection. Default: 200.
        threshold: The sigma used to mask pixels along the circular mask edge. Default: 0.5.

    Returns
    -------
    np.array()
        A NumPy array containing the knife edge distance in X and Y with respect to the image center.

Definition at line 17 of file utils.py.

Referenced by corAlign.corAlign.measure_fpm_mask_shift().

◆ measure_center_position()

def utils.measure_center_position (   image,
  threshold = 1,
  mask_diameter = 20 
)

Definition at line 6 of file utils.py.

Referenced by corAlign.corAlign.measure_fpm_mask_shift().