AdditionalDimensionMap¶

Bases: NBOBaseClass

Represents the XML element AdditionalDimensionMap.

This map defines any additional dimension beyond the canonical 5 dimensions XYZCT. It contains a number of elements for each Plane of data referring to this Additional Dimension.

`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
`AdditionalDimensionMap`	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

`setID(value, validate=True)` ¶

Sets the value of the ID attribute.

A Unique Identifier for this component.

Parameters:

Name	Type	Description	Default
`value`	`LSID_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.

A Unique Identifier for this component.

Returns:

Type	Description
`LSID_Type`	The value of the attribute

`resetID()` ¶

Resets the ID attribute to an unset state.

A Unique Identifier for this component.

`hasID()` ¶

Checks whether the optional ID attribute is present.

A Unique Identifier for this component.

Returns:

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

`setName(value, validate=True)` ¶

Sets the value of the Name attribute.

A user assigned Name for this component.

Parameters:

Name	Type	Description	Default
`value`	`Denomination_Type`	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 user assigned Name for this component.

Returns:

Type	Description
`Denomination_Type`	The value of the attribute

`resetName()` ¶

Resets the Name attribute to an unset state.

A user assigned Name for this component.

`hasName()` ¶

Checks whether the optional Name attribute is present.

A user assigned Name for this component.

Returns:

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

`setSize(value, validate=True)` ¶

Sets the value of the Size attribute.

This field captures the number of sample points recorded along this dimension.

Parameters:

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

`getSize()` ¶

Returns the value of the Size attribute.

This field captures the number of sample points recorded along this dimension.

Returns:

Type	Description
`int`	The value of the attribute

`resetSize()` ¶

Resets the Size attribute to an unset state.

This field captures the number of sample points recorded along this dimension.

`hasSize()` ¶

Checks whether the Size attribute is present.

This field captures the number of sample points recorded along this dimension.

Returns:

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

`setType(value, validate=True)` ¶

Sets the value of the Type attribute.

This field describes the Type of this Additional Dimension.

Parameters:

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

`getType()` ¶

Returns the value of the Type attribute.

This field describes the Type of this Additional Dimension.

Returns:

Type	Description
`AdditionalDimensionType_Type`	The value of the attribute

`resetType()` ¶

Resets the Type attribute to an unset state.

This field describes the Type of this Additional Dimension.

`hasType()` ¶

Checks whether the optional Type attribute is present.

This field describes the Type of this Additional Dimension.

Returns:

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

`setTypeDescription(value, validate=True)` ¶

Sets the value of the TypeDescription attribute.

This is a description of the Type used to indicate to an application or user how the data should be interpreted.

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`

`getTypeDescription()` ¶

Returns the value of the TypeDescription attribute.

This is a description of the Type used to indicate to an application or user how the data should be interpreted.

Returns:

Type	Description
`string`	The value of the attribute

`resetTypeDescription()` ¶

Resets the TypeDescription attribute to an unset state.

This is a description of the Type used to indicate to an application or user how the data should be interpreted.

`hasTypeDescription()` ¶

Checks whether the TypeDescription attribute is present.

This is a description of the Type used to indicate to an application or user how the data should be interpreted.

Returns:

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

`getTypeDescriptionAllowedValues()` `staticmethod` ¶

Returns the allowed values for this attribut.

This is a description of the Type used to indicate to an application or user how the data should be interpreted.

Returns:

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

`setOrder(value, validate=True)` ¶

Sets the value of the Order attribute.

This field describes the order in which the individual Planes of data referring to this dimension are interleaved in the Image past the canonical 5 dimension XYZCT. The number should be zero based, e.g., 0, 1, 2 etc.

Parameters:

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

`getOrder()` ¶

Returns the value of the Order attribute.

This field describes the order in which the individual Planes of data referring to this dimension are interleaved in the Image past the canonical 5 dimension XYZCT. The number should be zero based, e.g., 0, 1, 2 etc.

Returns:

Type	Description
`int`	The value of the attribute

`resetOrder()` ¶

Resets the Order attribute to an unset state.

This field describes the order in which the individual Planes of data referring to this dimension are interleaved in the Image past the canonical 5 dimension XYZCT. The number should be zero based, e.g., 0, 1, 2 etc.

`hasOrder()` ¶

Checks whether the Order attribute is present.

This field describes the order in which the individual Planes of data referring to this dimension are interleaved in the Image past the canonical 5 dimension XYZCT. The number should be zero based, e.g., 0, 1, 2 etc.

Returns:

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

`setPresetStepIncrement(value, validate=True)` ¶

Sets the value of the PresetStepIncrement attribute.

This field records the preset size of Step Increment between Planes of data along this dimension. The Increment is numbered from 0, with default value of 1. Setting a value for this attribute to -1 indicates non-uniform sampling along this Additional Dimension. In this case the actual Step Increment value associated with each Plane along this Additional Dimension will have to be stored in TheIncrementStamp attribute of TheAdditionalDimension.

Parameters:

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

`getPresetStepIncrement()` ¶

Returns the value of the PresetStepIncrement attribute.

This field records the preset size of Step Increment between Planes of data along this dimension. The Increment is numbered from 0, with default value of 1. Setting a value for this attribute to -1 indicates non-uniform sampling along this Additional Dimension. In this case the actual Step Increment value associated with each Plane along this Additional Dimension will have to be stored in TheIncrementStamp attribute of TheAdditionalDimension.

Returns:

Type	Description
`float`	The value of the attribute

`resetPresetStepIncrement()` ¶

Resets the PresetStepIncrement attribute to an unset state.

This field records the preset size of Step Increment between Planes of data along this dimension. The Increment is numbered from 0, with default value of 1. Setting a value for this attribute to -1 indicates non-uniform sampling along this Additional Dimension. In this case the actual Step Increment value associated with each Plane along this Additional Dimension will have to be stored in TheIncrementStamp attribute of TheAdditionalDimension.

`hasPresetStepIncrement()` ¶

Checks whether the PresetStepIncrement attribute is present.

This field records the preset size of Step Increment between Planes of data along this dimension. The Increment is numbered from 0, with default value of 1. Setting a value for this attribute to -1 indicates non-uniform sampling along this Additional Dimension. In this case the actual Step Increment value associated with each Plane along this Additional Dimension will have to be stored in TheIncrementStamp attribute of TheAdditionalDimension.

Returns:

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

`setUnit(value, validate=True)` ¶

Sets the value of the Unit attribute.

This field records the Unit used for the metric recorded along this dimension

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`

`getUnit()` ¶

Returns the value of the Unit attribute.

This field records the Unit used for the metric recorded along this dimension

Returns:

Type	Description
`string`	The value of the attribute

`resetUnit()` ¶

Resets the Unit attribute to an unset state.

This field records the Unit used for the metric recorded along this dimension

`hasUnit()` ¶

Checks whether the Unit attribute is present.

This field records the Unit used for the metric recorded along this dimension

Returns:

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

`getUnitAllowedValues()` `staticmethod` ¶

Returns the allowed values for this attribut.

This field records the Unit used for the metric recorded along this dimension

Returns:

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