WellSample

Bases: NBOBaseClass

Represents the XML element WellSample.

WellSample is an individual Image that has been captured within a Well.

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
WellSample	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.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
value	WellSampleID_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
WellSampleID_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

setPositionX(value, validate=True)

Sets the value of the PositionX attribute.

The X position of the field (Image) within the well relative to the well origin defined on the Plate. Units are set by PositionXUnit.

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

getPositionX()

Returns the value of the PositionX attribute.

The X position of the field (Image) within the well relative to the well origin defined on the Plate. Units are set by PositionXUnit.

Returns:

Type	Description
float	The value of the attribute

resetPositionX()

Resets the PositionX attribute to an unset state.

The X position of the field (Image) within the well relative to the well origin defined on the Plate. Units are set by PositionXUnit.

hasPositionX()

Checks whether the PositionX attribute is present.

The X position of the field (Image) within the well relative to the well origin defined on the Plate. Units are set by PositionXUnit.

Returns:

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

setPositionXUnit(value, validate=True)

Sets the value of the PositionXUnit attribute.

No description available in the XSD standard.

Parameters:

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

getPositionXUnit()

Returns the value of the PositionXUnit attribute.

No description available in the XSD standard.

Returns:

Type	Description
UnitsLength_Type	The value of the attribute

resetPositionXUnit()

Resets the PositionXUnit attribute to an unset state.

No description available in the XSD standard.

hasPositionXUnit()

Checks whether the optional PositionXUnit attribute is present.

No description available in the XSD standard.

Returns:

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

setPositionY(value, validate=True)

Sets the value of the PositionY attribute.

The Y position of the field (Image) within the well relative to the well origin defined on the Plate. Units are set by PositionYUnit.

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

getPositionY()

Returns the value of the PositionY attribute.

The Y position of the field (Image) within the well relative to the well origin defined on the Plate. Units are set by PositionYUnit.

Returns:

Type	Description
float	The value of the attribute

resetPositionY()

Resets the PositionY attribute to an unset state.

The Y position of the field (Image) within the well relative to the well origin defined on the Plate. Units are set by PositionYUnit.

hasPositionY()

Checks whether the PositionY attribute is present.

The Y position of the field (Image) within the well relative to the well origin defined on the Plate. Units are set by PositionYUnit.

Returns:

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

setPositionYUnit(value, validate=True)

Sets the value of the PositionYUnit attribute.

No description available in the XSD standard.

Parameters:

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

getPositionYUnit()

Returns the value of the PositionYUnit attribute.

No description available in the XSD standard.

Returns:

Type	Description
UnitsLength_Type	The value of the attribute

resetPositionYUnit()

Resets the PositionYUnit attribute to an unset state.

No description available in the XSD standard.

hasPositionYUnit()

Checks whether the optional PositionYUnit attribute is present.

No description available in the XSD standard.

Returns:

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

setTimepoint(value, validate=True)

Sets the value of the Timepoint attribute.

The time-point at which the Image started to be collected

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

getTimepoint()

Returns the value of the Timepoint attribute.

The time-point at which the Image started to be collected

Returns:

Type	Description
string	The value of the attribute

resetTimepoint()

Resets the Timepoint attribute to an unset state.

The time-point at which the Image started to be collected

hasTimepoint()

Checks whether the Timepoint attribute is present.

The time-point at which the Image started to be collected

Returns:

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

getTimepointAllowedValues() staticmethod

Returns the allowed values for this attribut.

The time-point at which the Image started to be collected

Returns:

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

setIndex(value, validate=True)

Sets the value of the Index attribute.

This records the order of the well samples. Each index should be unique for a given plate but they do not have to be sequential, there may be gaps if part of the dataset is missing. In the user interface the displayed value of the index will be calculated modulo the number of PlateAcquisitions for the plate.

Parameters:

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

getIndex()

Returns the value of the Index attribute.

This records the order of the well samples. Each index should be unique for a given plate but they do not have to be sequential, there may be gaps if part of the dataset is missing. In the user interface the displayed value of the index will be calculated modulo the number of PlateAcquisitions for the plate.

Returns:

Type	Description
NonNegativeInt_Type	The value of the attribute

resetIndex()

Resets the Index attribute to an unset state.

This records the order of the well samples. Each index should be unique for a given plate but they do not have to be sequential, there may be gaps if part of the dataset is missing. In the user interface the displayed value of the index will be calculated modulo the number of PlateAcquisitions for the plate.

hasIndex()

Checks whether the optional Index attribute is present.

This records the order of the well samples. Each index should be unique for a given plate but they do not have to be sequential, there may be gaps if part of the dataset is missing. In the user interface the displayed value of the index will be calculated modulo the number of PlateAcquisitions for the plate.

Returns:

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

setImageRef(value, validate=True)

Sets the value of the ImageRef element.

This is the main link to the core Image element

Parameters:

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

getImageRef()

Returns the value of the ImageRef element.

This is the main link to the core Image element

Returns:

Type	Description
ImageRef	The value of the element

resetImageRef()

Resets the ImageRef element to an unset state.

This is the main link to the core Image element

hasImageRef()

Checks whether the optional ImageRef element is present.

This is the main link to the core Image element

Returns:

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