magneticScattering.holography.holography_reference

holography_reference(sample, hole_size=1, axis='y')

Creates a holography reference hole for the given sample.

The new sample has a fourfold increased size along the specified axis to allow for recovery.

Parameters:

samplenp.ndarray | Sample

The sample to add holography reference holes.

hole_sizeint (optional)

The size of reference hole in voxels.

axis{‘x’, ‘y’, ‘xy’, ‘yx’} (optional)

Axis along which to add the reference.

Returns:

np.ndarray (optional)

The holography sample or None if directly applied to a Sample class.