Package org.eclipse.dawnsci.nexus

Interface NXslit

All Superinterfaces:

GroupNode, Iterable<NodeLink>, Node, NXcomponent, NXobject

public interface NXslit
extends NXcomponent

A simple slit. For more complex geometries, :ref:`NXaperture` should be used.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	NX_X_GAP
static final String	NX_Y_GAP

Fields inherited from interface org.eclipse.dawnsci.analysis.api.tree.Node

ATTRIBUTE, SEPARATOR

Fields inherited from interface org.eclipse.dawnsci.nexus.NXcomponent

NX_APPLIED, NX_DEPENDS_ON, NX_DESCRIPTION, NX_INPUTS, NX_NAME, NX_OUTPUTS

Fields inherited from interface org.eclipse.dawnsci.nexus.NXobject

NX_ATTRIBUTE_DEFAULT

Method Summary

Modifier and Type	Method	Description
org.eclipse.january.dataset.Dataset	getDepends_on()	If desired the location of the slit can also be described relative to an NXbeam, which will allow a simple description of a non-centred slit.
String	getDepends_onScalar()	If desired the location of the slit can also be described relative to an NXbeam, which will allow a simple description of a non-centred slit.
org.eclipse.january.dataset.Dataset	getX_gap()	Size of the gap opening in the first dimension of the local coordinate system.
Number	getX_gapScalar()	Size of the gap opening in the first dimension of the local coordinate system.
org.eclipse.january.dataset.Dataset	getY_gap()	Size of the gap opening in the second dimension of the local coordinate system.
Number	getY_gapScalar()	Size of the gap opening in the second dimension of the local coordinate system.
DataNode	setDepends_on(org.eclipse.january.dataset.IDataset depends_onDataset)	If desired the location of the slit can also be described relative to an NXbeam, which will allow a simple description of a non-centred slit.
DataNode	setDepends_onScalar(String depends_onValue)	If desired the location of the slit can also be described relative to an NXbeam, which will allow a simple description of a non-centred slit.
DataNode	setX_gap(org.eclipse.january.dataset.IDataset x_gapDataset)	Size of the gap opening in the first dimension of the local coordinate system.
DataNode	setX_gapScalar(Number x_gapValue)	Size of the gap opening in the first dimension of the local coordinate system.
DataNode	setY_gap(org.eclipse.january.dataset.IDataset y_gapDataset)	Size of the gap opening in the second dimension of the local coordinate system.
DataNode	setY_gapScalar(Number y_gapValue)	Size of the gap opening in the second dimension of the local coordinate system.

Methods inherited from interface org.eclipse.dawnsci.analysis.api.tree.GroupNode

addDataNode, addGroupNode, addNode, addNodeLink, addSymbolicNode, containsDataNode, containsGroupNode, containsNode, containsSymbolicNode, findLinkedNodeName, findNode, findNodeLink, getDataNode, getDataNodeMap, getDataNodeNames, getDataNodes, getDatasets, getGlobalPool, getGroupNode, getGroupNodeMap, getGroupNodeNames, getGroupNodes, getNames, getNode, getNodeLink, getNodeNameIterator, getNumberOfDataNodes, getNumberOfGroupNodes, getNumberOfNodelinks, getSymbolicNode, getSymbolicNodeNames, isPopulated, iterator, removeDataNode, removeDataNode, removeGroupNode, removeGroupNode, removeSymbolicNode, removeSymbolicNode, setGlobalPool

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface org.eclipse.dawnsci.analysis.api.tree.Node

addAttribute, containsAttribute, getAttribute, getAttributeIterator, getAttributeNameIterator, getAttributeNames, getID, getNumberOfAttributes, isDataNode, isGroupNode, isSymbolicNode, removeAttribute, removeAttribute

Methods inherited from interface org.eclipse.dawnsci.nexus.NXcomponent

getAllFabrication, getAllProgram, getAllTransformations, getApplied, getAppliedScalar, getDescription, getDescriptionScalar, getFabrication, getFabrication, getInputs, getInputsScalar, getName, getNameScalar, getOutputs, getOutputsScalar, getProgram, getProgram, getTransformations, getTransformations, setAllFabrication, setAllProgram, setAllTransformations, setApplied, setAppliedScalar, setDescription, setDescriptionScalar, setFabrication, setFabrication, setInputs, setInputsScalar, setName, setNameScalar, setOutputs, setOutputsScalar, setProgram, setProgram, setTransformations, setTransformations

Methods inherited from interface org.eclipse.dawnsci.nexus.NXobject

addExternalLink, canAddChild, createDataNode, getAllDatasets, getAttr, getAttrBoolean, getAttrDate, getAttrDouble, getAttributeDefault, getAttrLong, getAttrNumber, getAttrString, getBoolean, getChild, getChildren, getChildren, getDataset, getDate, getDouble, getLazyDataset, getLazyWritableDataset, getLong, getNexusBaseClass, getNumber, getNXclass, getPermittedChildGroupClasses, getString, initializeFixedSizeLazyDataset, initializeLazyDataset, initializeLazyDataset, initializeLazyDataset, putChild, setAttribute, setAttributeDefault, setChildren, setDataset, setField

Field Details

NX_X_GAP

static final String NX_X_GAP

See Also:

• Constant Field Values

NX_Y_GAP

static final String NX_Y_GAP

See Also:

• Constant Field Values

Method Details

getDepends_on

org.eclipse.january.dataset.Dataset getDepends_on()

If desired the location of the slit can also be described relative to an NXbeam, which will allow a simple description of a non-centred slit. The reference plane of the slit is orthogonal to the z axis and includes the surface that is the entry surface of the slit. The reference point of the slit is the centre of the slit opening in the x and y axis on the reference plane. The reference point on the z axis is the reference plane. .. image:: slit/slit.png :width: 40%

Type: NX_CHAR

Specified by:

getDepends_on in interface NXcomponent

Returns:

the value.

setDepends_on

DataNode setDepends_on(org.eclipse.january.dataset.IDataset depends_onDataset)

If desired the location of the slit can also be described relative to an NXbeam, which will allow a simple description of a non-centred slit. The reference plane of the slit is orthogonal to the z axis and includes the surface that is the entry surface of the slit. The reference point of the slit is the centre of the slit opening in the x and y axis on the reference plane. The reference point on the z axis is the reference plane. .. image:: slit/slit.png :width: 40%

Type: NX_CHAR

Specified by:

setDepends_on in interface NXcomponent

Parameters:

depends_onDataset - the depends_onDataset

getDepends_onScalar

String getDepends_onScalar()

If desired the location of the slit can also be described relative to an NXbeam, which will allow a simple description of a non-centred slit. The reference plane of the slit is orthogonal to the z axis and includes the surface that is the entry surface of the slit. The reference point of the slit is the centre of the slit opening in the x and y axis on the reference plane. The reference point on the z axis is the reference plane. .. image:: slit/slit.png :width: 40%

Type: NX_CHAR

Specified by:

getDepends_onScalar in interface NXcomponent

Returns:

the value.

setDepends_onScalar

DataNode setDepends_onScalar(String depends_onValue)

If desired the location of the slit can also be described relative to an NXbeam, which will allow a simple description of a non-centred slit. The reference plane of the slit is orthogonal to the z axis and includes the surface that is the entry surface of the slit. The reference point of the slit is the centre of the slit opening in the x and y axis on the reference plane. The reference point on the z axis is the reference plane. .. image:: slit/slit.png :width: 40%

Type: NX_CHAR

Specified by:

setDepends_onScalar in interface NXcomponent

Parameters:

depends_on - the depends_on

getX_gap

org.eclipse.january.dataset.Dataset getX_gap()

Size of the gap opening in the first dimension of the local coordinate system.

Type: NX_NUMBER Units: NX_LENGTH

Returns:

the value.

setX_gap

DataNode setX_gap(org.eclipse.january.dataset.IDataset x_gapDataset)

Size of the gap opening in the first dimension of the local coordinate system.

Type: NX_NUMBER Units: NX_LENGTH

Parameters:

x_gapDataset - the x_gapDataset

getX_gapScalar

Number getX_gapScalar()

Size of the gap opening in the first dimension of the local coordinate system.

Type: NX_NUMBER Units: NX_LENGTH

Returns:

the value.

setX_gapScalar

DataNode setX_gapScalar(Number x_gapValue)

Size of the gap opening in the first dimension of the local coordinate system.

Type: NX_NUMBER Units: NX_LENGTH

Parameters:

x_gap - the x_gap

getY_gap

org.eclipse.january.dataset.Dataset getY_gap()

Size of the gap opening in the second dimension of the local coordinate system.

Type: NX_NUMBER Units: NX_LENGTH

Returns:

the value.

setY_gap

DataNode setY_gap(org.eclipse.january.dataset.IDataset y_gapDataset)

Size of the gap opening in the second dimension of the local coordinate system.

Type: NX_NUMBER Units: NX_LENGTH

Parameters:

y_gapDataset - the y_gapDataset

getY_gapScalar

Number getY_gapScalar()

Size of the gap opening in the second dimension of the local coordinate system.

Type: NX_NUMBER Units: NX_LENGTH

Returns:

the value.

setY_gapScalar

DataNode setY_gapScalar(Number y_gapValue)

Size of the gap opening in the second dimension of the local coordinate system.

Type: NX_NUMBER Units: NX_LENGTH

Parameters:

y_gap - the y_gap