ch.specchio.types

Class UncertaintyNode

java.lang.Object

ch.specchio.types.UncertaintyNode

Direct Known Subclasses:

UncertaintyInstrumentNode, UncertaintySpectrumNode

public class UncertaintyNode
extends java.lang.Object

This class represents an uncertainty node

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	abs_rel
double	confidence_level
java.lang.Boolean	is_spectrum
java.lang.String	node_description
java.lang.String	node_type
float[]	u_vector
java.lang.String	uncertainty_node_description
int	uncertainty_node_id
int	unit_id

Constructor Summary

Constructors

Constructor and Description
UncertaintyNode()

Method Summary

Modifier and Type	Method and Description
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
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.
java.lang.Boolean	getIsSpectrum() Return boolean about whether uncertainty node is of type spectrum
java.lang.String	getNodeDescription() Get the uncertainty node description.
java.lang.String	getNodeType() Get the uncertainty node node_type.
java.lang.String	getUncertaintyNodeDescription() Get the uncertainty node description
int	getUncertaintyNodeId() Get the uncertainty node id
java.util.ArrayList<UncertaintySourcePair>	getUncertaintySourcePairs() Getting uncertainty source pairs
float[]	getUncertaintyVector() 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	setIsSpectrum(java.lang.Boolean is_spectrum) Set the boolean is_spectrum
void	setNodeDescription(java.lang.String node_description) Set the uncertainty node description.
void	setNodeType(java.lang.String node_type) Set the uncertainty node node_type
void	setUncertaintyNodeDescription(java.lang.String uncertainty_node_description) Set the uncertainty node description
void	setUncertaintyNodeId(int uncertainty_node_id) Set the uncertainty node id
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 (fast method).
void	setUncertaintyVector(float[] u_vector_input) Set the instrument node uncertainty vector (fast method).
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

uncertainty_node_id

public int uncertainty_node_id

node_type

public java.lang.String node_type

u_vector

public 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

is_spectrum

public java.lang.Boolean is_spectrum

uncertainty_node_description

public java.lang.String uncertainty_node_description

Constructor Detail

UncertaintyNode

public UncertaintyNode()

Method Detail

getUncertaintyNodeId

public int getUncertaintyNodeId()

Get the uncertainty node id

Returns:

uncertainty_node_id

setUncertaintyNodeId

public void setUncertaintyNodeId(int uncertainty_node_id)

Set the uncertainty node id

Parameters:

uncertainty_node_id -

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'

getUncertaintyVector

public float[] getUncertaintyVector()

Get the instrument node uncertainty vector

Returns:

u_vector

setUncertaintyVector

public void setUncertaintyVector(double[] u_vector_input)

Set the instrument node uncertainty vector (fast method).

Parameters:

u_vector_input -

setUncertaintyVector

public void setUncertaintyVector(float[] u_vector_input)

Set the instrument node uncertainty vector (fast method).

Parameters:

u_vector_input -

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

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:

unit_id - 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

getIsSpectrum

public java.lang.Boolean getIsSpectrum()

Return boolean about whether uncertainty node is of type spectrum

Returns:

is_spectrum a boolean

setIsSpectrum

public void setIsSpectrum(java.lang.Boolean is_spectrum)

Set the boolean is_spectrum

Parameters:

is_spectrum - a boolean

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

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_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