Package org.opengda.detector.electronanalyser.api

Class SESSettings

java.lang.Object

gda.factory.FindableBase

org.opengda.detector.electronanalyser.api.SESSettings

All Implemented Interfaces:

Findable, SESSettingsService

@OsgiService(SESSettingsService.class)
@ServiceInterface(SESSettingsService.class)
public class SESSettings
extends FindableBase
implements SESSettingsService

Constructor Summary

Constructors

Constructor	Description
SESSettings()
SESSettings(String name)

Method Summary

Modifier and Type	Method	Description
String	convertLegacyExcitationEnergyToExcitationEnergySourceName(double excitationEnergy)	Helper function that will map an excitationEnergy value to a corresponding excitationEnergySourceName.
String	getDefaultExcitationEnergySourceForSESRegion()
String	getDefaultLensModeForSESRegion()
Map<String,List<Number>>	getLegacyConversionExcitationEnergyForSESRegion()
String	getLegacyFileExtensionForSESSequenceJSONHanlder()	Used when opening a file that is in legacy xml format and SESSettingsService.isLegacyFileFormatOverwrittenForSESSequenceJSONHanlder() is set to false.
List<SESConfigExcitationEnergySource>	getSESConfigExcitationEnergySourceList()
List<SESExcitationEnergySource>	getSESExcitationEnergySourceList()
boolean	isExcitationEnergySourceSelectable()
boolean	isLegacyFileFormatOverwrittenForSESSequenceJSONHanlder()
void	setDefaultExcitationEnergySourceForSESRegion(String defaultExcitationEnergySourceForSESRegion)
void	setDefaultLensModeForSESRegion(String defaultLensModeForSESRegion)
void	setLegacyConversionExcitationEnergyForSESRegion(Map<String,List<Number>> legacyConversionExcitationEnergySourceForSESRegion)	Set the legacy conversion of excitationEnergy to a excitationEnergySource SESRegion.
void	setLegacyFileExtensionForSESSequenceJSONHanlder(String legacyFileExtensionForSESSequenceJSONHanlder)	Used when opening a file that is in legacy xml format and SESSettingsService.isLegacyFileFormatOverwrittenForSESSequenceJSONHanlder() is set to false.
void	setLegacyFileFormatOverwrittenForSESSequenceJSONHanlder(boolean legacyFileFormatOverwrittenForSESSequenceJSONHanlder)
void	setSESConfigExcitationEnergySourceList(List<SESConfigExcitationEnergySource> excitationEnergyConfigList)

Methods inherited from class gda.factory.FindableBase

equals, getName, hashCode, setName

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface gda.factory.Findable

getName, setName

Constructor Details

SESSettings

public SESSettings()

SESSettings

public SESSettings(String name)

Method Details

getDefaultExcitationEnergySourceForSESRegion

public String getDefaultExcitationEnergySourceForSESRegion()

Specified by:

getDefaultExcitationEnergySourceForSESRegion in interface SESSettingsService

Returns:

String defining the defaultExcitationEnergySourceForSESRegion value for a SESRegion.

setDefaultExcitationEnergySourceForSESRegion

public void setDefaultExcitationEnergySourceForSESRegion(String defaultExcitationEnergySourceForSESRegion)

Specified by:

setDefaultExcitationEnergySourceForSESRegion in interface SESSettingsService

getDefaultLensModeForSESRegion

public String getDefaultLensModeForSESRegion()

Specified by:

getDefaultLensModeForSESRegion in interface SESSettingsService

Returns:

the default lens mode for SESRegion.

setDefaultLensModeForSESRegion

public void setDefaultLensModeForSESRegion(String defaultLensModeForSESRegion)

Specified by:

setDefaultLensModeForSESRegion in interface SESSettingsService

Parameters:

defaultLensModeForSESRegion - Set the default lens mode when a new SESRegion is created.

getLegacyConversionExcitationEnergyForSESRegion

public Map<String,List<Number>> getLegacyConversionExcitationEnergyForSESRegion()

Specified by:

getLegacyConversionExcitationEnergyForSESRegion in interface SESSettingsService

Returns:

Mapinvalid input: '<'String, String> excitationEnergySourceToLimits where limits is two numbers joined by "-" e.g "0-2100".

setLegacyConversionExcitationEnergyForSESRegion

public void setLegacyConversionExcitationEnergyForSESRegion(Map<String,List<Number>> legacyConversionExcitationEnergySourceForSESRegion)

Description copied from interface: SESSettingsService

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>
 
 

Specified by:

setLegacyConversionExcitationEnergyForSESRegion in interface SESSettingsService

getLegacyFileExtensionForSESSequenceJSONHanlder

public String getLegacyFileExtensionForSESSequenceJSONHanlder()

Description copied from interface: SESSettingsService

Used when opening a file that is in legacy xml format and SESSettingsService.isLegacyFileFormatOverwrittenForSESSequenceJSONHanlder() is set to false.

Specified by:

getLegacyFileExtensionForSESSequenceJSONHanlder in interface SESSettingsService

Returns:

the file extensions that this file is renamed to by adding this value at the end.

setLegacyFileExtensionForSESSequenceJSONHanlder

public void setLegacyFileExtensionForSESSequenceJSONHanlder(String legacyFileExtensionForSESSequenceJSONHanlder)

Description copied from interface: SESSettingsService

Used when opening a file that is in legacy xml format and SESSettingsService.isLegacyFileFormatOverwrittenForSESSequenceJSONHanlder() is set to false.

Specified by:

setLegacyFileExtensionForSESSequenceJSONHanlder in interface SESSettingsService

Parameters:

legacyFileExtensionForSESSequenceJSONHanlder - To preserve the legacy file, rename the file by adding this extension at the end.

isLegacyFileFormatOverwrittenForSESSequenceJSONHanlder

public boolean isLegacyFileFormatOverwrittenForSESSequenceJSONHanlder()

Specified by:

isLegacyFileFormatOverwrittenForSESSequenceJSONHanlder in interface SESSettingsService

Returns:

boolean determining when opening a legacy file, if it is overwritten when converted.

setLegacyFileFormatOverwrittenForSESSequenceJSONHanlder

public void setLegacyFileFormatOverwrittenForSESSequenceJSONHanlder(boolean legacyFileFormatOverwrittenForSESSequenceJSONHanlder)

Specified by:

setLegacyFileFormatOverwrittenForSESSequenceJSONHanlder in interface SESSettingsService

getSESConfigExcitationEnergySourceList

public List<SESConfigExcitationEnergySource> getSESConfigExcitationEnergySourceList()

Specified by:

getSESConfigExcitationEnergySourceList in interface SESSettingsService

Returns:

List which defines the the default SESExcitationEnergySource and how client displays it.

setSESConfigExcitationEnergySourceList

public void setSESConfigExcitationEnergySourceList(List<SESConfigExcitationEnergySource> excitationEnergyConfigList)

Specified by:

setSESConfigExcitationEnergySourceList in interface SESSettingsService

getSESExcitationEnergySourceList

public List<SESExcitationEnergySource> getSESExcitationEnergySourceList()

Specified by:

getSESExcitationEnergySourceList in interface SESSettingsService

Returns:

List of the default SESExcitationEnergySource which is used when creating new sequence files. Defined by

invalid reference

#setSESConfigExcitationEnergySourceList()

isExcitationEnergySourceSelectable

public boolean isExcitationEnergySourceSelectable()

Specified by:

isExcitationEnergySourceSelectable in interface SESSettingsService

Returns:

true if size of SESSettingsService.getSESExcitationEnergySourceList() is greater than 1, else false.

convertLegacyExcitationEnergyToExcitationEnergySourceName

public String convertLegacyExcitationEnergyToExcitationEnergySourceName(double excitationEnergy)

Description copied from interface: SESSettingsService

Helper function that will map an excitationEnergy value to a corresponding excitationEnergySourceName. Uses the configuration supplied by SESSettingsService.getSESConfigExcitationEnergySourceList().

Specified by:

convertLegacyExcitationEnergyToExcitationEnergySourceName in interface SESSettingsService

Parameters:

excitationEnergy -

Returns: