MicroscopeStandSettings

Bases: Settings_Type

Represents the XML element MicroscopeStandSettings.

This element refers to the Microscope Stand used to acquire this Image and it holds the Settings that were applied to the Microscope Stand during this Acquisition.

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

This is the Unique Identifier of the Microscope used in this case.

Parameters:

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

This is the Unique Identifier of the Microscope used in this case.

Returns:

Type	Description
MicroscopeID_Type	The value of the attribute

resetID()

Resets the ID attribute to an unset state.

This is the Unique Identifier of the Microscope used in this case.

hasID()

Checks whether the optional ID attribute is present.

This is the Unique Identifier of the Microscope used in this case.

Returns:

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

setTotalEffectiveMagnification(value, validate=True)

Sets the value of the TotalEffectiveMagnification attribute.

This fields records the Total Effective Magnification used in this case. This number can be obtained by multiplying Magnification Changer:Magnification times the Objective:NominalMagnification or even better the Objective:CalibratedMagnification if available.

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

getTotalEffectiveMagnification()

Returns the value of the TotalEffectiveMagnification attribute.

This fields records the Total Effective Magnification used in this case. This number can be obtained by multiplying Magnification Changer:Magnification times the Objective:NominalMagnification or even better the Objective:CalibratedMagnification if available.

Returns:

Type	Description
float	The value of the attribute

resetTotalEffectiveMagnification()

Resets the TotalEffectiveMagnification attribute to an unset state.

This fields records the Total Effective Magnification used in this case. This number can be obtained by multiplying Magnification Changer:Magnification times the Objective:NominalMagnification or even better the Objective:CalibratedMagnification if available.

hasTotalEffectiveMagnification()

Checks whether the TotalEffectiveMagnification attribute is present.

This fields records the Total Effective Magnification used in this case. This number can be obtained by multiplying Magnification Changer:Magnification times the Objective:NominalMagnification or even better the Objective:CalibratedMagnification if available.

Returns:

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

setFieldOfView(value, validate=True)

Sets the value of the FieldOfView attribute.

The Field of View defines the area of the specimen that is viewable via the eyepiece. This field caputers the measures size of the Field of View.

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

getFieldOfView()

Returns the value of the FieldOfView attribute.

The Field of View defines the area of the specimen that is viewable via the eyepiece. This field caputers the measures size of the Field of View.

Returns:

Type	Description
float	The value of the attribute

resetFieldOfView()

Resets the FieldOfView attribute to an unset state.

The Field of View defines the area of the specimen that is viewable via the eyepiece. This field caputers the measures size of the Field of View.

hasFieldOfView()

Checks whether the FieldOfView attribute is present.

The Field of View defines the area of the specimen that is viewable via the eyepiece. This field caputers the measures size of the Field of View.

Returns:

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

setFieldOfViewUnit(value, validate=True)

Sets the value of the FieldOfViewUnit 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

getFieldOfViewUnit()

Returns the value of the FieldOfViewUnit attribute.

No description available in the XSD standard.

Returns:

Type	Description
UnitsLength_Type	The value of the attribute

resetFieldOfViewUnit()

Resets the FieldOfViewUnit attribute to an unset state.

No description available in the XSD standard.

hasFieldOfViewUnit()

Checks whether the optional FieldOfViewUnit attribute is present.

No description available in the XSD standard.

Returns:

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