Dataset

Bases: NBOBaseClass

Represents the XML element Dataset.

An element specifying a collection of images that are always processed together. Images can belong to more than one Dataset, and a Dataset may contain more than one Image. Images contain one or more DatasetRef elements to specify what datasets they belong to. Once a Dataset has been processed in any way, its collection of images cannot be altered. The ExperimenterRef and ExperimenterGroupRef elements specify the person and group this Dataset belongs to. Projects may contain one or more Datasets, and Datasets may belong to one or more Projects. This relationship is specified by listing DatasetRef elements within the Project element.

fromBase(base) staticmethod

Cast a NBOBaseClass to a CMOS.

Parameters:

Name	Type	Description	Default
base	NBOBaseClass	The base class to cast	required

Returns:

Type	Description
Dataset	The casted element, or nullptr if the cast fails

getTypeName()

Returns the class type name.

Returns:

Type	Description
string	The class type name

getXMLName()

Returns the XML element name corresponding to this class.

Returns:

Type	Description
string	The XML element name

getNBOType()

Returns the NBO Type corresponding to this class.

Returns:

Type	Description
int	The NBO Type value

getChildren()

Returns a list of all classes derived from this class.

Returns:

Type	Description
List[NBOBaseClass]	The list of derived classes

getSubElements()

Returns a list of all child elements contained in this class.

Returns:

Type	Description
List[NBOBaseClass]	The list of child classes

fromJsonFile(path, validate=True)

Populates this object from a JSON file.

Parameters:

Name	Type	Description	Default
path	string	The path to the JSON file	required
validate	(boolean, optional)	If true, validates constraints on value. Default is true.	True

fromJsonString(json_string, validate=True)

Populates this object from a JSON string.

Parameters:

Name	Type	Description	Default
json_string	string	The JSON content as a string	required
validate	(boolean, optional)	If true, validates constraints on value. Default is true.	True

fromXmlFile(path, validate=True)

Populates this object from a XML file.

Parameters:

Name	Type	Description	Default
path	string	The path to the XML file	required
validate	(boolean, optional)	If true, validates constraints on value. Default is true.	True

fromXmlString(xml_string, validate=True)

Populates this object from a XML string.

Parameters:

Name	Type	Description	Default
xml_string	string	The XML content as a string	required
validate	(boolean, optional)	If true, validates constraints on value. Default is true.	True

toXmlFile(filename, validate=True)

Serializes this object to an XML file.

Parameters:

Name	Type	Description	Default
filename	string	The path to the output XML file	required
validate	(boolean, optional)	If true, validates constraints on value. Default is true.	True

toXmlString(validate=True)

Serializes this object to an XML string.

Parameters:

Name	Type	Description	Default
validate	(boolean, optional)	If true, validates constraints on value. Default is true.	True

Returns:

Type	Description
string	A string containing the XML representation of this object

setName(value, validate=True)

Sets the value of the Name attribute.

A name for the dataset that is suitable for presentation to the user.

Parameters:

Name	Type	Description	Default
value	string	The value to set	required
validate	(boolean, optional)	If true, validates constraints on value. Default is true.	True

getName()

Returns the value of the Name attribute.

A name for the dataset that is suitable for presentation to the user.

Returns:

Type	Description
string	The value of the attribute

resetName()

Resets the Name attribute to an unset state.

A name for the dataset that is suitable for presentation to the user.

hasName()

Checks whether the Name attribute is present.

A name for the dataset that is suitable for presentation to the user.

Returns:

Type	Description
boolean	true if the attribute has been set, false otherwise

getNameAllowedValues() staticmethod

Returns the allowed values for this attribut.

A name for the dataset that is suitable for presentation to the user.

Returns:

Type	Description
std::set< str,std::less< str >,std::allocator< str > >	The list of allowed values

setID(value, validate=True)

Sets the value of the ID attribute.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
value	DatasetID_Type	The value to set	required
validate	(boolean, optional)	If true, validates constraints on value. Default is true.	True

getID()

Returns the value of the ID attribute.

No description available in the XSD standard.

Returns:

Type	Description
DatasetID_Type	The value of the attribute

resetID()

Resets the ID attribute to an unset state.

No description available in the XSD standard.

hasID()

Checks whether the optional ID attribute is present.

No description available in the XSD standard.

Returns:

Type	Description
boolean	true if the optional attribute has been set, false otherwise

setDescription(value, validate=True)

Sets the value of the Description element.

A description for the dataset. [plain-text multi-line string]

Parameters:

Name	Type	Description	Default
value	Dataset_InlineDescription	The value to set	required
validate	(boolean, optional)	If true, validates constraints on value. Default is true.	True

getDescription()

Returns the value of the Description element.

A description for the dataset. [plain-text multi-line string]

Returns:

Type	Description
Dataset_InlineDescription	The value of the element

resetDescription()

Resets the Description element to an unset state.

A description for the dataset. [plain-text multi-line string]

hasDescription()

Checks whether the optional Description element is present.

A description for the dataset. [plain-text multi-line string]

Returns:

Type	Description
boolean	true if the optional attribute has been set, false otherwise

setExperimenterRef(value, validate=True)

Sets the value of the ExperimenterRef element.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
value	ExperimenterRef	The value to set	required
validate	(boolean, optional)	If true, validates constraints on value. Default is true.	True

getExperimenterRef()

Returns the value of the ExperimenterRef element.

No description available in the XSD standard.

Returns:

Type	Description
ExperimenterRef	The value of the element

resetExperimenterRef()

Resets the ExperimenterRef element to an unset state.

No description available in the XSD standard.

hasExperimenterRef()

Checks whether the optional ExperimenterRef element is present.

No description available in the XSD standard.

Returns:

Type	Description
boolean	true if the optional attribute has been set, false otherwise

setExperimenterGroupRef(value, validate=True)

Sets the value of the ExperimenterGroupRef element.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
value	ExperimenterGroupRef	The value to set	required
validate	(boolean, optional)	If true, validates constraints on value. Default is true.	True

getExperimenterGroupRef()

Returns the value of the ExperimenterGroupRef element.

No description available in the XSD standard.

Returns:

Type	Description
ExperimenterGroupRef	The value of the element

resetExperimenterGroupRef()

Resets the ExperimenterGroupRef element to an unset state.

No description available in the XSD standard.

hasExperimenterGroupRef()

Checks whether the optional ExperimenterGroupRef element is present.

No description available in the XSD standard.

Returns:

Type	Description
boolean	true if the optional attribute has been set, false otherwise

setImageRef_List(value, validate=True)

Sets the list of ImageRef elements.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
value	List[ImageRef]	The new list of ImageRef elements	required
validate	(boolean, optional)	If true, validates constraints on value. Default is true.	True

getImageRef_List()

Returns the list of ImageRef elements.

No description available in the XSD standard.

Returns:

Type	Description
List[ImageRef]	The list of ImageRef elements

addToImageRef_List(value, validate=True)

Adds a new ImageRef element to this object.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
value	ImageRef	The element to add	required
validate	(boolean, optional)	If true, validates constraints on value. Default is true.	True

clearImageRef_List()

Clear the list of ImageRef.

No description available in the XSD standard.

setAnnotationRef_List(value, validate=True)

Sets the list of AnnotationRef elements.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
value	List[AnnotationRef]	The new list of AnnotationRef elements	required
validate	(boolean, optional)	If true, validates constraints on value. Default is true.	True

getAnnotationRef_List()

Returns the list of AnnotationRef elements.

No description available in the XSD standard.

Returns:

Type	Description
List[AnnotationRef]	The list of AnnotationRef elements

addToAnnotationRef_List(value, validate=True)

Adds a new AnnotationRef element to this object.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
value	AnnotationRef	The element to add	required
validate	(boolean, optional)	If true, validates constraints on value. Default is true.	True

clearAnnotationRef_List()

Clear the list of AnnotationRef.

No description available in the XSD standard.