Package org.opengda.detector.electronanalyser.api

Interface SESSettingsService

All Superinterfaces:
Findable
All Known Implementing Classes:
SESSettings
public interface SESSettingsService extends Findable
Service that provide global settings for SES api e.g default settings for SESRegion, SESExcitationEnergySource and how the client display it.

  • Method Details

    • getDefaultExcitationEnergySourceForSESRegion

      String getDefaultExcitationEnergySourceForSESRegion()
      Returns:
      String defining the defaultExcitationEnergySourceForSESRegion value for a SESRegion.

    • setDefaultExcitationEnergySourceForSESRegion

      void setDefaultExcitationEnergySourceForSESRegion(String defaultExcitationEnergySourceForSESRegion)

    • getDefaultLensModeForSESRegion

      String getDefaultLensModeForSESRegion()
      Returns:
      the default lens mode for SESRegion.

    • setDefaultLensModeForSESRegion

      void setDefaultLensModeForSESRegion(String defaultLensModeForSESRegion)
      Parameters:
      defaultLensModeForSESRegion - Set the default lens mode when a new SESRegion is created.

    • getLegacyConversionExcitationEnergyForSESRegion

      Map<String,List<Number>> getLegacyConversionExcitationEnergyForSESRegion()
      Returns:
      Mapinvalid input: '<'String, String> excitationEnergySourceToLimits where limits is two numbers joined by "-" e.g "0-2100".

    • setLegacyConversionExcitationEnergyForSESRegion

      void setLegacyConversionExcitationEnergyForSESRegion(Map<String,List<Number>> excitationEnergySourceToLimits)
      Set the legacy conversion of excitationEnergy to a excitationEnergySource SESRegion. The first String value of the map is the excitationEnergySource name, the second is a list of two values containing the excitationEnergy range it is valid at. Example configuration: 
       
 <bean id="sessettings" class="org.opengda.detector.electronanalyser.api.SESSettings">
 	<property name="legacyConversionExcitationEnergyForSESRegion">
 		<map>
 			<!-- convert excitation energies in this range to source1-->
 			<entry key="source1">
 				<list value-type="java.lang.Double">
 					<bean id="source1LowLimt" class="java.lang.Double">
 						<constructor-arg value="2100"/>
 					</bean>
 					<bean id="source1HighLimt" class="java.lang.Double">
 						<constructor-arg>
 							<util:constant static-field="java.lang.Double.MAX_VALUE"/>
 						</constructor-arg>
 					</bean>
 				</list>
 			</entry>
 		</map>
 	</property>
 </bean>

    • getLegacyFileExtensionForSESSequenceJSONHanlder

      String getLegacyFileExtensionForSESSequenceJSONHanlder()
      Used when opening a file that is in legacy xml format and isLegacyFileFormatOverwrittenForSESSequenceJSONHanlder() is set to false.
      Returns:
      the file extensions that this file is renamed to by adding this value at the end.

    • setLegacyFileExtensionForSESSequenceJSONHanlder

      void setLegacyFileExtensionForSESSequenceJSONHanlder(String legacyFileExtensionForSESSequenceJSONHanlder)
      Used when opening a file that is in legacy xml format and isLegacyFileFormatOverwrittenForSESSequenceJSONHanlder() is set to false.
      Parameters:
      legacyFileExtensionForSESSequenceJSONHanlder - To preserve the legacy file, rename the file by adding this extension at the end.

    • isLegacyFileFormatOverwrittenForSESSequenceJSONHanlder

      boolean isLegacyFileFormatOverwrittenForSESSequenceJSONHanlder()
      Returns:
      boolean determining when opening a legacy file, if it is overwritten when converted.

    • setLegacyFileFormatOverwrittenForSESSequenceJSONHanlder

      void setLegacyFileFormatOverwrittenForSESSequenceJSONHanlder(boolean legacyFileExtensionForSESSequenceJSONHanlder)
      Parameters:
      boolean - determining when opening a legacy file, if it is overwritten when converted.

    • setSESConfigExcitationEnergySourceList

      void setSESConfigExcitationEnergySourceList(List<SESConfigExcitationEnergySource> sesConfigExcitationEnergySource)
      Parameters:
      sesConfigExcitationEnergySourceList - which defines the default SESExcitationEnergySource and how the client will display the excitation energy sources. Example configuration: 
       
 <bean id="sessettings" class="org.opengda.detector.electronanalyser.api.SESSettings">
 	<property name="SESConfigExcitationEnergySourceList">
 		<bean id="excitationEnergySourceConfig" class="java.util.ArrayList">
 			<constructor-arg>
 				<list>
 					<bean id="dcmenergyConfig" class="org.opengda.detector.electronanalyser.api.SESConfigExcitationEnergySource">
 						<constructor-arg name="name" value="source1"/>
 						<constructor-arg name="displayName" value="Hard X-ray"/>
 						<constructor-arg name="scannableName" value="dcmenergyEv"/>
 					</bean>
 					<bean id="pgmenergyConfig" class="org.opengda.detector.electronanalyser.api.SESConfigExcitationEnergySource">
 						<constructor-arg name="name" value="source2"/>
 						<constructor-arg name="displayName" value="Soft X-ray"/>
 						<constructor-arg name="scannableName" value="pgmenergy"/>
 					</bean>
 				</list>
 			</constructor-arg>
 		</bean>
 	</property>
 </bean>

    • getSESConfigExcitationEnergySourceList

      List<SESConfigExcitationEnergySource> getSESConfigExcitationEnergySourceList()
      Returns:
      List which defines the the default SESExcitationEnergySource and how client displays it.

    • getSESExcitationEnergySourceList

      List<SESExcitationEnergySource> getSESExcitationEnergySourceList()
      Returns:
      List of the default SESExcitationEnergySource which is used when creating new sequence files. Defined by
      invalid reference 
      #setSESConfigExcitationEnergySourceList()

    • isExcitationEnergySourceSelectable

      boolean isExcitationEnergySourceSelectable()
      Returns:
      true if size of getSESExcitationEnergySourceList() is greater than 1, else false.

    • convertLegacyExcitationEnergyToExcitationEnergySourceName

      String convertLegacyExcitationEnergyToExcitationEnergySourceName(double excitationEnergy)
      Helper function that will map an excitationEnergy value to a corresponding excitationEnergySourceName. Uses the configuration supplied by getSESConfigExcitationEnergySourceList().
      Parameters:
      excitationEnergy -
      Returns: