ImmersionLiquid

Bases: ManufacturerSpec_Type

Represents the XML element ImmersionLiquid.

This element refers to the Immersion Liquid that was used with this Objective during the Acquisition of this Image. According to ISO 10934-1:2002, an Immersion Liquid is a liquid (commonly immersion oil, water, glycerol or any media in which the Specimen is submerged during acquisition in case a Cover Glass is not used) specified as suitable for use in the space between the front of an Objective lens and the Cover Glass or the Object itself (i.e., such as is the case for Dipping Objectives). Refer to ISO 8036-1 for more details on Immersion Oil. Please NOTE: Because the Immersion Liquid is considered in the computing of corrections to be part of the lens, its refractive index and dispersion (or Abbe number) are critical. Also please NOTE: In case a Cover Glass is not used during Acquisition the Immersion Liquid is most often referred to as Dipping Medium. Examples of Dipping Media include, water-based solutions (biological buffers, culture media, other water-based solutions) and organic-based [FocusClear (CLARITY); CUBIC-1, CUBIC-2, CUBIC-R1, CUBIC-R2; 2,2-thiodiethanol (TDE); ethyl cinnamate; Benzyl Benzoate and BB-PEG (PEGASOS); Benzyl Alcohol, Benzyl Benzoate (BABB); dibenzyl ether (DBE); Ethanol].

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
ImmersionLiquid	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

setType(value, validate=True)

Sets the value of the Type attribute.

This field records the general category to which this Immersion Liquid belongs.

Parameters:

Name	Type	Description	Default
value	ImmersionLiquidType_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 records the general category to which this Immersion Liquid belongs.

Returns:

Type	Description
ImmersionLiquidType_Type	The value of the attribute

resetType()

Resets the Type attribute to an unset state.

This field records the general category to which this Immersion Liquid belongs.

hasType()

Checks whether the optional Type attribute is present.

This field records the general category to which this Immersion Liquid belongs.

Returns:

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

setRefractiveIndex(value, validate=True)

Sets the value of the RefractiveIndex attribute.

This field reocrds the nominal Refractive Index of this Immersion Liquid, as specified by the Manufacturer.

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

getRefractiveIndex()

Returns the value of the RefractiveIndex attribute.

This field reocrds the nominal Refractive Index of this Immersion Liquid, as specified by the Manufacturer.

Returns:

Type	Description
float	The value of the attribute

resetRefractiveIndex()

Resets the RefractiveIndex attribute to an unset state.

This field reocrds the nominal Refractive Index of this Immersion Liquid, as specified by the Manufacturer.

hasRefractiveIndex()

Checks whether the RefractiveIndex attribute is present.

This field reocrds the nominal Refractive Index of this Immersion Liquid, as specified by the Manufacturer.

Returns:

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

setViscosity(value, validate=True)

Sets the value of the Viscosity attribute.

This field records the nominal Viscosity of this Immersion Liquid as specified by the Manufacturer.

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

getViscosity()

Returns the value of the Viscosity attribute.

This field records the nominal Viscosity of this Immersion Liquid as specified by the Manufacturer.

Returns:

Type	Description
float	The value of the attribute

resetViscosity()

Resets the Viscosity attribute to an unset state.

This field records the nominal Viscosity of this Immersion Liquid as specified by the Manufacturer.

hasViscosity()

Checks whether the Viscosity attribute is present.

This field records the nominal Viscosity of this Immersion Liquid as specified by the Manufacturer.

Returns:

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