def DisplayMask(mask_worksp=None):
"""
Displays masking by applying it to a workspace and displaying
it in instrument view. If no workspace is passed a copy of the
sample workspace is used, unless no sample was loaded and then
an empty instrument will be shown
@param mask_worksp: optional this named workspace will be modified and should be from the currently selected instrument
@return the name of the workspace that was displayed
"""
#this will be copied from a sample work space if one exists
counts_data = None
instrument = ReductionSingleton().instrument
if not mask_worksp:
mask_worksp = '__CurrentMask'
samp = LAST_SAMPLE
if samp:
counts_data = '__DisplayMasked_tempory_wksp'
Integration(samp, counts_data)
CloneWorkspace(samp, mask_worksp)
else:
instrument.load_empty(mask_worksp)
instrument.set_up_for_run('emptyInstrument')
ReductionSingleton().mask.display(mask_worksp, ReductionSingleton(), counts_data)
if counts_data:
mantid.deleteWorkspace(counts_data)
return mask_worksp
