dectris.albula.DNeXusGroup Class Reference

class DNeXusGroup represents a group in the NeXus tree. More...

Inheritance diagram for dectris.albula.DNeXusGroup:

Public Member Functions
def	childElement (name)
	Return Child element with given name. More...
def	eraseChild (name)
	Remove the child with the given name. More...
def	subGroup (name)
	Return subgroup with given name. More...
def	addSubGroup (name)
	Add new subgoup. More...
def	dataset (name)
	Return dataset with given name. More...
def	addDataset (name)
	Add new dataset. More...
def	attribute (name)
	Return attribute with given name. More...
def	addAttribute (name)
	Add new attribute. More...
def	children (recursive=False)
	Return list of child elements. More...
def	subGroups ()
	Return list of subgroups. More...
def	datasets ()
	Return list of datasets. More...
def	attributes ()
	Return list of attributes. More...
Public Member Functions inherited from dectris.albula.DNeXusNode
def	path ()
	path() returns the full NeXus path. More...
def	name ()
	Name of NeXus node. More...
def	type ()
	NeXus Type More...
def	parent ()
	Parent NeXus Node. More...

Detailed Description

class DNeXusGroup represents a group in the NeXus tree.

Groups may contain children, which are either groups or datasets (DNeXusData). In addition groups may contain attributes (DNeXusAttribute).

Member Function Documentation

addAttribute()

def dectris.albula.DNeXusGroup.addAttribute

(

name

)

Add new attribute.

Parameters

name	of the attribute

Returns

DNeXusAttribute referencing the new attribute

addDataset()

def dectris.albula.DNeXusGroup.addDataset

(

name

)

Add new dataset.

Parameters

name	of the dataset

Returns

DNeXusData referencing the new dataset

addSubGroup()

def dectris.albula.DNeXusGroup.addSubGroup

(

name

)

Add new subgoup.

Parameters

name	of the subgroup

Returns

DNeXusGroup referencing the new subgroup

attribute()

def dectris.albula.DNeXusGroup.attribute

(

name

)

Return attribute with given name.

If the attribute does not exist a DOutOfRangeException is thrown.

Parameters

name	of the attribute

Returns

DNeXusAttribute referencing attribute

attributes()

def dectris.albula.DNeXusGroup.attributes

(

)

Return list of attributes.

Returns

python list of DNeXusAttribute objects

childElement()

def dectris.albula.DNeXusGroup.childElement

(

name

)

Return Child element with given name.

If the child does not exist a DOutOfRangeException is thrown.

Parameters

name	of the child element or path to childElement.

Returns

DNeXusNode referencing the child element

children()

def dectris.albula.DNeXusGroup.children

(

recursive = False

)

Return list of child elements.

Parameters

recursive

If True return all children and grandchildren else return only direct descendants

Returns

python list of DNeXusNode objects

dataset()

def dectris.albula.DNeXusGroup.dataset

(

name

)

Return dataset with given name.

If the dataset does not exist a DOutOfRangeException is thrown.

Parameters

name	of the dataset

Returns

DNeXusGroup referencing dataset

datasets()

def dectris.albula.DNeXusGroup.datasets

(

)

Return list of datasets.

Returns

python list of DNeXusData objects

eraseChild()

def dectris.albula.DNeXusGroup.eraseChild

(

name

)

Remove the child with the given name.

Parameters

name	String with the name of the child to erase

subGroup()

def dectris.albula.DNeXusGroup.subGroup

(

name

)

Return subgroup with given name.

If the subgroup does not exist a DOutOfRangeException is thrown.

Parameters

name	of the subgroup

Returns

DNeXusGroup referencing subgroup

subGroups()

def dectris.albula.DNeXusGroup.subGroups

(

)

Return list of subgroups.

Returns

python list of DNeXusGroup objects