ColoredBeadsSlide¶

Bases: OpticalCalibrationStandard_Type

Represents the XML element ColoredBeadsSlide.

This element describes a Slide coated with Multicolor Fluorescent Microspheres (also known as Multicolored Beads) used for assessing the Optical properties of the Microscope that was used to acquire this experimental Image. These Slides can be used to measure Optical properties such as resolution, chromatic registration, and different kinds of optical distorsions.

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

`setDate(value, validate=True)` ¶

Sets the value of the Date attribute.

This field captures the Date in which this Colored Beads Slide was prepared.

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`

`getDate()` ¶

Returns the value of the Date attribute.

This field captures the Date in which this Colored Beads Slide was prepared.

Returns:

Type	Description
`string`	The value of the attribute

`resetDate()` ¶

Resets the Date attribute to an unset state.

This field captures the Date in which this Colored Beads Slide was prepared.

`hasDate()` ¶

Checks whether the Date attribute is present.

This field captures the Date in which this Colored Beads Slide was prepared.

Returns:

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

`getDateAllowedValues()` `staticmethod` ¶

Returns the allowed values for this attribut.

This field captures the Date in which this Colored Beads Slide was prepared.

Returns:

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

`setBeadVolume(value, validate=True)` ¶

Sets the value of the BeadVolume attribute.

This field captures the Volume of the Multi Color Microspheres preparation that was utilized to prepare this Slide.

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`

`getBeadVolume()` ¶

Returns the value of the BeadVolume attribute.

This field captures the Volume of the Multi Color Microspheres preparation that was utilized to prepare this Slide.

Returns:

Type	Description
`float`	The value of the attribute

`resetBeadVolume()` ¶

Resets the BeadVolume attribute to an unset state.

This field captures the Volume of the Multi Color Microspheres preparation that was utilized to prepare this Slide.

`hasBeadVolume()` ¶

Checks whether the BeadVolume attribute is present.

This field captures the Volume of the Multi Color Microspheres preparation that was utilized to prepare this Slide.

Returns:

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