LoadMask v1¶

ws = Load('HYS_11092_event.nxs')
mask = LoadMask('HYS', 'HYS_mask.xml')
# To check if mask loaded, apply it
MaskDetectors(ws, MaskedWorkspace=mask)
# One can alternatively do
# ws.maskDetectors(MaskedWorkspace=mask)

# Check some pixels
print("Is detector 0 masked: {}".format(ws.getDetector(0).isMasked()))
print("Is detector 6245 masked: {}".format(ws.getDetector(6245).isMasked()))
print("Is detector 11464 masked: {}".format(ws.getDetector(11464).isMasked()))
print("Is detector 17578 masked: {}".format(ws.getDetector(17578).isMasked()))
print("Is detector 20475 masked: {}".format(ws.getDetector(20475).isMasked()))

# Load workspace with real spectra-derector mask
rws = Load(Filename=r'MAR11001.raw', OutputWorkspace='realWs',InlcudeMonitors=True);

# Create sample mask
MaskDetectors(Workspace=rws, SpectraList='10,11,12,13,100,110,120,130,140,200,300')
masked_list = ExportSpectraMask(rws,'SampleMask')
file2remove = os.path.join(config.getString('defaultsave.directory'),'SampleMask.msk')

#

# Load sample  spectra mask using 1:1 instrument
mask1to1ws= LoadMask('MARI','SampleMask.msk')

# Apply spectra mask using real workspace spectra-detector map.
# Note that rws does not need to be masked like its here, We use it masked here only to avoid overhead of loading it again
# it just needs to contain the same spectra-detector map as the initial workspace
# you may want to try rows below to be sure:
#rws1 = Load(Filename=r'MAR11001.raw', OutputWorkspace='realWs1',InlcudeMonitors=True);

# Load Mask using  instrument and spectra-detector map provided with source workspace
maskRealSDM=LoadMask('MARI','SampleMask.msk',RefWorkspace=rws)

# Clear up rubbish
os.remove(file2remove)

# See the difference:
nhist = mask1to1ws.getNumberHistograms()
Sig0Masked = []
Det0Masked= []
MaskedSp1to1 = []
MaskedDet1to1= []
MaskedSp_R  = []
MaskedDet_R= []
for ind in range(0,nhist):
    try:
        det = rws.getDetector(ind)
        if det.isMasked():
            Sig0Masked.append(ind)
            Det0Masked.append(det.getID())
        #  1:1 map generated from instrument definitions
        if mask1to1ws.readY(ind)[0]>0.5:
            det = mask1to1ws.getDetector(ind)
            MaskedSp1to1.append(ind)
            MaskedDet1to1.append(det.getID())
        # Real spectra-detector map:
        if maskRealSDM.readY(ind)[0]>0.5:
            det = maskRealSDM.getDetector(ind)
            MaskedSp_R.append(ind)
            MaskedDet_R.append(det.getID())
    except:
        pass
print("*** ************************************ **********************************************")
print("*** Masked Spec. Id(s):  {0}".format(masked_list))
print( "*** Initial workspace masking parameters **********************************************")
print("Masked Spectra Numbers:  {}".format(Sig0Masked))
print("Masked Detector IDs   :  {}".format(Det0Masked))
print("*** One to one mask workspace has masked the same spectra numbers but different detectors")
print("ws 1to1 Masked spectra:  {}".format(MaskedSp1to1))
print("ws 1to1 Masked DedIDs :  {}".format(MaskedDet1to1))
print("*** Real spectra-det-map workspace has masked different spectra numbers but the same detectors")
print("ws RSDM Masked spectra:  {}".format(MaskedSp_R))
print("ws RSDM Masked DedIDs :  {}".format(MaskedDet_R))
print("*** indeed the same:")
Det0Masked.sort()
MaskedDet_R.sort()
print("sorted initial DetIDs :  {}".format(Det0Masked))
print("sorted RSDM    DedIDs :  {}".format(MaskedDet_R))
print("*** ************************************ **********************************************")
print("*** note spectra with id 4 is a monitor, not present in the masking workspaces")
print("*** ************************************ **********************************************")