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.ILazyDataset;
016
017/**
018 * This metadata describes ARPES-related information
019 */
020public interface ARPESMetadata extends MetadataType {
021
022        /**
023         * Initialize
024         */
025        public void initialize();
026
027        // Constants for the scan
028        public double getPhotonEnergy();
029        public double getWorkFunction();
030        public double getPassEnergy();
031        public double getTemperature();
032        
033        // Axis associated with detector images
034        public ILazyDataset getKineticEnergies();
035        public ILazyDataset getAnalyserAngles();
036        
037        // Axis associated with the scan direction of the data
038        public ILazyDataset getPolarAngles();
039        public ILazyDataset getTiltAngles();
040        public ILazyDataset getAzimuthalAngles();
041
042        // Calibration information
043        public double getEnergyAxisGlobalOffset();
044        public double getAngleAxisGlobalOffset();
045        public ILazyDataset getEnergyAxisOffset();
046        
047        
048        // calculated axis associated with frames
049        public ILazyDataset getBindingEnergies();
050        public ILazyDataset getPhotoelectronMomentum();
051        
052        
053        // Methods to correct data
054        
055}