    001/*-
    002 *******************************************************************************
    003 * Copyright (c) 2011, 2016 Diamond Light Source Ltd.
    004 * All rights reserved. This program and the accompanying materials
    005 * are made available under the terms of the Eclipse Public License v1.0
    006 * which accompanies this distribution, and is available at
    007 * http://www.eclipse.org/legal/epl-v10.html
    008 *
    009 * Contributors:
    010 *    Peter Chang - initial API and implementation and/or initial documentation
    011 *******************************************************************************/
    012
    013package org.eclipse.january.metadata;
    014
    015import org.eclipse.january.dataset.IDataset;
    016
    017/**
    018 * This metadata describes masking information associated with a dataset
    019 */
    020public interface MaskMetadata extends MetadataType {
    021
    022        /**
    023         * Initialize mask
    024         * @param mask
    025         */
    026        public void initialize(IDataset mask);
    027
    028        /**
    029         * Get mask
    030         * @return mask
    031         */
    032        public IDataset getMask();
    033}