SpectralSet (SPECCHIO 3.3.0 API)

java.lang.Object
- ch.specchio.types.SpectralSet

public class SpectralSet
extends java.lang.Object

This class represents a spectral set

Field Summary

Fields
Modifier and Type	Field and Description
`java.lang.String`	`abs_rel`
`AdjacencyMatrix`	`adjacency_matrix`
`double`	`confidence_level`
`int`	`instrument_node_id`
`java.lang.String`	`node_description`
`java.util.ArrayList<java.lang.Integer>`	`node_nums`
`int`	`node_set_id`
`java.lang.String`	`node_type`
`java.lang.String`	`source_link_description`
`java.util.ArrayList<java.lang.Integer>`	`spectrum_ids`
`java.lang.String`	`spectrum_set_description`
`int`	`spectrum_set_id`
`int`	`spectrum_subset_id`
`java.util.ArrayList<java.lang.Integer>`	`spectrum_subset_ids`
`java.lang.Float[]`	`u_vector`
`java.lang.Float[][]`	`u_vectors`
`java.lang.String`	`uncertainty_node_description`
`java.util.ArrayList<java.lang.String>`	`uncertainty_node_descriptions`
`int`	`uncertainty_node_id`
`java.util.ArrayList<java.lang.Integer>`	`uncertainty_node_ids`
`java.lang.String`	`uncertainty_set_description`
`int`	`uncertainty_set_id`
`int`	`uncertainty_source_id`
`java.util.ArrayList<java.lang.Integer>`	`uncertainty_source_ids`
`java.util.ArrayList<UncertaintySourcePair>`	`uncertainty_source_pairs`
`int`	`unit_id`

Constructor Summary

Constructors
Constructor and Description

SpectralSet()

Constructors
Constructor and Description
`SpectralSet()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`add_uncertainty_source_by_id(int input_source_id)` Set the id of a linked uncertainty source
`void`	`add_uncertainty_source_by_id(int input_source_id, java.lang.String input_source_link_description)` Set the id and the edge value (source_link_description) of a linked uncertainty source
`void`	`add_uncertainty_source_id_only(int input_source_id)` Set the id of a linked uncertainty source
`java.lang.String`	`getAbsRel()` Get whether the node's uncertainty is absolute or relative.
`double`	`getConfidenceLevel()` Get the instrument node confidence level % from 0 to 1.
`int`	`getInstrumentNodeId()` Get the instrument node identifier for an instrument-level node
`java.lang.String`	`getNodeDescription()` Get the uncertainty node description.
`java.util.ArrayList<java.lang.Integer>`	`getNodeNums()` Get the uncertainty node numbers for an uncertainty set
`int`	`getNodeSetId()` Get the node set id - a node set is a collection of nodes within an uncertainty set
`java.lang.String`	`getNodeType()` Get the uncertainty node node_type.
`java.lang.String`	`getSourceLinkDescription()` Get the source link description ie.
`java.util.ArrayList<java.lang.Integer>`	`getSpectrumIds()` Get the spectrum ids for a spectrum level uncertainty node
`java.lang.String`	`getSpectrumSetDescription()` Get the spectrum set description.
`int`	`getSpectrumSetId()` Get the spectrum set id
`int`	`getSpectrumSubsetId()` Get the spectrum subset id
`java.util.ArrayList<java.lang.Integer>`	`getSpectrumSubsetIds()` Get the spectrum subset ids for a spectrum level uncertainty node
`java.lang.String`	`getUncertaintyNodeDescription()` Get the uncertainty node description
`java.util.ArrayList<java.lang.String>`	`getUncertaintyNodeDescriptions()` Get uncertainty node descriptions for an uncertainty set
`int`	`getUncertaintyNodeId()` Get the uncertainty node id - this is where we standardise the instrument/spectrum nodes
`java.util.ArrayList<java.lang.Integer>`	`getUncertaintyNodeIds()` Get the uncertainty node ids for an uncertainty set
`java.lang.String`	`getUncertaintySetDescription()` Get the uncertainty set description
`int`	`getUncertaintySetId()` Get the uncertainty set id
`int`	`getUncertaintySourceId()` Get the uncertainty source id - an uncertainty node id
`java.util.ArrayList<java.lang.Integer>`	`getUncertaintySourceIds()` Getting uncertainty source ids
`java.util.ArrayList<UncertaintySourcePair>`	`getUncertaintySourcePairs()` Getting uncertainty source pairs
`java.lang.Float[]`	`getUncertaintyVector()` Get the instrument node uncertainty vector
`java.lang.Float[][]`	`getUncertaintyVectors()` Get the instrument node uncertainty vector
`int`	`getUnitId()` Get the uncertainty node unit id.
`void`	`setAbsRel(java.lang.String abs_rel)` Set whether the node's uncertainty is absolute or relative.
`void`	`setConfidenceLevel(double confidence_level)` Set the instrument node confidence level % from 0 to 1.
`void`	`setInstrumentNodeId(int instrument_node_id)` Set the instrument node identifier for an instrument-level node
`void`	`setNodeDescription(java.lang.String node_description)` Set the uncertainty node description.
`void`	`setNodeNums(java.util.ArrayList<java.lang.Integer> node_nums)` Set the uncertainty node numbers for an uncertainty set
`void`	`setNodeSetId(int node_set_id)` Set the node set id
`void`	`setNodeType(java.lang.String node_type)` Set the uncertainty node node_type
`void`	`setSpectrumIds(java.util.ArrayList<java.lang.Integer> spectrum_ids)` Set the spectrum ids for a spectrum level uncertainty node
`void`	`setSpectrumSetDescription(java.lang.String spectrum_set_description)` Set the spectrum set description
`void`	`setSpectrumSetId(int spectrum_set_id)` Set the spectrum set id
`void`	`setSpectrumSubsetId(int spectrum_subset_id)` Set the spectrum subset id
`void`	`setSpectrumSubsetIds(java.util.ArrayList<java.lang.Integer> spectrum_subset_ids)` Set the spectrum subset ids for a spectrum level uncertainty node
`void`	`setUncertaintyMatrix(double[][] u_matrix)` Set the instrument node uncertainty matrix.
`void`	`setUncertaintyNodeDescription(java.lang.String uncertainty_node_description)` Set the uncertainty node description
`void`	`setUncertaintyNodeDescriptions(java.util.ArrayList<java.lang.String> uncertainty_node_descriptions)` Set the uncertainty node descriptions for a spectral set
`void`	`setUncertaintyNodeId(int uncertainty_node_id)` Set the uncertainty node id
`void`	`setUncertaintyNodeIds(java.util.ArrayList<java.lang.Integer> uncertainty_node_ids)` Set the uncertainty node ids for an uncertainty set
`void`	`setUncertaintySetDescription(java.lang.String uncertainty_set_description)` Set the uncertainty set description
`void`	`setUncertaintySetId(int uncertainty_set_id)` Set the uncertainty set id
`void`	`setUncertaintySourceIds(java.util.ArrayList<java.lang.Integer> uncertainty_source_ids)` Set the arraylist of all uncertainty source ids
`void`	`setUncertaintySourcePairs(java.util.ArrayList<UncertaintySourcePair> uncertainty_source_pairs)` Set the arraylist of type UncertaintySourcePair which is a set of source ids and source descriptions
`void`	`setUncertaintyVector(double[] u_vector_input)` Set the instrument node uncertainty vector.
`void`	`setUncertaintyVector(java.lang.Float[] u_vector)` Set the instrument node uncertainty vector.
`void`	`setUncertaintyVectors(java.lang.Float[][] u_vectors)` Set the instrument node uncertainty vector.
`void`	`setUnitId(int unit_id)` Set the uncertainty node unit id.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - instrument_node_id
```
public int instrument_node_id
```
  - node_type
```
public java.lang.String node_type
```
  - u_vector
```
public java.lang.Float[] u_vector
```
  - confidence_level
```
public double confidence_level
```
  - abs_rel
```
public java.lang.String abs_rel
```
  - unit_id
```
public int unit_id
```
  - node_description
```
public java.lang.String node_description
```
  - spectrum_ids
```
public java.util.ArrayList<java.lang.Integer> spectrum_ids
```
  - spectrum_set_description
```
public java.lang.String spectrum_set_description
```
  - spectrum_set_id
```
public int spectrum_set_id
```
  - u_vectors
```
public java.lang.Float[][] u_vectors
```
  - spectrum_subset_id
```
public int spectrum_subset_id
```
  - spectrum_subset_ids
```
public java.util.ArrayList<java.lang.Integer> spectrum_subset_ids
```
  - uncertainty_source_id
```
public int uncertainty_source_id
```
  - source_link_description
```
public java.lang.String source_link_description
```
  - uncertainty_source_pairs
```
public java.util.ArrayList<UncertaintySourcePair> uncertainty_source_pairs
```
  - uncertainty_source_ids
```
public java.util.ArrayList<java.lang.Integer> uncertainty_source_ids
```
  - uncertainty_set_id
```
public int uncertainty_set_id
```
  - uncertainty_set_description
```
public java.lang.String uncertainty_set_description
```
  - uncertainty_node_id
```
public int uncertainty_node_id
```
  - node_set_id
```
public int node_set_id
```
  - uncertainty_node_description
```
public java.lang.String uncertainty_node_description
```
  - uncertainty_node_ids
```
public java.util.ArrayList<java.lang.Integer> uncertainty_node_ids
```
  - node_nums
```
public java.util.ArrayList<java.lang.Integer> node_nums
```
  - uncertainty_node_descriptions
```
public java.util.ArrayList<java.lang.String> uncertainty_node_descriptions
```
  - adjacency_matrix
```
public AdjacencyMatrix adjacency_matrix
```
- Constructor Detail
  - SpectralSet
```
public SpectralSet()
```
- Method Detail
  - getInstrumentNodeId
```
public int getInstrumentNodeId()
```
    Get the instrument node identifier for an instrument-level node
    
    Returns:
    
    the instrument node identifier
  - setInstrumentNodeId
```
public void setInstrumentNodeId(int instrument_node_id)
```
    Set the instrument node identifier for an instrument-level node
    
    Parameters:
    
    the - instrument node identifier
  - getNodeType
```
public java.lang.String getNodeType()
```
    Get the uncertainty node node_type.
    
    Returns:
    
    node_type either 'spectrum' or 'instrument'
  - setNodeType
```
public void setNodeType(java.lang.String node_type)
```
    Set the uncertainty node node_type
    
    Parameters:
    
    node_type - a either 'spectrum' or 'instrument'
  - getConfidenceLevel
```
public double getConfidenceLevel()
```
    Get the instrument node confidence level % from 0 to 1.
    
    Returns:
    
    confidence_level Percentage from 0 to 1
  - setConfidenceLevel
```
public void setConfidenceLevel(double confidence_level)
```
    Set the instrument node confidence level % from 0 to 1.
    
    Parameters:
    
    confidence_level - Percentage from 0 to 1
  - getUncertaintyVector
```
public java.lang.Float[] getUncertaintyVector()
```
    Get the instrument node uncertainty vector
    
    Returns:
    
    u_vector
  - setUncertaintyVector
```
public void setUncertaintyVector(java.lang.Float[] u_vector)
```
    Set the instrument node uncertainty vector.
    
    Parameters:
    
    u_vector -
  - setUncertaintyMatrix
```
public void setUncertaintyMatrix(double[][] u_matrix)
```
    Set the instrument node uncertainty matrix.
    
    Parameters:
    
    u_matrix -
  - setUncertaintyVector
```
public void setUncertaintyVector(double[] u_vector_input)
```
    Set the instrument node uncertainty vector.
    
    Parameters:
    
    u_vector_input -
  - getAbsRel
```
public java.lang.String getAbsRel()
```
    Get whether the node's uncertainty is absolute or relative.
    
    Returns:
    
    abs_rel absolute or relative uncertainty
  - setAbsRel
```
public void setAbsRel(java.lang.String abs_rel)
```
    Set whether the node's uncertainty is absolute or relative.
    
    Parameters:
    
    abs_rel - absolute or relative uncertainty
  - getUnitId
```
public int getUnitId()
```
    Get the uncertainty node unit id.
    
    Returns:
    
    the uncertainty node unit id
  - setUnitId
```
public void setUnitId(int unit_id)
```
    Set the uncertainty node unit id.
    
    Parameters:
    
    the - uncertainty node's unit id
  - getNodeDescription
```
public java.lang.String getNodeDescription()
```
    Get the uncertainty node description.
    
    Returns:
    
    node description what the uncertainty node describes
  - setNodeDescription
```
public void setNodeDescription(java.lang.String node_description)
```
    Set the uncertainty node description.
    
    Parameters:
    
    node_description - what the uncertainty node describes
  - getSpectrumIds
```
public java.util.ArrayList<java.lang.Integer> getSpectrumIds()
```
    Get the spectrum ids for a spectrum level uncertainty node
    
    Parameters:
    
    spectrum_ids - a list of spectrum ids
  - setSpectrumIds
```
public void setSpectrumIds(java.util.ArrayList<java.lang.Integer> spectrum_ids)
```
    Set the spectrum ids for a spectrum level uncertainty node
    
    Parameters:
    
    spectrum_ids - a list of spectrum ids
  - getSpectrumSetDescription
```
public java.lang.String getSpectrumSetDescription()
```
    Get the spectrum set description.
    
    Returns:
    
    spectrum_set_description
  - setSpectrumSetDescription
```
public void setSpectrumSetDescription(java.lang.String spectrum_set_description)
```
    Set the spectrum set description
    
    Parameters:
    
    spectrum_set_description -
  - getSpectrumSetId
```
public int getSpectrumSetId()
```
    Get the spectrum set id
    
    Returns:
    
    spectrum_set_id the spectrum set identifier
  - setSpectrumSetId
```
public void setSpectrumSetId(int spectrum_set_id)
```
    Set the spectrum set id
    
    Parameters:
    
    spectrum_set_id - unique spectrum set id
  - getUncertaintySetId
```
public int getUncertaintySetId()
```
    Get the uncertainty set id
    
    Returns:
    
    uncertainty_set_id the uncertainty set identifier
  - setUncertaintySetId
```
public void setUncertaintySetId(int uncertainty_set_id)
```
    Set the uncertainty set id
    
    Parameters:
    
    uncertainty_set_id - unique uncertainty set id
  - getUncertaintySetDescription
```
public java.lang.String getUncertaintySetDescription()
```
    Get the uncertainty set description
    
    Returns:
    
    uncertainty_set_description the uncertainty set description
  - setUncertaintySetDescription
```
public void setUncertaintySetDescription(java.lang.String uncertainty_set_description)
```
    Set the uncertainty set description
    
    Parameters:
    
    uncertainty_set_description - the uncertainty set description
  - getUncertaintyNodeId
```
public int getUncertaintyNodeId()
```
    Get the uncertainty node id - this is where we standardise the instrument/spectrum nodes
    
    Returns:
    
    uncertainty_node_id
  - setUncertaintyNodeId
```
public void setUncertaintyNodeId(int uncertainty_node_id)
```
    Set the uncertainty node id
    
    Parameters:
    
    uncertainty_node_id -
  - getNodeSetId
```
public int getNodeSetId()
```
    Get the node set id - a node set is a collection of nodes within an uncertainty set
    
    Returns:
    
    node_set_id node set identifier
  - setNodeSetId
```
public void setNodeSetId(int node_set_id)
```
    Set the node set id
    
    Parameters:
    
    node_set_id - unique node set id
  - getUncertaintyVectors
```
public java.lang.Float[][] getUncertaintyVectors()
```
    Get the instrument node uncertainty vector
    
    Returns:
    
    u_vectors
  - setUncertaintyVectors
```
public void setUncertaintyVectors(java.lang.Float[][] u_vectors)
```
    Set the instrument node uncertainty vector.
    
    Parameters:
    
    u_vectors -
  - getUncertaintySourceId
```
public int getUncertaintySourceId()
```
    Get the uncertainty source id - an uncertainty node id
    
    Returns:
    
    uncertainty_source_id the uncertainty node id of the source
  - getSourceLinkDescription
```
public java.lang.String getSourceLinkDescription()
```
    Get the source link description ie. edge value
    
    Returns:
    
    source_link_description the description of how the source links to current node
  - add_uncertainty_source_by_id
```
public void add_uncertainty_source_by_id(int input_source_id)
```
    Set the id of a linked uncertainty source
    
    Parameters:
    
    input_source_id - the uncertainty node id of the linked node
  - add_uncertainty_source_by_id
```
public void add_uncertainty_source_by_id(int input_source_id,
                                         java.lang.String input_source_link_description)
```
    Set the id and the edge value (source_link_description) of a linked uncertainty source
    
    Parameters:
    
    input_source_id - the uncertainty node id of the linked node
    
    input_source_link_description - the description of how this source links to the current node
  - setUncertaintySourcePairs
```
public void setUncertaintySourcePairs(java.util.ArrayList<UncertaintySourcePair> uncertainty_source_pairs)
```
    Set the arraylist of type UncertaintySourcePair which is a set of source ids and source descriptions
    
    Parameters:
    
    uncertainty_source_pairs - an arraylist of type UncertaintySourcePair
  - getUncertaintySourcePairs
```
public java.util.ArrayList<UncertaintySourcePair> getUncertaintySourcePairs()
```
    Getting uncertainty source pairs
    
    Returns:
    
    uncertainty_source_pairs a list of type UncertaintySourcePair
  - add_uncertainty_source_id_only
```
public void add_uncertainty_source_id_only(int input_source_id)
```
    Set the id of a linked uncertainty source
    
    Parameters:
    
    input_source_id - the uncertainty node id of the linked node
  - setUncertaintySourceIds
```
public void setUncertaintySourceIds(java.util.ArrayList<java.lang.Integer> uncertainty_source_ids)
```
    Set the arraylist of all uncertainty source ids
    
    Parameters:
    
    uncertainty_source_ids - an arraylist of integers of uncertainty source ids
  - getUncertaintySourceIds
```
public java.util.ArrayList<java.lang.Integer> getUncertaintySourceIds()
```
    Getting uncertainty source ids
    
    Returns:
    
    uncertainty_source_ids a list of type integer
  - getSpectrumSubsetId
```
public int getSpectrumSubsetId()
```
    Get the spectrum subset id
    
    Returns:
    
    spectrum_subset_id the spectrum subset identifier
  - setSpectrumSubsetId
```
public void setSpectrumSubsetId(int spectrum_subset_id)
```
    Set the spectrum subset id
    
    Parameters:
    
    spectrum_subset_id - unique spectrum subset id
  - getSpectrumSubsetIds
```
public java.util.ArrayList<java.lang.Integer> getSpectrumSubsetIds()
```
    Get the spectrum subset ids for a spectrum level uncertainty node
    
    Parameters:
    
    spectrum_subset_ids - a list of spectrum subset ids
  - setSpectrumSubsetIds
```
public void setSpectrumSubsetIds(java.util.ArrayList<java.lang.Integer> spectrum_subset_ids)
```
    Set the spectrum subset ids for a spectrum level uncertainty node
    
    Parameters:
    
    spectrum_subset_ids - a list of spectrum subset ids
  - getUncertaintyNodeIds
```
public java.util.ArrayList<java.lang.Integer> getUncertaintyNodeIds()
```
    Get the uncertainty node ids for an uncertainty set
    
    Parameters:
    
    uncertainty_node_ids - a list of uncertainty node ids for an uncertainty set
  - setUncertaintyNodeIds
```
public void setUncertaintyNodeIds(java.util.ArrayList<java.lang.Integer> uncertainty_node_ids)
```
    Set the uncertainty node ids for an uncertainty set
    
    Parameters:
    
    uncertainty_set_node_ids - a list of uncertainty node ids
  - getNodeNums
```
public java.util.ArrayList<java.lang.Integer> getNodeNums()
```
    Get the uncertainty node numbers for an uncertainty set
    
    Parameters:
    
    node_nums - a list of uncertainty node numbers
  - setNodeNums
```
public void setNodeNums(java.util.ArrayList<java.lang.Integer> node_nums)
```
    Set the uncertainty node numbers for an uncertainty set
    
    Parameters:
    
    node_nums - a list of uncertainty node numbers
  - getUncertaintyNodeDescription
```
public java.lang.String getUncertaintyNodeDescription()
```
    Get the uncertainty node description
    
    Returns:
    
    uncertainty_node_description the uncertainty node description
  - setUncertaintyNodeDescription
```
public void setUncertaintyNodeDescription(java.lang.String uncertainty_node_description)
```
    Set the uncertainty node description
    
    Parameters:
    
    uncertainty_node_description - the uncertainty node description
  - getUncertaintyNodeDescriptions
```
public java.util.ArrayList<java.lang.String> getUncertaintyNodeDescriptions()
```
    Get uncertainty node descriptions for an uncertainty set
    
    Parameters:
    
    uncertainty_node_descriptions - a list of uncertainty set descriptions
  - setUncertaintyNodeDescriptions
```
public void setUncertaintyNodeDescriptions(java.util.ArrayList<java.lang.String> uncertainty_node_descriptions)
```
    Set the uncertainty node descriptions for a spectral set
    
    Parameters:
    
    uncertainty_node_descriptions - a list of uncertainty node descriptions

Class SpectralSet

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

instrument_node_id

node_type

u_vector

confidence_level

abs_rel

unit_id

node_description

spectrum_ids

spectrum_set_description

spectrum_set_id

u_vectors

spectrum_subset_id

spectrum_subset_ids

uncertainty_source_id

source_link_description

uncertainty_source_pairs

uncertainty_source_ids

uncertainty_set_id

uncertainty_set_description

uncertainty_node_id

node_set_id

uncertainty_node_description

uncertainty_node_ids

node_nums

uncertainty_node_descriptions

adjacency_matrix

Constructor Detail

SpectralSet

Method Detail

getInstrumentNodeId

setInstrumentNodeId

getNodeType

setNodeType

getConfidenceLevel

setConfidenceLevel

getUncertaintyVector

setUncertaintyVector

setUncertaintyMatrix

setUncertaintyVector

getAbsRel

setAbsRel

getUnitId

setUnitId

getNodeDescription

setNodeDescription

getSpectrumIds

setSpectrumIds

getSpectrumSetDescription

setSpectrumSetDescription

getSpectrumSetId

setSpectrumSetId

getUncertaintySetId

setUncertaintySetId

getUncertaintySetDescription

setUncertaintySetDescription

getUncertaintyNodeId

setUncertaintyNodeId

getNodeSetId

setNodeSetId

getUncertaintyVectors

setUncertaintyVectors

getUncertaintySourceId

getSourceLinkDescription

add_uncertainty_source_by_id

add_uncertainty_source_by_id

setUncertaintySourcePairs

getUncertaintySourcePairs

add_uncertainty_source_id_only

setUncertaintySourceIds

getUncertaintySourceIds

getSpectrumSubsetId

setSpectrumSubsetId

getSpectrumSubsetIds

setSpectrumSubsetIds