Package adams.data.statistics
Class ArrayAngle<T extends Number>
- java.lang.Object
-
- adams.core.logging.LoggingObject
-
- adams.core.logging.CustomLoggingLevelObject
-
- adams.core.option.AbstractOptionHandler
-
- adams.data.statistics.AbstractArrayStatistic<T>
-
- adams.data.statistics.ArrayAngle<T>
-
- All Implemented Interfaces:
AdditionalInformationHandler
,Destroyable
,GlobalInfoSupporter
,LoggingLevelHandler
,LoggingSupporter
,OptionHandler
,ShallowCopySupporter<AbstractArrayStatistic>
,SizeOfHandler
,TechnicalInformationHandler
,EqualLengthArrayStatistic
,Serializable
public class ArrayAngle<T extends Number> extends AbstractArrayStatistic<T> implements EqualLengthArrayStatistic, TechnicalInformationHandler
Calculates the angle between the first array and the remaining arrays. The arrays must be numeric.
For more information see:
Kruse, Fred A, Lefkoff, AB, Boardman, JW, Heidebrecht, KB, Shapiro, AT, Barloon, PJ, Goetz, AFH (1993). The spectral image processing system (SIPS)—interactive visualization and analysis of imaging spectrometer data. Remote sensing of environment. 44(2-3):145--163.
Oshigami, Shoko, Yamaguchi, Yasushi, Uezato, Tatsumi, Momose, Atsushi, Arvelyna, Yessy, Kawakami, Yuu, Yajima, Taro, Miyatake, Shuichi, Nguno, Anna (2013). Mineralogical mapping of southern Namibia by application of continuum-removal MSAM method to the HyMap data. International journal of remote sensing. 34(15):5282--5295.
@article{Kruse1993, author = {Kruse, Fred A and Lefkoff, AB and Boardman, JW and Heidebrecht, KB and Shapiro, AT and Barloon, PJ and Goetz, AFH}, journal = {Remote sensing of environment}, number = {2-3}, pages = {145--163}, publisher = {Elsevier}, title = {The spectral image processing system (SIPS)—interactive visualization and analysis of imaging spectrometer data}, volume = {44}, year = {1993} } @article{Oshigami2013, author = {Oshigami, Shoko and Yamaguchi, Yasushi and Uezato, Tatsumi and Momose, Atsushi and Arvelyna, Yessy and Kawakami, Yuu and Yajima, Taro and Miyatake, Shuichi and Nguno, Anna}, journal = {International journal of remote sensing}, number = {15}, pages = {5282--5295}, publisher = {Taylor & Francis}, title = {Mineralogical mapping of southern Namibia by application of continuum-removal MSAM method to the HyMap data}, volume = {34}, year = {2013} }
-logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel) The logging level for outputting errors and debugging output. default: WARNING
-modified <boolean> (property: modified) Whether to use the modified algorithm described in Oshigami et al. default: false
- Author:
- Corey Sterling (csterlin at waikato dot ac dot nz)
- See Also:
- Serialized Form
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class adams.data.statistics.AbstractArrayStatistic
AbstractArrayStatistic.StatisticContainer<T extends Serializable>
-
-
Field Summary
Fields Modifier and Type Field Description protected boolean
m_UseModifiedAlgorithm
Whether to use the modified algorithm described in Oshigami et al.-
Fields inherited from class adams.data.statistics.AbstractArrayStatistic
m_Data
-
Fields inherited from class adams.core.option.AbstractOptionHandler
m_OptionManager
-
Fields inherited from class adams.core.logging.LoggingObject
m_Logger, m_LoggingIsEnabled, m_LoggingLevel
-
-
Constructor Summary
Constructors Constructor Description ArrayAngle()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
defineOptions()
Adds options to the internal list of options.protected AbstractArrayStatistic.StatisticContainer
doCalculate()
Generates the actual result.int
getLength()
Returns the length of the stored arrays.int
getMax()
Returns the maximum number of arrays that need to be present.int
getMin()
Returns the minimum number of arrays that need to be present.boolean
getModified()
Gets whether to use the modified algorithm.TechnicalInformation
getTechnicalInformation()
Returns an instance of a TechnicalInformation object, containing detailed information about the technical background of this class, e.g., paper reference or book this class is based on.String
globalInfo()
Returns a string describing the object.String
modifiedTipText()
Gets the tip-text for the modified option.void
setModified(boolean value)
Sets whether to use the modified algorithm.protected double[]
toDoubleArray(T[] input)
Converts an array of Numbers into an array of doubles.-
Methods inherited from class adams.data.statistics.AbstractArrayStatistic
add, calculate, check, checkEqualLength, clear, forCommandLine, forName, get, getAdditionalInformation, getStatistics, initialize, remove, set, shallowCopy, shallowCopy, size, toString
-
Methods inherited from class adams.core.option.AbstractOptionHandler
cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, loggingLevelTipText, newOptionManager, reset, setLoggingLevel, toCommandLine
-
Methods inherited from class adams.core.logging.LoggingObject
configureLogger, getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled, sizeOf
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface adams.core.logging.LoggingLevelHandler
getLoggingLevel
-
-
-
-
Method Detail
-
globalInfo
public String globalInfo()
Returns a string describing the object.- Specified by:
globalInfo
in interfaceGlobalInfoSupporter
- Specified by:
globalInfo
in classAbstractOptionHandler
- Returns:
- a description suitable for displaying in the gui
-
defineOptions
public void defineOptions()
Adds options to the internal list of options.- Specified by:
defineOptions
in interfaceOptionHandler
- Overrides:
defineOptions
in classAbstractOptionHandler
-
getModified
public boolean getModified()
Gets whether to use the modified algorithm.- Returns:
- Whether to use the modified algorithm.
-
setModified
public void setModified(boolean value)
Sets whether to use the modified algorithm.- Parameters:
value
- Whether to use the modified algorithm.
-
modifiedTipText
public String modifiedTipText()
Gets the tip-text for the modified option.- Returns:
- The tip-text as a string.
-
getTechnicalInformation
public TechnicalInformation getTechnicalInformation()
Returns an instance of a TechnicalInformation object, containing detailed information about the technical background of this class, e.g., paper reference or book this class is based on.- Specified by:
getTechnicalInformation
in interfaceTechnicalInformationHandler
- Returns:
- the technical information about this class
-
getMin
public int getMin()
Returns the minimum number of arrays that need to be present. -1 for unbounded.- Specified by:
getMin
in classAbstractArrayStatistic<T extends Number>
- Returns:
- the minimum number, -1 for unbounded
-
getMax
public int getMax()
Returns the maximum number of arrays that need to be present. -1 for unbounded.- Specified by:
getMax
in classAbstractArrayStatistic<T extends Number>
- Returns:
- the maximum number, -1 for unbounded
-
getLength
public int getLength()
Returns the length of the stored arrays.- Specified by:
getLength
in interfaceEqualLengthArrayStatistic
- Returns:
- the length of the arrays, -1 if none stored
-
doCalculate
protected AbstractArrayStatistic.StatisticContainer doCalculate()
Generates the actual result.- Specified by:
doCalculate
in classAbstractArrayStatistic<T extends Number>
- Returns:
- the generated result
-
toDoubleArray
protected double[] toDoubleArray(T[] input)
Converts an array of Numbers into an array of doubles.- Parameters:
input
- The Number array.- Returns:
- The double array.
-
-